Struct bevy::prelude::SceneSpawner

source ·
pub struct SceneSpawner { /* private fields */ }
Expand description

Handles spawning and despawning scenes in the world, either synchronously or batched through the scene_spawner_system.

Synchronous methods: (Scene operations will take effect immediately)

Deferred methods: (Scene operations will be processed when the scene_spawner_system is run)

Implementations§

source§

impl SceneSpawner

source

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

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

source

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

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

source

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

Schedule the spawn of a new instance of the provided scene.

source

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

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

source

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

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

source

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

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

source

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

Immediately despawns all instances of a dynamic scene.

source

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

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

source

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

Immediately spawns a new instance of the provided dynamic scene.

source

pub fn spawn_sync( &mut self, world: &mut World, id: AssetId<Scene> ) -> Result<InstanceId, SceneSpawnError>

Immediately spawns a new instance of the provided scene.

source

pub fn update_spawned_scenes( &mut self, world: &mut World, scene_ids: &[AssetId<DynamicScene>] ) -> Result<(), SceneSpawnError>

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

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

source

pub fn despawn_queued_scenes( &mut self, world: &mut World ) -> Result<(), SceneSpawnError>

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

source

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

Immediately despawns all scene instances scheduled for despawn.

source

pub fn spawn_queued_scenes( &mut self, world: &mut World ) -> Result<(), SceneSpawnError>

Immediately spawns all scenes scheduled for spawn.

source

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

Check that an scene instance spawned previously is ready to use

source

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 scene is spawned, the iterator will be empty. Use Self::instance_is_ready to check if the instance is ready.

Trait Implementations§

source§

impl Default for SceneSpawner

source§

fn default() -> SceneSpawner

Returns the “default value” for a type. Read more
source§

impl Resource for SceneSpawner
where SceneSpawner: Send + Sync + 'static,

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

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

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

source§

impl<T> FromWorld for T
where T: Default,

source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,