Struct PlacementContext 

#[non_exhaustive]
pub struct PlacementContext {
    pub pos: BlockPos,
    pub hit_pos: BlockPos,
    pub face: Direction,
    pub hit: [f64; 3],
    pub inside: bool,
    pub yaw: f32,
    pub pitch: f32,
    pub sneaking: bool,
    pub item: Option<ItemKey>,
    pub replace_clicked: bool,
}

Inputs to selecting a block’s placement state.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pos: BlockPos

Resolved destination of the block being placed.

hit_pos: BlockPos

Position of the clicked block.

face: Direction

Clicked face.

hit: [f64; 3]

World-space click location.

inside: bool

Whether the click originated inside the block’s shape.

yaw: f32

Placer yaw in degrees.

pitch: f32

Placer pitch in degrees.

sneaking: bool

Whether secondary use is active.

item: Option<ItemKey>

The resolved item in the placing hand; None for an empty hand.

replace_clicked: bool

Whether the clicked block itself is replaced.

Implementations

impl PlacementContext

pub fn new( pos: BlockPos, face: Direction, item: Option<ItemKey>, ) -> PlacementContext

A placement at pos, with a click on face and an optional held item. The click starts at the block origin, with zero view angles and no flags set.

Trait Implementations

impl Clone for PlacementContext

fn clone(&self) -> PlacementContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PlacementContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for PlacementContext

fn eq(&self, other: &PlacementContext) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PlacementContext

impl Wire for PlacementContext

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<PlacementContext, WireError>

Decodes one value, leaving any following bytes for the caller.