Class Entity

Hierarchy

Entity
- Ped
- Prop
- Vehicle

Index

Constructors

Properties

Methods

delete fromHandle fromNetworkId

Constructors

constructor

new Entity(handle: number): Entity
Parameters
- handle: number
Returns Entity
- Defined in entities/Entity.ts:13

Properties

`Protected` handle

handle: number

`Protected` type

type: ClassTypes = ClassTypes.Entity

Accessors

AttachedTo

get AttachedTo(): EntityType
Returns EntityType
- Defined in entities/Entity.ts:35

Exists

get Exists(): boolean
Returns boolean
- Defined in entities/Entity.ts:31

Handle

get Handle(): number
Returns number
- Defined in entities/Entity.ts:27

Heading

get Heading(): number
Returns number
- Defined in entities/Entity.ts:43

Health

get Health(): number
Returns number
- Defined in entities/Entity.ts:51

IsNoLongerNeeded

get IsNoLongerNeeded(): boolean
Returns boolean
- Defined in entities/Entity.ts:113

IsVisible

get IsVisible(): boolean
Returns boolean
- Defined in entities/Entity.ts:105

MaxHealth

get MaxHealth(): number
Returns number
- Defined in entities/Entity.ts:55

Model

get Model(): number
Returns number
- Defined in entities/Entity.ts:59

NetworkId

get NetworkId(): number
Returns number
- Defined in entities/Entity.ts:109

Owner

get Owner(): Player
Returns Player
- Defined in entities/Entity.ts:101

PopulationType

get PopulationType(): PopulationType
Returns PopulationType
- Defined in entities/Entity.ts:63

Position

get Position(): Vector3
Returns Vector3
- Defined in entities/Entity.ts:39

PositionAndHeading

get PositionAndHeading(): Vector4
Returns Vector4
- Defined in entities/Entity.ts:47

Rotation

get Rotation(): Vector3
Returns Vector3
- Defined in entities/Entity.ts:67

RotationVelocity

get RotationVelocity(): Vector3
Returns Vector3
- Defined in entities/Entity.ts:71

RoutingBucket

get RoutingBucket(): number
Returns number
- Defined in entities/Entity.ts:75

Script

get Script(): string
Returns
The script that made the entity

Returns string
- Defined in entities/Entity.ts:82

Speed

get Speed(): number
Returns number
- Defined in entities/Entity.ts:86

State

get State(): StateBagInterface
Returns StateBagInterface
- Defined in entities/Entity.ts:23

Type

get Type(): eEntityType
Returns eEntityType
- Defined in entities/Entity.ts:90

Velocity

get Velocity(): Vector3
Returns
the entitys velocity, if the entity is a ped it will return Vector3(0, 0, 0)

Returns Vector3
- Defined in entities/Entity.ts:97

Methods

delete

delete(): void
Returns void
- Defined in entities/Entity.ts:117

`Static` fromHandle

fromHandle(handle: number): Entity
Parameters
- handle: number
Returns Entity
- Defined in entities/Entity.ts:19

`Static` fromNetworkId

fromNetworkId(netId: number): Entity
Parameters
- netId: number
Returns Entity
- Defined in entities/Entity.ts:15

Generated using TypeDoc