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 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
//local shortcuts
use crate::prelude::*;
//third-party shortcuts
use bevy::prelude::*;
use bevy::ecs::system::SystemParam;
//standard shortcuts
use core::ops::Deref;
//-------------------------------------------------------------------------------------------------------------------
/// Tag trait for reactive components.
///
/// It is not recommended to add `ReactComponent` and `Component` to the same struct, as it will likely cause confusion.
pub trait ReactComponent: Send + Sync + 'static {}
//-------------------------------------------------------------------------------------------------------------------
/// Component wrapper that enables reacting to component mutations.
/// - WARNING: It is possible to remove a `React` from one entity and manually insert it to another entity. That WILL
/// break the react framework. Instead use `react_commands.insert(new_entity, react_component.take());`.
#[derive(Component)]
pub struct React<C: ReactComponent>
{
pub(crate) entity : Entity,
pub(crate) component : C,
}
impl<C: ReactComponent> React<C>
{
/// Immutably accesses the component.
pub fn get(&self) -> &C
{
&self.component
}
/// Mutably accesses the component and triggers reactions.
pub fn get_mut<'a>(&'a mut self, c: &mut Commands) -> &'a mut C
{
c.syscall(self.entity, ReactCache::schedule_mutation_reaction::<C>);
&mut self.component
}
/// Mutably accesses the component without triggering reactions.
pub fn get_noreact(&mut self) -> &mut C
{
&mut self.component
}
/// Sets the component value and triggers mutations only if the value will change.
///
/// Returns the previous value if it changed.
pub fn set_if_neq(&mut self, c: &mut Commands, new: C) -> Option<C>
where
C: PartialEq
{
if new == self.component { return None; }
c.syscall(self.entity, ReactCache::schedule_mutation_reaction::<C>);
let old = std::mem::replace(&mut self.component, new);
Some(old)
}
/// Unwrap the `React`.
pub fn take(self) -> C
{
self.component
}
}
impl<C: ReactComponent> Deref for React<C>
{
type Target = C;
fn deref(&self) -> &C
{
&self.component
}
}
//-------------------------------------------------------------------------------------------------------------------
/// System parameter for accessing [`React<T>`] components immutably.
///
/// See [`ReactiveMut`] for the mutable version.
#[derive(SystemParam)]
pub struct Reactive<'w, 's, T: ReactComponent>
{
components: Query<'w, 's, (Entity, &'static React<T>)>,
}
impl<'w, 's, T: ReactComponent> Reactive<'w, 's, T>
{
/// Reads `T` on `entity`.
///
/// Does not trigger reactions.
pub fn get(&self, entity: Entity) -> Option<&T>
{
self.components.get(entity).ok().map(|(_, c)| c.get())
}
/// Reads `T` on a single entity.
///
/// Does not trigger reactions.
///
/// Panics if the inner query doesn't have exactly one entity.
pub fn single(&self) -> (Entity, &T)
{
let (e, x) = self.components.single();
(e, x.get())
}
}
//-------------------------------------------------------------------------------------------------------------------
/// System parameter for accessing [`React<T>`] components mutably.
///
/// See [`Reactive`] for the immutable version.
#[derive(SystemParam)]
pub struct ReactiveMut<'w, 's, T: ReactComponent>
{
components: Query<'w, 's, (Entity, &'static mut React<T>)>,
}
impl<'w, 's, T: ReactComponent> ReactiveMut<'w, 's, T>
{
/// Reads `T` on `entity`.
///
/// Does not trigger reactions.
pub fn get(&self, entity: Entity) -> Option<&T>
{
self.components.get(entity).ok().map(|(_, c)| c.get())
}
/// Reads `T` on a single entity.
///
/// Does not trigger reactions.
///
/// Panics if the inner query doesn't have exactly one entity.
pub fn single(&self) -> (Entity, &T)
{
let (e, x) = self.components.single();
(e, x.get())
}
/// Gets a mutable reference to `T` on `entity`.
///
/// Triggers mutation reactions.
pub fn get_mut(&mut self, c: &mut Commands, entity: Entity) -> Option<&mut T>
{
let (_, x) = self.components.get_mut(entity).ok()?;
Some(x.into_inner().get_mut(c))
}
/// Gets a mutable reference to `T` on a single entity.
///
/// Triggers mutation reactions.
///
/// Panics if the inner query doesn't have exactly one entity.
pub fn single_mut(&mut self, c: &mut Commands) -> (Entity, &mut T)
{
let (e, x) = self.components.single_mut();
(e, x.into_inner().get_mut(c))
}
/// Gets a mutable reference to `T` on `entity`.
///
/// Does not trigger reactions.
pub fn get_noreact(&mut self, entity: Entity) -> Option<&mut T>
{
let (_, x) = self.components.get_mut(entity).ok()?;
Some(x.into_inner().get_noreact())
}
/// Gets a mutable reference to `T` on a single entity
///
/// Does not trigger reactions.
///
/// Panics if the inner query doesn't have exactly one entity.
pub fn single_noreact(&mut self) -> (Entity, &mut T)
{
let (e, x) = self.components.single_mut();
(e, x.into_inner().get_noreact())
}
/// Sets a new value on the specified entity if it would change.
///
/// Returns the previous value if changed.
pub fn set_if_neq(&mut self, c: &mut Commands, entity: Entity, new: T) -> Option<T>
where
T: PartialEq
{
let (_, mut x) = self.components.get_mut(entity).ok()?;
(*x).set_if_neq(c, new)
}
/// Sets a new value on a single entity if it would change.
///
/// Returns the previous value if changed.
///
/// Panics if the inner query doesn't have exactly one entity.
pub fn set_single_if_not_eq(&mut self, c: &mut Commands, new: T) -> (Entity, Option<T>)
where
T: PartialEq
{
let (e, mut x) = self.components.single_mut();
(e, (*x).set_if_neq(c, new))
}
}
//-------------------------------------------------------------------------------------------------------------------