siecs 0.1.2

Rust bindings for SIECS
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

//! Rust bindings for SIECS.
//!
//! The safe API wraps common world, entity, component, query, system, resource,
//! observer, and event workflows. The [`raw`] module exposes the C FFI when a
//! feature is not wrapped yet.
//!
//! ```
//! use siecs::prelude::*;
//!
//! #[derive(Component)]
//! struct Position {
//!     x: f32,
//!     y: f32,
//! }
//!
//! #[derive(Component)]
//! struct Velocity {
//!     x: f32,
//!     y: f32,
//! }
//!
//! fn move_system(mut query: Query<(&mut Position, &Velocity)>) {
//!     for (position, velocity) in &mut query {
//!         position.x += velocity.x;
//!         position.y += velocity.y;
//!     }
//! }
//!
//! let mut world = World::new();
//! let entity = world.entity();
//! world.set(entity, Position { x: 0.0, y: 0.0 });
//! world.set(entity, Velocity { x: 1.0, y: 2.0 });
//!
//! world.system(Phase::OnUpdate, move_system);
//! world.progress();
//!
//! let position = world.get::<Position>(entity).unwrap();
//! assert_eq!(position.x, 1.0);
//! assert_eq!(position.y, 2.0);
//! ```

extern crate self as siecs;

pub mod component;
pub mod entity;
pub mod module;
pub mod observer;
#[doc(hidden)]
pub mod private;
pub mod query;
pub mod raw;
pub mod resource;
pub mod system;
pub mod world;
pub mod world_ref;

pub use component::{Abstract, ChildOf, Component, Disabled, Name};
pub use entity::Entity;
pub use module::{Module, ModuleId};
pub use observer::{
    Event, EventId, Observer, ObserverEvent, ObserverId, OnAdd, OnRemove, OnSet, RawEvent,
    TypedEvent,
};
pub use query::{
    Field, FieldKind, ParamError, Query, QueryFilter, QueryParam, QueryState, With, Without,
};
pub use resource::{Res, ResMut, Resource, ResourceId};
pub use siecs_derive::{Component, Event, Resource};
pub use system::{
    Commands, EachCtx, IntoSystem, Phase, System, SystemContext, SystemDescBuilder, SystemId,
    SystemParam,
};
pub use world::{DeferGuard, World, WorldFeatures};
pub use world_ref::WorldRef;

pub mod prelude {
    pub use crate::{
        Abstract, ChildOf, Commands, Component, DeferGuard, Disabled, EachCtx, Entity, Event,
        EventId, Field, FieldKind, IntoSystem, Module, ModuleId, Name, Observer, ObserverEvent,
        ObserverId, OnAdd, OnRemove, OnSet, ParamError, Phase, Query, QueryFilter, QueryParam,
        QueryState, RawEvent, Res, ResMut, Resource, ResourceId, System, SystemContext,
        SystemDescBuilder, SystemId, SystemParam, TypedEvent, With, Without, World, WorldFeatures,
        WorldRef,
    };
}