Struct GameControl

pub struct GameControl { /* private fields */ }

Main context, for controlling the game while it is running. You don’t normally need to create this yourself as Gameloop::new() does this for you, but it can be useful to create this directly if you need to run automated tests.

Implementations

impl GameControl

pub fn new_headless(gameinfo: &GameInfo) -> Result<GameControl, InitError>

Creates a GameControl in a headless configuration, allowing you to run automated tests, validation, or other processes without needing a gameloop, window, renderer, or audio.

pub fn input(&self) -> &Input

Retrieves the Input object for reading player input such as keyboard, mouse, and gamepad.

pub fn input_mut(&mut self) -> &mut Input

Retrieves the Input object mutably for changing input bindings and deadzones

pub fn renderer(&self) -> &Renderer

Retrieves the Renderer object to read various parameters for the renderer window

pub fn renderer_mut(&mut self) -> &mut Renderer

Retrieves the Renderer object mutably to change various parameters for the renderer window

pub fn audio(&self) -> &Box<dyn Audio>

Retrieves the Audio object for reading information about audio playback

pub fn audio_mut(&mut self) -> &mut Box<dyn Audio>

Retrieves the Audio object mutably to control audio playback

pub fn source_manager(&self) -> Rc<RefCell<SourceManager>>

Retrieves the SourceManager for registering and querying data Sources

pub fn res(&self) -> &DataMultistore

Retrieves the DataMultistore for accessing data resources

pub fn singleton_mut<T: 'static + GameSingleton + Default>(&mut self) -> &mut T

Retrieves the GameSingleton of the current type mutably. If it has not been created yet, it will be Default-constructed.

pub fn target_framerate(&self) -> f64

Returns the framerate that game logic is synchronized to, in frames per second

pub fn set_target_framerate(&mut self, new_framerate: f64)

Sets the framerate that game logic is synchronized to, in frames per second

pub fn frame_interpolation(&self) -> FrameInterpolationMode

Returns the mode to use for interpolating frames in the renderer.

pub fn set_frame_interpolation(&mut self, mode: FrameInterpolationMode)

Sets the mode to use for interpolating frames in the renderer.

pub fn frame_interpolation_cap(&self) -> FrameInterpolationCap

Returns the framerate cap mode for when frame interpolation is enabled.

pub fn set_frame_interpolation_cap(&mut self, cap: FrameInterpolationCap)

Sets the framerate cap mode for when frame interpolation is enabled.

pub fn frame_interpolation_pacing(&self) -> FrameInterpolationPacing

Returns the framerate pacing mode for when frame interpolation is enabled.

pub fn set_frame_interpolation_pacing( &mut self, pacing: FrameInterpolationPacing, )

Sets the framerate pacing mode for when frame interpolation is enabled.

pub fn frame_interpolation_active(&self) -> bool

Returns true if frame interpolation is currently active. For the automatic mode, returns true if the refresh rate of the window’s current monitor does not match with the target logic framerate.

pub fn console_history(&self) -> MutexGuard<'_, ConsoleHistory>

Retrieves the ConsoleHistory object, which is useful for implementing an in-game console window

pub fn stats(&self) -> &GameStats

Retrieves the GameStats object, which contains timing statistics

pub fn goto_new_scene<T: SceneType + 'static>(&mut self)

Switches the game to a new scene of the given SceneType after the current frame is done. Doing this will perform automatic unloading of unused data resources (ones without an active crate::datapack::DataHandle or crate::datapack::PackageUseToken) if it is configured to do so via the GameInfo passed in during creation of the Gameloop or GameControl.

pub fn quit(&mut self)

Leaves the main gameloop. This usually means closing the game.