bevy_pipe_affect/
lib.rs

1#![doc = include_str!("../book/src/blurb.md")]
2//!
3//! ## This API Reference
4//! The purpose of this API reference is to describe the API provided by this library.
5//! More explanation-oriented documentation, tutorials, and guides are available in the
6//! [`bevy_pipe_affect` book](https://trouv.github.io/bevy_pipe_affect/v0.3.0). <!-- x-release-please-version -->
7//!
8//! The following are good jumping-off points for beginners:
9//! - [*Motivations* explanation](https://trouv.github.io/bevy_pipe_affect/v0.3.0/explanation/motivations.html) <!-- x-release-please-version -->
10//! - [*effects* module api reference](effects) (a list of effects and constructors provided by the library)
11//!
12//! Cargo examples are also available in this library's
13//! [github repository](https://github.com/Trouv/bevy_pipe_affect/tree/v0.3.0/examples). <!-- x-release-please-version -->
14//!
15//! ## Feature flags
16//! This crate provides the following set of [feature flags]:
17//! - `derive`: enables the [`Effect`] derive macro for structs and enums of effects
18//! - `asset`: enables the `bevy/bevy_asset` feature and [`Asset`-related effects]
19//!
20//! None of these are enabled by default.
21//!
22//! [feature flags]: https://doc.rust-lang.org/cargo/reference/features.html#the-features-section
23//! [`Asset`-related effects]: effects::asset
24#![warn(missing_docs)]
25#![deny(rustdoc::all)]
26
27mod effect;
28pub use effect::Effect;
29
30mod effect_out;
31pub use effect_out::{EffectOut, effect_out};
32
33pub mod effects;
34
35mod query_data_effect;
36pub use query_data_effect::QueryDataEffect;
37
38pub mod query_data_effects;
39
40pub mod system_combinators;
41
42pub mod effect_composition;
43
44pub mod prelude;
45
46/// Derive macro for the [`Effect`] trait. See that trait for more details.
47///
48/// *Requires the `derive` feature to be enabled.*
49#[cfg(feature = "derive")]
50pub use bevy_pipe_affect_derive::Effect;
bevy_pipe_affect/lib.rs

bevy_pipe_affect/
lib.rs
