GetVehicleName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (updated)
No edit summary
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
{{Server client function}}
This function returns a string containing the name of the vehicle
This function returns a string containing the name of the vehicle


Line 6: Line 7:
string getVehicleName ( vehicle theVehicle )             
string getVehicleName ( vehicle theVehicle )             
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[vehicle]]:getName|name}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The vehicle you want to get the name of.  
*'''theVehicle:''' the [[vehicle]] you want to get the name of.  


===Returns===
===Returns===
Returns a string containing the requested vehicle's name, or false if the vehicle 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 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 ) --when someone enters a vehicle
function planeEnter ( theVehicle, seat, jacked ) -- when someone enters a vehicle
  id = getVehicleID ( theVehicle ) -- get the ID of the vehicle
    local id = getElementModel ( theVehicle ) -- get the model ID of the vehicle
  if id == 519 or 577 then --if theVehicle is one of these two planes
    if id == 519 or id == 577 then -- if theVehicle is either Shamal or AT-400
    vehiclename = getVehicleName ( theVehicle ) -- define the vehicle name  
        local vehicleName = getVehicleName ( theVehicle ) -- get the name of theVehicle
    outputChatBox ( "Someone stole a "..vehiclename.."!" ) -- announce that someone stole the plane
        outputChatBox ( "Someone has stolen a " .. vehicleName .. "!" ) -- announce that someone has stolen the plane
  end
    end
end
end
-- add the event to the event handler
-- add the event handler to the event
addEventHandler ( "onPlayerEnterVehicle", getRootElement(), planeEnter )
addEventHandler ( "onPlayerVehicleEnter", root, planeEnter )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Vehicle_functions}}
{{Vehicle_functions}}
[[ru:getVehicleName]]

Latest revision as of 08:23, 4 November 2020

This function returns a string containing the name of the vehicle

Syntax

string getVehicleName ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getName(...)
Variable: .name


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 = getElementModel ( 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 has stolen a " .. vehicleName .. "!" ) -- announce that someone has stolen the plane
    end
end
-- add the event handler to the event
addEventHandler ( "onPlayerVehicleEnter", root, planeEnter )

See Also

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