SetVehicleOverrideLights: Difference between revisions
Jump to navigation
Jump to search
m (OOP) |
|||
Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setVehicleOverrideLights ( vehicle theVehicle, int value )</syntaxhighlight> | <syntaxhighlight lang="lua">bool setVehicleOverrideLights ( vehicle theVehicle, int value )</syntaxhighlight> | ||
{{OOP||[[vehicle]]:setOverrideLights|overrideLights|getVehicleOverrideLights}} | |||
===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. |
Latest revision as of 19:19, 4 June 2017
This function changes the light overriding setting on a vehicle.
Syntax
bool setVehicleOverrideLights ( vehicle theVehicle, int value )
OOP Syntax Help! I don't understand this!
- Method: vehicle:setOverrideLights(...)
- Variable: .overrideLights
- Counterpart: getVehicleOverrideLights
Required Arguments
- theVehicle: The vehicle you wish to change the override lights setting of.
- value: A whole number representing the state of the lights:
- 0: No override, lights are set to default.
- 1: Lights are forced off.
- 2: Lights are forced on.
Returns
Returns true if the vehicle's lights setting was changed. Otherwise false.
Example
Click to collapse [-]
Example 1This example will toggle the car lights on and off for a player's vehicle by using a "vehiclelights" command.
function consoleVehicleLights ( source ) if isPedInVehicle(source) then -- checks is the player in vehicle if yes, then: playerVehicle = getPedOccupiedVehicle ( 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 end addCommandHandler ( "vehiclelights", consoleVehicleLights )
Click to collapse [-]
Example 2This example will toggle the car lights on and off for a player's vehicle by using a "vehiclelights" command.
function consoleVehicleLights () if isPedInVehicle(getLocalPlayer()) then -- checks is the player in vehicle if yes, then: playerVehicle = getPedOccupiedVehicle ( getLocalPlayer() ) -- get the local 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 end addCommandHandler ( "vehiclelights", consoleVehicleLights )
See Also
- addVehicleUpgrade
- attachTrailerToVehicle
- blowVehicle
- createVehicle
- detachTrailerFromVehicle
- fixVehicle
- getOriginalHandling
- getTrainDirection
- getTrainPosition
- getTrainSpeed
- getTrainTrack
- getVehicleColor
- getVehicleCompatibleUpgrades
- getVehicleController
- getVehicleDoorOpenRatio
- getVehicleDoorState
- getVehicleEngineState
- getVehicleHandling
- getVehicleHeadLightColor
- getVehicleLandingGearDown
- getVehicleLightState
- getVehicleMaxPassengers
- getVehicleModelFromName
- getVehicleName
- getVehicleNameFromModel
- getVehicleOccupant
- getVehicleOccupants
- getVehicleOverrideLights
- getVehiclePaintjob
- getVehiclePanelState
- getVehiclePlateText
- getVehicleSirenParams
- getVehicleSirens
- getVehicleSirensOn
- getVehicleTowedByVehicle
- getVehicleTowingVehicle
- getVehicleTurretPosition
- getVehicleType
- getVehicleUpgradeOnSlot
- getVehicleUpgradeSlotName
- getVehicleUpgrades
- getVehicleVariant
- getVehicleWheelStates
- isTrainDerailable
- isTrainDerailed
- isVehicleBlown
- isVehicleDamageProof
- isVehicleFuelTankExplodable
- isVehicleLocked
- isVehicleOnGround
- isVehicleTaxiLightOn
- removeVehicleUpgrade
- setTrainDerailable
- setTrainDerailed
- setTrainDirection
- setTrainPosition
- setTrainSpeed
- setTrainTrack
- setVehicleColor
- setVehicleDamageProof
- setVehicleDoorOpenRatio
- setVehicleDoorState
- setVehicleDoorsUndamageable
- setVehicleEngineState
- setVehicleFuelTankExplodable
- setVehicleHandling
- setVehicleHeadLightColor
- setVehicleLandingGearDown
- setVehicleLightState
- setVehicleLocked
- setVehicleOverrideLights
- setVehiclePaintjob
- setVehiclePanelState
- setVehiclePlateText
- setVehicleSirens
- setVehicleSirensOn
- setVehicleTaxiLightOn
- setVehicleTurretPosition
- setVehicleVariant
- setVehicleWheelStates