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
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

use std::{thread::sleep, time::Duration};

use flax::components::name;

#[test]
fn access() {
    use flax::*;
    component! {
        health: f32,
        weapon: &'static str,
        blue_team: (),
        red_team: (),
        support_of(id): (),
    }

    let mut world = World::new();

    // Spectator
    let spectator = Entity::builder()
        .set(name(), "spectator".into())
        .set(health(), 100.0)
        .set(weapon(), "bow")
        .spawn(&mut world);

    let _blue1 = Entity::builder()
        .set(name(), "blue1".into())
        .set(health(), 100.0)
        .set(weapon(), "Rifle")
        .tag(blue_team())
        .spawn(&mut world);

    let red1 = Entity::builder()
        .set(name(), "red1".into())
        .set(health(), 100.0)
        .set(weapon(), "Wrench")
        .tag(red_team())
        .spawn(&mut world);

    // Like a turret
    Entity::builder()
        .set(name(), "turret".into())
        .set(health(), 100.0)
        .tag(red_team())
        .tag(support_of(red1))
        .spawn(&mut world);

    let weapons = System::builder()
        .with_name("weapons")
        .with_query(Query::new(weapon()))
        .build(|mut q: QueryBorrow<Component<&'static str>>| {
            let weapons: Vec<_> = q.iter().collect();
            eprintln!("Weapons in use: {weapons:?}");
        })
        .boxed();

    let names = System::builder()
        .with_name("names")
        .with_query(Query::new(name()))
        .build(|mut q: QueryBorrow<Component<String>>| {
            let names: Vec<_> = q.iter().collect();
            eprintln!("names in use: {names:?}");
        })
        .boxed();

    let regen_system = System::builder()
        .with_name("regen_system")
        .with_query(Query::new(health().as_mut()))
        .try_for_each(|v| {
            *v = (*v + 10.0).min(100.0);
            anyhow::Ok(())
        })
        .boxed();

    let blue_system = System::builder()
        .with_name("blue_system")
        .with_query(Query::new(weapon().as_mut()).filter(blue_team().with() & health().gt(0.0)))
        .for_each(|_v| {
            sleep(Duration::from_millis(100));
            // here be logic
        })
        .boxed();

    let red_system = System::builder()
        .with_name("red_system")
        .with_query(Query::new(weapon().as_mut()).filter(red_team().with() & health().gt(0.0)))
        .for_each(|_v| {
            sleep(Duration::from_millis(100));
            // here be logic
        })
        .boxed();

    let stats_system = System::builder()
        .with_name("stats")
        .with_query(Query::new((weapon(), health())).filter(health().gt(0.0)))
        .for_each(|(weapon, health)| eprintln!("player using {weapon} is alive {health}"))
        .boxed();

    let mut schedule = Schedule::from([
        regen_system,
        weapons,
        blue_system,
        red_system,
        stats_system,
        names,
    ]);

    assert_eq!(
        schedule.batch_info(&world).to_names(),
        [
            &["regen_system", "weapons", "names"][..],
            &["blue_system", "red_system"],
            &["stats"]
        ]
    );

    world.set(spectator, blue_team(), ()).unwrap();

    assert_eq!(
        schedule.batch_info(&world).to_names(),
        [
            &["regen_system", "weapons", "names"][..],
            &["blue_system", "red_system"],
            &["stats"]
        ]
    );

    // Now on both teams, can no longer parallelize
    world.set(spectator, red_team(), ()).unwrap();

    assert_eq!(
        schedule.batch_info(&world).to_names(),
        [
            &["regen_system", "weapons", "names"][..],
            &["blue_system"],
            &["red_system"],
            &["stats"],
        ]
    );

    world.remove(spectator, weapon()).unwrap();

    assert_eq!(
        schedule.batch_info(&world).to_names(),
        [
            &["regen_system", "weapons", "names"][..],
            &["blue_system"],
            &["red_system"],
            &["stats"]
        ]
    );

    world.prune_archetypes();

    assert_eq!(
        schedule.batch_info(&world).to_names(),
        [
            &["regen_system", "weapons", "names"][..],
            &["blue_system", "red_system"],
            &["stats"]
        ]
    );
}