Struct WorldInstanceSpawner 

pub struct WorldInstanceSpawner { /* private fields */ }

Handles spawning and despawning world instances, either synchronously or batched through the world_instance_spawner_system.

Synchronous methods: (WorldAsset operations will take effect immediately)

• spawn_sync
• spawn_dynamic_sync
• despawn_sync
• despawn_dynamic_sync
• despawn_instance_sync
• update_spawned_instances
• update_spawned_dynamic_worlds
• spawn_queued_instances
• despawn_queued_world_asset_instances
• despawn_queued_dynamic_world_instances

Deferred methods: (WorldAsset operations will be processed when the world_instance_spawner_system is run)

• spawn_dynamic
• spawn_dynamic_as_child
• spawn
• spawn_as_child
• despawn
• despawn_dynamic
• despawn_instance

Implementations

impl WorldInstanceSpawner

pub fn spawn_dynamic( &mut self, id: impl Into<Handle<DynamicWorld>>, ) -> InstanceId

Schedule the spawn of a new instance of the provided dynamic world.

pub fn spawn_dynamic_as_child( &mut self, id: impl Into<Handle<DynamicWorld>>, parent: Entity, ) -> InstanceId

Schedule the spawn of a new instance of the provided dynamic world as a child of parent.

pub fn spawn(&mut self, id: impl Into<Handle<WorldAsset>>) -> InstanceId

Schedule the spawn of a new instance of the provided world asset.

pub fn spawn_as_child( &mut self, id: impl Into<Handle<WorldAsset>>, parent: Entity, ) -> InstanceId

Schedule the spawn of a new instance of the provided world asset as a child of parent.

pub fn despawn(&mut self, id: impl Into<AssetId<WorldAsset>>)

Schedule the despawn of all instances of the provided world asset.

pub fn despawn_dynamic(&mut self, id: impl Into<AssetId<DynamicWorld>>)

Schedule the despawn of all instances of the provided dynamic world.

pub fn despawn_instance(&mut self, instance_id: InstanceId)

Schedule the despawn of a world asset instance, removing all its entities from the world.

Note: this will despawn all entities associated with this instance, including those that have been removed from the hierarchy. To despawn only entities still in the hierarchy, despawn the relevant root entity directly.

pub fn unregister_instance(&mut self, instance_id: InstanceId)

This will remove all records of this instance, without despawning any entities.

pub fn despawn_sync( &mut self, world: &mut World, id: impl Into<AssetId<WorldAsset>>, ) -> Result<(), WorldInstanceSpawnError>

Immediately despawns all instances of a world asset.

pub fn despawn_dynamic_sync( &mut self, world: &mut World, id: impl Into<AssetId<DynamicWorld>>, ) -> Result<(), WorldInstanceSpawnError>

Immediately despawns all instances of a dynamic world.

pub fn despawn_instance_sync( &mut self, world: &mut World, instance_id: &InstanceId, )

Immediately despawns a world asset instance, removing all its entities from the world.

pub fn spawn_dynamic_sync( &mut self, world: &mut World, id: impl Into<AssetId<DynamicWorld>>, ) -> Result<InstanceId, WorldInstanceSpawnError>

Immediately spawns a new instance of the provided dynamic world.

pub fn spawn_sync( &mut self, world: &mut World, id: impl Into<AssetId<WorldAsset>>, ) -> Result<InstanceId, WorldInstanceSpawnError>

Immediately spawns a new instance of the provided world asset.

pub fn update_spawned_instances( &mut self, world: &mut World, world_asset_ids: &[AssetId<WorldAsset>], ) -> Result<(), WorldInstanceSpawnError>

Iterate through all instances of the provided worlds and update those immediately.

Useful for updating already spawned world asset instances after their corresponding world asset has been modified.

pub fn update_spawned_dynamic_worlds( &mut self, world: &mut World, dynamic_world_ids: &[AssetId<DynamicWorld>], ) -> Result<(), WorldInstanceSpawnError>

Iterate through all instances of the provided dynamic worlds and update those immediately.

Useful for updating already spawned world asset instances after their corresponding dynamic world has been modified.

pub fn despawn_queued_world_asset_instances( &mut self, world: &mut World, ) -> Result<(), WorldInstanceSpawnError>

Immediately despawns all instances scheduled for despawn by despawning their instances.

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

Immediately despawns all world asset instances scheduled for despawn.

pub fn spawn_queued_instances( &mut self, world: &mut World, ) -> Result<(), WorldInstanceSpawnError>

Immediately spawns all instances scheduled for spawn.

pub fn instance_is_ready(&self, instance_id: InstanceId) -> bool

Check that a world asset instance spawned previously is ready to use

pub fn iter_instance_entities( &self, instance_id: InstanceId, ) -> impl Iterator<Item = Entity>

Get an iterator over the entities in an instance, once it’s spawned.

Before the world asset is spawned, the iterator will be empty. Use Self::instance_is_ready to check if the instance is ready.

Trait Implementations

impl Component for WorldInstanceSpawner

where WorldInstanceSpawner: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

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<WorldInstanceSpawner>>

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 Default for WorldInstanceSpawner

fn default() -> WorldInstanceSpawner

Returns the “default value” for a type.

impl Resource for WorldInstanceSpawner

where WorldInstanceSpawner: Send + Sync + 'static,