Skip to content

Main NavigationIntro

Guides Team 💾 Download

Appearance

Sidebar Navigation

Client API

addGxtText()beginScaleformMovieMethodMinimap()clearPedProp()copyToClipboard()doesConfigFlagExist()emit()emitRaw()emitServer()emitServerRaw()evalModule()gameControlsEnabled()getCamPos()getConfigFlag()getCursorPos()getFps()getGxtText()getHeadshotBase64()getLicenseHash()getLocale()getLocalMeta()getMsPerGameMinute()getPermissionState()getPing()getRemoteEventListeners()getScreenResolution()getServerIp()getServerPort()getStat()Setup getTotalPacketsLost()getTotalPacketsSent()hasLocalMeta()isCamFrozen()isConsoleOpen()isCursorVisible()isGameFocused()isInStreamerMode()isKeyDown()isKeyToggled()isMenuOpen()isPointOnScreen()isTextureExistInArchetype()loadDefaultIpls()loadModel()loadModelAsync()loadRmlFont()loadYtyp()offServer()on()once()onceServer()onServer()removeGxtText()removeIpl()requestIpl()resetStat()rmlControlsEnabled()screenToWorld()setCamFrozen()setConfigFlag()setCursorPos()setMinimapComponentPosition()setMinimapIsRectangle()setMsPerGameMinute()setPedDlcClothes()setPedDlcProp()setRotationVelocity()setStat()setWatermarkPosition()setWeatherCycle()setWeatherSyncActive()showCursor()takeScreenshot()takeScreenshotGameOnly()toggleGameControls()toggleRmlControls()toggleVoiceControls()unloadYtyp()worldToScreen()

AreaBlip

Audio

addOutput()audio()category()currentTime()deleteMeta()frontendPlay()getMeta()getOutputs()hasMeta()looped()maxTime()on()pause()play()playing()removeOutput()reset()seek()setMeta()source()volume()

BaseObject

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

Blip

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

Checkpoint

checkpoint()checkpointType()color()deleteMeta()getMeta()hasMeta()height()isEntityIn()isPointIn()nextPos()radius()setMeta()

Discord

currentUser()discord()requestOAuth2Token()

Entity

all()deleteMeta()getByID()getByScriptID()getMeta()getStreamSyncedMeta()getSyncedMeta()hasMeta()hasStreamSyncedMeta()hasSyncedMeta()id()isSpawned()model()netOwner()pos()rot()scriptID()setMeta()visible()

FocusData

clearFocus()focusData()focusOverrideEntity()focusOverrideOffset()focusOverridePos()isFocusOverriden()overrideFocus()

HandlingData

acceleration()antiRollBarBiasFront()antiRollBarBiasRear()antiRollBarForce()brakeBiasFront()brakeBiasRear()brakeForce()camberStiffnesss()centreOfMassOffset()clutchChangeRateScaleDownShift()clutchChangeRateScaleUpShift()collisionDamageMult()damageFlags()deformationDamageMult()downforceModifier()driveBiasFront()driveInertia()driveMaxFlatVel()engineDamageMult()getForHandlingName()handBrakeForce()handlingData()handlingFlags()handlingNameHash()inertiaMultiplier()initialDragCoeff()initialDriveForce()initialDriveGears()initialDriveMaxFlatVel()lowSpeedTractionLossMult()mass()modelFlags()monetaryValue()oilVolume()percentSubmerged()percentSubmergedRatio()petrolTankVolume()rollCentreHeightFront()rollCentreHeightRear()seatOffsetDistX()seatOffsetDistY()seatOffsetDistZ()steeringLock()steeringLockRatio()suspensionBiasFront()suspensionBiasRear()suspensionCompDamp()suspensionForce()suspensionLowerLimit()suspensionRaise()suspensionReboundDamp()suspensionUpperLimit()tractionBiasFront()tractionBiasRear()tractionCurveLateral()tractionCurveLateralRatio()tractionCurveMax()tractionCurveMaxRatio()tractionCurveMin()tractionCurveMinRatio()tractionLossMult()tractionSpringDeltaMax()tractionSpringDeltaMaxRatio()unkFloat1()unkFloat2()unkFloat4()unkFloat5()weaponDamageMult()

HttpClient

connect()delete()get()getExtraHeaders()head()httpClient()options()patch()post()put()setExtraHeader()trace()

LocalPlayer

currentAmmo()deleteMeta()getMeta()getWeaponAmmo()getWeaponComponents()hasMeta()hasWeapon()setMeta()weapons()

LocalStorage

clear()delete()deleteAll()get()localStorage()save()set()

MapZoomData

fScrollSpeed()fZoomScale()fZoomSpeed()get()mapZoomData()reset()resetAll()vTilesX()vTilesY()

MemoryBuffer

address()byte()double()float()free()int()long()memoryBuffer()short()size()string()ubyte()uint()ulong()ushort()

Object

activatePhysics()all()allWorld()alpha()attachToEntity()detach()dynamic()hasGravity()isCollisionEnabled()isRemote()isWorldObject()lodDistance()object()placeOnGroundProperly()pos()resetAlpha()rot()setPositionFrozen()textureVariation()toggleCollision()waitForSpawn()

Player

aimPos()all()armour()currentWeapon()currentWeaponComponents()deleteMeta()entityAimingAt()entityAimOffset()flashlightActive()forwardSpeed()getByID()getByScriptID()getMeta()getStreamSyncedMeta()getSyncedMeta()hasMeta()hasStreamSyncedMeta()hasSyncedMeta()headRot()health()isAiming()isDead()isInRagdoll()isReloading()isTalking()local()maxArmour()maxHealth()micLevel()moveSpeed()name()nonSpatialVolume()seat()setMeta()spatialVolume()strafeSpeed()streamedIn()vehicle()

PointBlip

Profiler

getMemoryProfile()heapStats()profiler()profilesRunning()samplingInterval()startProfiling()stopProfiling()

RadiusBlip

RmlDocument

body()createElement()createTextNode()hide()isModal()isVisible()rmlDocument()show()sourceUrl()title()update()

RmlElement

absoluteLeft()absoluteOffset()absoluteTop()addClass()addPseudoClass()appendChild()baseline()blur()childCount()childNodes()click()clientHeight()clientLeft()clientTop()clientWidth()closest()containingBlock()firstChild()focus()focusedElement()getAttribute()getAttributes()getClassList()getElementByID()getElementsByClassName()getElementsByTagName()getEventListeners()getLocalProperty()getProperty()getPropertyAbsoluteValue()getPseudoClassList()hasAttribute()hasChildren()hasClass()hasLocalProperty()hasProperty()hasPseudoClass()id()innerRML()insertBefore()isOwned()isPointWithinElement()isVisible()lastChild()nextSibling()off()offsetHeight()offsetLeft()offsetTop()offsetWidth()on()ownerDocument()parent()previousSibling()querySelector()querySelectorAll()relativeOffset()removeAttribute()removeChild()removeClass()removeProperty()removePseudoClass()replaceChild()scrollHeight()scrollIntoView()scrollLeft()scrollTop()scrollWidth()setAttribute()setOffset()setProperty()style()tagName()zIndex()

Utils

drawText2d()drawText2dThisFrame()drawText3d()drawText3dThisFrame()requestAnimDict()requestAnimSet()requestClipSet()requestCutscene()requestModel()

Vehicle

all()deleteMeta()engineOn()engineTemperature()fuelLevel()gear()getByID()getByScriptID()getMeta()getStreamSyncedMeta()getSyncedMeta()getWheelCamber()getWheelHeight()getWheelRimRadius()getWheelTrackWidth()getWheelTyreRadius()getWheelTyreWidth()handling()hasMeta()hasStreamSyncedMeta()hasSyncedMeta()indicatorLights()lockState()maxGear()oilLevel()petrolTankHealth()rpm()seatCount()setMeta()setWheelCamber()setWheelHeight()setWheelRimRadius()setWheelTrackWidth()setWheelTyreRadius()setWheelTyreWidth()speed()speedVector()streamedIn()wheelsCount()

Voice

activationKey()activityInputEnabled()muteInput()voice()voiceControlsEnabled()

WeaponData

accuracySpread()animReloadRate()clipSize()damage()getForHash()headshotDamageModifier()lockOnRange()modelHash()nameHash()playerDamageModifier()range()recoilAccuracyMax()recoilAccuracyToAllowHeadshotPlayer()recoilRecoveryRate()recoilShakeAmplitude()timeBetweenShots()vehicleReloadTime()weaponData()

WebSocketClient

addSubProtocol()autoReconnect()getEventListeners()getSubProtocols()off()on()perMessageDeflate()pingInterval()readyState()send()setExtraHeader()start()stop()url()webSocketClient()

WebView

deleteMeta()emit()focus()focused()getEventListeners()getMeta()hasMeta()isOverlay()isReady()isVisible()off()on()once()pos()setExtraHeader()setMeta()setZoomLevel()size()unfocus()url()webView()

Worker

addSharedArrayBuffer()destroy()emit()filePath()isPaused()maxWorkers()off()on()once()pause()removeSharedArrayBuffer()resume()start()valid()worker()

WorldObject

On this page

Table of Contents for current page

Function Definition
Documentation

readyState()

No Description Provided

Function Definition

ts

public readonly readyState: WebSocketReadyState;

Returns

WebSocketReadyState

Documentation

No Documentation Provided Yet

Documentation Created with ❤️ by Stuyk