Automatically provides an Engine instance with a fullscreen-capable window, render loop, input handling, etc. More...

Inheritance diagram for OmegaEngine.GameBase:

Classes
class	GameForm
	An internal Windows Form to use as Engine render target with mouse+keyboard event handling More...

Public Member Functions
virtual void	Run ()
	Shows the window and runs the render loop until Exit is called. More...

void	Exit ()
	Stops the render loop and closes the window More...

void	AddInputReceiver (IInputReceiver receiver)
	Calls InputProvider.AddReceiver for all default InputProviders. More...

void	RemoveInputReceiver (IInputReceiver receiver)
	Calls InputProvider.RemoveReceiver for all default InputProviders. More...

virtual void	Debug ()
	Called when the debug form is to be displayed More...

virtual Lua	NewLua ()
	Creates a new Lua instance with commonly used objects preloaded. More...

void	Dispose ()
	Dispose the Engine, the internal windows form, etc. More...

Static Public Member Functions
static void	Crash ()
	Crashes the game for testing purposes More...

Protected Member Functions
	GameBase (string name, Icon icon=null, Image background=null, bool stretch=false)
	Sets up the Form. Call ToWindowed or ToFullscreen and Run afterwards. More...

void	ToFullscreen ()
	Sets up the System.Windows.Forms.Form for fullscreen display More...

void	ToWindowed (Size size)
	Sets up the System.Windows.Forms.Form for normal windowed (non-fullscreen) mode More...

void	UpdateStatus (string message)
	Updates the current status of the loading process More...

virtual void	Dispose (bool disposing)
	To be called by IDisposable.Dispose and the object destructor. More...

virtual void	ResetEngine ()
	Resets the Engine More...

virtual EngineConfig	BuildEngineConfig (bool fullscreen)
	Called to generate an EngineConfig based on external settings More...

virtual void	ApplyGraphicsSettings ()
	Called when graphics settings from an external source need to be applied to the Engine More...

virtual bool	Initialize ()
	To be called after the window is ready and the Engine needs to be set up More...

virtual void	Render (double elapsedTime)
	Called when the next frame needs to be rendered. More...

Protected Attributes
readonly GameForm	Form
	The internal form used as the Engine render-targets More...

Properties
bool	Disposed `[get]`
	Has the game been shutdown? More...

Engine	Engine `[get]`
	The Engine instance used by the game. Warning! Only set after Control.Show has been called More...

bool	Fullscreen `[get]`
	Is the game in fullscreen mode? More...

bool?	Loading `[get, set]`
	Indicates the game is currently loading something and the user must wait. More...

KeyboardInputProvider	KeyboardInputProvider `[get]`
	A default Input.KeyboardInputProvider hooked up to the Form. More...

MouseInputProvider	MouseInputProvider `[get]`
	A default Input.MouseInputProvider hooked up to the Form. More...

TouchInputProvider	TouchInputProvider `[get]`
	A default Input.TouchInputProvider hooked up to the Form. More...

Detailed Description

Automatically provides an Engine instance with a fullscreen-capable window, render loop, input handling, etc.

By using this class, you don't need to create a window, set up InputProviders, provide access to DebugConsole, etc. yourself.

You should override at least Initialize and Render. This corresponds to the template method pattern.

Constructor & Destructor Documentation

◆ GameBase()

OmegaEngine.GameBase.GameBase	(	string	name,
		Icon	icon = `null`,
		Image	background = `null`,
		bool	stretch = `false`
	)

inlineprotected

Sets up the Form. Call ToWindowed or ToFullscreen and Run afterwards.

Parameters

name	The name of the application for the title bar
icon	The icon of the application for the title bar
background	A background image for the window while loading
stretch	Stretch background to fit the screen? (`false` will center it instead)

Member Function Documentation

◆ AddInputReceiver()

void OmegaEngine.GameBase.AddInputReceiver ( IInputReceiver receiver )

inline

Calls InputProvider.AddReceiver for all default InputProviders.

Parameters

receiver The object to receive the commands.

◆ ApplyGraphicsSettings()

virtual void OmegaEngine.GameBase.ApplyGraphicsSettings ( )

inlineprotectedvirtual

Called when graphics settings from an external source need to be applied to the Engine

◆ BuildEngineConfig()

virtual EngineConfig OmegaEngine.GameBase.BuildEngineConfig ( bool fullscreen )

inlineprotectedvirtual

Called to generate an EngineConfig based on external settings

Parameters

fullscreen Shall the configuration be generated for fullscreen mode?

◆ Crash()

static void OmegaEngine.GameBase.Crash ( )

inlinestatic

Crashes the game for testing purposes

◆ Debug()

virtual void OmegaEngine.GameBase.Debug ( )

inlinevirtual

Called when the debug form is to be displayed

◆ Dispose() [1/2]

void OmegaEngine.GameBase.Dispose ( )

inline

Dispose the Engine, the internal windows form, etc.

◆ Dispose() [2/2]

virtual void OmegaEngine.GameBase.Dispose ( bool disposing )

inlineprotectedvirtual

To be called by IDisposable.Dispose and the object destructor.

Parameters

disposing true if called manually and not by the garbage collector.

◆ Exit()

void OmegaEngine.GameBase.Exit ( )

inline

Stops the render loop and closes the window

◆ Initialize()

virtual bool OmegaEngine.GameBase.Initialize ( )

inlineprotectedvirtual

To be called after the window is ready and the Engine needs to be set up

Returns: true if the initialization worked, false if it failed an the app must be closed

◆ NewLua()

virtual Lua OmegaEngine.GameBase.NewLua ( )

inlinevirtual

Creates a new Lua instance with commonly used objects preloaded.

◆ RemoveInputReceiver()

void OmegaEngine.GameBase.RemoveInputReceiver ( IInputReceiver receiver )

inline

Calls InputProvider.RemoveReceiver for all default InputProviders.

Parameters

receiver The object to no longer receive the commands.

◆ Render()

virtual void OmegaEngine.GameBase.Render ( double elapsedTime )

inlineprotectedvirtual

Called when the next frame needs to be rendered.

Parameters

elapsedTime The number of seconds that have passed since this method was last called.

◆ ResetEngine()

virtual void OmegaEngine.GameBase.ResetEngine ( )

inlineprotectedvirtual

Resets the Engine

◆ Run()

virtual void OmegaEngine.GameBase.Run ( )

inlinevirtual

Shows the window and runs the render loop until Exit is called.

◆ ToFullscreen()

void OmegaEngine.GameBase.ToFullscreen ( )

inlineprotected

Sets up the System.Windows.Forms.Form for fullscreen display

◆ ToWindowed()

void OmegaEngine.GameBase.ToWindowed ( Size size )

inlineprotected

Sets up the System.Windows.Forms.Form for normal windowed (non-fullscreen) mode

Parameters

size	The window size

◆ UpdateStatus()

void OmegaEngine.GameBase.UpdateStatus ( string message )

inlineprotected

Updates the current status of the loading process

Parameters

message The new message to display

Member Data Documentation

◆ Form

readonly GameForm OmegaEngine.GameBase.Form

protected

The internal form used as the Engine render-targets

Property Documentation

◆ Disposed

bool OmegaEngine.GameBase.Disposed

get

Has the game been shutdown?

◆ Engine

Engine OmegaEngine.GameBase.Engine

get

The Engine instance used by the game. Warning! Only set after Control.Show has been called

◆ Fullscreen

bool OmegaEngine.GameBase.Fullscreen

get

Is the game in fullscreen mode?

◆ KeyboardInputProvider

KeyboardInputProvider OmegaEngine.GameBase.KeyboardInputProvider

get

A default Input.KeyboardInputProvider hooked up to the Form.

◆ Loading

bool? OmegaEngine.GameBase.Loading

getset

Indicates the game is currently loading something and the user must wait.

On Windows 7 and newer this will cause a neat taskbar animation.

◆ MouseInputProvider

MouseInputProvider OmegaEngine.GameBase.MouseInputProvider

get

A default Input.MouseInputProvider hooked up to the Form.

◆ TouchInputProvider

TouchInputProvider OmegaEngine.GameBase.TouchInputProvider

get

A default Input.TouchInputProvider hooked up to the Form.

The documentation for this class was generated from the following files:

OmegaEngine/GameBase.cs
OmegaEngine/GameBase.Render.cs

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ GameBase()

Member Function Documentation

◆ AddInputReceiver()

◆ ApplyGraphicsSettings()

◆ BuildEngineConfig()

◆ Crash()

◆ Debug()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ Exit()

◆ Initialize()

◆ NewLua()

◆ RemoveInputReceiver()

◆ Render()

◆ ResetEngine()

◆ Run()

◆ ToFullscreen()

◆ ToWindowed()

◆ UpdateStatus()

Member Data Documentation

◆ Form

Property Documentation

◆ Disposed

◆ Engine

◆ Fullscreen

◆ KeyboardInputProvider

◆ Loading

◆ MouseInputProvider

◆ TouchInputProvider