Struct ReflectResource

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

Available on crate feature bevy_reflect only.

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

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

Implementations

impl ReflectResource

pub fn insert( &self, world: &mut World, resource: &dyn Reflect, registry: &TypeRegistry, )

Insert a reflected Resource into the world like insert().

pub fn apply(&self, world: &mut World, resource: &dyn Reflect)

Uses reflection to set the value of this Resource type in the world to the given value.

Panics

Panics if there is no Resource of the given type.

pub fn apply_or_insert( &self, world: &mut World, resource: &dyn Reflect, registry: &TypeRegistry, )

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

pub fn remove(&self, world: &mut World)

Removes this Resource type from the world. Does nothing if it doesn’t exist.

pub fn reflect<'a>(&self, world: &'a World) -> Option<&'a dyn Reflect>

Gets the value of this Resource type from the world as a reflected reference.

pub fn reflect_mut<'a>( &self, world: &'a mut World, ) -> Option<Mut<'a, dyn Reflect>>

Gets the value of this Resource type from the world as a mutable reflected reference.

pub unsafe fn reflect_unchecked_mut<'w>( &self, world: UnsafeWorldCell<'w>, ) -> Option<Mut<'w, 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 an UnsafeWorldCell which can be used to mutably access the resource.
• Don’t call this method more than once in the same scope for a given Resource.

pub fn copy( &self, source_world: &World, destination_world: &mut World, registry: &TypeRegistry, )

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

Panics

Panics if there is no Resource of the given type.

pub fn new(&self, fns: ReflectResourceFns) -> Self

Create a custom implementation of ReflectResource.

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(Resource)] component to generate a ReflectResource implementation automatically.

See ReflectResourceFns for more information.

pub fn fn_pointers(&self) -> &ReflectResourceFns

The underlying function pointers implementing methods on ReflectResource.

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

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

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

Trait Implementations

impl Clone for ReflectResource

fn clone(&self) -> ReflectResource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Resource + FromReflect> FromType<R> for ReflectResource

fn from_type() -> Self