Struct bones_framework::prelude::Sessions

pub struct Sessions { /* private fields */ }

Container for multiple game sessions.

Each session shares the same Entities.

Implementations

impl Sessions

pub fn create(&mut self, builder: SessionBuilder) -> &mut Session

Create a new session from SessionBuilder, insert into Sessions, and borrow it mutably so it can be modified. If session with same name already exists, it will be replaced.

pub fn create_with<N>( &mut self, name: N, build_function: impl FnOnce(&mut SessionBuilder), ) -> &mut Session

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

Create a new session from default SessionBuilder, and modify in closure before it is added to Sessions. Then borrow it mutably so it can be modified.

If session with same name already exists, it will be replaced.

pub fn modify_and_replace_existing_session<N>( &mut self, name: N, build_function: impl FnOnce(&mut SessionBuilder), ) -> Option<&mut Session>

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

Replaces an existing session after converting it into a SessionBuilder with same systems, stages, etc. It then is given to build_function to extend or modify it.

WARNING - this is intended to allow a GamePlugin to extend a session created by another plugin during setup. It destroys and re-creates session, and if used during gameplay, could break assumptions around determinism and cause desyncs in network play. The sessions World is not preserved. This is a utility for constructing session, not for runtime mutation.

None is returned if the session with name was not found.

pub fn delete<K>(&mut self, name: K)

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

Delete a session.

pub fn get<K>(&self, name: K) -> Option<&Session>

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

Borrow a session from the sessions list.

pub fn get_mut<K>(&mut self, name: K) -> Option<&mut Session>

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

Borrow a session from the sessions list.

pub fn iter_mut(&mut self) -> IterMut<'_, Ustr, Session>

Mutably iterate over sessions.

pub fn iter(&self) -> Iter<'_, Ustr, Session>

Iterate over sessions.

pub fn add_command( &mut self, command: Box<dyn FnOnce(&mut Sessions) + Send + Sync>, )

Add a SessionCommand to queue.

Trait Implementations

impl Default for Sessions

fn default() -> Sessions

Returns the “default value” for a type.

impl HasSchema for Sessions

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