Interface IContainer

Hierarchy

IUncastableContainer
ICastable
- IContainer

Implemented by

Properties

`Optional` [SYMBOL_CONTAINER_CACHED_REFERENCE]

[SYMBOL_CONTAINER_CACHED_REFERENCE]?: ContainerReference

`Optional` addOrder

addOrder?: number[]

containedItems

containedItems: default[]

`Optional` containedWithin

containedWithin?: IContainer

`Optional` containerType

containerType?: ContainerType

`Optional` sort

sort?: ContainerSort

`Optional` sortDirection

sortDirection?: SortDirection

When not provided, uses SortDirection.Ascending

`Optional` stacks

stacks?: Set<ItemType>

`Optional` transientItems

transientItems?: default[]

Accessors

asContainer

get asContainer(): undefined | this & IUncastableContainer
Returns undefined | this & IUncastableContainer
Inherited from ICastable.asContainer
- Defined in src/game/game/entity/IEntity.ts:96

asCorpse

get asCorpse(): undefined | default
Returns undefined | default
Inherited from ICastable.asCorpse
- Defined in src/game/game/entity/IEntity.ts:86

asCreature

get asCreature(): undefined | default
Returns undefined | default
Inherited from ICastable.asCreature
- Defined in src/game/game/entity/IEntity.ts:87

asDoodad

get asDoodad(): undefined | default
Returns undefined | default
Inherited from ICastable.asDoodad
- Defined in src/game/game/entity/IEntity.ts:88

asEntity

get asEntity(): undefined | default<unknown, number, EntityReferenceTypes, unknown>
Returns undefined | default<unknown, number, EntityReferenceTypes, unknown>
Inherited from ICastable.asEntity
- Defined in src/game/game/entity/IEntity.ts:84

asHuman

get asHuman(): undefined | default<unknown, number, NPC | Player>
Returns undefined | default<unknown, number, NPC | Player>
Inherited from ICastable.asHuman
- Defined in src/game/game/entity/IEntity.ts:89

asItem

get asItem(): undefined | default
Returns undefined | default
Inherited from ICastable.asItem
- Defined in src/game/game/entity/IEntity.ts:94

asLocalPlayer

get asLocalPlayer(): undefined | default
Returns undefined | default
Inherited from ICastable.asLocalPlayer
- Defined in src/game/game/entity/IEntity.ts:92

asNPC

get asNPC(): undefined | default
Returns undefined | default
Inherited from ICastable.asNPC
- Defined in src/game/game/entity/IEntity.ts:90

asPlayer

get asPlayer(): undefined | default
Returns undefined | default
Inherited from ICastable.asPlayer
- Defined in src/game/game/entity/IEntity.ts:91

asTile

get asTile(): undefined | default
Returns undefined | default
Inherited from ICastable.asTile
- Defined in src/game/game/entity/IEntity.ts:95

asTileEvent

get asTileEvent(): undefined | default
Returns undefined | default
Inherited from ICastable.asTileEvent
- Defined in src/game/game/entity/IEntity.ts:93

asUnion

get asUnion(): undefined | default | default | default | default | default<unknown, number, NPC | Player> | default | default | default | default
Returns undefined | default | default | default | default | default<unknown, number, NPC | Player> | default | default | default | default
Inherited from ICastable.asUnion
- Defined in src/game/game/entity/IEntity.ts:85

isLocalPlayer

get isLocalPlayer(): boolean
Returns boolean
Inherited from ICastable.isLocalPlayer
- Defined in src/game/game/entity/IEntity.ts:104

island

get island(): default
Returns default
Inherited from ICastable.island
- Defined in src/game/game/entity/IEntity.ts:83

Methods

isContainer

isContainer(): this is IUncastableContainer
Returns this is IUncastableContainer
Inherited from ICastable.isContainer
- Defined in src/game/game/entity/IEntity.ts:108

isCorpse

isCorpse(): this is default
Returns this is default
Inherited from ICastable.isCorpse
- Defined in src/game/game/entity/IEntity.ts:98

isCreature

isCreature(): this is default
Returns this is default
Inherited from ICastable.isCreature
- Defined in src/game/game/entity/IEntity.ts:99

isDoodad

isDoodad(): this is default
Returns this is default
Inherited from ICastable.isDoodad
- Defined in src/game/game/entity/IEntity.ts:100

isEntity

isEntity(): this is default<unknown, number, EntityReferenceTypes, unknown>
Returns this is default<unknown, number, EntityReferenceTypes, unknown>
Inherited from ICastable.isEntity
- Defined in src/game/game/entity/IEntity.ts:97

isHuman

isHuman(): this is default<unknown, number, NPC | Player>
Returns this is default<unknown, number, NPC | Player>
Inherited from ICastable.isHuman
- Defined in src/game/game/entity/IEntity.ts:101

isItem

isItem(): this is default
Returns this is default
Inherited from ICastable.isItem
- Defined in src/game/game/entity/IEntity.ts:106

isNPC

isNPC(): this is default
Returns this is default
Inherited from ICastable.isNPC
- Defined in src/game/game/entity/IEntity.ts:102

isPlayer

isPlayer(): this is default
Returns this is default
Inherited from ICastable.isPlayer
- Defined in src/game/game/entity/IEntity.ts:103

isTile

isTile(): this is default
Returns this is default
Inherited from ICastable.isTile
- Defined in src/game/game/entity/IEntity.ts:107

isTileEvent

isTileEvent(): this is default
Returns this is default
Inherited from ICastable.isTileEvent
- Defined in src/game/game/entity/IEntity.ts:105

Generated using TypeDoc