Struct BehaviorSet 

pub struct BehaviorSet<H: Host> { /* private fields */ }

Collects Behaviors and invokes them.

Note: This type is public out of necessity because it is revealed elsewhere, but its details are currently subject to change.

To modify the set, use a BehaviorSetTransaction.

Serialization stability warning

This type implements serde::Serialize and serde::Deserialize, but serialization support is still experimental (as is the game data model in general). We do not guarantee that future versions of all-is-cubes will be able to deserialize data which is serialized by this version.

Additionally, the serialization schema is designed with serde_json in mind. It is not guaranteed that using a different data format crate, which may use a different subset of the information exposed via serde::Serialize, will produce stable results.

Implementations

impl<H: Host> BehaviorSet<H>

pub fn new() -> Self

Constructs an empty BehaviorSet.

pub fn query<T: Behavior<H>>( &self, ) -> impl Iterator<Item = QueryItem<'_, H, T>> + '_

Find behaviors of a specified type.

The behaviors will be returned in a deterministic order. In the current implementation, that order is the order in which they were added.

TODO: Allow querying by attachment details (spatial, etc)

pub fn query_any<'a>( &'a self, type_filter: Option<TypeId>, ) -> impl Iterator<Item = QueryItem<'a, H, dyn Behavior<H> + 'static>> + 'a

Find behaviors by filter criteria. All Nones mean “anything”.

The behaviors will be returned in a deterministic order. In the current implementation, that order is the order in which they were added.

TODO: Allow querying by attachment details (spatial, etc)

Trait Implementations

impl<H: Host> Clone for BehaviorSet<H>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<H: Host> Component for BehaviorSet<H>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

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

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl<H: Host> Debug for BehaviorSet<H>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<H: Host> Default for BehaviorSet<H>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, H> Deserialize<'de> for BehaviorSet<H>

where H: Host<Attachment: DeserializeOwned>,

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<H> Serialize for BehaviorSet<H>

where H: Host<Attachment: Serialize>,

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<H: Host> Transactional for BehaviorSet<H>

type Transaction = BehaviorSetTransaction<H>

The type of transaction which should be used with Self.

fn transact<'c, F, O>( &mut self, f: F, ) -> Result<O, ExecuteError<Self::Transaction>>

where F: FnOnce(&mut Self::Transaction, &Self) -> Result<O, <Self::Transaction as Merge>::Conflict>, Self::Transaction: Transaction<Target = Self, Context<'c> = (), Output = NoOutput> + Default,

Convenience method for building and then applying a transaction to self, equivalent to the following steps:

impl<H: Host> VisitHandles for BehaviorSet<H>

fn visit_handles(&self, visitor: &mut dyn HandleVisitor)

For each Handle contained within self that is reachable without traversing another Handle, call visitor with a reference to it.