Game Class - NocturnalWisp/Tynted-Engine GitHub Wiki

Usage

The game class is the main working function of the program. This is what runs everything.

Constructor

Summary Creates an instance of the game class with the provided game options.

Implementation

Game(GameOptions options)

Vars

  • options - a struct representation of the options that control the setup and inner workings of the game.

Run

Summary
Begins initializing and running the main game loop.

Implementation

Run()

Quit

Summary
Closes the game and stops running the main game loop.

Implementation

Quit()

Initialize (overridable)

Summary This is called when initializing the game.

Implementation

override Initialize()

Update (overridable)

Summary This is called each loop the game updates.

Implementation

override Update(GameTime gameTime)

Vars

  • gameTime - The time represented struct.

Draw (overridable)

Summary This is called each time the game begins drawing.

Implementation

override Draw(RenderWindow renderWindow)

Vars

  • renderWindow - The SFML associated window to run draw calls upon.