Class ItemBundleTrait

Hierarchy (View Summary)

ItemTrait
- ItemBundleTrait

Index

Constructors

constructor

new ItemBundleTrait(item: ItemStack): ItemBundleTrait
Parameters
- item: ItemStack
Returns ItemBundleTrait
Overrides ItemTrait.constructor
- Defined in packages/core/src/item/traits/bundle.ts:46

Properties

`Readonly`container

container: Container

The container of the item.

`Readonly`identifier

identifier: string = ...

The identifier of the trait.

`Protected` `Readonly`item

item: ItemStack

The item stack that this trait is attached to.

`Static` `Readonly`components

components: string[] = []

The item component that this trait is compatible with by default. If null, the trait will not attach to any item stack by default.

`Static` `Readonly`identifier

identifier: "dynamic_container"

The identifier of the trait.

`Static` `Readonly`tag

tag: null | string = null

The item tag that this trait is compatible with by default. If null, the trait will not attach to any item stack by default.

`Static` `Readonly`types

types: ItemIdentifier[] = ...

The item type identifiers that this trait is compatible with by default.

Accessors

dynamicId

get dynamicId(): number
The bundle id of the item.

Returns number
- Defined in packages/core/src/item/traits/bundle.ts:84
set dynamicId(id: number): void
Sets the bundle id of the item.
Parameters
- id: number
Returns void
- Defined in packages/core/src/item/traits/bundle.ts:94

Methods

clone

clone(item: ItemStack): this
Clones the item trait to another item stack.
Parameters
- item: ItemStack
  The item stack to clone the component to.
Returns this
A new item trait.
Inherited from ItemTrait.clone
- Defined in packages/core/src/item/traits/trait.ts:142

equals

equals(other: ItemTrait): boolean
Compares another item trait to this one.
Parameters
- other: ItemTrait
  The other item trait to compare.
Returns boolean
Whether the item traits are equal.
Inherited from ItemTrait.equals
- Defined in packages/core/src/item/traits/trait.ts:133

`Optional`onAdd

onAdd(): void
Called when the trait is added to an object.

Returns void
Inherited from ItemTrait.onAdd
- Defined in packages/core/src/trait.ts:42

onContainerClose

onContainerClose(player: Player): void
Called when the container that the item is stored in is closed.
Parameters
- player: Player
  The player that closed the container
Returns void
Overrides ItemTrait.onContainerClose
- Defined in packages/core/src/item/traits/bundle.ts:110

onContainerOpen

onContainerOpen(player: Player): void
Called when the container that the item is stored in is opened.
Parameters
- player: Player
  The player that opened the container.
Returns void
Overrides ItemTrait.onContainerOpen
- Defined in packages/core/src/item/traits/bundle.ts:105

`Optional`onRelease

onRelease(player: Player): void
Called when the release action is triggered by a player.
Parameters
- player: Player
  The player that released the item.
Returns void
Inherited from ItemTrait.onRelease
- Defined in packages/core/src/item/traits/trait.ts:103

`Optional`onRemove

onRemove(): void
Called when the trait is removed from an object.

Returns void
Inherited from ItemTrait.onRemove
- Defined in packages/core/src/trait.ts:47

`Optional`onStartCooldown

onStartCooldown(duration: number): void
Called when the item has been signaled to cooldown.
Parameters
- duration: number
  The duration of the cooldown in ticks.
Returns void
Inherited from ItemTrait.onStartCooldown
- Defined in packages/core/src/item/traits/trait.ts:109

`Optional`onStartUse

onStartUse(player: Player, options: ItemStackUseOptions): boolean | void
Called when the item is used by a player.
Parameters
- player: Player
  The player that used the item.
- options: ItemStackUseOptions
  The additional options for the item use.
Returns boolean | void
Whether the item use was successful; default is true
Inherited from ItemTrait.onStartUse
- Defined in packages/core/src/item/traits/trait.ts:54

`Optional`onStopCooldown

onStopCooldown(): void
Called when the item cooldown has stopped.

Returns void
Inherited from ItemTrait.onStopCooldown
- Defined in packages/core/src/item/traits/trait.ts:114

`Optional`onStopUse

onStopUse(player: Player, options: ItemStackUseOptions): boolean | void
Called when the item is stopped being used by a player.
Parameters
- player: Player
  The player that stopped using the item.
- options: ItemStackUseOptions
  The additional options for the item use.
Returns boolean | void
Inherited from ItemTrait.onStopUse
- Defined in packages/core/src/item/traits/trait.ts:64

onTick

onTick(): void
Called when the trait is ticked by the dimension.

Returns void
Overrides ItemTrait.onTick
- Defined in packages/core/src/item/traits/bundle.ts:115

`Optional`onUse

onUse(
player: Player,
options: ItemStackUseOptions,
): boolean | void | ItemUseMethod
Called when the item is used by a player.
Parameters
- player: Player
  The player that used the item.
- options: ItemStackUseOptions
  The additional options for the item use.
Returns boolean | void | ItemUseMethod
Inherited from ItemTrait.onUse
- Defined in packages/core/src/item/traits/trait.ts:74

`Optional`onUseOnBlock

onUseOnBlock(
player: Player,
options: ItemStackUseOnBlockOptions,
): boolean | void | ItemUseMethod
Called when the item is used on a block by a player.
Parameters
- player: Player
  The player that used the item.
- options: ItemStackUseOnBlockOptions
  The additional options for the item use.
Returns boolean | void | ItemUseMethod
Inherited from ItemTrait.onUseOnBlock
- Defined in packages/core/src/item/traits/trait.ts:84

`Optional`onUseOnEntity

onUseOnEntity(
player: Player,
options: ItemStackUseOnEntityOptions,
): boolean | void | ItemUseMethod
Called when the item is used on an entity by a player.
Parameters
- player: Player
  The player that used the item.
- options: ItemStackUseOnEntityOptions
  The additional options for the item use.
Returns boolean | void | ItemUseMethod
Inherited from ItemTrait.onUseOnEntity
- Defined in packages/core/src/item/traits/trait.ts:94

Class ItemBundleTrait

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ItemBundleTrait

Properties

Readonlycontainer

Readonlyidentifier

Protected Readonlyitem

Static Readonlycomponents

Static Readonlyidentifier

Static Readonlytag

Static Readonlytypes

Accessors

dynamicId

Returns number

Parameters

Returns void

Methods

clone

Parameters

Returns this

equals

Parameters

Returns boolean

OptionalonAdd

Returns void

onContainerClose

Parameters

Returns void

onContainerOpen

Parameters

Returns void

OptionalonRelease

Parameters

Returns void

OptionalonRemove

Returns void

OptionalonStartCooldown

Parameters

Returns void

OptionalonStartUse

Parameters

Returns boolean | void

OptionalonStopCooldown

Returns void

OptionalonStopUse

Parameters

Returns boolean | void

onTick

Returns void

OptionalonUse

Parameters

Returns boolean | void | ItemUseMethod

OptionalonUseOnBlock

Parameters

Returns boolean | void | ItemUseMethod

OptionalonUseOnEntity

Parameters

Returns boolean | void | ItemUseMethod

Settings

On This Page

`Readonly`container

`Readonly`identifier

`Protected` `Readonly`item

`Static` `Readonly`components

`Static` `Readonly`identifier

`Static` `Readonly`tag

`Static` `Readonly`types

`Optional`onAdd

`Optional`onRelease

`Optional`onRemove

`Optional`onStartCooldown

`Optional`onStartUse

`Optional`onStopCooldown

`Optional`onStopUse

`Optional`onUse

`Optional`onUseOnBlock

`Optional`onUseOnEntity