Struct bones_framework::lib::prelude::Game

pub struct Game {
    pub sessions: Sessions,
    pub systems: GameSystems,
    pub sorted_session_keys: Vec<Ustr>,
    pub shared_resources: Vec<Arc<UntypedResource>>,
}

The Game encompasses a complete bones game’s logic, independent of the renderer and IO implementations.

Games are made up of one or more Sessions, each of which contains it’s own World and SystemStages. These different sessions can be used for parts of the game with independent states, such as the main menu and the gameplay.

Fields

sessions: Sessions

The sessions that make up the game.

systems: GameSystems

The collection of systems that are associated to the game itself, and not a specific session.

sorted_session_keys: Vec<Ustr>

List of sorted session keys.

These are only guaranteed to be sorted and up-to-date immediately after calling Game::step().

shared_resources: Vec<Arc<UntypedResource>>

Collection of resources that will have a shared instance of each be inserted into each session automatically.

Implementations

impl Game

pub fn new() -> Game

Create an empty game with an asset server.

pub fn install_plugin<P>(&mut self, plugin: P) -> &mut Game

where P: GamePlugin,

Install a GamePlugin.

pub fn shared_resource<T>(&self) -> Option<Ref<'_, T>>

where T: HasSchema,

Get the shared resource of a given type out of this Games shared resources.

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

where T: HasSchema,

Get the shared resource of a given type out of this Games shared resources.

pub fn shared_resource_cell<T>(&self) -> Option<AtomicResource<T>>

where T: HasSchema,

Get the shared resource cell of a given type out of this Games shared resources.

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

where T: HasSchema + Default,

Initialize a resource that will be shared across game sessions using it’s Default value if it is not already initialized, and borrow it for modification.

pub fn insert_shared_resource<T>(&mut self, resource: T)

where T: HasSchema,

Insert a resource that will be shared across all game sessions.

Note: This resource will only be visible in sessions that have not already initialized or access a resource of the same type locally.

pub fn step(&mut self, now: Instant)

Step the game simulation.

Trait Implementations

impl Default for Game

fn default() -> Game

Returns the “default value” for a type.