GetVehiclePanelState: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
This function returns the current state of a specifed panel on the vehicle. A vehicle can have up to 7 panels. | This function returns the current state of a specifed panel on the vehicle. A vehicle can have up to 7 panels. | ||
| Line 11: | Line 10: | ||
==Required Arguments== | ==Required Arguments== | ||
*'''theVehicle:''' The [[vehicle]] that you wish to know the panel state of. | *'''theVehicle:''' The [[vehicle]] that you wish to know the panel state of. | ||
*'''panel:''' An ''integer'' | *'''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== | ||
Returns an [[int]] indicating the state of the specified the panel. | Returns an [[int]] indicating the state of the specified the panel. | ||
==Example== | ==Example== | ||
| Line 30: | Line 34: | ||
==See Also== | ==See Also== | ||
{{Vehicle functions}} | {{Vehicle functions}} | ||
{{Category:Incomplete}} | |||
Revision as of 00:53, 24 September 2008
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 )
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.
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 ( 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
This is a list of functions that need to be documented. To list a function as incomplete, add the following to the function's page:
[[Category:Incomplete]]