Ped

Hierarchy

• Entity
  • Ped

Index

Properties

• armour
• currentWeapon
• dimension
• frozen
• health
• id
• isRemote
• isSpawned
• maxHealth
• netOwner
• pos
• refCount
• remoteID
• rot
• scriptID
• type
• valid
• visible
• all
• count
• streamedIn

Accessors

• model

Methods

• deleteMeta
• destroy
• getMeta
• getMetaDataKeys
• getStreamSyncedMeta
• getStreamSyncedMetaKeys
• getSyncInfo
• getSyncedMeta
• getSyncedMetaKeys
• hasMeta
• hasStreamSyncedMeta
• hasSyncedMeta
• setMeta
• getByID
• getByRemoteID
• getByScriptID

Properties

publicreadonlyarmour

armour: number

Current armour.

publicreadonlycurrentWeapon

currentWeapon: number

Currently equipped weapon.

publicdimension

dimension: number

Object dimension.

Remarks

Check https://docs.altv.mp/articles/dimensions.html to understand how it works.

Inherited from Entity.dimension

publicfrozen

frozen: boolean

Inherited from Entity.frozen

publicreadonlyhealth

health: number

Current health of the ped.

publicreadonlyid

id: number

Inherited from Entity.id

publicreadonlyisRemote

isRemote: boolean

Whether this entity was created clientside or serverside. (Clientside = false, Serverside = true).

Inherited from Entity.isRemote

publicreadonlyisSpawned

isSpawned: boolean

Returns whether the entity is spawned in the game world.

Remarks

This does the same thing as checking if the scriptID is 0.

Inherited from Entity.isSpawned

publicreadonlymaxHealth

maxHealth: number

Current max health of the ped.

publicreadonlynetOwner

netOwner: null | Player

Network owner of the entity.

Remarks

Network owner is responsible for syncing entity with the server. It changes when actual network owner passes the migration range, then the new one is determined based on distance from the entity (if entity is a vehicle, then the driver will take priority for becoming network owner). Disabling migration range will stop this process from happening until turned on again.

Inherited from Entity.netOwner

publicpos

pos: Vector3

Object position.

Remarks

Setting this throws an error if the client is not the network owner of an entity

Inherited from Entity.pos

publicreadonlyrefCount

refCount: number

Returns the ref count of the entity.

Remarks

It’s only available in debug-mode.

Inherited from Entity.refCount

publicreadonlyremoteID

remoteID: number

The serverside id of this entity.

Inherited from Entity.remoteID

publicrot

rot: Vector3

Entity rotation in radians

Remarks

Setting this throws an error if the client is not the network owner of an entity

Inherited from Entity.rot

publicreadonlyscriptID

scriptID: number

Internal game id that can be used in native calls

Inherited from Entity.scriptID

publicreadonlytype

type: BaseObjectType

Type of the object.

Inherited from Entity.type

publicreadonlyvalid

valid: boolean

Object usability.

Returns

False if object is no longer usable.

Inherited from Entity.valid

publicreadonlyvisible

visible: boolean

Inherited from Entity.visible

publicstaticreadonlyall

all: readonly Ped[]

Overrides Entity.all

publicstaticreadonlycount

count: number

publicstaticreadonlystreamedIn

streamedIn: readonly Ped[]

Accessors

publicmodel

• get model(): number

Getter

• Inherited from Entity.model

  Hash of entity model

Methods

publicdeleteMeta

• deleteMeta(key: string): void
• deleteMeta<K>(key: K): void

• Overrides Entity.deleteMeta

publicdestroy

• destroy(): void

• Inherited from Entity.destroy

  Removes the object from the world.

publicgetMeta

• getMeta<K>(key: Exclude<K, never>): unknown
• getMeta<K>(key: K): undefined | ICustomPedMeta[K]

• Overrides Entity.getMeta

  Type parameters

  • K: string

publicgetMetaDataKeys

• getMetaDataKeys(): readonly string[]

• Inherited from Entity.getMetaDataKeys

publicgetStreamSyncedMeta

• getStreamSyncedMeta<K>(key: Exclude<K, never>): unknown
• getStreamSyncedMeta<K>(key: K): undefined | ICustomPedStreamSyncedMeta[K]

• Overrides Entity.getStreamSyncedMeta

  Type parameters

  • K: string

publicgetStreamSyncedMetaKeys

• getStreamSyncedMetaKeys(): readonly string[]

• Inherited from Entity.getStreamSyncedMetaKeys

publicgetSyncInfo

• getSyncInfo(): ISyncInfo

• Inherited from Entity.getSyncInfo

publicgetSyncedMeta

• getSyncedMeta<K>(key: Exclude<K, never>): unknown
• getSyncedMeta<K>(key: K): undefined | ICustomPedSyncedMeta[K]

• Overrides Entity.getSyncedMeta

  Type parameters

  • K: string

publicgetSyncedMetaKeys

• getSyncedMetaKeys(): readonly string[]

• Inherited from Entity.getSyncedMetaKeys

publichasMeta

• hasMeta(key: string): boolean
• hasMeta<K>(key: K): boolean

• Overrides Entity.hasMeta

publichasStreamSyncedMeta

• hasStreamSyncedMeta(key: string): boolean
• hasStreamSyncedMeta<K>(key: K): boolean

• Overrides Entity.hasStreamSyncedMeta

publichasSyncedMeta

• hasSyncedMeta(key: string): boolean
• hasSyncedMeta<K>(key: K): boolean

• Overrides Entity.hasSyncedMeta

publicsetMeta

• setMeta<K>(key: K, value: InterfaceValueByKey<ICustomPedMeta, K, unknown, void>): void
• setMeta<K>(key: K, value: ICustomPedMeta[K]): void

• Overrides Entity.setMeta

  Type parameters

  • K: string

publicstaticgetByID

• getByID(id: number): null | Ped

• Overrides Entity.getByID

  Retrieves the ped from the pool.

publicstaticgetByRemoteID

• getByRemoteID(id: number): null | Ped

• Overrides Entity.getByRemoteID

  Gets the ped with the given remote id

publicstaticgetByScriptID

• getByScriptID(scriptID: number): null | Ped

• Overrides Entity.getByScriptID

  Retrieves the ped from the pool.