SetVehicleColor: Difference between revisions

From Onset Developer Wiki
← Older editNewer edit →
No edit summary
No edit summary
Line 3: Line 3:
{{FuncDescription|Sets the color of a given vehicle.}}
{{FuncDescription|Sets the color of a given vehicle.}}


{{FuncSyntax|SetVehicleColor(vehicle, HexColor)}}
{{FuncSyntax|SetVehicleColor(vehicle, IntColor)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle|The vehicle to change the color of.}}
{{FuncParam|vehicle|The vehicle to change the color of.}}
{{FuncParam|HexColor|The color in hex format. Use [[RGB]] to convert RGB codes to hex.}}
{{FuncParam|HexColor|The color as an integer. Use [[RGB]] to convert RGB codes to int.}}


{{FuncReturnValue|Returns '''true''' on success, '''false''' on error.}}
{{FuncReturnValue|Returns '''true''' on success, '''false''' on error.}}

Revision as of 13:14, 22 July 2020

SetVehicleColor

Type: Function
Context: Server
Introduced: v1.0

Description

Sets the color of a given vehicle.

Syntax

SetVehicleColor(vehicle, IntColor)

Parameters

  • vehicle
    The vehicle to change the color of.
  • HexColor
    The color as an integer. Use RGB to convert RGB codes to int.

Return Value

  • Returns true on success, false on error.

Example

function cmd_vcolor(player, r, g, b)
	if (r == nil or g == nil or b == nil) then
		return AddPlayerChat(player, "Usage: /vcolor <r> <g> <b>")
	end

	local vehicle = GetPlayerVehicle(player)

	if (vehicle == 0) then
		return AddPlayerChat(player, "You must be in a vehicle")
	end

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

	SetVehicleColor(vehicle, RGB(r, g, b))
	AddPlayerChat(player, "New vehicle color set (HEX: "..GetVehicleColor(vehicle)..")")
end
AddCommand("vcolor", cmd_vcolor)

See also

Retrieved from "https://dev.playonset.com/index.php?title=SetVehicleColor&oldid=4000"