Class EntityItemStackTrait

Hierarchy (View Summary)

EntityTrait
- EntityItemStackTrait

Index

Constructors

Constructors

constructor

new EntityItemStackTrait(
entity: Entity,
options?: EntityItemStackTraitOptions,
): EntityItemStackTrait
Creates a new instance of the EntityItemStackTrait.
Parameters
- entity: Entity
  The entity that the trait is attached to.
- Optionaloptions: EntityItemStackTraitOptions
  The options for the trait, including the item stack and lifespan.
Returns EntityItemStackTrait
Overrides EntityTrait.constructor
- Defined in packages/core/src/entity/traits/item-stack.ts:94

Properties

`Readonly`birthTick

birthTick: bigint

The birth tick of the item.

canDespawn

canDespawn: boolean = true

Whether the item can despawn according to its lifespan.

canMerge

canMerge: boolean = true

Whether the item can be merged with other items.

`Protected` `Readonly`entity

entity: Entity

The entity that this trait is attached to.

`Readonly`identifier

identifier: string = ...

The identifier of the trait.

`Protected`isMerging

isMerging: boolean = false

The merging state of the item.

`Readonly`itemStack

itemStack: ItemStack

The item stack of the component.

lifeSpan

lifeSpan: number = 6000

The lifespan of the item in ticks.

`Protected`mergingEntity

mergingEntity: null | Entity = null

The target entity that the item is merging with.

`Protected`pickupTick

pickupTick: bigint = -1n

The pickup tick of the item.

`Protected`target

target: null | Player = null

The target player of the item.

`Static` `Readonly`components

components: string[] = []

The entity component identifiers that this trait is compatible with by default. If empty, the trait will not be initialized by any component.

`Static` `Readonly`identifier

identifier: "itemstack"

The identifier of the trait.

`Static` `Readonly`types

types: EntityIdentifier[] = []

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

Accessors

`Protected`dimension

get dimension(): Dimension
The dimension that the entity is in.

Returns Dimension
Inherited from EntityTrait.dimension
- Defined in packages/core/src/entity/traits/trait.ts:35

Methods

clone

clone(entity: Entity): this
Clones the entity trait.
Parameters
- entity: Entity
  The entity to clone the trait to.
Returns this
A new entity trait.
Inherited from EntityTrait.clone
- Defined in packages/core/src/entity/traits/trait.ts:101

decrement

decrement(amount?: number): void
Parameters
- Optionalamount: number
Returns void
- Defined in packages/core/src/entity/traits/item-stack.ts:161

increment

increment(amount?: number): void
Parameters
- Optionalamount: number
Returns void
- Defined in packages/core/src/entity/traits/item-stack.ts:141

onAdd

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

Returns void
Overrides EntityTrait.onAdd
- Defined in packages/core/src/entity/traits/item-stack.ts:181

`Optional`onCommand

onCommand(state: CommandExecutionState): boolean | void
Called when the entity that this trait is attached executes a command.
Parameters
- state: CommandExecutionState
  The command execution state.
Returns boolean | void
Whether the command was successful; default is true.
Inherited from EntityTrait.onCommand
- Defined in packages/core/src/entity/traits/trait.ts:81

`Optional`onContainerUpdate

onContainerUpdate(container: Container): void
Called when a container that is attached to the entity is updated.
Parameters
- container: Container
  The container that was updated.
Returns void
Inherited from EntityTrait.onContainerUpdate
- Defined in packages/core/src/entity/traits/trait.ts:87

`Optional`onDeath

onDeath(details: EntityDeathOptions): void
Called when the entity that this trait is attached to is killed.
Parameters
- details: EntityDeathOptions
  The details of the entity death.
Returns void
Inherited from EntityTrait.onDeath
- Defined in packages/core/src/entity/traits/trait.ts:67

`Optional`onDespawn

onDespawn(details: EntityDespawnOptions): void
Called when the entity that this trait is attached to is despawned from a dimension.
Parameters
- details: EntityDespawnOptions
  The details of the entity despawn.
Returns void
Inherited from EntityTrait.onDespawn
- Defined in packages/core/src/entity/traits/trait.ts:61

`Optional`onFallOnBlock

onFallOnBlock(event: EntityFallOnBlockTraitEvent): void
Called when the entity that this trait is attached to falls on a block.
Parameters
- event: EntityFallOnBlockTraitEvent
  The event properties of the entity falling on a block.
Returns void
Note
This event requires the entity to have EntityGravityTrait attached.
Inherited from EntityTrait.onFallOnBlock
- Defined in packages/core/src/entity/traits/trait.ts:94

`Optional`onInteract

onInteract(player: Player, method: EntityInteractMethod): void
Called when the entity that this trait is attached to is interacted with by a player.
Parameters
- player: Player
  The player that interacted with the entity.
- method: EntityInteractMethod
  The method that the player used to interact with the entity.
Returns void
Inherited from EntityTrait.onInteract
- Defined in packages/core/src/entity/traits/trait.ts:74

onRemove

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

Returns void
Overrides EntityTrait.onRemove
- Defined in packages/core/src/entity/traits/item-stack.ts:189

`Optional`onSpawn

onSpawn(details: EntitySpawnOptions): void
Called then the entity that this trait is attached to is spawned into a dimension.
Parameters
- details: EntitySpawnOptions
  The details of the entity spawn.
Returns void
Inherited from EntityTrait.onSpawn
- Defined in packages/core/src/entity/traits/trait.ts:55

onTick

onTick(details: TraitOnTickDetails): void
Called when the trait is ticked by the dimension.
Parameters
- details: TraitOnTickDetails
  The details about the tick event.
Returns void
Overrides EntityTrait.onTick
- Defined in packages/core/src/entity/traits/item-stack.ts:194

pickup

pickup(player: Player): void
Picks up the item by a player.
Parameters
- player: Player
  The player that picked up the item.
Returns void
- Defined in packages/core/src/entity/traits/item-stack.ts:130

Class EntityItemStackTrait

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EntityItemStackTrait

Properties

ReadonlybirthTick

canDespawn

canMerge

Protected Readonlyentity

Readonlyidentifier

ProtectedisMerging

ReadonlyitemStack

lifeSpan

ProtectedmergingEntity

ProtectedpickupTick

Protectedtarget

Static Readonlycomponents

Static Readonlyidentifier

Static Readonlytypes

Accessors

Protecteddimension

Returns Dimension

Methods

clone

Parameters

Returns this

decrement

Parameters

Returns void

increment

Parameters

Returns void

onAdd

Returns void

OptionalonCommand

Parameters

Returns boolean | void

OptionalonContainerUpdate

Parameters

Returns void

OptionalonDeath

Parameters

Returns void

OptionalonDespawn

Parameters

Returns void

OptionalonFallOnBlock

Parameters

Returns void

Note

OptionalonInteract

Parameters

Returns void

onRemove

Returns void

OptionalonSpawn

Parameters

Returns void

onTick

Parameters

Returns void

pickup

Parameters

Returns void

Settings

On This Page

`Readonly`birthTick

`Protected` `Readonly`entity

`Readonly`identifier

`Protected`isMerging

`Readonly`itemStack

`Protected`mergingEntity

`Protected`pickupTick

`Protected`target

`Static` `Readonly`components

`Static` `Readonly`identifier

`Static` `Readonly`types

`Protected`dimension

`Optional`onCommand

`Optional`onContainerUpdate

`Optional`onDeath

`Optional`onDespawn

`Optional`onFallOnBlock

`Optional`onInteract

`Optional`onSpawn