GetVehicleHeadLightColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server client function}} This function will get the headlight color of a vehicle. ==Syntax== <section name="Server and Client" class="both" show="true"> <syntaxhighlight lang="lua"> int, in...)
 
mNo edit summary
 
(5 intermediate revisions by 4 users not shown)
Line 4: Line 4:


==Syntax==  
==Syntax==  
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int, int, int getVehicleHeadLightColor ( vehicle theVehicle )             
int, int, int getVehicleHeadLightColor ( vehicle theVehicle )             
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[vehicle]]:getHeadLightColor||setVehicleHeadLightColor}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The [[vehicle]] that you wish to set the headlight color of.
*'''theVehicle:''' The [[vehicle]] that you wish to set the headlight color of.
Line 14: Line 13:
===Returns===
===Returns===
Returns three ''integers'' for the red, green and blue of the headlight color for the specified vehicle, ''false'' if an invalid vehicle was specified.
Returns three ''integers'' for the red, green and blue of the headlight color for the specified vehicle, ''false'' if an invalid vehicle was specified.
</section>


==Example==  
==Example==  
<section name="Example" class="server" show="true">
This example outputs the player vehicle head lights color.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function getHeadLightsColor()
local vehicle = getPedOccupiedVehicle(localPlayer) -- We get the player vehicle..
if (vehicle) then -- We check if he's on a vehicle...
local r, g, b = getVehicleHeadLightColor(vehicle) -- We get the vehicle head lights color..
outputChatBox("Your vehicle lights color are: ".. r ..", ".. g ..", ".. b) -- We output them to the chatbox.
end
end
addCommandHandler("lightscolor",getHeadLightsColor) -- Add the command handler attached to the function "getHeadLightsColor".
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function getHeadLightsColor(thePlayer)
local vehicle = getPedOccupiedVehicle(thePlayer) -- We get the player vehicle..
if (vehicle) then -- We check if he's on a vehicle...
local r, g, b = getVehicleHeadLightColor(vehicle) -- We get the vehicle head lights color..
outputChatBox("Your vehicle lights color are: ".. r ..", ".. g ..", ".. b, thePlayer) -- We output them to the chatbox.
end
end
addCommandHandler("lightscolor",getHeadLightsColor) -- Add the command handler attached to the function "getHeadLightsColor".
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Latest revision as of 14:21, 7 June 2015

This function will get the headlight color of a vehicle.

Syntax

int, int, int getVehicleHeadLightColor ( vehicle theVehicle )            

OOP Syntax Help! I don't understand this!

Method: vehicle:getHeadLightColor(...)
Counterpart: setVehicleHeadLightColor


Required Arguments

  • theVehicle: The vehicle that you wish to set the headlight color of.

Returns

Returns three integers for the red, green and blue of the headlight color for the specified vehicle, false if an invalid vehicle was specified.

Example

This example outputs the player vehicle head lights color.

Click to collapse [-]
Client
function getHeadLightsColor()
	local vehicle = getPedOccupiedVehicle(localPlayer) -- We get the player vehicle..
	if (vehicle) then -- We check if he's on a vehicle...
		local r, g, b = getVehicleHeadLightColor(vehicle) -- We get the vehicle head lights color..
		outputChatBox("Your vehicle lights color are: ".. r ..", ".. g ..", ".. b) -- We output them to the chatbox.
	end
end
addCommandHandler("lightscolor",getHeadLightsColor) -- Add the command handler attached to the function "getHeadLightsColor".
Click to collapse [-]
Server
function getHeadLightsColor(thePlayer)
	local vehicle = getPedOccupiedVehicle(thePlayer) -- We get the player vehicle..
	if (vehicle) then -- We check if he's on a vehicle...
		local r, g, b = getVehicleHeadLightColor(vehicle) -- We get the vehicle head lights color..
		outputChatBox("Your vehicle lights color are: ".. r ..", ".. g ..", ".. b, thePlayer) -- We output them to the chatbox.
	end
end
addCommandHandler("lightscolor",getHeadLightsColor) -- Add the command handler attached to the function "getHeadLightsColor".

See Also