nightshade 0.52.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
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

use crate::ecs::world::World;

pub type SystemFn = fn(&mut World);

/// The frame schedule's coarse phases, in run order. Within a phase,
/// systems run in the order they were registered, so composition order is
/// run order: the core systems land first, then each plugin's systems in
/// the order the plugins were added.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum FramePhase {
    Start,
    Update,
    PostUpdate,
    Render,
    Last,
}

#[derive(Clone, Default)]
pub struct FrameSchedule {
    pub start: Vec<SystemFn>,
    pub update: Vec<SystemFn>,
    pub post_update: Vec<SystemFn>,
    pub render: Vec<SystemFn>,
    pub last: Vec<SystemFn>,
}

impl FrameSchedule {
    fn phase_mut(&mut self, phase: FramePhase) -> &mut Vec<SystemFn> {
        match phase {
            FramePhase::Start => &mut self.start,
            FramePhase::Update => &mut self.update,
            FramePhase::PostUpdate => &mut self.post_update,
            FramePhase::Render => &mut self.render,
            FramePhase::Last => &mut self.last,
        }
    }

    fn phases(&self) -> [&[SystemFn]; 5] {
        [
            &self.start,
            &self.update,
            &self.post_update,
            &self.render,
            &self.last,
        ]
    }

    fn phases_mut(&mut self) -> [&mut Vec<SystemFn>; 5] {
        [
            &mut self.start,
            &mut self.update,
            &mut self.post_update,
            &mut self.render,
            &mut self.last,
        ]
    }
}

#[derive(Clone, Default)]
pub struct Schedules {
    pub frame: FrameSchedule,
    pub retained_ui: Vec<SystemFn>,
}

pub fn schedule_push(schedule: &mut FrameSchedule, phase: FramePhase, system: SystemFn) {
    schedule.phase_mut(phase).push(system);
}

pub fn schedule_remove(schedule: &mut FrameSchedule, system: SystemFn) {
    for phase in schedule.phases_mut() {
        phase.retain(|entry| !std::ptr::fn_addr_eq(*entry, system));
    }
}

pub fn schedule_run(schedule: &FrameSchedule, world: &mut World) {
    let _span = tracing::info_span!("systems").entered();
    for phase in schedule.phases() {
        for system in phase {
            system(world);
        }
    }
}

pub fn build_default_frame_schedule() -> FrameSchedule {
    let mut schedule = FrameSchedule::default();
    schedule_push(
        &mut schedule,
        FramePhase::Start,
        crate::ecs::event::swap_events_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::graphics::systems::day_night_cycle_system,
    );
    #[cfg(target_arch = "wasm32")]
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::camera::systems::sync_wasm_canvas_size,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::bounding_volume::systems::ensure_bounding_volumes,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::animation::systems::update_animation_players,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::animation::systems::apply_animations,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::tween::update_tweens_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::particles::systems::update_particle_emitters,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::cloth::systems::sync_cloth_meshes_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Update,
        crate::ecs::vfx::systems::update_vfx_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::PostUpdate,
        crate::ecs::transform::systems::run_systems,
    );
    schedule_push(
        &mut schedule,
        FramePhase::PostUpdate,
        crate::ecs::mesh::systems::update_instanced_mesh_caches_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Last,
        crate::ecs::input::systems::apply_ime_allowed_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Last,
        crate::ecs::input::systems::reset_mouse_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Last,
        crate::ecs::input::systems::reset_keyboard_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Last,
        crate::ecs::input::systems::reset_touch_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Last,
        crate::ecs::world::process_commands_system,
    );
    schedule_push(
        &mut schedule,
        FramePhase::Last,
        crate::ecs::world::cleanup_unused_resources_system,
    );
    schedule
}