moirai-for-games 0.1.0

A small deterministic no_std ECS for constrained and headless games
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

//! Moirai is a single-threaded, `no_std + alloc` entity-component-system library.
//!
//! The public surface is a set of concept-level namespaces, curated root re-exports,
//! and a smaller system-authoring prelude. Implementation modules such as allocators,
//! registries, storage engines, command queues, and schedule runners stay private.
//!
//! # Crate root and prelude admission
//!
//! Common application, world, schedule, query, bundle, state, and time vocabulary is
//! available at the crate root. [`prelude`] contains the subset normally needed to
//! author systems. Advanced construction helpers such as [`world::BundleWriter`] stay
//! in their semantic namespace.
//!
//! # Learn by example
//!
//! [`examples`] is the canonical ordered learning path. Its stable, runnable doctests
//! progress from a first app through scheduling, queries, and deterministic replay.
//!
//! # Privacy boundary
//!
//! Internal modules are not reachable from downstream crates:
//!
//! ```compile_fail
//! use moirai::entity::allocator;
//! ```
//!
//! ```compile_fail
//! use moirai::storage;
//! ```
//!
//! ```compile_fail
//! use moirai::component::registry;
//! ```

#![no_std]
#![forbid(unsafe_code)]

extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

mod app;
mod command;
pub mod diagnostics;
pub mod event;
pub mod examples;
mod operation;
pub mod prelude;
pub mod query;
mod resource;
mod revision;
pub mod schedule;
pub mod state;
mod storage;
mod time;

#[cfg(feature = "bench-internals")]
#[doc(hidden)]
pub mod bench_internals;

mod entity;

pub mod component;
pub mod math;
pub mod world;

#[cfg(feature = "testkit")]
pub mod testkit;

pub use app::{App, AppBuilder, AppError, AppFault, BuildError};
pub use component::{ComponentId, ComponentOptions, StorageKind};
pub use entity::EntityId;
pub use event::{
    ComponentAdded, ComponentRemoved, EventId, EventOptions, EventReader, EventReaderStart,
    EventRegistrationError, EventRetention,
};
pub use math::Q16;
pub use operation::StageOperation;
pub use query::{
    ExactIdPolicy, PreparedQuery1, PreparedQuery2, Query1, Query2, QueryCommands, QueryCursor,
    QueryEffects, QueryError, QueryPolicy, QuerySpec, QueryWindow,
};
pub use revision::{Revision, RevisionExhausted, RevisionKey};
pub use schedule::stage;
pub use schedule::{
    Condition, ConditionError, FlushMode, Schedule, ScheduleBuilder, ScheduleError, StageId,
    System, SystemId, SystemInitContext, SystemSet, UpdatePlan,
};
pub use state::{apply, on_enter, on_exit, on_transition, State, StateError};
pub use time::{
    ChangeTick, FixedConfig, FixedDebtCoalesced, FixedDebtDropped, FixedDebtPolicy, FixedStep,
    WorldTick,
};
pub use world::{
    Bundle, Commands, DenseEntityScratch, DynamicBundle, EntityScratchError, World, WorldBuilder,
    WorldError,
};