Struct Vec3 

pub struct Vec3 {
    pub x: f64,
    pub y: f64,
    pub z: f64,
}

Used to represent an exact position in the world where an entity could be.

For blocks, BlockPos is used instead.

Fields

x: f64

y: f64

z: f64

Implementations

impl Vec3

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

pub fn normalize(&self) -> Vec3

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

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

impl Vec3

pub const ZERO: Self

The position where x, y, and z are all 0.

pub const fn new(x: f64, y: f64, z: f64) -> Self

pub fn length_squared(&self) -> f64

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

pub fn distance_squared_to(self, other: Self) -> f64

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

pub fn horizontal_distance_squared(&self) -> f64

pub fn horizontal_distance_squared_to(self, other: Self) -> f64

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

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

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

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

Examples found in repository

azalea/examples/testbot/commands/movement.rs (line 28)

pub fn register(commands: &mut Dispatcher) {
    commands.register(
        literal("goto")
            .executes(|ctx: &Ctx| {
                let source = ctx.source.lock();
                println!("got goto");
                // look for the sender
                let Some(entity) = source.entity() else {
                    source.reply("I can't see you!");
                    return Ok(0);
                };
                let position = entity.position()?;
                source.reply("ok");
                source
                    .bot
                    .start_goto(BlockPosGoal(BlockPos::from(position.up(0.5))));
                Ok(1)
            })
            .then(literal("xz").then(argument("x", integer()).then(
                argument("z", integer()).executes(|ctx: &Ctx| {
                    let source = ctx.source.lock();
                    let x = get_integer(ctx, "x").unwrap();
                    let z = get_integer(ctx, "z").unwrap();
                    println!("goto xz {x} {z}");
                    source.reply("ok");
                    source.bot.start_goto(XZGoal { x, z });
                    Ok(1)
                }),
            )))
            .then(literal("radius").then(argument("radius", float()).then(
                argument("x", integer()).then(argument("y", integer()).then(
                    argument("z", integer()).executes(|ctx: &Ctx| {
                        let source = ctx.source.lock();
                        let radius = get_float(ctx, "radius").unwrap();
                        let x = get_integer(ctx, "x").unwrap();
                        let y = get_integer(ctx, "y").unwrap();
                        let z = get_integer(ctx, "z").unwrap();
                        println!("goto radius {radius}, position: {x} {y} {z}");
                        source.reply("ok");
                        source.bot.start_goto(RadiusGoal {
                            pos: BlockPos::new(x, y, z).center(),
                            radius,
                        });
                        Ok(1)
                    }),
                )),
            )))
            .then(argument("x", integer()).then(argument("y", integer()).then(
                argument("z", integer()).executes(|ctx: &Ctx| {
                    let source = ctx.source.lock();
                    let x = get_integer(ctx, "x").unwrap();
                    let y = get_integer(ctx, "y").unwrap();
                    let z = get_integer(ctx, "z").unwrap();
                    println!("goto xyz {x} {y} {z}");
                    source.reply("ok");
                    source.bot.start_goto(BlockPosGoal(BlockPos::new(x, y, z)));
                    Ok(1)
                }),
            ))),
    );

    commands.register(literal("follow").executes(|ctx: &Ctx| {
        let source = ctx.source.lock();
        println!("got follow");
        // look for the sender
        let Some(entity) = source.entity() else {
            source.reply("I can't see you!");
            return Ok(0);
        };
        source.reply("ok");
        *source.state.following_entity.lock() = Some(entity);
        Ok(1)
    }));

    commands.register(literal("down").executes(|ctx: &Ctx| {
        let source = ctx.source.clone();
        let bot = source.lock().bot.clone();
        let position = BlockPos::from(bot.position()?);
        tokio::spawn(async move {
            source.lock().reply("mining...");
            bot.mine(position.down(1)).await;
            source.lock().reply("done");
        });
        Ok(1)
    }));

    commands.register(
        literal("look")
            .executes(|ctx: &Ctx| {
                // look for the sender
                let source = ctx.source.lock();
                let Some(entity) = source.entity() else {
                    source.reply("I can't see you!");
                    return Ok(0);
                };
                let eye_position = entity.eye_position()?;
                source.bot.look_at(eye_position);
                Ok(1)
            })
            .then(argument("x", integer()).then(argument("y", integer()).then(
                argument("z", integer()).executes(|ctx: &Ctx| {
                    let pos = BlockPos::new(
                        get_integer(ctx, "x").unwrap(),
                        get_integer(ctx, "y").unwrap(),
                        get_integer(ctx, "z").unwrap(),
                    );
                    println!("{pos:?}");
                    let source = ctx.source.lock();
                    source.bot.look_at(pos.center());
                    Ok(1)
                }),
            ))),
    );

    fn walk_command(ctx: &Ctx, direction: WalkDirection) -> eyre::Result<i32> {
        let mut seconds = get_float(ctx, "seconds").unwrap();
        let source = ctx.source.lock();
        let bot = source.bot.clone();

        if seconds < 0. {
            bot.walk(direction.opposite());
            seconds = -seconds;
        } else {
            bot.walk(direction);
        }

        tokio::spawn(async move {
            tokio::time::sleep(Duration::from_secs_f32(seconds)).await;
            bot.walk(WalkDirection::None);
        });
        source.reply(format!("ok, walking {direction:?} for {seconds} seconds"));
        Ok(1)
    }

    commands.register(
        literal("walk").then(
            argument("seconds", float())
                .executes(|ctx: &Ctx| walk_command(ctx, WalkDirection::Forward)),
        ),
    );
    commands.register(literal("left").then(
        argument("seconds", float()).executes(|ctx: &Ctx| walk_command(ctx, WalkDirection::Left)),
    ));
    commands.register(literal("right").then(
        argument("seconds", float()).executes(|ctx: &Ctx| walk_command(ctx, WalkDirection::Left)),
    ));
    commands.register(
        literal("sprint").then(argument("seconds", float()).executes(|ctx: &Ctx| {
            let seconds = get_float(ctx, "seconds").unwrap();
            let source = ctx.source.lock();
            let bot = source.bot.clone();
            bot.sprint(SprintDirection::Forward);
            tokio::spawn(async move {
                tokio::time::sleep(Duration::from_secs_f32(seconds)).await;
                bot.walk(WalkDirection::None);
            });
            source.reply(format!("ok, sprinting for {seconds} seconds"));
            Ok(1)
        })),
    );

    commands.register(literal("north").executes(|ctx: &Ctx| {
        let source = ctx.source.lock();
        source.bot.set_direction(180., 0.)?;
        source.reply("ok");
        Ok(1)
    }));
    commands.register(literal("south").executes(|ctx: &Ctx| {
        let source = ctx.source.lock();
        source.bot.set_direction(0., 0.)?;
        source.reply("ok");
        Ok(1)
    }));
    commands.register(literal("east").executes(|ctx: &Ctx| {
        let source = ctx.source.lock();
        source.bot.set_direction(-90., 0.)?;
        source.reply("ok");
        Ok(1)
    }));
    commands.register(literal("west").executes(|ctx: &Ctx| {
        let source = ctx.source.lock();
        source.bot.set_direction(90., 0.)?;
        source.reply("ok");
        Ok(1)
    }));
    commands.register(
        literal("jump")
            .executes(|ctx: &Ctx| {
                let source = ctx.source.lock();
                source.bot.jump();
                source.reply("ok");
                Ok(1)
            })
            .then(argument("enabled", bool()).executes(|ctx: &Ctx| {
                let jumping = get_bool(ctx, "enabled").unwrap();
                let source = ctx.source.lock();
                source.bot.set_jumping(jumping)?;
                Ok(1)
            })),
    );

    let sneak = |ctx: &Ctx| {
        let source = ctx.source.lock();
        source.bot.set_crouching(!source.bot.crouching())?;
        source.reply("ok");
        Ok(1)
    };
    let sneak_enabled = argument("enabled", bool()).executes(|ctx: &Ctx| {
        let sneaking = get_bool(ctx, "enabled").unwrap();
        let source = ctx.source.lock();
        source.bot.set_crouching(sneaking)?;
        Ok(1)
    });
    commands.register(literal("sneak").executes(sneak).then(sneak_enabled.clone()));
    commands.register(literal("crouch").executes(sneak).then(sneak_enabled));

    commands.register(literal("stop").executes(|ctx: &Ctx| {
        let source = ctx.source.lock();
        source.bot.stop_pathfinding();
        source.reply("ok");
        *source.state.following_entity.lock() = None;
        Ok(1)
    }));
    commands.register(literal("forcestop").executes(|ctx: &Ctx| {
        let source = ctx.source.lock();
        source.bot.force_stop_pathfinding();
        source.reply("ok");
        *source.state.following_entity.lock() = None;
        Ok(1)
    }));
}

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

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

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

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

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

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

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

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

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

pub fn cross(&self, other: Self) -> Self

pub fn min(&self, other: Self) -> Self

Make a new position with the lower coordinates for each axis.

pub fn max(&self, other: Self) -> Self

Make a new position with the higher coordinates for each axis.

pub fn xz(&self) -> Self

Replace the Y with 0.

pub fn with_x(&self, x: f64) -> Self

pub fn with_y(&self, y: f64) -> Self

pub fn with_z(&self, z: f64) -> Self

impl Vec3

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: Self) -> f64

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

Examples found in repository

azalea/examples/testbot/killaura.rs (line 23)

pub fn tick(bot: Client, state: State) -> eyre::Result<()> {
    if !state.killaura {
        return Ok(());
    }
    if bot.has_attack_cooldown() {
        return Ok(());
    }
    let bot_position = bot.eye_position()?;

    let nearest_entity = bot.nearest_entity_by::<&Position, (
        With<AbstractMonster>,
        Without<LocalEntity>,
        Without<Dead>,
    )>(|position: &Position| {
        let distance = bot_position.distance_to(**position);
        distance < 4.
    })?;

    if let Some(nearest_entity) = nearest_entity {
        println!("attacking {nearest_entity:?}");
        nearest_entity.attack();
    }

    Ok(())
}

pub fn horizontal_distance_to(self, other: Self) -> f64

pub fn horizontal_distance(self) -> f64

pub fn x_rot(self, radians: f32) -> Vec3

pub fn y_rot(self, radians: f32) -> Vec3

pub fn to_block_pos_floor(&self) -> BlockPos

pub fn to_block_pos_ceil(&self) -> BlockPos

pub fn closer_than(&self, other: Vec3, range: f64) -> bool

Whether the distance between this point and other is less than range.

Trait Implementations

impl Add for &Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Add<f64> for Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: f64) -> Self::Output

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AzBuf for Vec3

fn azalea_write(&self, buf: &mut impl Write) -> Result<(), Error>

fn azalea_read(buf: &mut Cursor<&[u8]>) -> Result<Self, BufReadError>

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Vec3

impl Debug for Vec3

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

Formats the value using the given formatter.

impl Default for Vec3

fn default() -> Vec3

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vec3

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Vec3

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

Display a position as x y z.

impl Div<f64> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, divisor: f64) -> Self::Output

Performs the / operation.

impl DivAssign<f64> for Vec3

fn div_assign(&mut self, divisor: f64)

Performs the /= operation.

impl From<&(f64, f64, f64)> for Vec3

fn from(pos: &(f64, f64, f64)) -> Self

Converts to this type from the input type.

impl From<&Vec3> for BlockPos

fn from(pos: &Vec3) -> Self

Converts to this type from the input type.

impl From<&Vec3> for ChunkBlockPos

fn from(pos: &Vec3) -> Self

Converts to this type from the input type.

impl From<&Vec3> for ChunkPos

fn from(pos: &Vec3) -> Self

Converts to this type from the input type.

impl From<&Vec3> for ChunkSectionPos

fn from(pos: &Vec3) -> Self

Converts to this type from the input type.

impl From<(f64, f64, f64)> for Vec3

fn from(pos: (f64, f64, f64)) -> Self

Converts to this type from the input type.

impl From<LpVec3> for Vec3

fn from(value: LpVec3) -> Self

Converts to this type from the input type.

impl<T: PositionDeltaTrait> From<T> for Vec3

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<Vec3> for (f64, f64, f64)

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for BlockPos

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for ChunkBlockPos

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for ChunkPos

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for ChunkSectionPos

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for LpVec3

fn from(value: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for Vec3f32

fn from(v: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3f32> for Vec3

fn from(v: Vec3f32) -> Self

Converts to this type from the input type.

impl FromNbtTag for Vec3

fn from_nbt_tag(tag: NbtTag<'_, '_>) -> Option<Self>

fn from_optional_nbt_tag( tag: Option<NbtTag<'_, '_>>, ) -> Result<Option<Self>, DeserializeError>

impl FromStr for Vec3

Parses a string in the format “X Y Z” into a Vec3.

The input string should contain three floating-point values separated by spaces, representing the x, y, and z components of the vector respectively. This can be used to parse user input or from Vec3::to_string.

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Mul<f64> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, multiplier: f64) -> Self::Output

Performs the * operation.

impl MulAssign<f64> for Vec3

fn mul_assign(&mut self, multiplier: f64)

Performs the *= operation.

impl PartialEq for Vec3

fn eq(&self, other: &Vec3) -> 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 Rem<f64> for Vec3

type Output = Vec3

The resulting type after applying the % operator.

fn rem(self, rhs: f64) -> Self::Output

Performs the % operation.

impl Serialize for Vec3

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Vec3

impl Sub for &Vec3

fn sub(self, other: Self) -> Self::Output

Find the difference between two positions.

type Output = Vec3

The resulting type after applying the - operator.

impl Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.