GetVehicleOverrideLights - Revision history

Strix: OOP

2014-10-13T16:10:14Z

OOP

← Older revision		Revision as of 16:10, 13 October 2014
Line 1:		Line 1:
			__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~__NOTOC__~~
	This function is used to find out the current state of the override-lights setting of a vehicle.		This function is used to find out the current state of the override-lights setting of a vehicle.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">int getVehicleOverrideLights ( vehicle theVehicle )</syntaxhighlight>		<syntaxhighlight lang="lua">int getVehicleOverrideLights ( vehicle theVehicle )</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:getOverrideLights\|overrideLights\|setVehicleOverrideLights}}
	===Required Arguments===		===Required Arguments===
	*'''theVehicle''': ~~The~~ [[vehicle]] you wish to retrieve the override lights setting of.		*'''theVehicle''': the [[vehicle]] you wish to retrieve the override lights setting of.

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

X86dev at 21:51, 27 August 2010

2010-08-27T21:51:03Z

← Older revision		Revision as of 21:51, 27 August 2010
Line 8:		Line 8:
	*'''theVehicle''': The [[vehicle]] you wish to retrieve the override lights setting of.		*'''theVehicle''': The [[vehicle]] you wish to retrieve the override lights setting of.

	==Returns==		===Returns===
	Returns an integer value: 0 (No override), 1 (Force off) or 2 (Force on).		Returns an integer value: 0 (No override), 1 (Force off) or 2 (Force on).

Arc at 18:08, 17 August 2007

2007-08-17T18:08:56Z

← Older revision		Revision as of 18:08, 17 August 2007
Line 15:		Line 15:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function vehicleLights ( source )		function vehicleLights ( source )
	~~vehicle~~ = getPlayerOccupiedVehicle ( source ) -- get the player's vehicle		local theVehicle = getPlayerOccupiedVehicle ( source ) -- get the player's vehicle
	if ( ~~vehicle~~ ) then -- if he was in one		if ( theVehicle ) then -- if he was in one
	if ( getVehicleOverrideLights ( ~~vehicle~~ ) ~= 2 ) then -- if the current state isnt 'force on'		if ( getVehicleOverrideLights ( theVehicle ) ~= 2 ) then -- if the current state isnt 'force on'
	setVehicleOverrideLights ( ~~vehicle~~, 2 ) -- force the lights on		setVehicleOverrideLights ( theVehicle, 2 ) -- force the lights on
	else		else
	setVehicleOverrideLights ( ~~vehicle~~, 1 ) -- otherwise, force the lights off		setVehicleOverrideLights ( theVehicle, 1 ) -- otherwise, force the lights off
	end		end
	end		end

Arc at 18:07, 17 August 2007

2007-08-17T18:07:48Z

← Older revision		Revision as of 18:07, 17 August 2007
Line 1:		Line 1:
			{{Server client function}}
	__NOTOC__		__NOTOC__
	This function is used to find out the current state of the override-lights setting of a vehicle.		This function is used to find out the current state of the override-lights setting of a vehicle.
Line 13:		Line 14:
	This example will toggle the car lights on and off for a player's vehicle		This example will toggle the car lights on and off for a player's vehicle
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addCommandHandler ( "vehiclelights", "vehicleLights" )~~
	function vehicleLights ( source )		function vehicleLights ( source )
	vehicle = getPlayerOccupiedVehicle ( source ) -- get the player's vehicle		vehicle = getPlayerOccupiedVehicle ( source ) -- get the player's vehicle
	if ( vehicle ) then -- if he was in one		if ( vehicle ) then -- if he was in one
	if ( getVehicleOverrideLights ( vehicle ) ~= 2 ) then -- if the current state isnt 'force on'		if ( getVehicleOverrideLights ( vehicle ) ~= 2 ) then -- if the current state isnt 'force on'
	setVehicleOverrideLights ( vehicle, 2 ) -- force the lights on		setVehicleOverrideLights ( vehicle, 2 ) -- force the lights on
	else		else
	setVehicleOverrideLights ( vehicle, 1 ) -- otherwise, force the lights off		setVehicleOverrideLights ( vehicle, 1 ) -- otherwise, force the lights off
			end
	end		end
	~~end~~
	end		end
			addCommandHandler ( "vehiclelights", vehicleLights )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Vehicle functions}}		{{Vehicle functions}}

MrJax at 15:05, 30 June 2006

2006-06-30T15:05:15Z

← Older revision		Revision as of 15:05, 30 June 2006
Line 15:		Line 15:
	addCommandHandler ( "vehiclelights", "vehicleLights" )		addCommandHandler ( "vehiclelights", "vehicleLights" )
	function vehicleLights ( source )		function vehicleLights ( source )
	vehicle = getPlayerOccupiedVehicle ( source )		vehicle = getPlayerOccupiedVehicle ( source ) -- get the player's vehicle
	if ( vehicle ) then		if ( vehicle ) then -- if he was in one
	if ( getVehicleOverrideLights ( vehicle ) ~= 2 ) then		if ( getVehicleOverrideLights ( vehicle ) ~= 2 ) then -- if the current state isnt 'force on'
	setVehicleOverrideLights ( vehicle, 2 )		setVehicleOverrideLights ( vehicle, 2 ) -- force the lights on
	else		else
	setVehicleOverrideLights ( vehicle, 1 )		setVehicleOverrideLights ( vehicle, 1 ) -- otherwise, force the lights off
	end		end
	end		end

MrJax at 15:03, 30 June 2006

2006-06-30T15:03:55Z

New page

__NOTOC__
This function is used to find out the current state of the override-lights setting of a vehicle.
==Syntax==
<syntaxhighlight lang="lua">int getVehicleOverrideLights ( vehicle theVehicle )</syntaxhighlight>

===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to retrieve the override lights setting of.

==Returns==
Returns an integer value: 0 (No override), 1 (Force off) or 2 (Force on).

==Example==
This example will toggle the car lights on and off for a player's vehicle
<syntaxhighlight lang="lua">
addCommandHandler ( "vehiclelights", "vehicleLights" )
function vehicleLights ( source )
vehicle = getPlayerOccupiedVehicle ( source )
if ( vehicle ) then
if ( getVehicleOverrideLights ( vehicle ) ~= 2 ) then
setVehicleOverrideLights ( vehicle, 2 )
else
setVehicleOverrideLights ( vehicle, 1 )
end
end
end
</syntaxhighlight>

==See Also==
{{Vehicle functions}}