rig-ecs 0.44.0

rig inside a Bevy World: effects as entities, handlers as entities, the driver as a system.
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

//! Runtime effect and run counts exposed as Bevy diagnostic time series.
//!
//! ```
//! let mut app = bevy_app::App::new();
//! app.add_plugins(bevy_diagnostic::DiagnosticsPlugin);
//! rig_ecs::systems::diagnostics::register(&mut app);
//! ```

use bevy_app::App;
use bevy_diagnostic::{Diagnostic, DiagnosticPath, Diagnostics, RegisterDiagnostic};
use bevy_ecs::{prelude::*, query::QueryFilter};

use crate::{
    agent::{Failed, Run, Settled},
    bus::{InFlight, PendingEffect},
};

/// Effects in flight at the end of the pass.
pub const EFFECTS_IN_FLIGHT: DiagnosticPath = DiagnosticPath::const_new("rig/effects/in_flight");
/// Effects pending dispatch at the end of the pass.
pub const EFFECTS_PENDING: DiagnosticPath = DiagnosticPath::const_new("rig/effects/pending");
/// Runs neither settled nor failed.
pub const RUNS_LIVE: DiagnosticPath = DiagnosticPath::const_new("rig/runs/live");

/// Register every diagnostic.
pub fn register(app: &mut App) {
    app.register_diagnostic(Diagnostic::new(EFFECTS_IN_FLIGHT))
        .register_diagnostic(Diagnostic::new(EFFECTS_PENDING))
        .register_diagnostic(Diagnostic::new(RUNS_LIVE));
}

/// An effect pending dispatch.
#[derive(QueryFilter)]
pub struct PendingDispatch {
    _pending: With<PendingEffect>,
    _not_taken: Without<InFlight>,
    _not_answered: Without<crate::bus::EffectOutcome>,
}

/// A run neither settled nor failed.
#[derive(QueryFilter)]
pub struct LiveRun {
    _run: With<Run>,
    _not_settled: Without<Settled>,
    _not_failed: Without<Failed>,
}

/// `RigSet::Settle`: one measurement per diagnostic per pass.
pub fn measure(
    mut diagnostics: Diagnostics,
    in_flight: Query<(), With<InFlight>>,
    pending: Query<(), PendingDispatch>,
    live: Query<(), LiveRun>,
) {
    diagnostics.add_measurement(&EFFECTS_IN_FLIGHT, || in_flight.iter().count() as f64);
    diagnostics.add_measurement(&EFFECTS_PENDING, || pending.iter().count() as f64);
    diagnostics.add_measurement(&RUNS_LIVE, || live.iter().count() as f64);
}