bevy_simple_preferences 0.1.0

A simple Preferences API 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
57
58
59
60
61
62
63
64
65

use crate::PreferencesType;
use bevy::ecs::system::SystemParam;
use bevy::prelude::*;
use std::ops::{Deref, DerefMut};

/// Stores the specific values of a preferences of type T.
/// Is preferable to use [`Preferences`] system param, but if you need fine-grained
/// control over the change detection, you might need to use the Resource directly
#[derive(Resource, Deref, DerefMut, Reflect)]
#[reflect(Resource)]
pub struct PreferencesResource<T: PreferencesType>(T);

impl<T: PreferencesType> PreferencesResource<T> {
    pub(crate) fn new(value: T) -> Self {
        Self(value)
    }
}

/// System param that allows to read and write preferences of a type `T`.
/// ```
/// # use bevy::prelude::*;
/// # use bevy_simple_preferences::*;
/// # #[derive(Reflect, Default)]
/// # struct MyPreferences;
/// let app = App::new()
///     .register_preferences::<MyPreferences>()
///     .add_systems(Update, |mut preferences: Preferences<MyPreferences>| {
///         // Do stuff with your preferences
///     })
///     .run();
///
/// ```
#[derive(SystemParam)]
pub struct Preferences<'w, T: PreferencesType> {
    resource: ResMut<'w, PreferencesResource<T>>,
}

impl<'w, T> Deref for Preferences<'w, T>
where
    T: PreferencesType,
{
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.resource
    }
}

impl<'w, T> DerefMut for Preferences<'w, T>
where
    T: PreferencesType,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.resource
    }
}

impl<'w, T> PartialEq<T> for Preferences<'w, T>
where
    T: PreferencesType + PartialEq,
{
    fn eq(&self, other: &T) -> bool {
        (**self.resource).eq(other)
    }
}