ghast-entity 0.2.0

Entity tracking for the ghast Minecraft Java Edition client library: zero-allocation parsing of 1.8.9 and 1.16.5 entity packets, vanilla-exact server positions, O(1) lookup
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
//! Version-independent entity store shared by the per-version trackers.

use std::collections::HashMap;
use std::hash::{BuildHasherDefault, Hasher};

use uuid::Uuid;

use crate::entity::{Entity, EntityType, MetaValue};

/// What the tracker keeps. Everything off costs nothing beyond position tracking; packets for a
/// disabled part are not parsed (and the client should not even decode them, see the version
/// modules' packet id lists).
///
/// `#[non_exhaustive]`: build it from [`Config::default`] with the `with_*` methods:
///
/// ```
/// let c = ghast_entity::Config::default().with_equipment(false).with_skins(true);
/// assert!(c.metadata && !c.equipment && c.skins);
/// ```
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub struct Config {
    /// Entity metadata (flags, health, item of item entities, names, ...). Default `true`.
    pub metadata: bool,
    /// Equipment. Default `true`.
    pub equipment: bool,
    /// Status effects. Default `true`.
    pub effects: bool,
    /// Tab list (`player_info`). Default `true`.
    pub player_list: bool,
    /// Queue [`Event`]s for [`Entities::drain_events`]. Default `false`.
    pub events: bool,
    /// Keep the base64 `"textures"` profile property (skin / cape URLs) of tab-list entries in
    /// [`PlayerInfo::textures`]. Default `false`: properties are skipped without allocating.
    pub skins: bool,
}

impl Config {
    /// Sets [`Config::metadata`].
    #[must_use]
    pub const fn with_metadata(mut self, on: bool) -> Self {
        self.metadata = on;
        self
    }

    /// Sets [`Config::equipment`].
    #[must_use]
    pub const fn with_equipment(mut self, on: bool) -> Self {
        self.equipment = on;
        self
    }

    /// Sets [`Config::effects`].
    #[must_use]
    pub const fn with_effects(mut self, on: bool) -> Self {
        self.effects = on;
        self
    }

    /// Sets [`Config::player_list`].
    #[must_use]
    pub const fn with_player_list(mut self, on: bool) -> Self {
        self.player_list = on;
        self
    }

    /// Sets [`Config::events`].
    #[must_use]
    pub const fn with_events(mut self, on: bool) -> Self {
        self.events = on;
        self
    }

    /// Sets [`Config::skins`].
    #[must_use]
    pub const fn with_skins(mut self, on: bool) -> Self {
        self.skins = on;
        self
    }
}

impl Default for Config {
    fn default() -> Self {
        Config {
            metadata: true,
            equipment: true,
            effects: true,
            player_list: true,
            events: false,
            skins: false,
        }
    }
}

/// A change notification (only queued with [`Config::events`]).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Event {
    /// A new entity (or a replacement for an existing id).
    Spawned(i32),
    /// An entity was removed (destroy, pickup, world change).
    Removed {
        /// Id.
        id: i32,
        /// Its type.
        ty: EntityType,
    },
    /// Server position or rotation changed (movement, teleport).
    Moved(i32),
    /// Velocity changed.
    Velocity(i32),
    /// `entity_status` (e.g. 2 hurt, 3 death).
    Status {
        /// Id.
        id: i32,
        /// Status byte.
        status: i8,
    },
    /// Metadata changed.
    Metadata(i32),
    /// Equipment changed.
    Equipment(i32),
    /// Effects changed.
    Effects(i32),
    /// Riding changed: `id` now rides `vehicle`.
    Mounted {
        /// Rider.
        id: i32,
        /// Vehicle (`None` = dismounted).
        vehicle: Option<i32>,
    },
    /// An item / orb / arrow was picked up (`collector` may be the bot).
    Collected {
        /// Picked-up entity.
        collected: i32,
        /// Collector.
        collector: i32,
    },
    /// The tab list changed.
    PlayerList,
}

/// A tab-list entry (`#[non_exhaustive]`: read-only for callers, fields may be added).
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub struct PlayerInfo {
    /// Profile name.
    pub name: Box<str>,
    /// Game mode.
    pub game_mode: i32,
    /// Latency in ms.
    pub ping: i32,
    /// Display name (raw chat JSON), if set.
    pub display_name: Option<Box<str>>,
    /// The base64 `"textures"` profile property as sent (only with [`Config::skins`]; its
    /// signature is not kept). Decoded it is JSON with the skin and cape URLs.
    pub textures: Option<Box<str>>,
}

#[derive(Default, Clone, Copy)]
pub(crate) struct IdHasher(u64);

impl Hasher for IdHasher {
    #[inline]
    fn finish(&self) -> u64 {
        let h = self.0.wrapping_mul(0x9E37_79B9_7F4A_7C15);
        h ^ (h >> 29)
    }

    #[inline]
    fn write(&mut self, bytes: &[u8]) {
        for &b in bytes {
            self.0 = (self.0 << 8) | u64::from(b);
        }
    }

    #[inline]
    fn write_i32(&mut self, v: i32) {
        self.0 = u64::from(v as u32);
    }

    #[inline]
    fn write_u128(&mut self, v: u128) {
        self.0 = (v as u64) ^ ((v >> 64) as u64);
    }
}

type Fast<K, V> = HashMap<K, V, BuildHasherDefault<IdHasher>>;

/// The tracked entities and tab list (queries are the same for every version).
#[derive(Clone, Debug, Default)]
pub struct Entities {
    pub(crate) map: Fast<i32, Entity>,
    pub(crate) self_id: Option<i32>,
    pub(crate) config: Config,
    pub(crate) events: Vec<Event>,
    pub(crate) players: Fast<Uuid, PlayerInfo>,
    pub(crate) scratch: Vec<(u8, MetaValue)>,
    /// Set once any leash link exists (skips the leash scan on removal otherwise).
    pub(crate) any_leash: bool,
    /// 1.16 tracker (selects the vanilla size table).
    pub(crate) modern: bool,
}

impl Entities {
    pub(crate) fn new(config: Config) -> Self {
        Entities {
            config,
            ..Default::default()
        }
    }

    /// The entity with this id (including the bot's own entry, see [`Entities::self_id`]).
    #[inline]
    #[must_use]
    pub fn get(&self, id: i32) -> Option<&Entity> {
        self.map.get(&id)
    }

    /// Number of tracked entities (including the bot's own entry).
    #[must_use]
    pub fn len(&self) -> usize {
        self.map.len()
    }

    /// `true` when nothing is tracked.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.map.is_empty()
    }

    /// Other entities (the bot's own entry is skipped), arbitrary order.
    pub fn iter(&self) -> impl Iterator<Item = &Entity> {
        let me = self.self_id;
        self.map.values().filter(move |e| Some(e.id) != me)
    }

    /// The bot's own entity id (from `login`). Its entry carries metadata, effects, equipment
    /// and riding state, but **no position**: the client owns its own position.
    #[must_use]
    pub fn self_id(&self) -> Option<i32> {
        self.self_id
    }

    /// The bot's own entry.
    #[must_use]
    pub fn me(&self) -> Option<&Entity> {
        self.map.get(&self.self_id?)
    }

    /// Entities whose server position is within `radius` of `p` (linear scan).
    pub fn within(&self, p: [f64; 3], radius: f64) -> impl Iterator<Item = &Entity> {
        let r2 = radius * radius;
        self.iter().filter(move |e| {
            let d = [e.pos[0] - p[0], e.pos[1] - p[1], e.pos[2] - p[2]];
            d[0] * d[0] + d[1] * d[1] + d[2] * d[2] <= r2
        })
    }

    /// Alias of [`Entities::within`].
    pub fn near(&self, p: [f64; 3], radius: f64) -> impl Iterator<Item = &Entity> {
        self.within(p, radius)
    }

    /// The tab list.
    #[must_use]
    pub fn player_info(&self, uuid: &Uuid) -> Option<&PlayerInfo> {
        self.players.get(uuid)
    }

    /// All tab-list entries.
    pub fn players(&self) -> impl Iterator<Item = (&Uuid, &PlayerInfo)> {
        self.players.iter()
    }

    /// Name of a player entity (from the tab list).
    #[must_use]
    pub fn player_name(&self, id: i32) -> Option<&str> {
        let e = self.map.get(&id)?;
        e.is_player()
            .then(|| self.players.get(&e.uuid).map(|p| &*p.name))
            .flatten()
    }

    /// The configuration.
    #[must_use]
    pub fn config(&self) -> Config {
        self.config
    }

    /// Takes the queued events (keeps the buffer's capacity).
    pub fn drain_events(&mut self) -> std::vec::Drain<'_, Event> {
        self.events.drain(..)
    }

    /// Removes every entity (keeps the tab list and the bot's id).
    pub fn clear(&mut self) {
        if self.config.events {
            let me = self.self_id;
            self.events.extend(
                self.map
                    .values()
                    .filter(|e| Some(e.id) != me)
                    .map(|e| Event::Removed { id: e.id, ty: e.ty }),
            );
        }
        let me = self.self_id.and_then(|id| self.map.remove(&id));
        self.map.clear();
        if let Some(mut me) = me {
            me.vehicle = None;
            me.passengers.clear();
            me.leash_holder = None;
            self.map.insert(me.id, me);
        }
    }

    #[inline]
    pub(crate) fn event(&mut self, e: Event) {
        if self.config.events {
            self.events.push(e);
        }
    }

    pub(crate) fn set_self(&mut self, id: i32) {
        if let Some(old) = self.self_id {
            self.map.remove(&old);
        }
        self.self_id = Some(id);
        let mut me = Entity::new(id, EntityType::Player);
        me.sizer = if self.modern {
            crate::v1_16_5::vanilla_size(&me).map(|v| (v, true))
        } else {
            crate::v1_8::vanilla_size(&me).map(|v| (v, false))
        };
        self.map.insert(id, me);
    }

    /// Adds an entity, replacing (and unlinking) any entity with the same id, as vanilla does.
    pub(crate) fn spawn(&mut self, mut e: Entity) {
        let id = e.id;
        e.sizer = if self.modern {
            crate::v1_16_5::vanilla_size(&e).map(|v| (v, true))
        } else {
            crate::v1_8::vanilla_size(&e).map(|v| (v, false))
        };
        if Some(id) == self.self_id {
            return;
        }
        if self.map.contains_key(&id) {
            self.unlink(id);
        }
        self.map.insert(id, e);
        self.event(Event::Spawned(id));
    }

    pub(crate) fn remove(&mut self, id: i32) -> bool {
        if Some(id) == self.self_id || !self.map.contains_key(&id) {
            return false;
        }
        self.unlink(id);
        if let Some(e) = self.map.remove(&id) {
            self.event(Event::Removed { id, ty: e.ty });
        }
        true
    }

    /// Detaches `id` from its vehicle, passengers and leash links.
    fn unlink(&mut self, id: i32) {
        let Some(e) = self.map.get_mut(&id) else {
            return;
        };
        let vehicle = e.vehicle.take();
        let passengers = std::mem::take(&mut e.passengers);
        if let Some(v) = vehicle
            && let Some(v) = self.map.get_mut(&v)
        {
            v.passengers.retain(|&p| p != id);
        }
        for p in passengers {
            if let Some(p) = self.map.get_mut(&p)
                && p.vehicle == Some(id)
            {
                p.vehicle = None;
            }
        }
        if self.any_leash {
            for other in self.map.values_mut() {
                if other.leash_holder == Some(id) {
                    other.leash_holder = None;
                }
            }
        }
    }

    /// `true` when `vehicle` is `rider` or (indirectly) rides `rider`.
    fn rides(&self, vehicle: i32, rider: i32) -> bool {
        let mut cur = Some(vehicle);
        let mut guard = 0;
        while let Some(c) = cur {
            if c == rider {
                return true;
            }
            guard += 1;
            if guard > 64 {
                return true;
            }
            cur = self.map.get(&c).and_then(|e| e.vehicle);
        }
        false
    }

    /// Makes `rider` ride `vehicle` (or dismount with `None`). `single` = 1.8 semantics (one
    /// rider per vehicle: a previous rider is dismounted). Returns `false` when ignored.
    pub(crate) fn mount(&mut self, rider: i32, vehicle: Option<i32>, single: bool) -> bool {
        if !self.map.contains_key(&rider) {
            return false;
        }
        if let Some(v) = vehicle
            && (!self.map.contains_key(&v) || self.rides(v, rider))
        {
            return false;
        }
        // Leave the old vehicle.
        let old = self.map.get_mut(&rider).and_then(|e| e.vehicle.take());
        if let Some(o) = old
            && let Some(o) = self.map.get_mut(&o)
        {
            o.passengers.retain(|&p| p != rider);
        }
        if let Some(v) = vehicle {
            let prev: Vec<i32> = if single {
                self.map
                    .get_mut(&v)
                    .map(|e| std::mem::take(&mut e.passengers))
                    .unwrap_or_default()
            } else {
                Vec::new()
            };
            for p in prev {
                if let Some(p) = self.map.get_mut(&p) {
                    p.vehicle = None;
                }
            }
            if let Some(ve) = self.map.get_mut(&v) {
                ve.passengers.push(rider);
            }
            if let Some(r) = self.map.get_mut(&rider) {
                r.vehicle = Some(v);
            }
        }
        self.event(Event::Mounted { id: rider, vehicle });
        true
    }

    /// 1.16 `set_passengers`: ejects every current passenger of `vehicle`, then mounts `ids`.
    pub(crate) fn set_passengers(&mut self, vehicle: i32, ids: impl Iterator<Item = i32>) -> bool {
        let Some(v) = self.map.get_mut(&vehicle) else {
            return false;
        };
        let old = std::mem::take(&mut v.passengers);
        for p in &old {
            if let Some(p) = self.map.get_mut(p)
                && p.vehicle == Some(vehicle)
            {
                p.vehicle = None;
            }
        }
        // Reuse the old buffer for the new list (no allocation in steady state).
        let mut old = old;
        old.clear();
        if let Some(v) = self.map.get_mut(&vehicle) {
            v.passengers = old;
        }
        for id in ids {
            self.mount(id, Some(vehicle), false);
        }
        true
    }

    pub(crate) fn leash(&mut self, id: i32, holder: Option<i32>) -> bool {
        match self.map.get_mut(&id) {
            Some(e) => {
                e.leash_holder = holder;
                self.any_leash |= holder.is_some();
                true
            }
            None => false,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn store() -> Entities {
        let mut s = Entities::new(Config {
            events: true,
            ..Config::default()
        });
        for id in 1..=4 {
            s.spawn(Entity::new(id, EntityType::Registry(6)));
        }
        s
    }

    #[test]
    fn mount_single_and_multi() {
        let mut s = store();
        assert!(s.mount(1, Some(2), true));
        assert!(s.mount(3, Some(2), true)); // 1.8: replaces rider 1
        assert_eq!(s.get(2).unwrap().passengers(), &[3]);
        assert_eq!(s.get(1).unwrap().vehicle(), None);
        assert!(!s.mount(2, Some(3), true), "cycle");
        assert!(s.set_passengers(4, [1, 3].into_iter()));
        assert_eq!(s.get(4).unwrap().passengers(), &[1, 3]);
        assert_eq!(s.get(2).unwrap().passengers(), &[] as &[i32]);
        assert_eq!(s.get(3).unwrap().vehicle(), Some(4));
        s.remove(4);
        assert_eq!(s.get(1).unwrap().vehicle(), None);
        assert_eq!(s.get(3).unwrap().vehicle(), None);
    }

    #[test]
    fn self_entry_survives_clear() {
        let mut s = store();
        s.set_self(9);
        s.spawn(Entity::new(9, EntityType::Registry(1))); // ignored: own id
        assert_eq!(s.get(9).unwrap().entity_type(), EntityType::Player);
        assert!(!s.remove(9));
        s.drain_events().for_each(drop);
        s.clear();
        assert_eq!(s.len(), 1);
        assert!(s.me().is_some());
        assert_eq!(s.drain_events().count(), 4);
        assert_eq!(s.iter().count(), 0);
    }
}