GetVehicleOverrideLights: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Server client function}}
__NOTOC__
__NOTOC__
This function is used to find out the current state of the override-lights setting of a vehicle.
This function is used to find out the current state of the override-lights setting of a vehicle.
Line 13: Line 14:
This example will toggle the car lights on and off for a player's vehicle
This example will toggle the car lights on and off for a player's vehicle
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler ( "vehiclelights", "vehicleLights" )
function vehicleLights ( source )
function vehicleLights ( source )
  vehicle = getPlayerOccupiedVehicle ( source ) -- get the player's vehicle
    vehicle = getPlayerOccupiedVehicle ( source )               -- get the player's vehicle
  if ( vehicle ) then -- if he was in one
    if ( vehicle ) then                                         -- if he was in one
    if ( getVehicleOverrideLights ( vehicle ) ~= 2 ) then -- if the current state isnt 'force on'
        if ( getVehicleOverrideLights ( vehicle ) ~= 2 ) then   -- if the current state isnt 'force on'
      setVehicleOverrideLights ( vehicle, 2 ) -- force the lights on
            setVehicleOverrideLights ( vehicle, 2 )             -- force the lights on
    else
        else
      setVehicleOverrideLights ( vehicle, 1 ) -- otherwise, force the lights off
            setVehicleOverrideLights ( vehicle, 1 )             -- otherwise, force the lights off
        end
     end
     end
  end
end
end
addCommandHandler ( "vehiclelights", vehicleLights )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}

Revision as of 18:07, 17 August 2007

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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleOverrideLights?oldid=10604"