GetVehicleName: Difference between revisions

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


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


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

Revision as of 01:59, 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 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. 

-- add the event to the event handler
addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
function onPlayerEnterVehicle ( vehicle, seat, jacked ) --when someone enters a vehicle
  id = getVehicleID ( vehicle ) -- get the ID of the vehicle
  if id == 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=4108"