GetVehicleID: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (Visual improvement)
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
__NOTOC__
{{server client function}}
{{Deprecated|getElementModel}}


__NOTOC__
This function retrieves the ID of a vehicle as an integer value.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getVehicleID ( vehicle vehicle )             
int getVehicleID ( vehicle theVehicle )             
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''theVehicle:''' The vehicle you want to get the ID of.
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


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


==Example==  
==Example==  
This example does...
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function planeEnter ( theVehicle, seat, jacked ) --when someone enters a vehicle
blabhalbalhb --abababa
  id = getVehicleID ( theVehicle ) -- get the ID of the vehicle
--This line does this...
  if id == 519 or id == 577 then --if theVehicle is one of these two planes
mooo
    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 )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{IDs}}
 
{{Vehicle_functions}}

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)


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleID?oldid=40324"