bevy_alchemy 0.4.0

An experimental, status effects-as-entities system for Bevy.
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

#![doc = include_str!("../README.md")]

mod bundle_inspector;
mod command;
mod component;
mod registry;
mod relation;
mod spawnable_list;

use bevy_app::{App, Plugin};
use bevy_ecs::prelude::*;
use bevy_reflect::Reflect;
use bevy_reflect::prelude::ReflectDefault;

use crate::bundle_inspector::BundleInspector;
pub use command::*;
pub use component::*;
pub use registry::*;
pub use relation::*;
pub use spawnable_list::*;

/// Setup required types and systems for `bevy_alchemy`.
pub struct AlchemyPlugin;

impl Plugin for AlchemyPlugin {
    fn build(&self, app: &mut App) {
        app.register_type::<EffectMode>()
            .register_type::<Effecting>()
            .register_type::<EffectedBy>()
            .register_type::<Lifetime>()
            .register_type::<Delay>()
            .register_type::<TimerMergeMode>()
            .init_resource::<BundleInspector>()
            .init_resource::<EffectMergeRegistry>()
            .add_plugins(TimerPlugin)
            .add_plugins(StackPlugin);
    }
}

/// Describes the logic used when multiple of the same effect are applied to an entity.
#[derive(Component, Reflect, Eq, PartialEq, Debug, Default, Copy, Clone)]
#[reflect(Component, PartialEq, Debug, Default, Clone)]
pub enum EffectMode {
    /// Multiple of the same effect can exist at once, so when an effect is added, its components will be spawned as a new entity.
    #[default]
    Stack,
    /// When an effect is added, its components will be inserted into a matching effect.
    /// If there are no matches, the components will be spawned as a new entity.
    Insert,
    /// When an effect is added, its components will be merged into any matching effect.
    /// By default, the incoming component will replace the old one, same as [`Insert`](Self::Insert).
    /// This can be configured on a per-component basis using the [`EffectMergeRegistry`] resource.
    ///
    /// If there are no matching effects, the components will be spawned as a new entity.
    Merge,
}