Script API - v1.21.100
    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.

    import { system, world } from "@minecraft/server";

    system.runInterval(() => {
    for (const player of world.getPlayers()) {
    const cursorInventory = player.getComponent("minecraft:cursor_inventory");
    const item = cursorInventory.item;
    if (!item) continue;

    player.sendMessage("You selected " + item.typeId);
    }
    }, 20);

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    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

    This property can't be read in early-execution mode.

    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.

    This property can't be read in early-execution mode.

    item?: ItemStack

    The ItemStack currently in the players cursor inventory.

    This property can throw when used.

    This property can't be read in early-execution mode.

    typeId: string

    Identifier of the component.

    This property can't be read in early-execution mode.

    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.

      This function can't be called in early-execution mode.