SetVehicleOverrideLights: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function changes the overriding lights setting on a vehicle, possible values are: 0 (No override), 1 (Force off), 2 (Force on)
{{Server client function}}
This function changes the light overriding setting on a vehicle, possible values are: 0 (No override), 1 (Force off), 2 (Force on)
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool setVehicleOverrideLights ( vehicle theVehicle, int Value )</syntaxhighlight>
<syntaxhighlight lang="lua">bool setVehicleOverrideLights ( vehicle theVehicle, int value )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to change the override lights setting of.
*'''theVehicle''': The [[vehicle]] you wish to change the override lights setting of.
*'''Value''': A whole number representing 1 of the 3 settings (0,1,2)
*'''value''': A whole number representing 1 of the 3 settings (0,1,2)


==Returns==
==Returns==
Returns 'true' if the vehicle's lights settings was changed. Otherwise 'false'.
Returns ''true'' if the vehicle's lights setting was changed. Otherwise ''false''.


==Example==
==Example==
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
    playervehicle = getPlayerOccupiedVehicle ( source )             -- get the player's vehicle
  if ( vehicle ) then -- if he was in one
    if ( playervehicle ) then                                       -- if he was in one
    if ( getVehicleOverrideLights ( vehicle ) ~= 2 ) then -- if the current state isnt 'force on'
        if ( getVehicleOverrideLights ( playervehicle ) ~= 2 ) then -- if the current state isn't 'force on'
      setVehicleOverrideLights ( vehicle, 2 ) -- force the lights on
            setVehicleOverrideLights ( playervehicle, 2 )           -- force the lights on
    else
        else
      setVehicleOverrideLights ( vehicle, 1 ) -- otherwise, force the lights off
            setVehicleOverrideLights ( playervehicle, 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 20:00, 15 August 2007

This function changes the light overriding setting on a vehicle, possible values are: 0 (No override), 1 (Force off), 2 (Force on)

Syntax

bool setVehicleOverrideLights ( vehicle theVehicle, int value )

Required Arguments

  • theVehicle: The vehicle you wish to change the override lights setting of.
  • value: A whole number representing 1 of the 3 settings (0,1,2)

Returns

Returns true if the vehicle's lights setting was changed. Otherwise false.

Example

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

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleOverrideLights?oldid=10401"