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)

Properties

entity item? typeId componentId

Methods

clear isValid

Properties

Readonlyentity

entity: Entity

Remarks

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

Optional Readonlyitem

item?: ItemStack

Remarks

The ItemStack currently in the players cursor inventory.

Throws

This property can throw when used.

ReadonlytypeId

typeId: string

Remarks

Identifier of the component.

Static ReadonlycomponentId

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

Methods

clear

  • clear(): void

  • Returns void

    Remarks

    Clears the players cursor inventory.

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

    Throws

    This function can throw errors.

isValid

  • isValid(): boolean

  • 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.

Settings

Member Visibility

On This Page

Properties
Methods