alt:V JS Docs | alt:V JS Docs

Skip to content

Main NavigationIntro

Guides Team 💾 Download

Appearance

Sidebar Navigation

Server API

defaultDimension deleteSyncedMeta()emit()emitAllClients()emitAllClientsRaw()emitClient()emitClientRaw()emitRaw()getNetTime()getRemoteEventListeners()getResourceMain()getResourcePath()getServerConfig()getVehicleModelInfoByHash()Setup globalDimension hashServerPassword()offClient()on()once()onceClient()onClient()restartResource()rootDir setPassword()setSyncedMeta()startResource()stopResource()stopServer()

AreaBlip

BaseObject

deleteMeta()getMeta()hasMeta()setMeta()

Blip

all()alpha()asMissionCreator()attachedTo()bright()category()color()crewIndicatorVisible()deleteMeta()display()fade()flashes()flashesAlternate()flashInterval()flashTimer()friendIndicatorVisible()getMeta()gxtName()hasMeta()heading()headingIndicatorVisible()highDetail()name()number()outlineIndicatorVisible()priority()pulse()route()routeColor()scale()secondaryColor()setMeta()shortRange()showCone()shrinked()size()sprite()tickVisible()

Checkpoint

checkpoint()deleteMeta()getMeta()hasMeta()setMeta()

Colshape

colshapeType()deleteMeta()getMeta()hasMeta()isEntityIn()isPointIn()playersOnly()setMeta()

ColshapeCircle

colshapeCircle()

ColshapeCuboid

colshapeCuboid()

ColshapeCylinder

colshapeCylinder()

ColshapePolygon

colshapePolygon()

ColshapeRectangle

colshapeRectangle()

ColshapeSphere

colshapeSphere()

Entity

all()attachTo()collision()deleteMeta()deleteStreamSyncedMeta()deleteSyncedMeta()detach()frozen()getByID()getMeta()getStreamSyncedMeta()getSyncedMeta()hasMeta()hasStreamSyncedMeta()hasSyncedMeta()id()model()netOwner()resetNetOwner()rot()setMeta()setNetOwner()setStreamSyncedMeta()setSyncedMeta()streamed()visible()

Player

addWeaponComponent()aimPos()all()armour()authToken()clearBloodDamage()clearProp()currentAnimationDict()currentAnimationName()currentInterior()currentWeapon()currentWeaponComponents()currentWeaponTintIndex()deleteLocalMeta()deleteMeta()deleteStreamSyncedMeta()deleteSyncedMeta()despawn()discordID()emit()emitRaw()entityAimingAt()entityAimOffset()flashlightActive()forwardSpeed()getByID()getClothes()getDlcClothes()getDlcProp()getEyeColor()getFaceFeatureScale()getHairColor()getHairHighlightColor()getHeadBlendData()getHeadBlendPaletteColor()getHeadOverlay()getLocalMeta()getMeta()getProp()getStreamSyncedMeta()getSyncedMeta()giveWeapon()hasLocalMeta()hasMeta()hasStreamSyncedMeta()hasSyncedMeta()headRot()health()hwidExHash()hwidHash()invincible()ip()isAiming()isCrouching()isDead()isEntityInStreamRange()isInRagdoll()isReloading()isSpawned()isStealthy()isSuperJumpEnabled()kick()lastDamagedBodyPart()maxArmour()maxHealth()moveSpeed()name()ping()playAmbientSpeech()removeAllWeapons()removeFaceFeature()removeHeadOverlay()removeWeapon()removeWeaponComponent()seat()setClothes()setDateTime()setDlcClothes()setDlcProp()setEyeColor()setFaceFeature()setHairColor()setHairHighlightColor()setHeadBlendData()setHeadBlendPaletteColor()setHeadOverlay()setHeadOverlayColor()setIntoVehicle()setLocalMeta()setMeta()setProp()setStreamSyncedMeta()setSyncedMeta()setWeaponTintIndex()setWeather()socialID()spawn()strafeSpeed()vehicle()weapons()

PointBlip

RadiusBlip

Resource

Vehicle

activeRadioStation()all()attached()attachedTo()boatAnchorActive()bodyAdditionalHealth()bodyHealth()bombCount()counterMeasureCount()customPrimaryColor()customSecondaryColor()customTires()damageModifier()damageMultiplier()darkness()dashboardColor()daylightOn()deleteMeta()deleteStreamSyncedMeta()deleteSyncedMeta()destroyed()dirtLevel()doesWheelHasTire()driftModeEnabled()driver()engineHealth()engineOn()flamethrowerActive()frontWheels()getAppearanceDataBase64()getArmoredWindowHealth()getArmoredWindowShootCount()getBumperDamageLevel()getByID()getDamageStatusBase64()getDoorState()getExtra()getGamestateDataBase64()getHealthDataBase64()getMeta()getMod()getModsCount()getPartBulletHoles()getPartDamageLevel()getScriptDataBase64()getStreamSyncedMeta()getSyncedMeta()getWeaponCapacity()getWheelHealth()handbrakeActive()hasArmoredWindows()hasMeta()hasStreamSyncedMeta()hasSyncedMeta()hasTimedExplosion()headlightColor()hybridExtraActive()hybridExtraState()interiorColor()isLightDamaged()isMissionTrain()isSpecialLightDamaged()isTrainCaboose()isTrainEngine()isWheelBurst()isWheelDetached()isWheelOnFire()isWindowDamaged()isWindowOpened()lightsMultiplier()lightState()livery()lockState()manualEngineControl()model()modKit()modKitsCount()neon()neonColor()nightlightOn()numberPlateIndex()numberPlateText()pearlColor()petrolTankHealth()primaryColor()rearWheels()repair()repairsCount()rocketRefuelSpeed()roofLivery()roofState()scriptMaxSpeed()secondaryColor()setAppearanceDataBase64()setArmoredWindowHealth()setArmoredWindowShootCount()setBumperDamageLevel()setDamageStatusBase64()setDoorState()setExtra()setGamestateDataBase64()setHealthDataBase64()setLightDamaged()setMeta()setMod()setPartBulletHoles()setPartDamageLevel()setRearWheels()setScriptDataBase64()setSearchLightTo()setSpecialLightDamaged()setStreamSyncedMeta()setSyncedMeta()setTimedExplosion()setTrainEngineId()setTrainLinkedToBackwardId()setTrainLinkedToForwardId()setWeaponCapacity()setWheelBurst()setWheelDetached()setWheelFixed()setWheelHasTire()setWheelHealth()setWheelOnFire()setWheels()setWindowDamaged()setWindowOpened()sirenActive()timedExplosionCulprit()timedExplosionTime()tireSmokeColor()trainCarriageConfigIndex()trainConfigIndex()trainCruiseSpeed()trainDirection()trainDistanceFromEngine()trainEngineId()trainForceDoorsOpen()trainLinkedToBackwardId()trainLinkedToForwardId()trainPassengerCarriages()trainRenderDerailed()trainTrackId()trainUnk1()trainUnk2()trainUnk3()vehicle()velocity()wheelColor()wheelsCount()wheelType()windowTint()

VoiceChannel

addPlayer()deleteMeta()getMeta()hasMeta()isPlayerInChannel()isPlayerMuted()mutePlayer()playerCount()players()removePlayer()setMeta()unmutePlayer()voiceChannel()

WorldObject

dimension()pos()

Used to get or set a player's armour.

Documentation Created with ❤️ by Stuyk