Class Container

Represents a container.

Hierarchy (View Summary)

Container
- EntityContainer
- BlockContainer

Index

Constructors

Properties

identifier occupants storage type

Accessors

emptySlotsCount isFull size

Methods

addItem clear clearSlot close getItem isEntityContainer removeItem setItem show swapItems takeItem update updateSlot

Constructors

constructor

new Container(
    type: ContainerType,
    identifier: ContainerId,
    size: number,
): Container
Creates a new container.
Parameters
- type: ContainerType
- identifier: ContainerId
  The type of the container.
- size: number
  The size of the container.
Returns Container
- Defined in packages/core/src/container.ts:71

Properties

identifier

identifier: ContainerId

The identifier of the container.

`Readonly`occupants

occupants: Set<Player> = ...

The occupants of the container.

storage

storage: (null | ItemStack)[]

The storage of the container.

type

type: ContainerType

The type of the container.

Accessors

emptySlotsCount

get emptySlotsCount(): number
The amount of empty slots in the container.

Returns number
- Defined in packages/core/src/container.ts:55

isFull

get isFull(): boolean
Whether the container is full.

Returns boolean
- Defined in packages/core/src/container.ts:62

size

get size(): number
The size of the container.

Returns number
- Defined in packages/core/src/container.ts:36
set size(value: number): void
The size of the container.
Parameters
- value: number
Returns void
- Defined in packages/core/src/container.ts:43

Methods

addItem

addItem(item: ItemStack): boolean
Adds an item stack to the container.
Parameters
- item: ItemStack
  The item stack to add.
Returns boolean
Whether the item was successfully added into the container.
- Defined in packages/core/src/container.ts:125

clear

clear(): void
Clears all slots in the container.

Returns void
- Defined in packages/core/src/container.ts:330

clearSlot

clearSlot(slot: number): void
Clears a slot in the container.
Parameters
- slot: number
  The slot to clear.
Returns void
- Defined in packages/core/src/container.ts:285

close

close(player: Player, serverInitiated?: boolean): void
Close the container for a player.
Parameters
- player: Player
  The player to close the container for.
- serverInitiated: boolean = true
  Whether the close was initiated by the server.
Returns void
- Defined in packages/core/src/container.ts:422

getItem

getItem(slot: number): null | ItemStack
Gets an item from the container.
Parameters
- slot: number
  The slot to get the item from.
Returns null | ItemStack
The item in the slot.
- Defined in packages/core/src/container.ts:96

isEntityContainer

isEntityContainer(): this is EntityContainer
Checks if the container is an entity container.

Returns this is EntityContainer
Whether the container is an entity container.
- Defined in packages/core/src/container.ts:87

removeItem

removeItem(slot: number, amount: number): null | ItemStack
Removes an item from the container.
Parameters
- slot: number
  The slot to remove the item from.
- amount: number
  The amount of the item to remove.
Returns null | ItemStack
- Defined in packages/core/src/container.ts:197

setItem

setItem(slot: number, item: ItemStack): void
Sets an item in the container.
Parameters
- slot: number
  The slot to set the item in.
- item: ItemStack
  The item to set.
Returns void
- Defined in packages/core/src/container.ts:105

show

show(player: Player): void
Shows the container to a player.
Parameters
- player: Player
  The player to show the container to.
Returns void
- Defined in packages/core/src/container.ts:396

swapItems

swapItems(slot: number, otherSlot: number, otherContainer?: Container): void
Swaps items in the container.
Parameters
- slot: number
  The slot to swap the item from.
- otherSlot: number
  The slot to swap the item to.
- OptionalotherContainer: Container
  The other container to swap the item to.
Returns void
- Defined in packages/core/src/container.ts:261

takeItem

takeItem(slot: number, amount: number): null | ItemStack
Takes an item from the container.
Parameters
- slot: number
  The slot to take the item from.
- amount: number
  The amount of the item to take.
Returns null | ItemStack
The taken item.
- Defined in packages/core/src/container.ts:221

update

update(player?: Player): void
Updates the contents of the container.
Parameters
- Optionalplayer: Player
Returns void
- Defined in packages/core/src/container.ts:343

updateSlot

updateSlot(slot: number): void
Updates a slot in the container for all the occupants.
Parameters
- slot: number
  The slot to be updated.
Returns void
- Defined in packages/core/src/container.ts:298