GetVehicleID: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (Visual improvement)
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{server client function}}
{{Deprecated|getElementModel}}
This function retrieves the ID of a vehicle as an integer value.
This function retrieves the ID of a vehicle as an integer value.


Line 14: Line 17:


==Example==  
==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.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- add the event to the event handler
function planeEnter ( theVehicle, seat, jacked ) --when someone enters a vehicle
addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
   id = getVehicleID ( theVehicle ) -- get the ID of the vehicle
function onPlayerEnterVehicle ( vehicle, seat, jacked ) --when someone enters a vehicle
   if id == 519 or id == 577 then --if theVehicle is one of these two planes
   id = getVehicleID ( vehicle ) -- get the ID of the vehicle
     vehiclename = getVehicleName ( theVehicle ) -- define the vehicle name  
   if id == 519 or 577 then --if the vehicle is one of these two planes
     outputChatBox ( "Someone stole a " .. vehiclename .. "!" ) -- announce that someone stole the plane
     vehiclename = getVehicleName ( vehicle ) -- define the vehicle name  
     outputChatBox ( "Someone stole the "..vehiclename.."!" ) -- announce that someone stole the plane
   end
   end
end
end
-- add the event to the event handler
addEventHandler ( "onPlayerEnterVehicle", getRootElement(), planeEnter )
</syntaxhighlight>
</syntaxhighlight>



Revision as of 11:28, 26 June 2014

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use getElementModel instead.


This function retrieves the ID of a vehicle as an integer value.

Syntax

int getVehicleID ( vehicle theVehicle )             

Required Arguments

  • theVehicle: The vehicle you want to get the ID of.

Returns

Returns an integer containing the requested vehicle's ID, or false if the vehicle passed to the function is invalid.

Example

function planeEnter ( theVehicle, seat, jacked ) --when someone enters a vehicle
  id = getVehicleID ( theVehicle ) -- get the ID of the vehicle
  if id == 519 or id == 577 then --if theVehicle is one of these two planes
     vehiclename = getVehicleName ( theVehicle ) -- define the vehicle name 
     outputChatBox ( "Someone stole a " .. vehiclename .. "!" ) -- announce that someone stole the plane
  end
end
-- add the event to the event handler
addEventHandler ( "onPlayerEnterVehicle", getRootElement(), planeEnter )

See Also

GTASA IDs (vehicles, weapons, weathers, characters, colors): http://info.vces.net/ (Special thanks to Brophy and Ratt for making these lists)