stream.alwaysbecrafting.flare

Class GameEngine

java.lang.Object

stream.alwaysbecrafting.flare.GameEngine

public class GameEngine
extends java.lang.Object

The provider for the game's main loop logic

GameEngine should usually not be extended; instead, users of this class should create a new GameEngine() and add subclasses of GameSystem to handle the implementation.

Constructor Summary

Constructors

Constructor and Description
GameEngine()

Method Summary

Modifier and Type	Method and Description
void	add(Entity entity) Add an entity to the engine
void	add(GameSystem system) Add a GameSystem to the engine, calling its GameSystem.onStart(GameEngine) method and setting it to the lowest priority.
void	add(GameSystem system, int priority) Add a GameSystem to the engine, calling its GameSystem.onStart(GameEngine) method and setting it to the given priority.
void	pause() Temporarily stop all processing on this engine, until a subsequent call to resume() is made.
void	remove(java.lang.Class<? extends GameSystem> systemType) Remove a GameSystem from the engine
void	remove(Entity entity) Remove an entity from the engine
void	remove(GameSystem system) Remove a GameSystem from the engine
void	resume() Resume handling update calls, and call GameSystem.onResume() on all attached systems which were running before the engine was paused.
void	update(float deltaTime) Tell all GameSystems in this engine to execute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GameEngine

public GameEngine()

Method Detail

add

public void add(GameSystem system)

Add a GameSystem to the engine, calling its GameSystem.onStart(GameEngine) method and setting it to the lowest priority.

Parameters:

system - The system to add

add

public void add(GameSystem system,
                int priority)

Add a GameSystem to the engine, calling its GameSystem.onStart(GameEngine) method and setting it to the given priority.

Parameters:

system - The system to add

priority - The priority to set. In future releases, systems at the same priority will be eligible for concurrent execution.

update

public void update(float deltaTime)

Tell all GameSystems in this engine to execute.

Call this from your main game loop to perform all entity updates and rendering.

Parameters:

deltaTime - The time, in seconds, since the last update

remove

public void remove(GameSystem system)

Remove a GameSystem from the engine

Parameters:

system - The system to remove

remove

public void remove(java.lang.Class<? extends GameSystem> systemType)

Remove a GameSystem from the engine

Parameters:

systemType - The type of the system to remove

add

public void add(Entity entity)

Add an entity to the engine

Parameters:

entity - Entity to add

remove

public void remove(Entity entity)

Remove an entity from the engine

Parameters:

entity - Entity to remove

pause

public void pause()

Temporarily stop all processing on this engine, until a subsequent call to resume() is made. Calling update(float) while paused does nothing.

Also calls GameSystem.onPause() on all attached systems which are not already paused

resume

public void resume()

Resume handling update calls, and call GameSystem.onResume() on all attached systems which were running before the engine was paused.