@ascentbv/ts-common - v1.0.123
    Preparing search index...

    Class PlayerCursorInventoryComponent

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

    Hierarchy (View Summary)

    Index

    Properties

    isValid typeId entity item? componentId

    Methods

    clear

    Properties

    isValid: boolean

    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.

    typeId: string

    Identifier of the component.

    entity: Entity

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

    This property can throw when used.

    InvalidEntityError

    item?: ItemStack

    The ItemStack currently in the players cursor inventory.

    This property can throw when used.

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

    Methods

    • Returns void

      Clears the players cursor inventory.

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods