getVehicleOverrideLights | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getVehicleOverrideLights

Client-side
Server-side
Shared

Pair: setVehicleOverrideLights

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function is used to find out the current state of the override-lights setting of a vehicle.

OOP Syntax Help! I don't understand this!

  • Method:vehicle:getOverrideLights(...)
  • Variable: .overrideLights

Syntax 

int getVehicleOverrideLights ( vehicle theVehicle )
Required Arguments
  • theVehicle: the vehicle you wish to retrieve the override lights setting of.

Returns

  • int: value

Returns an integer value: 0 (No override), 1 (Force off) or 2 (Force on).

Code Examples

shared

This example will toggle the car lights on and off for a player's vehicle

function vehicleLights ( source )
    local theVehicle = getPlayerOccupiedVehicle ( source )        -- get the player's vehicle
    if ( theVehicle ) then                                        -- if he was in one
        if ( getVehicleOverrideLights ( theVehicle ) ~= 2 ) then  -- if the current state isnt 'force on'
            setVehicleOverrideLights ( theVehicle, 2 )            -- force the lights on
        else
            setVehicleOverrideLights ( theVehicle, 1 )            -- otherwise, force the lights off
        end
    end
end
addCommandHandler ( "vehiclelights", vehicleLights )

See Also

Vehicle Functions
Vehicle Events
Reference