GetVehiclePlateText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Improved example, fixed sections, minor changes)
mNo edit summary
Line 5: Line 5:


==Syntax==  
==Syntax==  
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getVehiclePlateText ( vehicle theVehicle )
string getVehiclePlateText ( vehicle theVehicle )
Line 15: Line 14:
===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 the vehicle is not a car.
</section>


==Example==  
==Example==  

Revision as of 10:36, 27 August 2007

Dialog-information.png This article needs checking.

Reason(s): This function doesn't work, mantis #2457 --Norby89 13:47, 26 August 2007 (CDT)

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 )
  -- get the vehicle the local player is in
  local localPlayerOccupiedVehicle = getPlayerOccupiedVehicle ( getLocalPlayer() )
  -- if he is in a vehicle,
  if localPlayerOccupiedVehicle then
    -- get the license plate text
    local plateText = getVehiclePlateText ( localPlayerOccupiedVehicle )
    -- if there was a license plate,
    if plateText then
      -- output it to the chatbox
      outputChatBox ( "Your license plate is: " .. plateText )
    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