Struct bones_framework::lib::SessionBuilder

pub struct SessionBuilder {
    pub name: Ustr,
    pub stages: SystemStagesBuilder,
    pub active: bool,
    pub visible: bool,
    pub priority: i32,
    pub runner: Box<dyn SessionRunner>,
    /* private fields */
}

Builder type used to create Session. If using this directly (as opposed to Sessions::create_with), it is important to rember to finish session and add to Sessions with SessionBuilder::finish_and_add.

Fields

name: Ustr

Name of session

stages: SystemStagesBuilder

System stage builder

active: bool

Whether or not this session should have it’s systems run.

visible: bool

Whether or not this session should be rendered.

priority: i32

The priority of this session relative to other sessions in the Game.

runner: Box<dyn SessionRunner>

The session runner to use for this session.

Implementations

impl SessionBuilder

pub fn new<N>(name: N) -> SessionBuilder

where N: TryInto<Ustr>, <N as TryInto<Ustr>>::Error: Debug,

Create a new SessionBuilder. Be sure to add it to Sessions when finished, with SessionBuilder::finish_and_add, or Sessions::create.

Panics

Panics if the name.try_into() cannot convert into Ustr.

pub fn from_existing_session<N>(name: N, session: Session) -> SessionBuilder

where N: TryInto<Ustr>, <N as TryInto<Ustr>>::Error: Debug,

Create a SessionBuilder to match existing Session, consuming it. This is useful if a GamePlugin wishes to modify a session created by another plugin. The builder is initialized with settings from session, can be further modified, and then added to session to replace existing.

pub fn stages(&mut self) -> &mut SystemStagesBuilder

Get the SystemStagesBuilder (though the stage build functions are also on SessionBuilder for convenience).

pub fn set_active(&mut self, active: bool) -> &mut SessionBuilder

Whether or not session should run systems.

pub fn set_visible(&mut self, visible: bool) -> &mut SessionBuilder

Whether or not session should be rendered.

pub fn set_priority(&mut self, priority: i32) -> &mut SessionBuilder

The priority of this session relative to other sessions in the Game.

pub fn insert_resource<T>(&mut self, resource: T) -> &mut SessionBuilder

where T: HasSchema,

Insert a resource.

Note: The resource is not actually initialized in World until first step of SystemStages. To mutate or inspect a resource inserted by another SessionPlugin during session build, use SessionBuilder::resource_mut.

pub fn init_resource<T>(&mut self) -> RefMut<'_, T>

where T: HasSchema + Default,

Insert a resource using default value (if not found). Returns a mutable ref for modification.

Note: The resource is not actually initialized in World until first step of SystemStages. To mutate or inspect a resource inserted by another SessionPlugin during session build, use SessionBuilder::resource_mut.

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

where T: HasSchema,

Get mutable reference to a resource if it exists.

pub fn add_startup_system<Args, S>(&mut self, system: S) -> &mut SessionBuilder

where S: IntoSystem<Args, (), (), Sys = StaticSystem<(), ()>>,

Add a system that will run only once, before all of the other non-startup systems. If wish to reset startup systems during gameplay and run again, can modify SessionStarted resource in world.

pub fn add_single_success_system<Args, S>( &mut self, system: S, ) -> &mut SessionBuilder

where S: IntoSystem<Args, (), Option<()>, Sys = StaticSystem<(), Option<()>>>,

Add a system that will run each frame until it succeeds (returns Some). Runs before all stages. Uses Option to allow for easy usage of ?.

pub fn add_system_to_stage<Args, S>( &mut self, label: impl StageLabel, system: S, ) -> &mut SessionBuilder

where S: IntoSystem<Args, (), (), Sys = StaticSystem<(), ()>>,

Add a System to the stage with the given label.

pub fn insert_stage_before<L, S>( &mut self, label: L, stage: S, ) -> &mut SessionBuilder

where L: StageLabel, S: SystemStage + 'static,

Insert a new stage, before another existing stage

pub fn insert_stage_after<L, S>( &mut self, label: L, stage: S, ) -> &mut SessionBuilder

where L: StageLabel, S: SystemStage + 'static,

Insert a new stage, after another existing stage

pub fn set_session_runner(&mut self, runner: Box<dyn SessionRunner>)

Set the session runner for this session.

pub fn install_plugin( &mut self, plugin: impl SessionPlugin, ) -> &mut SessionBuilder

Install a plugin.

pub fn finish_and_add(self, sessions: &mut Sessions) -> &mut Session

Finalize and add to Sessions.

Alternatively, you may directly pass a SessionBuilder to Sessions::create to add and finalize.