GetVehicleOverrideLights

From Multi Theft Auto: Wiki
Revision as of 18:07, 17 August 2007 by Arc (talk | contribs)
Jump to navigation Jump to search

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

Syntax

int getVehicleOverrideLights ( vehicle theVehicle )

Required Arguments

  • theVehicle: The vehicle you wish to retrieve the override lights setting of.

Returns

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

Example

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

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

See Also