SetVehicleLightState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Defined associated light to lights parameter.)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Description==
{{Server client function}}
__NOTOC__
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">setVehicleLightState ( vehicle, state )</syntaxhighlight>
<syntaxhighlight lang="lua">bool setVehicleLightState ( vehicle theVehicle, int light, int state )</syntaxhighlight>
{{OOP||[[vehicle]]:setLightState||getVehicleLightState}}


==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.
*'''State:''' A whole number determining the new state of the light. (0: ok, 1: smashed)
*'''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.
 
===Returns===
Returns ''true'' if the light state was set successfully, ''false'' if invalid arguments were passed to the function.


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


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

Latest revision as of 22:05, 6 April 2018

This function sets the state of the light on the vehicle.

Syntax

bool setVehicleLightState ( vehicle theVehicle, int light, int state )

OOP Syntax Help! I don't understand this!

Method: vehicle:setLightState(...)
Counterpart: getVehicleLightState


Required Arguments

  • theVehicle: A handle to the vehicle that you wish to change the light state of.
  • 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.

Returns

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

Example

newcar = createVehicle ( 520, 1024, 1024, 1024 )   -- create a new vehicle
state = setVehicleLightState ( newcar, 0,  1 )     -- break the left front light

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleLightState?oldid=54601"