stream.alwaysbecrafting.flare

Class GameSystem

java.lang.Object

stream.alwaysbecrafting.flare.GameSystem

All Implemented Interfaces:

java.lang.Comparable<GameSystem>

Direct Known Subclasses:

EntitySystem

public abstract class GameSystem
extends java.lang.Object
implements java.lang.Comparable<GameSystem>

Superclass for game systems which do some work on the main loop

If you need to iterate over a group of game entities each cycle, consider subclassing EntitySystem instead.

Constructor Summary

Constructors

Constructor and Description
GameSystem()

Method Summary

Modifier and Type	Method and Description
int	compareTo(GameSystem other)
void	onPause() Override to respond when this system is paused
void	onResume() Override to respond when this system is resumed from a paused state
void	onStart(GameEngine engine) Override to respond when this system is added to an engine and initialized
void	onStop(GameEngine engine) Override to respond when this system is removed from an engine and shut down
void	onUpdate(GameEngine engine, float deltaTime) Called when this system should execute its main game loop behavior.
void	pause() Pause a running system
void	resume() Resume a paused system

Methods inherited from class java.lang.Object

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

Constructor Detail

GameSystem

public GameSystem()

Method Detail

compareTo

public int compareTo(GameSystem other)

Specified by:

compareTo in interface java.lang.Comparable<GameSystem>

resume

public void resume()

Resume a paused system

pause

public void pause()

Pause a running system

onStart

public void onStart(GameEngine engine)

Override to respond when this system is added to an engine and initialized

Parameters:

engine - the GameEngine the system is added to

onResume

public void onResume()

Override to respond when this system is resumed from a paused state

Systems are considered paused upon initialization, and onResume() will always be called immediately after onStart(GameEngine) when initializing

onUpdate

public void onUpdate(GameEngine engine,
                     float deltaTime)

Called when this system should execute its main game loop behavior. This is where the system will do most of its work, and is called once for each time GameEngine.update(float) is called on the attached GameEngine.

Parameters:

engine - The engine this update is occurring in

deltaTime - The time given to GameEngine.update(float) for this iteration of the game loop; ostensibly, the time between the previous loop and the current one

onPause

public void onPause()

Override to respond when this system is paused

onPause() will always be called immediately before onStop(GameEngine) when shutting down

onStop

public void onStop(GameEngine engine)

Override to respond when this system is removed from an engine and shut down

Parameters:

engine - the GameEngine the system is removed from