libfj 0.10.0

An unofficial collection of APIs used in FreeJam games and mods
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

use crate::techblox::{hashname, brute_force, Parsable, blocks::lookup_name_by_hash};
use libfj_parsable_macro_derive::*;

/// An entity's header information.
///
/// This holds entity data common to all entities, such as entity type and ID.
#[derive(Clone, Copy, Parsable)]
pub struct EntityHeader {
    /// Entity type hash
    pub hash: u32,
    /// Entity identifier
    pub entity_id: u32,
    /// Entity group identifier
    pub group_id: u32,
    /// Count of serialized components after this header (this is not the size in bytes)
    pub component_count: u8,
}

impl EntityHeader {
    /// Guess the original name from the hashed value by brute-force.
    ///
    /// This is slow and cannot guarantee a correct result. Use is discouraged.
    pub fn guess_name(&self) -> String {
        brute_force(self.hash)
    }

    /// Lookup the name from the header's hash from a list of known entity names.
    ///
    /// This is much faster than guess_name() and is guaranteed to return a correct result if one exists.
    /// If the hash has no known correct name, None is returned instead.
    pub fn lookup_name(&self) -> Option<String> {
        if let Some(name) = lookup_name_by_hash(self.hash) {
            return Some(name.to_string());
        }
        None
    }

    /// Create an entity header using the hash of `name`.
    pub fn from_name(name: &str, entity_id: u32, group_id: u32, component_count: u8) -> Self {
        Self {
            hash: hashname(name),
            entity_id,
            group_id,
            component_count,
        }
    }
}

impl std::convert::Into<EntityGroupID> for EntityHeader {
    fn into(self) -> EntityGroupID {
        EntityGroupID {
            entity_id: self.entity_id,
            group_id: self.group_id,
        }
    }
}

/// Entity identifier common among all components in the same entity
#[derive(Clone, Copy, Parsable)]
pub struct EntityGroupID {
    /// Entity identifier
    pub entity_id: u32,
    /// Entity group identifier
    pub group_id: u32
}