Struct bevy_ecs::reflect::ReflectResource
source · pub struct ReflectResource(/* private fields */);
Expand description
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§
source§impl ReflectResource
impl ReflectResource
sourcepub fn insert(
&self,
world: &mut World,
resource: &dyn Reflect,
registry: &TypeRegistry
)
pub fn insert( &self, world: &mut World, resource: &dyn Reflect, registry: &TypeRegistry )
sourcepub fn apply_or_insert(
&self,
world: &mut World,
resource: &dyn Reflect,
registry: &TypeRegistry
)
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.
sourcepub fn remove(&self, world: &mut World)
pub fn remove(&self, world: &mut World)
Removes this Resource
type from the world. Does nothing if it doesn’t exist.
sourcepub fn reflect<'a>(&self, world: &'a World) -> Option<&'a dyn Reflect>
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.
sourcepub fn reflect_mut<'a>(
&self,
world: &'a mut World
) -> Option<Mut<'a, dyn Reflect>>
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.
sourcepub unsafe fn reflect_unchecked_mut<'w>(
&self,
world: UnsafeWorldCell<'w>
) -> Option<Mut<'w, dyn Reflect>>
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
.
sourcepub fn copy(
&self,
source_world: &World,
destination_world: &mut World,
registry: &TypeRegistry
)
pub fn copy( &self, source_world: &World, destination_world: &mut World, registry: &TypeRegistry )
sourcepub fn new(&self, fns: ReflectResourceFns) -> Self
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.
sourcepub fn fn_pointers(&self) -> &ReflectResourceFns
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§
source§impl Clone for ReflectResource
impl Clone for ReflectResource
source§fn clone(&self) -> ReflectResource
fn clone(&self) -> ReflectResource
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<R: Resource + FromReflect> FromType<R> for ReflectResource
impl<R: Resource + FromReflect> FromType<R> for ReflectResource
Auto Trait Implementations§
impl Freeze for ReflectResource
impl RefUnwindSafe for ReflectResource
impl Send for ReflectResource
impl Sync for ReflectResource
impl Unpin for ReflectResource
impl UnwindSafe for ReflectResource
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.