GetVehicleName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (→Example) |
||
Line 17: | Line 17: | ||
This example checks whether a player enters an AT-400 or a Shamal. If they do, it announces it to the chat specifying what vehicle was stolen. | This example checks whether a player enters an AT-400 or a Shamal. If they do, it announces it to the chat specifying what vehicle was stolen. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function planeEnter ( theVehicle, seat, jacked ) | function planeEnter ( theVehicle, seat, jacked ) -- when someone enters a vehicle | ||
local id = getVehicleID ( theVehicle ) | local id = getVehicleID ( theVehicle ) -- get the model ID of the vehicle | ||
if id == 519 or id == 577 then | if id == 519 or id == 577 then -- if theVehicle is either Shamal or AT-400 | ||
local | local vehicleName = getVehicleName ( theVehicle ) -- get the name of theVehicle | ||
outputChatBox ( "Someone stole a " .. | outputChatBox ( "Someone stole a " .. vehicleName .. "!" ) -- announce that someone stole the plane | ||
end | end | ||
end | end | ||
-- add the event to the event | -- add the event handler to the event | ||
addEventHandler ( " | addEventHandler ( "onPlayerVehicleEnter", getRootElement(), planeEnter ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Vehicle_functions}} | {{Vehicle_functions}} |
Revision as of 17:17, 4 April 2009
This function returns a string containing the name of the vehicle
Syntax
string getVehicleName ( vehicle theVehicle )
Required Arguments
- theVehicle: The vehicle you want to get the name of.
Returns
Returns a string containing the requested vehicle's name, or false if the vehicle passed to the function is invalid.
Example
This example checks whether a player enters an AT-400 or a Shamal. If they do, it announces it to the chat specifying what vehicle was stolen.
function planeEnter ( theVehicle, seat, jacked ) -- when someone enters a vehicle local id = getVehicleID ( theVehicle ) -- get the model ID of the vehicle if id == 519 or id == 577 then -- if theVehicle is either Shamal or AT-400 local vehicleName = getVehicleName ( theVehicle ) -- get the name of theVehicle outputChatBox ( "Someone stole a " .. vehicleName .. "!" ) -- announce that someone stole the plane end end -- add the event handler to the event addEventHandler ( "onPlayerVehicleEnter", getRootElement(), planeEnter )
See Also
- addVehicleUpgrade
- attachTrailerToVehicle
- blowVehicle
- createVehicle
- detachTrailerFromVehicle
- fixVehicle
- getOriginalHandling
- getTrainDirection
- getTrainPosition
- getTrainSpeed
- getTrainTrack
- getVehicleColor
- getVehicleCompatibleUpgrades
- getVehicleController
- getVehicleDoorOpenRatio
- getVehicleDoorState
- getVehicleEngineState
- getVehicleHandling
- getVehicleHeadLightColor
- getVehicleLandingGearDown
- getVehicleLightState
- getVehicleMaxPassengers
- getVehicleModelFromName
- getVehicleName
- getVehicleNameFromModel
- getVehicleOccupant
- getVehicleOccupants
- getVehicleOverrideLights
- getVehiclePaintjob
- getVehiclePanelState
- getVehiclePlateText
- getVehicleSirenParams
- getVehicleSirens
- getVehicleSirensOn
- getVehicleTowedByVehicle
- getVehicleTowingVehicle
- getVehicleTurretPosition
- getVehicleType
- getVehicleUpgradeOnSlot
- getVehicleUpgradeSlotName
- getVehicleUpgrades
- getVehicleVariant
- getVehicleWheelStates
- isTrainDerailable
- isTrainDerailed
- isVehicleBlown
- isVehicleDamageProof
- isVehicleFuelTankExplodable
- isVehicleLocked
- isVehicleOnGround
- isVehicleTaxiLightOn
- removeVehicleUpgrade
- setTrainDerailable
- setTrainDerailed
- setTrainDirection
- setTrainPosition
- setTrainSpeed
- setTrainTrack
- setVehicleColor
- setVehicleDamageProof
- setVehicleDoorOpenRatio
- setVehicleDoorState
- setVehicleDoorsUndamageable
- setVehicleEngineState
- setVehicleFuelTankExplodable
- setVehicleHandling
- setVehicleHeadLightColor
- setVehicleLandingGearDown
- setVehicleLightState
- setVehicleLocked
- setVehicleOverrideLights
- setVehiclePaintjob
- setVehiclePanelState
- setVehiclePlateText
- setVehicleSirens
- setVehicleSirensOn
- setVehicleTaxiLightOn
- setVehicleTurretPosition
- setVehicleVariant
- setVehicleWheelStates