Game class

Game class

The game class is one of the controller classes the engine has. It is used to create the basic structure of your program.

1. display(String name)

This is the method used to create a new Display(Window).

Parameters:

String name: The name you want to register the display with.

Examples:

Display display = Game.display("Main");

2. addScene(Scene scene, String alias)

This method is used to register a new scene to your program.

Parameters:

Scene scene: The scene you want to register.

String alias: The name you want to register the scene with.

Examples:

Game.addScene(new GameScene(), "Game");

Scene MenuScene = new MenuScene();
Game.addScene(MenuScene, "Menu");

3. setFrameRate(int frameRate)

This method is used to set a custom refresh rate to the logic and the render loop. If this method is not used, the frame rate will be set to 60.

Parameters:

int frameRate: The refresh rate you want the program to be looped with.

Examples:

Game.setFrameRate(120);

4. start()

This method is used to start the render and the Logic loop. It basically brings the program to life.

Examples:

Game.start();

Getters and Setters:

getScene(String alias)

returns the scene with the given alias.

getScenes()

returns an map object Map<String, Scene> with all registered scenes.

getDisplays()

returns an map object Map<String, Display> with all registered displays.