SetVehiclePlateText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Server client function}} __NOTOC__ {{New feature/item|3.0140|1.3.3|5394| This function can be used to change/set the numberplate text from a car. }} ==Syntax== <syntaxhighlight lang="lua"> f...")
 
(Remove obsolete Requirements section)
 
(16 intermediate revisions by 10 users not shown)
Line 1: Line 1:
__NOTOC__
{{Server client function}}
{{Server client function}}
__NOTOC__
This function can be used to set the numberplate text of a vehicle.
{{New feature/item|3.0140|1.3.3|5394|
All non ascii characters will be replaced by spaces.
This function can be used to change/set the numberplate text from a car.
}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float 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 vehicle (max 8 characters).


===Returns===
===Returns===
Returns ''true'' if the numberplate was changed successfully, or ''false'' if invalid arguments were passed
Returns ''true'' if the numberplate was changed successfully, or ''false'' if invalid arguments were passed
==Requirements==
{{Requirements|1.3.3|1.3.3|}}


==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Todo
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 or the plate is incorrect.",thePlayer)
end
else
outputChatBox("You must be in a Vehicle.",thePlayer)
end
end
addCommandHandler("setplate",PlateText)
</syntaxhighlight>
</syntaxhighlight>
==See Also==
==See Also==
{{Vehicle_functions}}
{{Vehicle_functions}}

Latest revision as of 17:11, 7 November 2024

This function can be used to set the numberplate text of a vehicle. All non ascii characters will be replaced by spaces.

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 vehicle (max 8 characters).

Returns

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

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 or the plate is incorrect.",thePlayer)
		end
	else
		outputChatBox("You must be in a Vehicle.",thePlayer)
	end
end
addCommandHandler("setplate",PlateText)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehiclePlateText?oldid=81181"