GetVehiclePlateText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Server client function}}
{{Server client function}}
__NOTOC__
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function is used to retrieve the text on the number plate of a specified vehicle.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getVehiclePlateText ( vehicle theVehicle )
string getVehiclePlateText ( vehicle theVehicle )
Line 11: Line 9:


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''theVehicle:''' A handle to the vehicle that you wish to retrieve the plate text from.
*'''argumentName:''' description
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
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 ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example outputs the text on the license plate of the vehicle the player is driving to the chatbox.
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function scriptPlate ( player, command )
blabhalbalhb --abababa
  local aVehicle = getPlayerOccupiedVehicle ( getLocalPlayer() )
--This line does this...
  local text = getVehiclePlateText ( aVehicle )
mooo
  if ( text and aVehicle ) then
    outputChatBox ( "text" )
  else outputChatBox ( "your vehicle has no licence plate or you're not in a vehicle" )
  end
end
addCommandHandler( "plate", scriptPlate )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
 
{{FunctionArea_functions}}
{{Vehicle functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 18:41, 26 August 2007

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

Syntax

string getVehiclePlateText ( vehicle theVehicle )

Required Arguments

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

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.

Example

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

function scriptPlate ( player, command )
  local aVehicle = getPlayerOccupiedVehicle ( getLocalPlayer() )
  local text = getVehiclePlateText ( aVehicle )
  if ( text and aVehicle ) then
    outputChatBox ( "text" )
  else outputChatBox ( "your vehicle has no licence plate or you're not in a vehicle" )
  end
end
addCommandHandler( "plate", scriptPlate )

See Also


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