Struct bevy::ecs::prelude::ReflectComponent

pub struct ReflectComponent(/* private fields */);

A struct used to operate on reflected Component of a type.

A ReflectComponent for type T can be obtained via bevy_reflect::TypeRegistration::data.

Implementations

impl ReflectComponent

pub fn from_world(&self, world: &mut World) -> Box<dyn Reflect, Global>

Constructs default reflected Component from world using from_world().

pub fn insert( &self, entity: &mut EntityWorldMut<'_>, component: &(dyn Reflect + 'static) )

Insert a reflected Component into the entity like insert().

pub fn apply( &self, entity: &mut EntityWorldMut<'_>, component: &(dyn Reflect + 'static) )

Uses reflection to set the value of this Component type in the entity to the given value.

Panics

Panics if there is no Component of the given type.

pub fn apply_or_insert( &self, entity: &mut EntityWorldMut<'_>, component: &(dyn Reflect + 'static) )

Uses reflection to set the value of this Component type in the entity to the given value or insert a new one if it does not exist.

pub fn remove(&self, entity: &mut EntityWorldMut<'_>)

Removes this Component type from the entity. Does nothing if it doesn’t exist.

pub fn contains(&self, entity: EntityRef<'_>) -> bool

Returns whether entity contains this Component

pub fn reflect<'a>( &self, entity: EntityRef<'a> ) -> Option<&'a (dyn Reflect + 'static)>

Gets the value of this Component type from the entity as a reflected reference.

pub fn reflect_mut<'a>( &self, entity: &'a mut EntityWorldMut<'_> ) -> Option<Mut<'a, dyn Reflect>>

Gets the value of this Component type from the entity as a mutable reflected reference.

pub unsafe fn reflect_unchecked_mut<'a>( &self, entity: UnsafeEntityCell<'a> ) -> Option<Mut<'a, dyn Reflect>>

Safety

This method does not prevent you from having two mutable pointers to the same data, violating Rust’s aliasing rules. To avoid this:

• Only call this method with a UnsafeEntityCell that may be used to mutably access the component on the entity entity
• Don’t call this method more than once in the same scope for a given Component.

pub fn copy( &self, source_world: &World, destination_world: &mut World, source_entity: Entity, destination_entity: Entity )

Gets the value of this Component type from entity from source_world and applies it to the value of this Component type in entity in destination_world.

Panics

Panics if there is no Component of the given type or either entity does not exist.

pub fn new(fns: ReflectComponentFns) -> ReflectComponent

Create a custom implementation of ReflectComponent.

This is an advanced feature, useful for scripting implementations, that should not be used by most users unless you know what you are doing.

Usually you should derive Reflect and add the #[reflect(Component)] component to generate a ReflectComponent implementation automatically.

See ReflectComponentFns for more information.

pub fn fn_pointers(&self) -> &ReflectComponentFns

The underlying function pointers implementing methods on ReflectComponent.

This is useful when you want to keep track locally of an individual function pointer.

Calling TypeRegistry::get followed by TypeRegistration::data::<ReflectComponent> can be costly if done several times per frame. Consider cloning ReflectComponent and keeping it between frames, cloning a ReflectComponent is very cheap.

If you only need a subset of the methods on ReflectComponent, use fn_pointers to get the underlying ReflectComponentFns and copy the subset of function pointers you care about.

Trait Implementations

impl Clone for ReflectComponent

fn clone(&self) -> ReflectComponent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> FromType<C> for ReflectComponentwhere C: Component + Reflect + FromWorld,

fn from_type() -> ReflectComponent