Skip to content

@minecraft/server


@minecraft/server / PlayerCursorInventoryComponent

Class: PlayerCursorInventoryComponent ​

Defined in: @minecraft/server/index.d.ts:17150

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

Extends ​

Properties ​

entity ​

readonly entity: Entity

Defined in: @minecraft/server/index.d.ts:9981

Remarks ​

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

Throws ​

This property can throw when used.

InvalidEntityError

Inherited from ​

EntityComponent.entity


isValid ​

readonly isValid: boolean

Defined in: @minecraft/server/index.d.ts:6234

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.

Inherited from ​

EntityComponent.isValid


item? ​

readonly optional item?: ItemStack

Defined in: @minecraft/server/index.d.ts:17158

Remarks ​

The ItemStack currently in the players cursor inventory.

Throws ​

This property can throw when used.


typeId ​

readonly typeId: string

Defined in: @minecraft/server/index.d.ts:6240

Remarks ​

Identifier of the component.

Inherited from ​

EntityComponent.typeId


componentId ​

readonly static componentId: "minecraft:cursor_inventory" = 'minecraft:cursor_inventory'

Defined in: @minecraft/server/index.d.ts:17159

Methods ​

clear() ​

clear(): void

Defined in: @minecraft/server/index.d.ts:17168

Returns ​

void

Remarks ​

Clears the players cursor inventory.

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

Throws ​

This function can throw errors.