GetVehiclePlateText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP)
 
(4 intermediate revisions by 4 users not shown)
Line 6: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getVehiclePlateText ( vehicle theVehicle )
string getVehiclePlateText ( vehicle theVehicle )
</syntaxhighlight>  
</syntaxhighlight>
 
{{OOP||[[vehicle]]:getPlateText|plateText|setVehiclePlateText}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The [[vehicle]] that you wish to retrieve the plate text from.
*'''theVehicle:''' the [[vehicle]] that you wish to retrieve the plate text from.


===Returns===
===Returns===
Returns a ''string'' that corresponds to the plate on the text, ''false'' if a bad argument was passed or if the vehicle is not a car.
Returns a ''string'' that corresponds to the plate on the text, ''false'' if a bad argument was passed or if it is not a vehicle. Every vehicle (including planes, boats, etc.) has a numberplate, even if it's not visible.


==Example==  
==Example==  
<section name="Example" class="client" show="true">
<section name="Client" class="client" show="true">
This example outputs the text on the license plate of the vehicle the player is driving to the chatbox.
This example outputs the text on the license plate of the vehicle the player is driving to the chatbox.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 21: Line 21:
     if isPedInVehicle(localPlayer) then --let's check if they're in a vehicle
     if isPedInVehicle(localPlayer) then --let's check if they're in a vehicle
         -- if they are in a vehicle
         -- if they are in a vehicle
         local localPlayerOccupiedVehicle = getPedOccupiedVehicle ( getLocalPlayer() ) --let's get the vehicle
         local vehicle = getPedOccupiedVehicle ( localPlayer ) --let's get the vehicle
         local plateText = getVehiclePlateText ( localPlayerOccupiedVehicle )-- get the license plate text
         local plateText = getVehiclePlateText ( vehicle ) --get the license plate text
         if plateText then -- if there was a license plate,
         if plateText then -- if there was a license plate,
             outputChatBox ( "Your license plate is: " .. plateText )-- output it to the chatbox
             outputChatBox ( "Your license plate is: " .. plateText )-- output it to the chatbox

Latest revision as of 20:33, 13 October 2014

This function is used to retrieve the text on the number plate of a specified vehicle.

Syntax

string getVehiclePlateText ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getPlateText(...)
Variable: .plateText
Counterpart: setVehiclePlateText


Required Arguments

  • theVehicle: the vehicle that you wish to retrieve the plate text from.

Returns

Returns a string that corresponds to the plate on the text, false if a bad argument was passed or if it is not a vehicle. Every vehicle (including planes, boats, etc.) has a numberplate, even if it's not visible.

Example

Click to collapse [-]
Client

This example outputs the text on the license plate of the vehicle the player is driving to the chatbox. 

function outputLicensePlate ( command )
    if isPedInVehicle(localPlayer) then --let's check if they're in a vehicle
         -- if they are in a vehicle
         local vehicle = getPedOccupiedVehicle ( localPlayer ) --let's get the vehicle
         local plateText = getVehiclePlateText ( vehicle ) --get the license plate text
         if plateText then -- if there was a license plate,
             outputChatBox ( "Your license plate is: " .. plateText )-- output it to the chatbox
         else
             outputChatBox ( "Your vehicle has no license plate." )
         end
    else
         outputChatBox ( "You're not in a vehicle." )
    end
end
-- add our function as a handler to the "plate" command
addCommandHandler( "plate", outputLicensePlate )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehiclePlateText?oldid=42593"