Struct EntityAttributeInstance 

pub struct EntityAttributeInstance { /* private fields */ }

An instance of an Entity Attribute.

Implementations

impl EntityAttributeInstance

pub fn new(attribute: EntityAttribute) -> Self

Creates a new instance of an Entity Attribute.

pub fn new_with_value(attribute: EntityAttribute, base_value: f64) -> Self

Creates a new instance of an Entity Attribute with a value.

pub fn attribute(&self) -> EntityAttribute

Gets the attribute.

pub fn base_value(&self) -> f64

Gets the base value of the attribute.

pub fn compute_value(&self) -> f64

Gets the computed value of the attribute.

pub fn with_add_modifier(&mut self, id: &str, modifier: f64) -> &mut Self

Sets an add modifier.

If the modifier already exists, it will be overwritten.

Returns a mutable reference to self.

pub fn with_multiply_base_modifier( &mut self, id: &str, modifier: f64, ) -> &mut Self

Sets a multiply base modifier.

If the modifier already exists, it will be overwritten.

Returns a mutable reference to self.

pub fn with_multiply_total_modifier( &mut self, id: &str, modifier: f64, ) -> &mut Self

Sets a multiply total modifier.

If the modifier already exists, it will be overwritten.

Returns a mutable reference to self.

pub fn with_modifier( &mut self, id: &str, modifier: f64, operation: EntityAttributeOperation, ) -> &mut Self

Sets a value modifier based on the operation.

If the modifier already exists, it will be overwritten.

Returns a mutable reference to self.

pub fn remove_modifier(&mut self, id: &String)

Removes a modifier.

pub fn clear_modifiers(&mut self)

Clears all modifiers.

pub fn has_modifier(&self, id: &String) -> bool

Checks if a modifier exists.

Trait Implementations

impl Clone for EntityAttributeInstance

fn clone(&self) -> EntityAttributeInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for EntityAttributeInstance

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 EntityAttributeInstance

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

Formats the value using the given formatter.

impl PartialEq for EntityAttributeInstance

fn eq(&self, other: &EntityAttributeInstance) -> 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 EntityAttributeInstance