Struct EntityAttributes 

pub struct EntityAttributes { /* private fields */ }

The attributes of a Living Entity.

Implementations

impl EntityAttributes

pub fn new() -> Self

Creates a new instance of EntityAttributes.

pub fn get( &self, attribute: EntityAttribute, ) -> Option<&EntityAttributeInstance>

Gets the instance of an attribute.

pub fn get_base_value(&self, attribute: EntityAttribute) -> Option<f64>

Gets the base value of an attribute.

Returns None if the attribute does not exist.

pub fn get_compute_value(&self, attribute: EntityAttribute) -> Option<f64>

Gets the computed value of an attribute.

Returns None if the attribute does not exist.

pub fn has_attribute(&self, attribute: EntityAttribute) -> bool

Checks if an attribute exists.

pub fn create_attribute(&mut self, attribute: EntityAttribute)

Creates an attribute if it does not exist.

pub fn set_base_value(&mut self, attribute: EntityAttribute, value: f64)

Sets the base value of an attribute.

pub fn set_add_modifier( &mut self, attribute: EntityAttribute, id: &str, modifier: f64, )

Sets an add modifier of an attribute.

pub fn set_multiply_base_modifier( &mut self, attribute: EntityAttribute, id: &str, modifier: f64, )

Sets a multiply base modifier of an attribute.

pub fn set_multiply_total_modifier( &mut self, attribute: EntityAttribute, id: &str, modifier: f64, )

Sets a multiply total modifier of an attribute.

pub fn set_modifier<S: Into<String>>( &mut self, attribute: EntityAttribute, id: S, modifier: f64, operation: EntityAttributeOperation, )

Sets a value modifier of an attribute based on the operation.

pub fn remove_modifier<S: Into<String>>( &mut self, attribute: EntityAttribute, id: S, )

Removes a modifier of an attribute.

pub fn clear_modifiers(&mut self, attribute: EntityAttribute)

Clears all modifiers of an attribute.

pub fn has_modifier<S: Into<String>>( &self, attribute: EntityAttribute, id: S, ) -> bool

Checks if a modifier exists on an attribute.

pub fn to_properties(&self) -> Vec<AttributeProperty<'_>>

For internal use only.

Converts to a Vec of AttributePropertys.

Trait Implementations

impl Clone for EntityAttributes

fn clone(&self) -> EntityAttributes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for EntityAttributes

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, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

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 relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

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_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [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 Debug for EntityAttributes

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

Formats the value using the given formatter.

impl Default for EntityAttributes

fn default() -> EntityAttributes

Returns the “default value” for a type.

impl PartialEq for EntityAttributes

fn eq(&self, other: &EntityAttributes) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EntityAttributes