nightshade 0.54.0

A cross-platform data-oriented game engine.
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

use crate::ecs::world::CORE;
use crate::ecs::world::World;
use freecs::Entity;
use std::collections::HashMap;

#[derive(Default, Clone)]
pub struct EntityRegistry {
    pub names: HashMap<String, Entity>,
    pub tags: HashMap<Entity, Vec<String>>,
    pub next_guid: u64,
    pub guid_index: HashMap<u64, Entity>,
}

/// Returns the entity's `Guid`, minting a fresh value if absent and
/// adding the `GUID` archetype flag if the entity doesn't already
/// carry it. Callers that know an entity is persistent should include
/// `GUID` in the initial spawn bitflags to skip the archetype
/// migration.
pub fn ensure_guid(world: &mut World, entity: Entity) -> crate::ecs::primitives::Guid {
    if let Some(existing) = world.get::<crate::ecs::primitives::Guid>(entity).copied() {
        world
            .res_mut::<crate::ecs::entity_registry::EntityRegistry>()
            .guid_index
            .entry(existing.0)
            .or_insert(entity);
        return existing;
    }
    world
        .res_mut::<crate::ecs::entity_registry::EntityRegistry>()
        .next_guid = world
        .res_mut::<crate::ecs::entity_registry::EntityRegistry>()
        .next_guid
        .saturating_add(1);
    let guid = crate::ecs::primitives::Guid(
        world
            .res::<crate::ecs::entity_registry::EntityRegistry>()
            .next_guid,
    );
    if !world.ecs.worlds[CORE].entity_has_components(entity, crate::ecs::world::GUID) {
        world.ecs.worlds[CORE].add_components(entity, crate::ecs::world::GUID);
    }
    world.set(entity, guid);
    world
        .res_mut::<crate::ecs::entity_registry::EntityRegistry>()
        .guid_index
        .insert(guid.0, entity);
    guid
}

/// Records that `entity` carries `guid` without touching the counter.
/// Used by scene load to restore authored guid values into the
/// reverse index.
pub fn assign_guid(world: &mut World, entity: Entity, guid: crate::ecs::primitives::Guid) {
    if !world.ecs.worlds[CORE].entity_has_components(entity, crate::ecs::world::GUID) {
        world.ecs.worlds[CORE].add_components(entity, crate::ecs::world::GUID);
    }
    world.set(entity, guid);
    world
        .res_mut::<crate::ecs::entity_registry::EntityRegistry>()
        .guid_index
        .insert(guid.0, entity);
    if guid.0
        > world
            .res::<crate::ecs::entity_registry::EntityRegistry>()
            .next_guid
    {
        world
            .res_mut::<crate::ecs::entity_registry::EntityRegistry>()
            .next_guid = guid.0;
    }
}

pub fn find_entity_by_guid(world: &World, guid: crate::ecs::primitives::Guid) -> Option<Entity> {
    world
        .res::<crate::ecs::entity_registry::EntityRegistry>()
        .guid_index
        .get(&guid.0)
        .copied()
}