GetVehicleLightState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Extended description of 'light' argument.)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function returns the current state of the specifed light on the vehicle.
{{Server client function}}
This function returns the current state of the specified light on the vehicle.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">getVehicleLightState ( vehicle, light )</syntaxhighlight>
<syntaxhighlight lang="lua">int getVehicleLightState ( vehicle theVehicle, int light )</syntaxhighlight>
{{OOP||[[vehicle]]:getLightState||setVehicleLightState}}


==Required Arguments==
==Required Arguments==
*'''Vehicle:''' A handle to the [[vehicle]] that you wish to know the light state of.
*'''theVehicle:''' the [[vehicle]] that you wish to know the light state of.
*'''Light:''' A whole number between 0 and 3
*'''light:''' A whole number determining the individual light:
**'''0:''' Front left
**'''1:''' Front right
**'''2:''' Rear right
**'''3:''' Rear left


==Returns==
==Returns==

Latest revision as of 21:56, 15 June 2018

This function returns the current state of the specified light on the vehicle.

Syntax

int getVehicleLightState ( vehicle theVehicle, int light )

OOP Syntax Help! I don't understand this!

Method: vehicle:getLightState(...)
Counterpart: setVehicleLightState


Required Arguments

  • theVehicle: the vehicle that you wish to know the light state of.
  • light: A whole number determining the individual light:
    • 0: Front left
    • 1: Front right
    • 2: Rear right
    • 3: Rear left

Returns

Returns 0 (working) or 1 (broken)

Example

newcar = createVehicle ( 520, 1024, 1024, 1024 )
state = getVehicleLightState ( newcar, 0 )
outputChatBox ( "The front-left light state on this car: " .. state )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleLightState?oldid=55329"