GetVehicleType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Replace to predefined variables.)
 
(3 intermediate revisions by 3 users not shown)
Line 8: Line 8:
string getVehicleType ( vehicle theVehicle )
string getVehicleType ( vehicle theVehicle )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[vehicle]]:getVehicleType|vehicleType}}
'''OR'''
'''OR'''


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


===Returns===
===Returns===
Line 23: Line 26:


Possible strings returned:
Possible strings returned:
* '''Automobile''': Cars, vans and trucks
{{VehicleTypes}}
* '''Plane'''
* '''Bike''': Motorbikes
* '''Helicopter'''
* '''Boat'''
* '''Train'''
* '''Trailer''': A trailer for a truck
* '''BMX'''
* '''Monster Truck'''
* '''Quad''': Quadbikes


==Example==
==Example==
Line 43: Line 37:
end
end


addEventHandler("onPlayerVehicleEnter", getRootElement(), enterPlane)
addEventHandler("onPlayerVehicleEnter", root, enterPlane)
</syntaxhighlight>
</syntaxhighlight>


Line 52: Line 46:
end
end


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


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

Latest revision as of 11:17, 12 June 2024

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", root, 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", root, enteredVehicleType)

See Also