Constructor. Take an optional GameConfig, and initialise all generic/abstractable aspects of the Game
the optional GameConfig
Audio manager for adding and playing sounds
HTML Canvas
Abstract reference to the current 2D or 3D State, to be type narrowed by the subclass
Generic mapping of Game Data, useful for storing and retrieving arbitrary global data at Game runtime
Internal-use DebugData for tracking certain game statistics while in Debug Mode
Debug Mode, as potentially set by the GameConfig
Default GameConfig fallback values for various configuration options
Frame time step, calculated during run()
Reference to the potential GameConfig init() method
InputManager
Time of the last frame, set during run()
Renderer
Abstract mapping of 2D or 3D States, to be type narrowed by the subclass
Abstract mapping of 2D or 3D Systems, to be type narrowed by the subclass
Abstract 2D or 3D Text; to be type narrowed by the subclass
Abstract 2D or 3D UI; to be type narrowed by the subclass
Abstract 2D or 3D World; to be type narrowed by the subclass
Abstract single 2D or 3D State addition; to be implemented and type narrowed by the subclass
the 2D or 3D State to add
Abstract multi 2D or 3D State addition; to be implemented and type narrowed by the subclass
the 2D or 3D States to add
Delete some arbitrary generic Game Data by key
the key of the Data to delete
Destroy the game [WIP]
Abstract State end routine, to be implemented by the subclass for type safety in State end methods
Retrieve the value of some arbitrary generic Game Data by key
Throws an error if there's no data by the given key
the type of the Data being retrieved
the key of the Data to retrieve
the retrieved Data
Abstract system retrieval method; to be implemented and type narrowed by the subclass
the name of the system to retrieve
the retrieved system
Check if the Game has a named System
the name of the System to check
whether or not the Game has the named System
Check if the Game has a list of named Systems
the names of the Systems to check
whether or not the Game has all of the named Systems
Abstract State initialization routine, to be implemented by the subclass for type safety in State initialization methods
Create a given ShaderProgram, making it available for use in Entity Shader Components
All ShaderPrograms to be used by the application should be registered before execution is begun with start()
the ShaderProgram to register
Remove a single System by name
the name of the System to remove
Remvove a list of Systems by name
the names of the Systems to remove
Set the value of some arbitrary generic Game Data
the key for the Data
the value for the Data
Begin game executon by calling the optional GameConfig init(), switching to the named State, and finally executing the main loop
the name of the State to start with
Switch to the named State
Ends the current State, then initializes the new State before switching for frame updates
Throws an error if the desired State is not found for runtime safety
the name of the State to switch to
Abstract frame update routine; to be implemented by the subclass for type safety on core construct update routines
Abstract core Game; implementing the abstractable behavior for the operation of both 2D and 3D Games
Broken down into concrete 2D and 3D variants, providing domain-specific behavior and type safety for Aura2D and Aura3D respectively
Games operate on the Entity-Component-System architecture, and make use of States (analogous to Scenes) for runtime functionality
This abstract Game centralises EntityManagement by weay of the World, Text and UI management utilities, as well as update and rendering
Game execution begins when
start()is called upon a Game instance, providing the name of a registered State to switch to