Interface IItemManagerEvents

Hierarchy

Events<default<default>>
- IItemManagerEvents

Index

Methods

canMoveItems containerItemAdd containerItemRemove containerItemUpdate containerStack containerUnstack containerUpdateOrder craft? create remove

Methods

canMoveItems

canMoveItems(human: undefined | default<unknown, number, NPC | Player>, itemsToMove: default[], fromContainer: undefined | IContainer, toContainer: IContainer, options?: IMoveItemOptions, mover?: default<unknown, number, NPC | Player>): undefined | boolean
Called before moving items to another container
Parameters
- human: undefined | default<unknown, number, NPC | Player>
- itemsToMove: default[]
- fromContainer: undefined | IContainer
- toContainer: IContainer
- Optional options: IMoveItemOptions
- Optional mover: default<unknown, number, NPC | Player>
Returns undefined | boolean
- Defined in src/game/game/item/ItemManager.ts:108

containerItemAdd

containerItemAdd(items: default[], container: IContainer, index: number, options?: IMoveItemOptions, mover?: default<unknown, number, NPC | Player>): any
Called when items are added to a container.
Parameters
- items: default[]
  
  The items.
- container: IContainer
  
  The container object the items were added to. This container might be inventory or a container within the inventory.
- index: number
  
  The position the items were inserted at
- Optional options: IMoveItemOptions
  
  Move item options.
- Optional mover: default<unknown, number, NPC | Player>
Returns any
- Defined in src/game/game/item/ItemManager.ts:134

containerItemRemove

containerItemRemove(items: default[], container: undefined | IContainer, containerTile: undefined | default, mover?: default<unknown, number, NPC | Player>): any
Called when items are removed from a container.
Parameters
- items: default[]
  
  The items.
- container: undefined | IContainer
  
  The container object the item was removed from.
- containerTile: undefined | default
  
  The tile of that container when the remove occurred.
- Optional mover: default<unknown, number, NPC | Player>
Returns any
- Defined in src/game/game/item/ItemManager.ts:116

containerItemUpdate

containerItemUpdate(items: default[], containerFrom: undefined | IContainer, containerFromTile: undefined | default, containerTo: IContainer, mover?: default<unknown, number, NPC | Player>): any
Called when items are moved from one container to another.
Parameters
- items: default[]
  
  The items.
- containerFrom: undefined | IContainer
  
  The container object the items were moved from. This container might be inventory or a container within the inventory.
- containerFromTile: undefined | default
  
  The tile of containerFrom when the update occurred.
- containerTo: IContainer
  
  The container object the items were moved to. This container might be inventory or a container within the inventory.
- Optional mover: default<unknown, number, NPC | Player>
Returns any
- Defined in src/game/game/item/ItemManager.ts:125

containerStack

containerStack(container: IContainer, type: ItemType): any
Parameters
- container: IContainer
- type: ItemType
Returns any
- Defined in src/game/game/item/ItemManager.ts:141

containerUnstack

containerUnstack(container: IContainer, type: ItemType): any
Parameters
- container: IContainer
- type: ItemType
Returns any
- Defined in src/game/game/item/ItemManager.ts:142

containerUpdateOrder

containerUpdateOrder(container: IContainer): any
Called when the container order is updated.
Parameters
- container: IContainer
Returns any
- Defined in src/game/game/item/ItemManager.ts:139

`Optional` craft

craft(human: default<unknown, number, NPC | Player>, item: default): void
Called when an item is crafted
Parameters
- human: default<unknown, number, NPC | Player>
  
  The human object
- item: default
  
  The item that was crafted
Returns void
- Defined in src/game/game/item/ItemManager.ts:149

create

create(entity: default, creator?: default<unknown, number, NPC | Player>): any
Parameters
- entity: default
- Optional creator: default<unknown, number, NPC | Player>
Returns any
Inherited from Events.create
- Defined in src/game/game/entity/EntityManager.ts:25

remove

remove(entity: default): any
Parameters
- entity: default
Returns any
Inherited from Events.remove
- Defined in src/game/game/entity/EntityManager.ts:26

Interface IItemManagerEvents

Hierarchy

Index

Methods

Methods

canMoveItems

Parameters

human: undefined | default<unknown, number, NPC | Player>

itemsToMove: default[]

fromContainer: undefined | IContainer

toContainer: IContainer

Optional options: IMoveItemOptions

Optional mover: default<unknown, number, NPC | Player>

Returns undefined | boolean

containerItemAdd

Parameters

items: default[]

container: IContainer

index: number

Optional options: IMoveItemOptions

Optional mover: default<unknown, number, NPC | Player>

Returns any

containerItemRemove

Parameters

items: default[]

container: undefined | IContainer

containerTile: undefined | default

Optional mover: default<unknown, number, NPC | Player>

Returns any

containerItemUpdate

Parameters

items: default[]

containerFrom: undefined | IContainer

containerFromTile: undefined | default

containerTo: IContainer

Optional mover: default<unknown, number, NPC | Player>

Returns any

containerStack

Parameters

container: IContainer

type: ItemType

Returns any

containerUnstack

Parameters

container: IContainer

type: ItemType

Returns any

containerUpdateOrder

Parameters

container: IContainer

Returns any

Optional craft

Parameters

human: default<unknown, number, NPC | Player>

item: default

Returns void

create

Parameters

entity: default

Optional creator: default<unknown, number, NPC | Player>

Returns any

remove

Parameters

entity: default

Returns any

Settings

Member Visibility

Theme

`Optional` options: IMoveItemOptions

`Optional` mover: default<unknown, number, NPC | Player>

`Optional` options: IMoveItemOptions

`Optional` mover: default<unknown, number, NPC | Player>

`Optional` mover: default<unknown, number, NPC | Player>

`Optional` mover: default<unknown, number, NPC | Player>

`Optional` craft

`Optional` creator: default<unknown, number, NPC | Player>