Difference between revisions of "SetVehicleLightState"

From Multi Theft Auto: Wiki
m (Added OOP syntax part)
m (Defined associated light to lights parameter.)
 
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.
  

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

FROM VERSION 1.5.7 r19626 ONWARDS
FROM VERSION 1.6 r7485 ONWARDS
FROM VERSION 1.6 r7485 ONWARDS