Class HFloorItem

Hierarchy

HFloorItem

Index

Constructors

Accessors

extra facing id ownerId ownerName secondsToExpiration sizeZ staticClass stuff stuffCategory tile typeId usagePolicy

Methods

appendToPacket getId constructPacket parse

Constructors

constructor

new HFloorItem(packet): HFloorItem
Parameters
- packet: HPacket
Returns HFloorItem
- Defined in lib/extension/parsers/hflooritem.d.ts:6

Accessors

extra

get extra(): number
Get extra of floor item

Returns number
- Defined in lib/extension/parsers/hflooritem.d.ts:80
set extra(val): void
Set extra of floor item
Parameters
- val: number
  
  Value to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:127

facing

get facing(): HFacing
Get direction in which floor item is facing

Returns HFacing
- Defined in lib/extension/parsers/hflooritem.d.ts:65
set facing(val): void
Set direction in which floor item is facing
Parameters
- val: HFacing
  
  Direction to set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:133

id

set id(val): void
Set id of floor item
Parameters
- val: number
  
  Id to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:103

ownerId

get ownerId(): number
Get owner id of floor item

Returns number
- Defined in lib/extension/parsers/hflooritem.d.ts:45
set ownerId(val): void
Set owner id of floor item
Parameters
- val: number
  
  Owner id to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:157

ownerName

get ownerName(): string
Get owner name of floor item

Returns string
- Defined in lib/extension/parsers/hflooritem.d.ts:50
set ownerName(val): void
Set owner name of floor item
Parameters
- val: String
  
  Owner name to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:97

secondsToExpiration

get secondsToExpiration(): number
Get seconds to expiration

Returns number
- Defined in lib/extension/parsers/hflooritem.d.ts:55
set secondsToExpiration(val): void
Set seconds to expiration of floor item
Parameters
- val: number
  
  Seconds to expiration to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:145

sizeZ

get sizeZ(): number
Get sizeZ of floor item

Returns number
- Defined in lib/extension/parsers/hflooritem.d.ts:75
set sizeZ(val): void
Set sizeZ of floor item
Parameters
- val: number
  
  Value to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:121

staticClass

get staticClass(): undefined | string
Get staticClass of floor item

Returns undefined | string
- Defined in lib/extension/parsers/hflooritem.d.ts:90
set staticClass(val): void
Set static class of floor item
Parameters
- val: undefined | string
  
  Value to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:169

stuff

get stuff(): any[]
Get stuff of floor item

Returns any[]
- Defined in lib/extension/parsers/hflooritem.d.ts:85
set stuff(val): void
Set stuff of floor item
Parameters
- val: any[]
  
  Stuff to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:163

stuffCategory

get stuffCategory(): number
Get stuff category of floor item

Returns number
- Defined in lib/extension/parsers/hflooritem.d.ts:60
set stuffCategory(val): void
Set stuff category of floor item
Parameters
- val: number
  
  Category to set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:139

tile

get tile(): HPoint
Get position of floor item

Returns HPoint
- Defined in lib/extension/parsers/hflooritem.d.ts:70
set tile(val): void
Set position of floor item
Parameters
- val: HPoint
  
  Position to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:115

typeId

get typeId(): number
Get type id of floor item

Returns number
- Defined in lib/extension/parsers/hflooritem.d.ts:35
set typeId(val): void
Set type id of floor item
Parameters
- val: number
  
  Type id to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:109

usagePolicy

get usagePolicy(): number
Get usage policy of floor item

Returns number
- Defined in lib/extension/parsers/hflooritem.d.ts:40
set usagePolicy(val): void
Set usage policy of floor item
Parameters
- val: number
  
  Usage policy to be set
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:151

Methods

appendToPacket

appendToPacket(packet): void
Append floor item to a packet
Parameters
- packet: HPacket
  
  Packet to be appended to
Returns void
- Defined in lib/extension/parsers/hflooritem.d.ts:12

getId

getId(): number
Get id of floor item

Returns number
- Defined in lib/extension/parsers/hflooritem.d.ts:30

`Static` constructPacket

constructPacket(floorItems, headerId): HPacket
Construct packet with header id containing all floor items
Parameters
- floorItems: HFloorItem[]
  
  Floor items to add to packet
- headerId: number
  
  Header id of packet
Returns HPacket
- Defined in lib/extension/parsers/hflooritem.d.ts:25

`Static` parse

parse(packet): HFloorItem[]
Parse all floor items from a packet
Parameters
- packet: HPacket
  
  Packet to parse from
Returns HFloorItem[]
- Defined in lib/extension/parsers/hflooritem.d.ts:18

Generated using TypeDoc