SetVehicleLightState - Revision history

Skully: Defined associated light to lights parameter.

2018-04-06T22:05:38Z

Defined associated light to lights parameter.

← Older revision		Revision as of 22:05, 6 April 2018
Line 9:		Line 9:
	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the light state of.		*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the light state of.
	*'''light:''' A whole number determining the individual light~~. (~~0 - 3)		*'''light:''' A whole number determining the individual light:
			**'''0:''' Front left
			**'''1:''' Front right
			**'''2:''' Rear right
			**'''3:''' Rear left

	*'''state:''' A whole number determining the new state of the light. ''0'' represents normal lights, and ''1'' represents broken lights.		*'''state:''' A whole number determining the new state of the light. ''0'' represents normal lights, and ''1'' represents broken lights.

2018-03-06T15:49:51Z

Added OOP syntax part

← Older revision		Revision as of 15:49, 6 March 2018
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool setVehicleLightState ( vehicle theVehicle, int light, int state )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setVehicleLightState ( vehicle theVehicle, int light, int state )</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:setLightState\|\|getVehicleLightState}}

	==Required Arguments==		==Required Arguments==

2009-04-15T19:23:17Z

← Older revision		Revision as of 19:23, 15 April 2009
Line 12:		Line 12:

	===Returns===		===Returns===
	Returns ''true'' if the light state was set, ''false'' if invalid arguments were passed to the function.		Returns ''true'' if the light state was set successfully, ''false'' if invalid arguments were passed to the function.

	==Example==		==Example==

2009-04-15T19:21:25Z

← Older revision		Revision as of 19:21, 15 April 2009
Line 8:		Line 8:
	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the light state of.		*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the light state of.
	*'''light:''' A whole number determining the individual light.		*'''light:''' A whole number determining the individual light. (0 - 3)
	*'''state:''' A whole number determining the new state of the light. ''0'' represents normal lights, and ''1'' represents broken lights.		*'''state:''' A whole number determining the new state of the light. ''0'' represents normal lights, and ''1'' represents broken lights.

			===Returns===
			Returns ''true'' if the light state was set, ''false'' if invalid arguments were passed to the function.

	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a new vehicle		newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a new vehicle
	state = setVehicleLightState ( newcar, 0, 1 ) -- break ~~one of its lights~~		state = setVehicleLightState ( newcar, 0, 1 ) -- break the left front light
	</syntaxhighlight>		</syntaxhighlight>

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

2009-04-07T15:58:21Z

void -> bool

← Older revision		Revision as of 15:58, 7 April 2009
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">~~void~~ setVehicleLightState ( vehicle theVehicle, int light, int state )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setVehicleLightState ( vehicle theVehicle, int light, int state )</syntaxhighlight>

	==Required Arguments==		==Required Arguments==

2008-04-21T19:41:39Z

← Older revision		Revision as of 19:41, 21 April 2008
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	~~__NO_TOC_~~		__NOTOC__
	This function sets the state of the light on the vehicle.		This function sets the state of the light on the vehicle.

2008-04-21T19:40:59Z

← Older revision		Revision as of 19:40, 21 April 2008
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	~~__NOTOC_~~		__NO_TOC_
	This function sets the state of the light on the vehicle.		This function sets the state of the light on the vehicle.

2008-04-21T19:40:52Z

← Older revision		Revision as of 19:40, 21 April 2008
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	~~==Description==~~		__NOTOC_
	This function sets the state of the light on the vehicle.		This function sets the state of the light on the vehicle.

2007-08-29T15:14:14Z

← Older revision		Revision as of 15:14, 29 August 2007
Line 9:		Line 9:
	*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the light state of.		*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the light state of.
	*'''light:''' A whole number determining the individual light.		*'''light:''' A whole number determining the individual light.
	*'''state:''' A whole number determining the new state of the light. (0~~: ok~~, 1~~: smashed)~~		*'''state:''' A whole number determining the new state of the light. ''0'' represents normal lights, and ''1'' represents broken lights.

	==Example==		==Example==

2007-08-15T19:32:38Z

← Older revision		Revision as of 19:32, 15 August 2007
Line 1:		Line 1:
			{{Server client function}}
	==Description==		==Description==
	This function sets the state of the light on the vehicle.		This function sets the state of the light on the vehicle.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">void setVehicleLightState ( vehicle, light, state )</syntaxhighlight>		<syntaxhighlight lang="lua">void setVehicleLightState ( vehicle theVehicle, int light, int state )</syntaxhighlight>

	==Required Arguments==		==Required Arguments==
	*'''~~Vehicle~~:''' A handle to the [[vehicle]] that you wish to change the light state of.		*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the light state of.
	*'''~~Light~~:''' A whole number determining the individual light.		*'''light:''' A whole number determining the individual light.
	*'''~~State~~:''' A whole number determining the new state of the light. (0: ok, 1: smashed)		*'''state:''' A whole number determining the new state of the light. (0: ok, 1: smashed)

	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	newcar = createVehicle ( 520, 1024, 1024, 1024 )		newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a new vehicle
	state = setVehicleLightState ( newcar, 0, 1 ) -- ~~Breaks a light on the vehicle.~~		state = setVehicleLightState ( newcar, 0, 1 ) -- break one of its lights
	</syntaxhighlight>		</syntaxhighlight>

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