Struct bones_framework::lib::prelude::ResetWorld

pub struct ResetWorld {
    pub reset: bool,
    pub reset_resources: UntypedResourceSet,
}

Resource that allows user to trigger a reset of world, clearing entities, components, and resources. This is supported in bone’s default session runners - but if implementing custom runner, must call world.handle_world_reset inside step.

reset_world: ResMutInit<ResetWorld> and setting reset_world.reset = true; may be used to trigger a reset from system execution.

Fields

reset: bool

Set to true to trigger reset of World.

reset_resources: UntypedResourceSet

List of resources that will be inserted into World after the resources are reset, before startup systems are executed. These override any startup resources captured during session build. If want to preserve a resource instead of having it reset, insert it here.

Implementations

impl ResetWorld

pub fn insert_reset_resource<T>(&mut self, resource: T)

where T: HasSchema,

Insert a resource that will be applied after reset. If resource was created on session iniialization, this will overwrite it using reset resource instead.

pub fn reset_resource_mut<T>(&self) -> Option<RefMut<'_, T>>

where T: HasSchema,

Get a mutable reference to a reset resource if found.

pub fn insert_empty_reset_resource<T>(&mut self)

where T: HasSchema,

Insert resource in “empty” state - If resource was created on session iniialization, instead of being reset to that state, after reset this resource will not be on World.

Trait Implementations

impl Clone for ResetWorld

fn clone(&self) -> ResetWorld

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ResetWorld

fn default() -> ResetWorld

Returns the “default value” for a type.

impl HasSchema for ResetWorld

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut