Vehicle::isAConvertible: Difference between revisions
(yay) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{ClientsideJsFunction}} | |||
{{JSContainer| | |||
Returns whether given vehicle has a converitble roof and an animation to lower/raise it. | |||
===Required Params=== | |||
*'''extraRoofCheck''' {{RageType|boolean}} Checks for vehicle roofs without animation that were added using vehicle extras. | |||
===Return value=== | |||
*''{{RageType|boolean}}'' | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="javascript">vehicle.isAConvertible( | <syntaxhighlight lang="javascript"> | ||
vehicle.isAConvertible(extraRoofCheck) | |||
</syntaxhighlight> | |||
==Example== | ==Example== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
const vehicle = mp.players.local.vehicle; | |||
if (!vehicle || !mp.vehicles.exists(vehicle)) return; | |||
const isConvertible = vehicle.isAConvertible(true); | |||
mp.console.logInfo(`Player's vehicle ${isConvertible ? 'is convertible' : 'is not convertible'}`); | |||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | |||
==See also== | ==See also== | ||
{{ | {{Vehicle_definition_c}} | ||
[[Category:Vehicle API]] | |||
[[Category:Clientside API]] | [[Category:Clientside API]] | ||
[[Category: | [[Category:Client-side Function]] | ||
[[Category:Shared Function]] | |||
Latest revision as of 10:51, 28 April 2024
Client-Side Function
 JavaScript
|
|---|
JavaScript Syntax
Returns whether given vehicle has a converitble roof and an animation to lower/raise it.
Required Params
- extraRoofCheck boolean Checks for vehicle roofs without animation that were added using vehicle extras.
Return value
- boolean
Syntax
vehicle.isAConvertible(extraRoofCheck)
Example
const vehicle = mp.players.local.vehicle;
if (!vehicle || !mp.vehicles.exists(vehicle)) return;
const isConvertible = vehicle.isAConvertible(true);
mp.console.logInfo(`Player's vehicle ${isConvertible ? 'is convertible' : 'is not convertible'}`);
See also
- Functions:
- Vehicle::Vehicle
- Vehicle.addUpsidedownCheck
- Vehicle.areAllWindowsIntact
- Vehicle.attachToCargobob
- Vehicle.attachToTowTruck
- Vehicle.attachToTrailer
- Vehicle.canShuffleSeat
- Vehicle.cargobobMagnetGrab
- Vehicle.clearCustomPrimaryColour
- Vehicle.clearCustomSecondaryColour
- Vehicle.closeBombBayDoors
- Vehicle.detachFromAnyCargobob
- Vehicle.detachFromAnyTowTruck
- Vehicle.detachFromCargobob
- Vehicle.detachFromTowTruck
- Vehicle.detachFromTrailer
- Vehicle.detachWindscreen
- Vehicle.disableImpactExplosionActivation
- Vehicle.disablePlaneAileron
- Vehicle.doesExtraExist
- Vehicle.doesHaveRoof
- Vehicle.doesHaveStuckVehicleCheck
- Vehicle.doesHaveWeapons
- Vehicle.ejectJb700Roof
- Vehicle.enableCargobobHook
- Vehicle.explodeInCutscene
- Vehicle.explode
- Vehicle.fixWindow
- Vehicle.getAcceleration
- Vehicle.getAttachedToCargobob
- Vehicle.getAttachedToTowTruck
- Vehicle.getBoatAnchor
- Vehicle.getBodyHealth2
- Vehicle.getBodyHealth
- Vehicle.getCargobobHookPosition
- Vehicle.getCauseOfDestruction
- Vehicle.getClass
- Vehicle.getColourCombination
- Vehicle.getColours
- Vehicle.getColor
- Vehicle.getConvertibleRoofState
- Vehicle.getCustomPrimaryColour
- Vehicle.getCustomSecondaryColour
- Vehicle.getDefaultHandling
- Vehicle.getDeformationAtPos
- Vehicle.getDirtLevel
- Vehicle.getDoorAngleRatio
- Vehicle.getDoorLockStatus
- Vehicle.getDoorsLockedForPlayer
- Vehicle.getEngineHealth
- Vehicle.getExtraColours
- Vehicle.getHandling
- Vehicle.getHeliEngineHealth
- Vehicle.getHeliMainRotorHealth
- Vehicle.getHeliTailRotorHealth
- Vehicle.getIsEngineRunning
- Vehicle.getIsLeftHeadlightDamaged
- Vehicle.getIsPrimaryColourCustom
- Vehicle.getIsRightHeadlightDamaged
- Vehicle.getIsSecondaryColourCustom
- Vehicle.getLandingGearState
- Vehicle.getLastPedInSeat
- Vehicle.getLayoutHash
- Vehicle.getLightsState
- Vehicle.getLiveryCount
- Vehicle.getLiveryName
- Vehicle.getLivery
- Vehicle.getMaxBraking
- Vehicle.getMaxNumberOfPassengers
- Vehicle.getMaxTraction
- Vehicle.getModColor1TextLabel
- Vehicle.getModColor1
- Vehicle.getModColor2TextLabel
- Vehicle.getModColor2
- Vehicle.getModKitType
- Vehicle.getModKit
- Vehicle.getModModifierValue
- Vehicle.getModSlotName
- Vehicle.getModTextLabel
- Vehicle.getModVariation
- Vehicle.getMod
- Vehicle.getNeonLightsColour
- Vehicle.getNumModKits
- Vehicle.getNumMods
- Vehicle.getNumberOfColours
- Vehicle.getNumberOfPassengers
- Vehicle.getNumberPlateTextIndex
- Vehicle.getNumberPlateText
- Vehicle.getOwner
- Vehicle.getPaintFade
- Vehicle.getPedInSeat
- Vehicle.getPedUsingDoor
- Vehicle.getPetrolTankHealth
- Vehicle.getPlateType
- Vehicle.getRimRadius
- Vehicle.getSuspensionHeight
- Vehicle.getTrailerVehicle
- Vehicle.getTrainCarriage
- Vehicle.getTyreRadius
- Vehicle.getTyreSmokeColor
- Vehicle.getTyreWidth
- Vehicle.getTyresCanBurst
- Vehicle.getWheelCamber
- Vehicle.getWheelHeight
- Vehicle.getWheelRadius
- Vehicle.getWheelTrackWidth
- Vehicle.getWheelType
- Vehicle.getWheelWidth
- Vehicle.getWindowTint
- Vehicle.isAConvertible
- Vehicle.isAlarmActivated
- Vehicle.isAnySeatEmpty
- Vehicle.isAttachedToCargobob
- Vehicle.isAttachedToTowTruck
- Vehicle.isAttachedToTrailer
- Vehicle.isBig
- Vehicle.isBumperBrokenOff
- Vehicle.isCargobobHookActive
- Vehicle.isCargobobMagnetActive
- Vehicle.isDamaged
- Vehicle.isDoorDamaged
- Vehicle.isDoorFullyOpen
- Vehicle.isDriveable
- Vehicle.isExtraTurnedOn
- Vehicle.isHeliPartBroken
- Vehicle.isHighDetail
- Vehicle.isInBurnout
- Vehicle.isModel
- Vehicle.isNeonLightEnabled
- Vehicle.isOnAllWheels
- Vehicle.isSearchlightOn
- Vehicle.isSeatFree
- Vehicle.isSirenOn
- Vehicle.isSirenSoundOn
- Vehicle.isStolen
- Vehicle.isStoppedAtTrafficLights
- Vehicle.isStopped
- Vehicle.isStuckOnRoof
- Vehicle.isStuckTimerUp
- Vehicle.isTaxiLightOn
- Vehicle.isToggleModOn
- Vehicle.isTyreBurst
- Vehicle.isVisible
- Vehicle.isWindowIntact
- Vehicle.jitter
- Vehicle.lowerConvertibleRoof
- Vehicle.openBombBayDoors
- Vehicle.raiseConvertibleRoof
- Vehicle.releasePreloadMods
- Vehicle.removeHighDetailModel
- Vehicle.removeMod
- Vehicle.removeUpsidedownCheck
- Vehicle.removeWindow
- Vehicle.requestHighDetailModel
- Vehicle.resetStuckTimer
- Vehicle.resetWheels
- Vehicle.retractCargobobHook
- Vehicle.rollDownWindows
- Vehicle.rollDownWindow
- Vehicle.rollUpWindow
- Vehicle.setAlarm
- Vehicle.setAllowNoPassengersLockon
- Vehicle.setAllsSpawn
- Vehicle.setAutomaticallyAttaches
- Vehicle.setBikeLeanAngle
- Vehicle.setBoatAnchor
- Vehicle.setBodyHealth
- Vehicle.setBrakeLights
- Vehicle.setBurnout
- Vehicle.setCanBeTargetted
- Vehicle.setCanBeUsedByFleeingPeds
- Vehicle.setCanBeVisiblyDamaged
- Vehicle.setCanBreak
- Vehicle.setCanRespray
- Vehicle.setCeilingHeight
- Vehicle.setColourCombination
- Vehicle.setColours
- Vehicle.setConvertibleRoof
- Vehicle.setCreatesMoneyPickupsWhenExploded
- Vehicle.setCustomPrimaryColour
- Vehicle.setCustomSecondaryColour
- Vehicle.setDamage
- Vehicle.setDeformationFixed
- Vehicle.setDirtLevel
- Vehicle.setDisablePetrolTankDamage
- Vehicle.setDisablePetrolTankFires
- Vehicle.setDoorBreakable
- Vehicle.setDoorBroken
- Vehicle.setDoorControl
- Vehicle.setDoorLatched
- Vehicle.setDoorOpen
- Vehicle.setDoorShut
- Vehicle.setDoorsLockedForAllPlayers
- Vehicle.setDoorsLockedForPlayer
- Vehicle.setDoorsLockedForTeam
- Vehicle.setDoorsLocked
- Vehicle.setDoorsShut
- Vehicle.setEngineCanDegrade
- Vehicle.setEngineHealth
- Vehicle.setEngineOn
- Vehicle.setEnginePowerMultiplier
- Vehicle.setEngineTorqueMultiplier
- Vehicle.setExclusiveDriver
- Vehicle.setExplodesOnHighExplosionDamage
- Vehicle.setExtraColours
- Vehicle.setExtra
- Vehicle.setFixed
- Vehicle.setForwardSpeed
- Vehicle.setFrictionOverride
- Vehicle.setFullbeam
- Vehicle.setGravity
- Vehicle.setHalt
- Vehicle.setHandbrake
- Vehicle.setHandling
- Vehicle.setHasBeenOwnedByPlayer
- Vehicle.setHasStrongAxles
- Vehicle.setHeliBladesFullSpeed
- Vehicle.setHeliBladesSpeed
- Vehicle.setHelicopterRollPitchYawMult
- Vehicle.setIndicatorLights
- Vehicle.setInteriorlight
- Vehicle.setIsConsideredByPlayer
- Vehicle.setIsStolen
- Vehicle.setIsWanted
- Vehicle.setJetEngineOn
- Vehicle.setLandingGear
- Vehicle.setLightMultiplier
- Vehicle.setLights
- Vehicle.setLivery
- Vehicle.setLodMultiplier
- Vehicle.setMissionTrainCoords
- Vehicle.setModColor1
- Vehicle.setModColor2
- Vehicle.setModKit
- Vehicle.setMod
- Vehicle.setNameDebug
- Vehicle.setNeedsToBeHotwired
- Vehicle.setNeonLightEnabled
- Vehicle.setNeonLightsColour
- Vehicle.setNumberPlateTextIndex
- Vehicle.setNumberPlateText
- Vehicle.setOnGroundProperly
- Vehicle.setOutOfControl
- Vehicle.setPaintFade
- Vehicle.setPedEnabledBikeRingtone
- Vehicle.setPedTargettableDestroy
- Vehicle.setPetrolTankHealth
- Vehicle.setPlaneMinHeightAboveGround
- Vehicle.setPlaybackToUseAi
- Vehicle.setPlayersLast
- Vehicle.setProvidesCover
- Vehicle.setReduceGrip
- Vehicle.setRenderTrainAsDerailed
- Vehicle.setRimRadius
- Vehicle.setRudderBroken
- Vehicle.setSearchlight
- Vehicle.setSilent
- Vehicle.setSiren
- Vehicle.setSirenSound
- Vehicle.setSteerBias
- Vehicle.setStrong
- Vehicle.setSuspensionHeight
- Vehicle.setTaxiLights
- Vehicle.setTimedExplosion
- Vehicle.setTowTruckCraneHeight
- Vehicle.setTrainCruiseSpeed
- Vehicle.setTrainSpeed
- Vehicle.setTyreBurst
- Vehicle.setTyreFixed
- Vehicle.setTyreRadius
- Vehicle.setTyreSmokeColor
- Vehicle.setTyresCanBurst
- Vehicle.setTyreWidth
- Vehicle.setUndriveable
- Vehicle.setWheelCamber
- Vehicle.setWheelHeight
- Vehicle.setWheelRadius
- Vehicle.setWheelTrackWidth
- Vehicle.setWheelType
- Vehicle.setWheelWidth
- Vehicle.setWheelsCanBreakOffWhenBlowUp
- Vehicle.setWheelsCanBreak
- Vehicle.setWindowTint
- Vehicle.smashWindow
- Vehicle.startAlarm
- Vehicle.startHorn
- Vehicle.steerUnlockBias
- Vehicle.toggleMod
- Vehicle.trackVisibility
- Vehicle.wasCounterActivated
- Vehicle.breakOffWheel
- Vehicle.isWheelBrokenOff
- Vehicle.fixWheel
- Vehicle.breakOffBumper
- Vehicle.fixBumper
- Vehicle.setLiveryTexture
- Vehicle.setNumberPlateTexture
- Vehicle.setDriftTyresEnabled
- Vehicle.getDriftTyresEnabled
- Properties: