GetVehiclePanelState: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Fixed broken redirect.) |
||
(5 intermediate revisions by 4 users not shown) | |||
Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getVehiclePanelState ( vehicle | int getVehiclePanelState ( vehicle theVehicle, int panel ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[vehicle]]:getPanelState||setVehiclePanelState}} | |||
==Required Arguments== | ==Required Arguments== | ||
*'''theVehicle:''' | *'''theVehicle:''' the [[vehicle]] that you wish to know the panel state of. | ||
*'''panel:''' | *'''panel:''' an ''integer'' specifying the panel you want to know the state of. Not every vehicle has every panel. Possible values are: | ||
** '''0:''' Front-left panel | ** '''0:''' Front-left panel | ||
** '''1:''' Front-right panel | ** '''1:''' Front-right panel | ||
Line 24: | Line 25: | ||
==Example== | ==Example== | ||
This function creates an admiral and outputs every panel's state in the chatbox. | This function creates an admiral and outputs every panel's state in the chatbox. | ||
<syntaxhighlight lang="lua">local admiral = createVehicle ( 445, 0, 0, 10 ) | <syntaxhighlight lang="lua"> | ||
local admiral = createVehicle ( 445, 0, 0, 10 ) | |||
for i=0, 6 do | for i=0, 6 do | ||
local panel = getVehiclePanelState ( admiral, i ) | |||
outputChatBox ( panel ) | outputChatBox ( tostring ( panel ) ) | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 34: | Line 35: | ||
==See Also== | ==See Also== | ||
{{Vehicle functions}} | {{Vehicle functions}} | ||
Latest revision as of 00:25, 7 April 2018
This function returns the current state of a specifed panel on the vehicle. A vehicle can have up to 7 panels.
Syntax
int getVehiclePanelState ( vehicle theVehicle, int panel )
OOP Syntax Help! I don't understand this!
- Method: vehicle:getPanelState(...)
- Counterpart: setVehiclePanelState
Required Arguments
- theVehicle: the vehicle that you wish to know the panel state of.
- panel: an integer specifying the panel you want to know the state of. Not every vehicle has every panel. Possible values are:
- 0: Front-left panel
- 1: Front-right panel
- 2: Rear-left panel
- 3: Rear-right panel
- 4: Windscreen
- 5: Front bumper
- 6: Rear bumper
Returns
Returns an int indicating the state of the specified the panel. This is a value between 0 and 3, with 0 indicating the panel is undamaged and 3 indicating it is very damaged.
Example
This function creates an admiral and outputs every panel's state in the chatbox.
local admiral = createVehicle ( 445, 0, 0, 10 ) for i=0, 6 do local panel = getVehiclePanelState ( admiral, i ) outputChatBox ( tostring ( panel ) ) end
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