GetVehicleName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:


__NOTOC__  
__NOTOC__  
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function returns a string containing the name of the vehicle


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getVehicleName ( vehicle )             
string getVehicleName ( vehicle theVehicle )             
</syntaxhighlight>  
</syntaxhighlight>  


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


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns a string containing the requested vehicle's name, or false if the client passed to the function is invalid.


==Example==  
==Example==  
This example does...
This example does...
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
-- add the event to the event handler
blabhalbalhb --abababa
addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
--This line does this...
function onPlayerEnterVehicle ( vehicle, seat, jacked ) --when someone enters a vehicle
mooo
  if vehicle == 519 or 577 then --if the vehicle is one of these two planes
    vehiclename = getVehicleName ( vehicle ) -- define the vehicle name
    outputChatBox ( "Someone stole the "..vehiclename.."!" ) -- announce that someone stole the plane
  end
end
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 01:51, 30 July 2006


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 client passed to the function is invalid.

Example

This example does... 

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleName?oldid=4105"