Represents the players cursor inventory. Used when moving items between between containers in the inventory UI. Not used with touch controls.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

entity: Entity

Remarks

The entity that owns this component. The entity will be undefined if it has been removed.

item?: ItemStack

Remarks

The ItemStack currently in the players cursor inventory.

Throws

This property can throw when used.

typeId: string

Remarks

Identifier of the component.

componentId: "minecraft:cursor_inventory" = 'minecraft:cursor_inventory'

Methods

  • Returns void

    Remarks

    Clears the players cursor inventory.

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

  • Returns boolean

    Whether the component is valid.

    Remarks

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.