Vehicle.LightState

From Liberty Unleashed Wiki
Jump to: navigation, search
Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This Vehicle class member returns or sets the status of the lights. Possible values are listed here.

Syntax

You can either return or set a new value using this member:

  1. int Vehicle.LightState
  1. Vehicle.LightState = int lights

Arguments

  • lights - This is the new state for the lights.
    • LIGHTSTATE_AUTO - lights are turned on and off automatically depending of the time and weather
    • LIGHTSTATE_ON - vehicle lights are always on
    • LIGHTSTATE_OFF - vehicle lights are always off

Example 1. Returning the value

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "lights" )
  5. {
  6. if ( pPlayer.Vehicle ) MessagePlayer( "Your light state is currently set to " + pPlayer.Vehicle.LightState, pPlayer );
  7. }
  8. return 1;
  9. }
  10.  

Notes

The function MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

Example 2. Setting a new value

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "lights2" )
  5. {
  6. if ( pPlayer.Vehicle ) pPlayer.Vehicle.LightState = LIGHTSTATE_ON;
  7. }
  8. return 1;
  9. }
  10.  

Notes

The event onPlayerCommand was used in this example. More info about this in the corresponding page.

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox