GetVehicleType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Replaced vehicle type list with template include)
 
(10 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server client function}}
{{Server client function}}
{{New feature|3|DP3|
{{New feature|3|1.0|
This function retrieves the vehicle type
This function retrieves the type of a vehicle (such as if it is a car or a boat).
}}
}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getVehicleType ( vehicle theVehicle )
string getVehicleType ( vehicle theVehicle )
string getVehicleType ( integer modelId )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[vehicle]]:getVehicleType|vehicleType}}
'''OR'''
<syntaxhighlight lang="lua">
string getVehicleType ( int modelId )
</syntaxhighlight>


===Required Arguments===  
===Required Arguments===  
*'''vehicle:''' The vehicle element or id.
*'''vehicle:''' The vehicle element to get the type of.
 
'''OR'''
 
*'''modelID:''' A vehicle model ID


===Returns===
===Returns===
Returns a ''string'' with vehicle type or ''false'' if an invalid modelID has been supplied, or an empty string if the vehicle is blocked internally (some trailers). Works server- and clientside.
Returns a ''string'' with vehicle type or ''false'' if an invalid modelID has been supplied, or an empty string if the vehicle is blocked internally (some trailers).
 
Possible strings returned:
{{VehicleTypes}}
 
==Example==
'''Example 1:''' In this example when a player enters an airplane, it displays a message welcoming the player onboard.
<syntaxhighlight lang="lua">
function enterPlane(theVehicle, seat, jacked)
    if (getVehicleType(theVehicle) == "Plane") then
        outputChatBox("Welcome onboard!", source)
    end
end


'''types:'''
addEventHandler("onPlayerVehicleEnter", getRootElement(), enterPlane)
Automobile<br /> Plane<br /> Bike<br /> Helicopter<br /> Boat<br /> Train<br /> Trailer<br /> BMX<br /> Monster Truck<br /> Quad
</syntaxhighlight>


==Example==
'''Example 2:''' In this example player gets message what type of vehicle he just entered.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function enteredVehicleType(theVehicle, seat, jacked)
outputChatBox("You entered ".. getVehicleType(theVehicle) ..".", source)
end


addEventHandler("onPlayerVehicleEnter", getRootElement(), enteredVehicleType)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}

Latest revision as of 17:14, 4 April 2016

This function retrieves the type of a vehicle (such as if it is a car or a boat).

Syntax

string getVehicleType ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getVehicleType(...)
Variable: .vehicleType


OR 

string getVehicleType ( int modelId )

Required Arguments

  • vehicle: The vehicle element to get the type of.

OR

  • modelID: A vehicle model ID

Returns

Returns a string with vehicle type or false if an invalid modelID has been supplied, or an empty string if the vehicle is blocked internally (some trailers).

Possible strings returned:

  • Automobile: Cars, vans and trucks
  • Plane
  • Bike: Motorbikes
  • Helicopter
  • Boat
  • Train
  • Trailer: A trailer for a truck
  • BMX
  • Monster Truck
  • Quad: Quadbikes

Example

Example 1: In this example when a player enters an airplane, it displays a message welcoming the player onboard. 

function enterPlane(theVehicle, seat, jacked)
    if (getVehicleType(theVehicle) == "Plane") then
        outputChatBox("Welcome onboard!", source)
    end
end

addEventHandler("onPlayerVehicleEnter", getRootElement(), enterPlane)

Example 2: In this example player gets message what type of vehicle he just entered. 

function enteredVehicleType(theVehicle, seat, jacked)
	outputChatBox("You entered ".. getVehicleType(theVehicle) ..".", source)
end

addEventHandler("onPlayerVehicleEnter", getRootElement(), enteredVehicleType)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleType?oldid=47339"