@minecraft/server
    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

    entity: Entity

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

    item?: ItemStack

    The ItemStack currently in the players cursor inventory.

    This property can throw when used.

    typeId: string

    Identifier of the component.

    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.

    • Returns boolean

      Whether the component is valid.

      This function is deprecated and will be removed in 2.0.0.

      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.