GetVehiclePlateText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Shortened example var. 'localPlayerOccupiedVehicle' -> 'vehicle')
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
{{Server client function}}
{{Server client function}}
__NOTOC__
This function is used to retrieve the text on the number plate of a specified vehicle.
This function is used to retrieve the text on the number plate of a specified vehicle.


Line 9: Line 9:


===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' A handle to 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 coresponds to the plate on the text or ''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 the vehicle is not a car.


==Example==  
==Example==  
<section name="Example" 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">
function scriptPlate ( player, command )
function outputLicensePlate ( command )
  local aVehicle = getPlayerOccupiedVehicle ( getLocalPlayer() )
    if isPedInVehicle(localPlayer) then --let's check if they're in a vehicle
  local text = getVehiclePlateText ( aVehicle )
        -- if they are in a vehicle
  if ( text and aVehicle ) then
        local vehicle = getPedOccupiedVehicle ( localPlayer ) --let's get the vehicle
    outputChatBox ( "text" )
        local plateText = getVehiclePlateText ( vehicle ) --get the license plate text
  else outputChatBox ( "your vehicle has no licence plate or you're not in a vehicle" )
        if plateText then -- if there was a license plate,
  end
            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
end
addCommandHandler( "plate", scriptPlate )
-- add our function as a handler to the "plate" command
addCommandHandler( "plate", outputLicensePlate )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}

Revision as of 20:00, 20 October 2013

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

Syntax

string getVehiclePlateText ( vehicle theVehicle )

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 the vehicle is not a car.

Example

Click to collapse [-]
Example

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=37387"