Struct bevy_app::ScheduleRunnerPlugin
source · pub struct ScheduleRunnerPlugin {
pub run_mode: RunMode,
}
Expand description
Configures an App
to run its Schedule
according to a given
RunMode
.
ScheduleRunnerPlugin
is included in the
MinimalPlugins
plugin group.
ScheduleRunnerPlugin
is not included in the
DefaultPlugins
plugin group
which assumes that the Schedule
will be executed by other means:
typically, the winit
event loop
(see WinitPlugin
)
executes the schedule making ScheduleRunnerPlugin
unnecessary.
Fields§
§run_mode: RunMode
Determines whether the Schedule
is run once or repeatedly.
Implementations§
source§impl ScheduleRunnerPlugin
impl ScheduleRunnerPlugin
sourcepub fn run_once() -> Self
pub fn run_once() -> Self
See RunMode::Once
.
sourcepub fn run_loop(wait_duration: Duration) -> Self
pub fn run_loop(wait_duration: Duration) -> Self
See RunMode::Loop
.
Trait Implementations§
source§impl Default for ScheduleRunnerPlugin
impl Default for ScheduleRunnerPlugin
source§fn default() -> ScheduleRunnerPlugin
fn default() -> ScheduleRunnerPlugin
Returns the “default value” for a type. Read more
source§impl Plugin for ScheduleRunnerPlugin
impl Plugin for ScheduleRunnerPlugin
source§fn ready(&self, _app: &App) -> bool
fn ready(&self, _app: &App) -> bool
Has the plugin finished its setup? This can be useful for plugins that need something
asynchronous to happen before they can finish their setup, like the initialization of a renderer.
Once the plugin is ready,
finish
should be called.source§fn finish(&self, _app: &mut App)
fn finish(&self, _app: &mut App)
Finish adding this plugin to the
App
, once all plugins registered are ready. This can
be useful for plugins that depends on another plugin asynchronous setup, like the renderer.source§fn cleanup(&self, _app: &mut App)
fn cleanup(&self, _app: &mut App)
Runs after all plugins are built and finished, but before the app schedule is executed.
This can be useful if you have some resource that other plugins need during their build step,
but after build you want to remove it and send it to another thread.
Auto Trait Implementations§
impl Freeze for ScheduleRunnerPlugin
impl RefUnwindSafe for ScheduleRunnerPlugin
impl Send for ScheduleRunnerPlugin
impl Sync for ScheduleRunnerPlugin
impl Unpin for ScheduleRunnerPlugin
impl UnwindSafe for ScheduleRunnerPlugin
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
Mutably borrows from an owned value. Read more
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>
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>
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)
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)
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
impl<T> DowncastSync for T
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given World
.