flax 0.7.1

An ergonomic archetypical ECS
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

use flax::{component, components::name, World};
use itertools::Itertools;

pub fn main() -> anyhow::Result<()> {
    // ANCHOR: world
    let mut world = World::new();
    // ANCHOR_END: world

    // ANCHOR: spawn
    let id = world.spawn();

    if world.is_alive(id) {
        println!("It is alive!");
    }
    // ANCHOR_END: spawn

    // ANCHOR: despawn
    world.despawn(id)?;

    if world.is_alive(id) {
        println!("We've got a zombie on our hands");
    }

    // ANCHOR_END: despawn
    // ANCHOR: spawn_many
    let ids = world.spawn_many().take(10).collect_vec();
    println!("ids: {ids:?}");
    // ANCHOR_END: spawn_many

    // ANCHOR: component_decl

    component! {
        /// Represents the position in the world
        position: (f32, f32),
    }

    // ANCHOR_END: component_decl

    // ANCHOR: world_component_access
    let id = world.spawn();

    // Add a component to `id`
    world.set(id, position(), (1.0, 4.0))?;

    {
        let val = world.get(id, position())?;

        println!("The entity is at: {val:?}");
    }

    // This will overwrite the previous value
    world.set(id, position(), (1.0, 4.5))?;

    {
        // Mutate the component
        let mut pos = world.get_mut(id, position())?;
        pos.1 += 1.0;
    }

    println!("The entity is now at: {:?}", world.get(id, position())?);

    // ANCHOR_END: world_component_access
    // ANCHOR: component_meta

    component! {
        /// An entity's health.
        /// Provides the Debug bundle, which adds the `debug_visitor` component.
        health: f32 => [ flax::Debuggable ],
    }

    // After adding the component, the associate metadata of the `health`
    // component is added to the world.
    world.set(id, health(), 100.0)?;

    let component_name = world.get(health().id(), name())?;
    println!("The name of the component is {component_name:?}");

    // Print the state of the world
    println!("World: {world:#?}");
    // Prints:
    //
    // World: {
    //     1v2: {},
    //     2v1: {},
    //     3v1: {},
    //     4v1: {},
    //     5v1: {},
    //     6v1: {},
    //     7v1: {},
    //     8v1: {},
    //     9v1: {},
    //     10v1: {},
    //     11v1: {
    //         "position": _,
    //         "health": 100.0,
    //     },
    // }

    // ANCHOR_END: component_meta

    Ok(())
}