Struct Position

pub struct Position(/* private fields */);

The position of the entity right now.

You are free to change this; there’s systems that update the indexes automatically.

Implementations

impl Position

pub fn new(pos: Vec3) -> Self

Methods from Deref<Target = Vec3>

pub fn with_delta(&self, delta: &impl PositionDeltaTrait) -> Vec3

pub fn length_squared(&self) -> f64

pub fn normalize(&self) -> Vec3

pub fn multiply(&self, x: f64, y: f64, z: f64) -> Vec3

pub fn scale(&self, amount: f64) -> Vec3

pub fn length_sqr(&self) -> f64

Get the distance of this vector to the origin by doing x^2 + y^2 + z^2.

pub fn distance_to_sqr(&self, other: &Vec3) -> f64

Get the squared distance from this position to another position. Equivalent to (self - other).length_sqr().

pub fn horizontal_distance_sqr(&self) -> f64

pub fn horizontal_distance_to_sqr(&self, other: &Vec3) -> f64

pub fn down(&self, y: f64) -> Vec3

Return a new instance of this position with the y coordinate decreased by the given number.

pub fn up(&self, y: f64) -> Vec3

Return a new instance of this position with the y coordinate increased by the given number.

pub fn north(&self, z: f64) -> Vec3

Return a new instance of this position with the z coordinate subtracted by the given number.

pub fn east(&self, x: f64) -> Vec3

Return a new instance of this position with the x coordinate increased by the given number.

pub fn south(&self, z: f64) -> Vec3

Return a new instance of this position with the z coordinate increased by the given number.

pub fn west(&self, x: f64) -> Vec3

Return a new instance of this position with the x coordinate subtracted by the given number.

pub fn dot(&self, other: Vec3) -> f64

pub fn length(&self) -> f64

Get the distance of this vector to the origin by doing sqrt(x^2 + y^2 + z^2).

pub fn distance_to(&self, other: &Vec3) -> f64

Get the distance from this position to another position. Equivalent to (self - other).length().

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Position

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl Deref for Position

type Target = Vec3

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Position

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<&Position> for BlockPos

fn from(value: &Position) -> Self

Converts to this type from the input type.

impl From<&Position> for ChunkPos

fn from(value: &Position) -> Self

Converts to this type from the input type.

impl From<&Position> for Vec3

fn from(value: &Position) -> Self

Converts to this type from the input type.

impl From<Position> for BlockPos

fn from(value: Position) -> Self

Converts to this type from the input type.

impl From<Position> for ChunkPos

fn from(value: Position) -> Self

Converts to this type from the input type.

impl PartialEq for Position

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Position

impl StructuralPartialEq for Position