REVO / API version 0.0.10
Player
Static queries return NPCs only. Use Player’s queries for players.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
armour |
number |
|
collisionEnabled |
boolean |
|
connectionId |
number |
— |
dead |
boolean |
— |
dimension |
number |
Dimension: 0..4294967294, default 0. globalDimension shows entities and spatial audio in every dimension. Players cannot use globalDimension. Global entities share movement, damage and seats across dimensions. A vehicle’s trailer follows its dimension. Occupants follow unless the new dimension is global. |
health |
number |
|
hwidHash |
string | null |
Client-reported SHA-256 hardware identifier in lowercase hex. null when unavailable. Available from playerConnected through playerDisconnected. Not verified by the server. |
id |
number |
|
ip |
string |
Connection IP address, without the port. |
maxHealth |
number |
|
netOwner |
Player | null |
|
networkId |
number | null |
Network ID shared with clients. null after destruction. |
ping |
number |
Round-trip time in milliseconds. |
socialClubId |
string | null |
Verified Rockstar account ID as a decimal string, or null when verification was unavailable or failed. |
socialClubName |
string |
Rockstar’s account name when verified. Otherwise the name supplied by the client. |
socialClubVerified |
boolean |
Whether Rockstar verified this session’s account identity. Available when playerConnected fires. |
state |
PlayerState |
— |
streamed |
boolean |
Defaults to true and persists across respawns. False streams this player out for all observers. Their own streaming and voice stay active. True restores distance and dimension checks. |
type |
BaseType |
|
valid |
boolean |
|
vehicleOccupancy |
IVehicleOccupancy |
|
visible |
boolean |
|
all |
readonly Player[] |
|
count |
number |
Accessors
Section titled “Accessors”| Accessor | Type | Details |
|---|---|---|
angVelocity |
Read: Vector3Write: IVector3 |
|
modelHash |
Read: numberWrite: string | number |
Accepts a model name or nonzero uint32 hash. Clients load the new model asynchronously. |
pos |
Read: Vector3Write: IVector3 |
|
quaternion |
Read: QuaternionWrite: IQuaternion |
|
rot |
Read: Vector3Write: IVector3 |
Euler angles in radians, applied X, then Y, then Z. |
velocity |
Read: Vector3Write: IVector3 |
Methods
Section titled “Methods”addWeaponComponent()
Section titled “addWeaponComponent()”addWeaponComponent(
weapon,component):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
weapon |
number |
component |
number |
Returns
Section titled “Returns”boolean
clearProp()
Section titled “clearProp()”clearProp(
prop):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
prop |
PedProp |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”clearProps()
Section titled “clearProps()”clearProps():
boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”deleteSyncedMeta()
Section titled “deleteSyncedMeta()”deleteSyncedMeta(
key):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Deletes the entity. Throws for players and already destroyed entities.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getComponentVariation()
Section titled “getComponentVariation()”getComponentVariation(
component):IPedComponentVariation|null
Requested clothing, or null if unset.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
component |
PedComponent |
Returns
Section titled “Returns”IPedComponentVariation | null
Inherited from
Section titled “Inherited from”getFaceFeature()
Section titled “getFaceFeature()”getFaceFeature(
feature):number|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
feature |
PedFaceFeature |
Returns
Section titled “Returns”number | null
Inherited from
Section titled “Inherited from”getHairColor()
Section titled “getHairColor()”getHairColor():
IPedHairColor|null
Returns
Section titled “Returns”IPedHairColor | null
Inherited from
Section titled “Inherited from”getHeadBlendData()
Section titled “getHeadBlendData()”getHeadBlendData():
Required<IPedHeadBlendData> |null
Copy of the requested blend with all fields filled, or null if unset.
Returns
Section titled “Returns”Required<IPedHeadBlendData> | null
Inherited from
Section titled “Inherited from”getHeadOverlay()
Section titled “getHeadOverlay()”getHeadOverlay(
overlay):IPedHeadOverlay|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
overlay |
PedHeadOverlay |
Returns
Section titled “Returns”IPedHeadOverlay | null
Inherited from
Section titled “Inherited from”getObservers()
Section titled “getObservers()”getObservers(): readonly
Player[]
Returns
Section titled “Returns”readonly Player[]
Inherited from
Section titled “Inherited from”getProp()
Section titled “getProp()”getProp(
prop):IPedPropVariation|null
Requested prop, or null if unset. A cleared prop has drawable -1.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
prop |
PedProp |
Returns
Section titled “Returns”IPedPropVariation | null
Inherited from
Section titled “Inherited from”getStreamedEntities()
Section titled “getStreamedEntities()”getStreamedEntities(): readonly
Entity[]
Returns
Section titled “Returns”readonly Entity[]
getSyncedMeta()
Section titled “getSyncedMeta()”Call Signature
Section titled “Call Signature”getSyncedMeta<
K>(key):ICustomBaseSyncedMeta[K] |undefined
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends never |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
Returns
Section titled “Returns”ICustomBaseSyncedMeta[K] | undefined
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”getSyncedMeta<
T>(key):T|undefined
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T |
TransportValue |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”T | undefined
Inherited from
Section titled “Inherited from”getSyncedMetaKeys()
Section titled “getSyncedMetaKeys()”getSyncedMetaKeys():
string[]
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”getWeapon()
Section titled “getWeapon()”getWeapon(
hash):IInventoryWeapon|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
hash |
number |
Returns
Section titled “Returns”IInventoryWeapon | null
getWeaponComponents()
Section titled “getWeaponComponents()”getWeaponComponents(
weapon): readonlynumber[]
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
weapon |
number |
Returns
Section titled “Returns”readonly number[]
giveWeapon()
Section titled “giveWeapon()”Call Signature
Section titled “Call Signature”giveWeapon(
hash,ammo,equip?):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
hash |
number |
ammo |
number |
equip? |
boolean |
Returns
Section titled “Returns”boolean
Call Signature
Section titled “Call Signature”giveWeapon(
hash,ammo,loadout,equip?):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
hash |
number |
ammo |
number |
loadout |
IWeaponLoadout |
equip? |
boolean |
Returns
Section titled “Returns”boolean
hasStreamedIn()
Section titled “hasStreamedIn()”hasStreamedIn(
entity):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
entity |
Entity |
Returns
Section titled “Returns”boolean
hasSyncedMeta()
Section titled “hasSyncedMeta()”hasSyncedMeta(
key):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”hasWeapon()
Section titled “hasWeapon()”hasWeapon(
hash):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
hash |
number |
Returns
Section titled “Returns”boolean
hasWeaponComponent()
Section titled “hasWeaponComponent()”hasWeaponComponent(
weapon,component):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
weapon |
number |
component |
number |
Returns
Section titled “Returns”boolean
kick()
Section titled “kick()”kick(
reason):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
reason |
string |
Returns
Section titled “Returns”void
removeAllWeapons()
Section titled “removeAllWeapons()”removeAllWeapons():
void
Returns
Section titled “Returns”void
removeFromVehicle()
Section titled “removeFromVehicle()”removeFromVehicle():
boolean
Removes the ped and cancels pending entry or exit, including requests made while on foot. Releases the server seat immediately. GTA chooses the exit position.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”removeWeapon()
Section titled “removeWeapon()”removeWeapon(
hash):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
hash |
number |
Returns
Section titled “Returns”boolean
removeWeaponComponent()
Section titled “removeWeaponComponent()”removeWeaponComponent(
weapon,component):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
weapon |
number |
component |
number |
Returns
Section titled “Returns”boolean
setComponentVariation()
Section titled “setComponentVariation()”setComponentVariation(
component,drawable,texture?,palette?):boolean
Uses global drawable indices. Once clothing is set, unset components use the model’s default outfit. Persists across streaming, respawns and model changes. Clients skip unsupported combinations. Returns false outside these ranges: component 0..11, drawable 0..65535, texture 0..255, palette 0..3.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
component |
PedComponent |
drawable |
number |
texture? |
number |
palette? |
number |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setCurrentWeapon()
Section titled “setCurrentWeapon()”setCurrentWeapon(
hash):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
hash |
number |
Returns
Section titled “Returns”boolean
setDefaultComponentVariation()
Section titled “setDefaultComponentVariation()”setDefaultComponentVariation():
boolean
Resets clothing to model defaults. Clears component overrides and keeps prop selections.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Ped.setDefaultComponentVariation
setFaceFeature()
Section titled “setFaceFeature()”setFaceFeature(
feature,scale):boolean
Scale: [-1, 1]. If no blend is set, face, overlay and hair setters use parent indices 0.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
feature |
PedFaceFeature |
scale |
number |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setHairColor()
Section titled “setHairColor()”setHairColor(
color,highlight?):boolean
Colours: 0..63. Highlight defaults to 0. Set the hairstyle through PedComponent.Hair.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
color |
number |
highlight? |
number |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setHeadBlendData()
Section titled “setHeadBlendData()”setHeadBlendData(
data):boolean
Applies to mp_m_freemode_01 and mp_f_freemode_01. Other models store the values without applying them. Persists across streaming, respawns and model changes. Keeps face features, overlays and hair colours. Returns false for out-of-range values. Wrong types and non-finite numbers throw TypeError.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data |
IPedHeadBlendData |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setHeadOverlay()
Section titled “setHeadOverlay()”setHeadOverlay(
overlay,index,opacity?):boolean
Index: 0..254, or -1 to disable. Unavailable indices also disable the overlay. Opacity: [0, 1], default 1. Keeps the overlay’s colours.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
overlay |
PedHeadOverlay |
index |
number |
opacity? |
number |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setHeadOverlayColor()
Section titled “setHeadOverlayColor()”setHeadOverlayColor(
overlay,colorType,color,secondColor?):boolean
Colours: 0..63. Use setHeadOverlay to enable the overlay. Hair palette: facial hair, eyebrows, chest hair. Makeup palette: blush and lipstick.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
overlay |
PedHeadOverlay |
colorType |
PedOverlayColorType |
color |
number |
secondColor? |
number |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setIntoVehicle()
Section titled “setIntoVehicle()”setIntoVehicle(
vehicle,seat?):boolean
Places the ped in a vehicle. Seat -1 is the driver (default). Seats 0–14 are passengers. Returns false for occupied or reserved seats, dead peds, unspawned players, invalid seat indices, or vehicles outside the ped’s visible dimension. Returns true when the server accepts the request. Clients wait for the vehicle to load and reject seats missing from its model. Requesting the current seat has no effect.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
vehicle |
Vehicle |
seat? |
number |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setProp()
Section titled “setProp()”setProp(
prop,drawable,texture?):boolean
Uses global drawable indices. Prop: 0..12, drawable: -1..65535, texture: 0..255 (default 0). Drawable -1 requires texture 0 and clears the prop. Unsupported combinations leave it cleared on that client. Persists across streaming, respawns and model changes.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
prop |
PedProp |
drawable |
number |
texture? |
number |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setSyncedMeta()
Section titled “setSyncedMeta()”Call Signature
Section titled “Call Signature”setSyncedMeta<
K>(key,value):void
Copies and replicates the value to the object’s audience. Player metadata also goes to that player.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends string |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
value |
K extends never ? ICustomBaseSyncedMeta[K] : TransportValue |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”setSyncedMeta(
values):void
Atomically merges own enumerable fields. Unsupported values reject the entire batch.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
values |
Partial<ICustomBaseSyncedMeta> & Record<string, TransportValue> |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setWeaponAmmo()
Section titled “setWeaponAmmo()”setWeaponAmmo(
hash,ammo):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
hash |
number |
ammo |
number |
Returns
Section titled “Returns”boolean
setWeaponLoadout()
Section titled “setWeaponLoadout()”setWeaponLoadout(
hash,loadout):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
hash |
number |
loadout |
IWeaponLoadout |
Returns
Section titled “Returns”boolean
spawn()
Section titled “spawn()”spawn(
pos,heading):boolean
Restores health to maxHealth and resets movement. Returns false if the spawn is rejected.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
pos |
IVector3 |
- |
heading |
number |
Heading in radians. Resets pitch and roll to zero. |
Returns
Section titled “Returns”boolean
getById()
Section titled “getById()”
staticgetById(id):Player|null
Looks up an NPC. Use Player.getById for players.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Player | null
Overrides
Section titled “Overrides”getByNetworkId()
Section titled “getByNetworkId()”
staticgetByNetworkId(networkId):Player|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
networkId |
number |
Returns
Section titled “Returns”Player | null
Overrides
Section titled “Overrides”getInRadius()
Section titled “getInRadius()”
staticgetInRadius(position,radius,dimension?): readonlyPlayer[]
Includes global entities alongside the selected dimension. globalDimension selects only global entities. Omit it to search all worlds.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
position |
IVector3 |
radius |
number |
dimension? |
number |
Returns
Section titled “Returns”readonly Player[]