Entities

Represents entities and networked properties within a demo.

Hierarchy

internal
- Entities

Index

Modules

internal

Properties

Accessors

Methods

Object literals

tableClassMap

Properties

Private _currentServerTick

_currentServerTick: number = -1

Private _demo

_demo: DemoFile = null!

Private _singletonEnts

_singletonEnts: object

Type declaration

[table: string]: Networkable | undefined

dataTables

dataTables: IDataTable[] = []

entities: Array<Networkable | null> = new Array(1 << consts.MAX_EDICT_BITS).fill(null)

Array of all entities in game.

instanceBaselines

instanceBaselines: object

Type declaration

[classId: number]: UnknownEntityProps | undefined

markedForDeletion

markedForDeletion: number[] = []

pendingBaselines

pendingBaselines: object

Type declaration

[classId: number]: BitStream | undefined

serverClassBits

serverClassBits: number = 0

serverClasses

serverClasses: IServerClass[] = []

Accessors

gameRules

get gameRules(): GameRules

- Defined in entities.ts:278
Returns GameRules

playerResource

get playerResource(): Networkable<CCSPlayerResource>

- Defined in entities.ts:271
Returns Networkable<CCSPlayerResource>

players

get players(): Player[]

- Defined in entities.ts:286
Returns Player[]

teams

get teams(): Team[]

- Defined in entities.ts:282
Returns Team[]

weapons

get weapons(): Weapon[]

- Defined in entities.ts:290
Returns Weapon[]

Methods

Private _addEntity

_addEntity(index: number, classId: number, serialNum: number): Networkable<any>

- Defined in entities.ts:613
Parameters
- index: number
- classId: number
- serialNum: number
Returns Networkable<any>

Private _findTableByName

_findTableByName(name: string): IDataTable | undefined

- Defined in entities.ts:609
Parameters
- name: string
Returns IDataTable | undefined

Private _flattenDataTable

_flattenDataTable(table: IDataTable): IFlattenedSendProp[]

- Defined in entities.ts:558
Parameters
- table: IDataTable
Returns IFlattenedSendProp[]

Private _gatherExcludes

_gatherExcludes(table: IDataTable): ReadonlyArray<ISendProp>

- Defined in entities.ts:496
Parameters
- table: IDataTable
Returns ReadonlyArray<ISendProp>

Private _gatherProps

_gatherProps(table: IDataTable, excludes: ReadonlyArray<ISendProp>): ReadonlyArray<IFlattenedSendProp>

- Defined in entities.ts:513
Parameters
- table: IDataTable
- excludes: ReadonlyArray<ISendProp>
Returns ReadonlyArray<IFlattenedSendProp>

Private _handlePacketEntities

_handlePacketEntities(msg: RequiredNonNullable<ICSVCMsg_PacketEntities>): void

- Defined in entities.ts:766
Parameters
- msg: RequiredNonNullable<ICSVCMsg_PacketEntities>
Returns void

Private _handleStringTableUpdate

_handleStringTableUpdate(event: IStringTableUpdateEvent<Buffer>): void

- Defined in entities.ts:829
Parameters
- event: IStringTableUpdateEvent<Buffer>
Returns void

Private _handleTempEntities

_handleTempEntities(msg: RequiredNonNullable<ICSVCMsg_TempEntities>): void

- Defined in entities.ts:730
Parameters
- msg: RequiredNonNullable<ICSVCMsg_TempEntities>
Returns void

Private _parseEntityUpdate

_parseEntityUpdate(entityBitBuffer: BitStream, classId: number): ReadonlyArray<IPropUpdate>

- Defined in entities.ts:667
Parameters
- entityBitBuffer: BitStream
- classId: number
Returns ReadonlyArray<IPropUpdate>

Private _parseInstanceBaseline

_parseInstanceBaseline(baselineBuf: BitStream, classId: number): UnknownEntityProps

- Defined in entities.ts:814
Parameters
- baselineBuf: BitStream
- classId: number
Returns UnknownEntityProps

Private _readNewEntity

_readNewEntity(entityBitBuffer: BitStream, entity: Networkable<any>): void

- Defined in entities.ts:694
Parameters
- entityBitBuffer: BitStream
- entity: Networkable<any>
Returns void

Private _removeEntity

_removeEntity(index: number, immediate: boolean): void

- Defined in entities.ts:646
Parameters
- index: number
- immediate: boolean
Returns void

Private _updatesToPropObject

_updatesToPropObject(target: UnknownEntityProps, updates: ReadonlyArray<IPropUpdate>): UnknownEntityProps

- Defined in entities.ts:716
Parameters
- target: UnknownEntityProps
- updates: ReadonlyArray<IPropUpdate>
Returns UnknownEntityProps

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:579
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

emit

emit(name: "datatablesready"): boolean
emit(name: "baselineupdate", event: IBaselineUpdateEvent): boolean
emit(name: "create", event: IEntityCreationEvent): boolean
emit(name: "postcreate", event: IEntityCreationEvent): boolean
emit(name: "beforeremove", event: IEntityBeforeRemoveEvent): boolean
emit(name: "remove", event: IEntityRemoveEvent): boolean
emit(name: "change", event: IEntityChangeEvent): boolean
emit(name: "tempent", event: ITempEntEvent): boolean

Overrides EventEmitter.emit
- Defined in entities.ts:210
Parameters
- name: "datatablesready"
Returns boolean
Overrides EventEmitter.emit
- Defined in entities.ts:219
Parameters
- name: "baselineupdate"
- event: IBaselineUpdateEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in entities.ts:227
Parameters
- name: "create"
- event: IEntityCreationEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in entities.ts:237
Parameters
- name: "postcreate"
- event: IEntityCreationEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in entities.ts:246
Parameters
- name: "beforeremove"
- event: IEntityBeforeRemoveEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in entities.ts:252
Parameters
- name: "remove"
- event: IEntityRemoveEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in entities.ts:258
Parameters
- name: "change"
- event: IEntityChangeEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in entities.ts:264
Parameters
- name: "tempent"
- event: ITempEntEvent
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:594
Returns Array<string | symbol>

findAllWithClass

findAllWithClass<T>(klass: NetworkableConstructor<T>): T[]

- Defined in entities.ts:424
Type parameters
- T
Parameters
- klass: NetworkableConstructor<T>
Returns T[]

findAllWithTable

findAllWithTable(table: string): Networkable[]

- Defined in entities.ts:418
Parameters
- table: string
Returns Networkable[]

getByHandle

getByHandle(handle: EntityHandle): Networkable | null

- Defined in entities.ts:360
Returns the entity specified by a particular handle.

Parameters
- handle: EntityHandle
  
  Networked entity handle value
Returns Networkable | null

Entity referenced by the handle. null if no matching entity.

getByUserId

getByUserId(userId: number): Player | null

- Defined in entities.ts:378
Returns the entity specified by a user ID.

Parameters
- userId: number
  
  Player user ID
Returns Player | null

Entity referenced by the user ID. null if no matching player.

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:586
Returns number

getSingleton

getSingleton<TServerClass, TEntityClass>(serverClass: string): TEntityClass

- Defined in entities.ts:398
Type parameters
- TServerClass
- TEntityClass: Networkable<TServerClass>
Parameters
- serverClass: string
Returns TEntityClass

handleDataTables

handleDataTables(chunk: ByteBuffer): void

- Defined in entities.ts:430
Parameters
- chunk: ByteBuffer
Returns void

isHandleSet

isHandleSet(handle: number): boolean

- Defined in entities.ts:351
Determines whether handle is set. This function does not determine whether the handle points to a valid entity.

Parameters
- handle: number
  
  Networked entity handle value
Returns boolean

true if handle is set

listen

listen(demo: DemoFile): void

- Defined in entities.ts:324
Parameters
- demo: DemoFile
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:590
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:587
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:583
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "datatablesready", listener: function): this
on(event: "baselineupdate", listener: function): this
on(event: "create", listener: function): this
on(event: "postcreate", listener: function): this
on(event: "beforeremove", listener: function): this
on(event: "remove", listener: function): this
on(event: "change", listener: function): this
on(event: "tempent", listener: function): this

Overrides EventEmitter.on
- Defined in entities.ts:209
Fired after data tables have been parsed. {@link Entities#serverClasses} can now be used.

Parameters
- event: "datatablesready"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in entities.ts:215
Fired when an instance baseline is updated.

Parameters
- event: "baselineupdate"
- listener: function
  - - (event: IBaselineUpdateEvent): void
    - Parameters
      - event: IBaselineUpdateEvent
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in entities.ts:226
Fired when an entity is created. Note no entity properties are available yet. Use {@link Entities#postcreate} if you need access to properties.

Parameters
- event: "create"
- listener: function
  - - (event: IEntityCreationEvent): void
    - Parameters
      - event: IEntityCreationEvent
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in entities.ts:233
Fired after an entity has been created. All properties are now available for inspection.

Parameters
- event: "postcreate"
- listener: function
  - - (event: IEntityCreationEvent): void
    - Parameters
      - event: IEntityCreationEvent
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in entities.ts:242
Fired when an entity is marked for deletion.

Parameters
- event: "beforeremove"
- listener: function
  - - (event: IEntityBeforeRemoveEvent): void
    - Parameters
      - event: IEntityBeforeRemoveEvent
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in entities.ts:251
Fired during DemoFile#tickend when an entity is removed from the game.

Parameters
- event: "remove"
- listener: function
  - - (event: IEntityRemoveEvent): void
    - Parameters
      - event: IEntityRemoveEvent
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in entities.ts:257
Fired when an entity property is changed.

Parameters
- event: "change"
- listener: function
  - - (event: IEntityChangeEvent): void
    - Parameters
      - event: IEntityChangeEvent
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in entities.ts:263
Fired when an a temp ent is created.

Parameters
- event: "tempent"
- listener: function
  - - (event: ITempEntEvent): void
    - Parameters
      - event: ITempEntEvent
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:581
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:592
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:593
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:588
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:584
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:582
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners
- Defined in C:/Code/demofile/node_modules/@types/node/index.d.ts:585
Parameters
- n: number
Returns this

Object literals

tableClassMap

tableClassMap: object

DT_BaseEntity

DT_BaseEntity: BaseEntity = BaseEntity

DT_CSGameRules

DT_CSGameRules: GameRules = GameRules

DT_CSPlayer

DT_CSPlayer: Player = Player

DT_Team

DT_Team: Team = Team

DT_WeaponCSBase

DT_WeaponCSBase: Weapon = Weapon

Hierarchy

Index

Modules

Properties

Accessors

Methods

Object literals

Properties

Private _currentServerTick

Private _demo

Private _singletonEnts

Type declaration

[table: string]: Networkable | undefined

dataTables

entities

instanceBaselines

Type declaration

[classId: number]: UnknownEntityProps | undefined

markedForDeletion

pendingBaselines

Type declaration

[classId: number]: BitStream | undefined

serverClassBits

serverClasses

Accessors

gameRules

Returns GameRules

playerResource

Returns Networkable<CCSPlayerResource>

players

Returns Player[]

teams

Returns Team[]

weapons

Returns Weapon[]

Methods

Private _addEntity

Parameters

index: number

classId: number

serialNum: number

Returns Networkable<any>

Private _findTableByName

Parameters

name: string

Returns IDataTable | undefined

Private _flattenDataTable

Parameters

table: IDataTable

Returns IFlattenedSendProp[]

Private _gatherExcludes

Parameters

table: IDataTable

Returns ReadonlyArray<ISendProp>

Private _gatherProps

Parameters

table: IDataTable

excludes: ReadonlyArray<ISendProp>

Returns ReadonlyArray<IFlattenedSendProp>

Private _handlePacketEntities

Parameters

msg: RequiredNonNullable<ICSVCMsg_PacketEntities>

Returns void

Private _handleStringTableUpdate

Parameters

event: IStringTableUpdateEvent<Buffer>

Returns void

Private _handleTempEntities

Parameters

msg: RequiredNonNullable<ICSVCMsg_TempEntities>

Returns void

Private _parseEntityUpdate

Parameters

entityBitBuffer: BitStream

classId: number

Returns ReadonlyArray<IPropUpdate>

Private _parseInstanceBaseline

Parameters

baselineBuf: BitStream

classId: number