Class HEntity

Hierarchy

HEntity

Index

Constructors

Accessors

entityType favoriteGroup figureId gender id index lastUpdate motto name stuff tile

Methods

appendToPacket tryUpdate constructPacket parse

Constructors

constructor

new HEntity(packet): HEntity
Parameters
- packet: HPacket
Returns HEntity
- Defined in lib/extension/parsers/hentity.d.ts:8

Accessors

entityType

get entityType(): HEntityType
Get entity type

Returns HEntityType
- Defined in lib/extension/parsers/hentity.d.ts:98
set entityType(val): void
Set entity type
Parameters
- val: HEntityType
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:103

favoriteGroup

get favoriteGroup(): null | string
Get favorite group

Returns null | string
- Defined in lib/extension/parsers/hentity.d.ts:118
set favoriteGroup(val): void
Set favorite group
Parameters
- val: null | string
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:123

figureId

get figureId(): string
Get figure

Returns string
- Defined in lib/extension/parsers/hentity.d.ts:108
set figureId(val): void
Set figure
Parameters
- val: string
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:113

gender

get gender(): null | HGender
Get entity gender

Returns null | HGender
- Defined in lib/extension/parsers/hentity.d.ts:88
set gender(val): void
Set entity gender
Parameters
- val: null | HGender
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:93

id

get id(): number
Get id from entity

Returns number
- Defined in lib/extension/parsers/hentity.d.ts:38
set id(val): void
Set id from entity
Parameters
- val: number
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:43

index

get index(): number
Get entity index in room

Returns number
- Defined in lib/extension/parsers/hentity.d.ts:48
set index(val): void
Set entity index in room
Parameters
- val: number
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:53

lastUpdate

get lastUpdate(): null | HEntityUpdate
Get last entity update

Returns null | HEntityUpdate
- Defined in lib/extension/parsers/hentity.d.ts:128
set lastUpdate(val): void
Set last entity update
Parameters
- val: null | HEntityUpdate
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:133

motto

get motto(): string
Get entity motto

Returns string
- Defined in lib/extension/parsers/hentity.d.ts:78
set motto(val): void
Set entity motto
Parameters
- val: string
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:83

name

get name(): string
Get entity name

Returns string
- Defined in lib/extension/parsers/hentity.d.ts:68
set name(val): void
Set entity name
Parameters
- val: string
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:73

stuff

get stuff(): any[]
Get stuff

Returns any[]
- Defined in lib/extension/parsers/hentity.d.ts:138
set stuff(val): void
Set stuff
Parameters
- val: any[]
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:143

tile

get tile(): HPoint
Get entity position in room

Returns HPoint
- Defined in lib/extension/parsers/hentity.d.ts:58
set tile(val): void
Set entity position in room
Parameters
- val: HPoint
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:63

Methods

appendToPacket

appendToPacket(packet): void
Append entity to a packet
Parameters
- packet: HPacket
  
  Packet to be appended to
Returns void
- Defined in lib/extension/parsers/hentity.d.ts:20

tryUpdate

tryUpdate(update): boolean
Try performing an entity update on entity
Parameters
- update: HEntityUpdate
  
  entity update to try
Returns boolean
- Defined in lib/extension/parsers/hentity.d.ts:33

`Static` constructPacket

constructPacket(entities, headerId): HPacket
Construct packet with header id containing all entities
Parameters
- entities: HEntity[]
  
  Entities to add to packet
- headerId: number
  
  Header id of packet
Returns HPacket
- Defined in lib/extension/parsers/hentity.d.ts:27

`Static` parse

parse(packet): HEntity[]
Parse all HEntities from packet
Parameters
- packet: HPacket
Returns HEntity[]
- Defined in lib/extension/parsers/hentity.d.ts:14

Generated using TypeDoc