Difference between revisions of "SetVehicleLicensePlate"

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetVehicleLicensePlate(vehicle, text)}} {{FuncParameters}} {{FuncParam|vehicle|__EDIT_ME__}} {{Fun...")
 
Line 1: Line 1:
 
{{Info|Function|Server|1.0}}
 
{{Info|Function|Server|1.0}}
  
{{FuncDescription|__EDIT_ME__}}
+
{{FuncDescription|Sets vehicle license plate text (up to 13 characters)}}
  
 
{{FuncSyntax|SetVehicleLicensePlate(vehicle, text)}}
 
{{FuncSyntax|SetVehicleLicensePlate(vehicle, text)}}
  
 
{{FuncParameters}}
 
{{FuncParameters}}
{{FuncParam|vehicle|__EDIT_ME__}}
+
{{FuncParam|vehicle|Vehicle identifier of vehicle which you wish to change license plate text}}
{{FuncParam|text|__EDIT_ME__}}
+
{{FuncParam|text|New license plate text}}
  
{{FuncReturnValue|__EDIT_ME__}}
+
{{FuncReturnValue|This function has no return value}}
  
 
== Example ==
 
== Example ==
__EDIT_ME__
+
<syntaxhighlight lang="Lua">
 +
function cmd_lp(player, ...)
 +
 
 +
local message = table.concat({...}, " ")
 +
 
 +
if (#{...} == 0) then
 +
return AddPlayerChat(player, "Usage: /lp <new license plate text>")
 +
end
 +
 
 +
local vehicle = GetPlayerVehicle(player)
 +
if (vehicle == 0) then
 +
return AddPlayerChat(player, '<span color="#ff0000ee">You must be in a vehicle!</>')
 +
end
 +
 
 +
if (GetPlayerVehicleSeat(player) ~= 1) then
 +
return AddPlayerChat(player, "You must be the driver of the vehicle")
 +
end
 +
 +
SetVehicleLicensePlate(vehicle, message)
 +
end
 +
AddCommand("lp", cmd_lp)
 +
</syntaxhighlight>
  
 
{{RelatedFunctions}}
 
{{RelatedFunctions}}
__EDIT_ME__
+
{{VehicleFunctions}}

Revision as of 16:45, 12 August 2019

SetVehicleLicensePlate

Type: Function
Context: Server
Introduced: v1.0

Description

Sets vehicle license plate text (up to 13 characters)

Syntax

SetVehicleLicensePlate(vehicle, text)

Parameters

  • vehicle
    Vehicle identifier of vehicle which you wish to change license plate text
  • text
    New license plate text

Return Value

  • This function has no return value

Example

function cmd_lp(player, ...)

	local message = table.concat({...}, " ") 

	if (#{...} == 0) then
		return AddPlayerChat(player, "Usage: /lp <new license plate text>")
	end

	local vehicle = GetPlayerVehicle(player)
	if (vehicle == 0) then
		return AddPlayerChat(player, '<span color="#ff0000ee">You must be in a vehicle!</>')
	end

	if (GetPlayerVehicleSeat(player) ~= 1) then
		return AddPlayerChat(player, "You must be the driver of the vehicle")
	end
	
	SetVehicleLicensePlate(vehicle, message)
end
AddCommand("lp", cmd_lp)

See also