Struct bevy_cobweb::react::React

pub struct React<C: ReactComponent> { /* private fields */ }

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());.

Implementations

impl<C: ReactComponent> React<C>

pub fn get(&self) -> &C

Immutably accesses the component.

pub fn get_mut<'a>(&'a mut self, c: &mut Commands<'_, '_>) -> &'a mut C

Mutably accesses the component and triggers reactions.

pub fn get_noreact(&mut self) -> &mut C

Mutably accesses the component without triggering reactions.

pub fn set_if_neq(&mut self, c: &mut Commands<'_, '_>, new: C) -> Option<C>

where C: PartialEq,

Sets the component value and triggers mutations only if the value will change.

Returns the previous value if it changed.

pub fn take(self) -> C

Unwrap the React.

Trait Implementations

impl<C: ReactComponent> Component for React<C>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl<C: ReactComponent> Deref for React<C>

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &C

Dereferences the value.