rle.core.event
Class GameClock

java.lang.Object
  rle.core.vm.PlugInBase
      rle.core.event.GameClock

All Implemented Interfaces:

PlayerTurnListener, PlugIn

public class GameClock
extends PlugInBase
implements PlayerTurnListener

Handles the scheduling interplay between player moves and everything else. Variant authors can subclass this class and override getEnergyRequiredToTakeTurn() and getEnergyBestowedPerTick(int) to adjust the affects that creature speed has on how often a creature gets to move in relation to other game events. The clock will run until stop() is called, at which point all processing stops and all methods should exit normally. Classes that wish to cause the player to exit the "game" perspective should first call stop(), which will prevent playerTurnEnded() from any further action, especially modifying command sets.

Field Summary

protected int	energyRequiredToTakeTurn
protected long	tickNumber
protected boolean	waitingForPlayerAction

Fields inherited from class rle.core.vm.PlugInBase

config, context, parameters

Constructor Summary

GameClock()

Method Summary

void	addGameClockListener(GameClockListener cl)
void	fireGameTick() Notify listeners that a new game tick has started.
int	getEnergyBestowedPerTick(int speed) How much energy should be given per tick to a creature with the given speed.
int	getEnergyRequiredToTakeTurn() The quantity of energy a creature requires before it can take its turn.
long	getTickNumber()
boolean	isWaitingForPlayerAction()
void	playerTurnEnded(PlayerTurnEvent event) Respond to a player's turn ending.
void	removeGameClockListener(GameClockListener cl)
void	setTickNumber(long tickNumber)
void	stop() Halt the clock because the player is dead, victorious, or is otherwise no longer playing.

Methods inherited from class rle.core.vm.PlugInBase

config, getContext, getParameters, paramMap, setConfig, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface rle.core.vm.PlugIn

config, getContext, paramMap, setConfig, setParameters

Field Detail

tickNumber

protected long tickNumber

energyRequiredToTakeTurn

protected int energyRequiredToTakeTurn

waitingForPlayerAction

protected boolean waitingForPlayerAction

Constructor Detail

GameClock

public GameClock()

Method Detail

isWaitingForPlayerAction

public boolean isWaitingForPlayerAction()

getEnergyRequiredToTakeTurn

public int getEnergyRequiredToTakeTurn()

The quantity of energy a creature requires before it can take its turn.

getEnergyBestowedPerTick

public int getEnergyBestowedPerTick(int speed)

How much energy should be given per tick to a creature with the given speed. Generally, more energy should be given per tick the higher the speed. However, giving too much energy relative to the required energy to take a turn will cause different speed values to lose their meaning.

getTickNumber

public long getTickNumber()

setTickNumber

public void setTickNumber(long tickNumber)

playerTurnEnded

public void playerTurnEnded(PlayerTurnEvent event)

Respond to a player's turn ending. When this happens, we must give everything else in the game a chance to act until the player has enough energy to move again. This method depends on the Player having the Runtime Attribute "speed", although subclasses could do away with that requirement. Note: In general, the processes run by this method will attempt to discontinue processing and return as quickly as possible after stop() is called.

Specified by:

playerTurnEnded in interface PlayerTurnListener

fireGameTick

public void fireGameTick()

Notify listeners that a new game tick has started. Note that the Player should not respond to this event! Player energy/turn taking is handled separately, but all other game events such as Monster energy, shop shuffling, timed effects, etc. may be driven by this method. This method will stop notifying listeners if the clock is stopped.

addGameClockListener

public void addGameClockListener(GameClockListener cl)

removeGameClockListener

public void removeGameClockListener(GameClockListener cl)

stop

public void stop()

Halt the clock because the player is dead, victorious, or is otherwise no longer playing.