yog-api 0.103.1

Yog — ergonomic Rust API for writing Minecraft mods (facade).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! The game's own mirrors, typed: every entity and every player, as the
//! host writes them (`yog_mirror::host` is their source).
//!
//! ```ignore
//! let near = Entities::declare(Entities::POS | Entities::KIND, Rate::Every(1))?;
//! for e in near.iter() { draw(e.pos(), e.kind()); }
//! ```

use yog_core::Point;
use yog_data::Atom;

use crate::yog_mirror;

/// Every live entity, by network id.
#[yog_mirror(host = yog_mirror::host::ENTITY)]
pub struct Entities {
    pub pos: Point,
    /// Blocks a tick.
    pub velocity: Point,
    /// Yaw, pitch (degrees).
    pub rotation: [f32; 2],
    /// Its type.
    pub kind: Option<Atom>,
    pub dimension: Option<Atom>,
    /// Living ones'; others 0.
    pub health: f32,
    /// `[high, low]`.
    pub uuid: [u64; 2],
}

/// Every player (part of the entities: their facts read through it).
#[yog_mirror(host = yog_mirror::host::PLAYER)]
pub struct Players {
    pub name: Option<Atom>,
}

/// The blocks of the areas asked for, a dimension each: declared with
/// `Blocks::declare_in(dimension, Some(&BlockScope { min, max }), …)`.
#[yog_mirror(host = yog_mirror::host::BLOCK)]
pub struct Blocks {
    /// Its state: `minecraft:oak_stairs[facing=north,…]`.
    pub state: Option<Atom>,
}

/// The entities this client sees, by network id: written after its ticks,
/// on any server.
#[yog_mirror(host = yog_mirror::host::CLIENT_ENTITY)]
pub struct ClientEntities {
    pub pos: Point,
    /// Blocks a tick.
    pub velocity: Point,
    /// Yaw, pitch (degrees).
    pub rotation: [f32; 2],
    /// Its type.
    pub kind: Option<Atom>,
    /// Living ones'; others 0.
    pub health: f32,
    /// `[high, low]`.
    pub uuid: [u64; 2],
    /// Its eyes' height over its feet.
    pub eye_height: f32,
    /// A monster (1) or not (0).
    pub hostile: u8,
    /// A player's name; others none.
    pub name: Option<Atom>,
}

/// The blocks of the area asked for in this client's world, by packed
/// position (`ClientBlocks::declare_scoped(&BlockScope { min, max }, …)`):
/// each one's state and what a body meets there.
#[yog_mirror(host = yog_mirror::host::CLIENT_BLOCK)]
pub struct ClientBlocks {
    pub state: Option<Atom>,
    /// Its traits ([`crate::mirror::BlockTraits`]).
    pub traits: u64,
    /// How hard it is to break (negative: it can't be).
    pub hardness: f32,
}