Struct BlockPlaceContext 

pub struct BlockPlaceContext<'a> {
    hit_pos: BlockPos,
    clicked_face: Direction,
    click_location: DVec3,
    inside: bool,
    place_pos: BlockPos,
    replaces_clicked_block: bool,
    pub world: &'a Arc<World>,
    source: PlacementSource<'a>,
    mode: PlacementMode,
}

Context for placing a block.

Vanilla porting map:

• UseOnContext.getClickedPos() is Self::hit_pos.
• BlockPlaceContext.getClickedPos() is Self::place_pos.
• BlockPlaceContext.replacingClickedOnBlock() is Self::replaces_clicked_block.

When translating vanilla block placement code, do not map BlockPlaceContext.getClickedPos() to Self::hit_pos.

Fields

hit_pos: BlockPos

Raw block position from the hit result.

Vanilla equivalent: UseOnContext.getClickedPos().

clicked_face: Direction

The face of the block that was clicked.

click_location: DVec3

The exact location where the click occurred.

inside: bool

Whether the click was inside the block.

place_pos: BlockPos

Position where the block will be placed.

Vanilla equivalent: BlockPlaceContext.getClickedPos(). Vanilla returns the raw hit position only when replacing the clicked block; otherwise it returns the adjacent block position in the clicked-face direction.

replaces_clicked_block: bool

Whether placement replaces the hit block itself.

Vanilla equivalent: BlockPlaceContext.replacingClickedOnBlock().

world: &'a Arc<World>

The world where the block is being placed.

source: PlacementSource<'a>

mode: PlacementMode

Implementations

impl<'a> BlockPlaceContext<'a>

pub fn new( world: &'a Arc<World>, source: PlacementSource<'a>, hit_result: &BlockHitResult, ) -> Self

Creates a placement context from a source and effective hit result.

fn with_mode( world: &'a Arc<World>, source: PlacementSource<'a>, hit_result: &BlockHitResult, mode: PlacementMode, ) -> Self

pub fn directional( world: &'a Arc<World>, pos: BlockPos, direction: Direction, stack: &'a mut ItemStack, clicked_face: Direction, ) -> Self

Creates vanilla’s playerless DirectionalPlaceContext equivalent.

fn resolve_placement_geometry(&mut self)

pub fn can_place(&self) -> bool

Returns whether the effective placement position can be replaced.

pub fn at(self, pos: BlockPos, direction: Direction) -> Self

Creates the shifted context used by vanilla BlockPlaceContext.at.

pub const fn hit_pos(&self) -> BlockPos

Returns the raw block position from the hit result.

pub const fn clicked_face(&self) -> Direction

Returns the face from the effective hit result.

pub const fn click_location(&self) -> DVec3

Returns the exact effective hit location.

pub const fn is_inside(&self) -> bool

Returns whether the effective hit location is inside the hit block.

pub const fn place_pos(&self) -> BlockPos

Returns the effective block placement position.

pub fn replaces_clicked_block(&self) -> bool

Returns whether placement replaces the originally hit block.

pub const fn player(&self) -> Option<&Player>

Returns the player associated with this placement, if any.

pub const fn hand(&self) -> InteractionHand

Returns the interaction hand associated with this placement.

pub fn with_item<R>(&self, f: impl FnOnce(&ItemStack) -> R) -> R

Runs f with read access to the current placement stack.

pub fn with_item_mut<R>(&mut self, f: impl FnOnce(&mut ItemStack) -> R) -> R

Runs f with mutable access to the current placement stack.

pub const fn source(&self) -> &PlacementSource<'a>

Returns the placement source used by block placement callbacks.

pub fn horizontal_direction(&self) -> Direction

Returns the horizontal placement direction.

pub const fn rotation(&self) -> f32

Returns the placement rotation.

pub const fn is_secondary_use_active(&self) -> bool

Returns whether secondary use is active for this placement.

pub fn get_nearest_looking_direction(&self) -> Direction

Returns the direction the player is looking at most directly.

This considers both yaw and pitch to determine the nearest direction among all 6 directions (UP, DOWN, NORTH, SOUTH, EAST, WEST).

Based on Java’s Direction.orderedByNearest(Entity)[0]. Unlike Self::get_nearest_looking_directions, this does not reorder around the clicked face when placing beside a non-replaceable block.

pub const fn get_nearest_looking_vertical_direction(&self) -> Direction

Returns the vertical direction the player is looking toward.

Based on Java’s BlockPlaceContext.getNearestLookingVerticalDirection().

pub fn get_nearest_looking_directions(&self) -> [Direction; 6]

Returns all 6 directions ordered by how closely the player is looking at them.

Based on Java’s BlockPlaceContext.getNearestLookingDirections(). When not replacing the clicked block, the opposite of the clicked face is moved to the front of the array.

pub fn is_water_source(&self) -> bool

Returns true if the block at the placement position is a water source.

pub fn is_full_water(&self) -> bool

Returns true if the block at the placement position contains full water.