ItemUseContext

Namespace Mc.Scripting.Content · Kind class (sealed)

public sealed class ItemUseContext

What a custom item’s use handler gets. Valid during the handler only.

Properties

Member	Description
bool Cancelled { get; set; }	Stops the vanilla behaviour of the base item and of the clicked block.
CustomItem Definition { get; }	The definition of the item.
BlockFace Face { get; }	The clicked face (only when ItemUseContext.HasBlock).
Hand Hand { get; }	The hand holding the item.
bool HasBlock { get; }	Whether the click was on a block.
ItemStack Item { get; }	The stack that was used.
Player Player { get; }	The player.
BlockPos Position { get; }	The clicked block (only when ItemUseContext.HasBlock).
World World { get; }	The dimension the player is in.

Cancelled

public bool Cancelled { get; set; }

Stops the vanilla behaviour of the base item and of the clicked block.

Definition

public CustomItem Definition { get; }

The definition of the item.

Face

public BlockFace Face { get; }

The clicked face (only when ItemUseContext.HasBlock).

Hand

public Hand Hand { get; }

The hand holding the item.

HasBlock

public bool HasBlock { get; }

Whether the click was on a block.

Item

public ItemStack Item { get; }

The stack that was used.

Player

public Player Player { get; }

The player.

Position

public BlockPos Position { get; }

The clicked block (only when ItemUseContext.HasBlock).

World

public World World { get; }

The dimension the player is in.

Methods

Member	Description
void Consume(int count = 1)	Uses up items of the stack that was used (nothing happens in creative mode).

Consume

public void Consume(int count = 1)

Uses up items of the stack that was used (nothing happens in creative mode).

Parameters

Name	Type	Description
count	int = 1	How many.

See also

BlockFace · BlockPos · CustomItem · Hand · ItemStack · Player · World