SetVehiclePlateText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
{{Server client function}}
{{Server client function}}
__NOTOC__
{{New feature/item|3.0133|1.3.3|5394|
{{New feature/item|3.0133|1.3.3|5394|
This function can be used to change/set the numberplate text of a car.
This function can be used to change/set the numberplate text of a car.
Line 9: Line 9:
bool setVehiclePlateText( element theVehicle, string numberplate )
bool setVehiclePlateText( element theVehicle, string numberplate )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[vehicle]]:setPlateText|plateText|getVehiclePlateText}}
===Required Arguments===
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] whose numberplate you want to change.
*'''theVehicle:''' the [[vehicle]] whose numberplate you want to change.
*'''numberplate:''' A string that will go on the number plate of the car (max 8 characters).
*'''numberplate:''' a string that will go on the number plate of the car (max 8 characters).


===Returns===
===Returns===

Revision as of 20:33, 13 October 2014

This function can be used to change/set the numberplate text of a car.

Syntax

bool setVehiclePlateText( element theVehicle, string numberplate )

OOP Syntax Help! I don't understand this!

Method: vehicle:setPlateText(...)
Variable: .plateText
Counterpart: getVehiclePlateText


Required Arguments

  • theVehicle: the vehicle whose numberplate you want to change.
  • numberplate: a string that will go on the number plate of the car (max 8 characters).

Returns

Returns true if the numberplate was changed successfully, or false if invalid arguments were passed

Requirements

This template will be deleted.

Example

function PlateText(thePlayer,commandName,text)
	local Vehicle = getPedOccupiedVehicle(thePlayer)
	if Vehicle then
		if text then
			setVehiclePlateText( Vehicle, text )
		else
			outputChatBox("You must enter a message.",thePlayer)
		end
	else
		outputChatBox("You must be in a Vehicle.",thePlayer)
	end
end
addCommandHandler("setplate",PlateText)

See Also