fr.aumgn.dac2.game

Class AbstractGame

java.lang.Object

fr.aumgn.dac2.game.AbstractGame

All Implemented Interfaces:

Game, Stage

Direct Known Subclasses:

ClassicGame, Colonnisation, Training

public abstract class AbstractGame
extends Object
implements Game

Common implementations of most game mode.

Field Summary

Fields

Modifier and Type	Field and Description
protected Arena	arena
protected DAC	dac
protected Listener	listener
protected PlayersRefSet	spectators

Constructor Summary

Constructors

Constructor and Description
AbstractGame(DAC dac, GameStartData data)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSpectator(Player player)
Arena	getArena()
Listener[]	getListeners()
abstract boolean	isPlayerTurn(Player player) Check if it's the given player turn.
boolean	isSpectator(Player player)
abstract void	onJumpFail(Player player) Callback called when a player failed.
abstract void	onJumpSuccess(Player player) Callback called when a player succeed.
void	onNewTurn() Callback called when a new turn starts.
void	removeSpectator(Player player)
protected void	resetPoolOnEnd() Resets the pool if configured to do so on game end.
protected void	resetPoolOnStart() Resets the pool if configured to do so on game start.
protected void	send(String key, Object... arguments) Send a message which is recorded in the main PluginMessages instance.
protected void	sendSpectators(String message) Sends a message to this game's spectators by prefixing the message with the arena's name as specified in the config.
protected void	tpAfterJumpFail(GamePlayer player) Teleport the player if configured to do so after player's failed jump.
protected void	tpAfterJumpSuccess(GamePlayer player, Column column) Teleport the player if configured to do so after player's success.
protected void	tpBeforeJump(GamePlayer player) Teleport the player if configured to do so on player's turn.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.aumgn.dac2.stage.Stage

contains, list, onQuit, sendMessage, start, stop

Field Detail

dac

protected final DAC dac

arena

protected final Arena arena

listener

protected final Listener listener

spectators

protected final PlayersRefSet spectators

Constructor Detail

AbstractGame

public AbstractGame(DAC dac,
            GameStartData data)

Method Detail

getArena

public Arena getArena()

Specified by:

getArena in interface Stage

getListeners

public Listener[] getListeners()

Specified by:

getListeners in interface Stage

send

protected void send(String key,
        Object... arguments)

Send a message which is recorded in the main PluginMessages instance.

isSpectator

public boolean isSpectator(Player player)

Specified by:

isSpectator in interface Stage

addSpectator

public void addSpectator(Player player)

Specified by:

addSpectator in interface Stage

removeSpectator

public void removeSpectator(Player player)

Specified by:

removeSpectator in interface Stage

onNewTurn

public void onNewTurn()

Description copied from interface: Game

Callback called when a new turn starts. (ie. all players have jumped once since the last one)

Specified by:

onNewTurn in interface Game

isPlayerTurn

public abstract boolean isPlayerTurn(Player player)

Check if it's the given player turn. This is used by GameListener to check if events need to be processed. So this method should be optimized as much as possible because some events (like PlayerMoveEvent) are heavy.

onJumpSuccess

public abstract void onJumpSuccess(Player player)

Callback called when a player succeed.

onJumpFail

public abstract void onJumpFail(Player player)

Callback called when a player failed.

sendSpectators

protected void sendSpectators(String message)

Sends a message to this game's spectators by prefixing the message with the arena's name as specified in the config.

resetPoolOnStart

protected void resetPoolOnStart()

Resets the pool if configured to do so on game start.

resetPoolOnEnd

protected void resetPoolOnEnd()

Resets the pool if configured to do so on game end.

tpBeforeJump

protected void tpBeforeJump(GamePlayer player)

Teleport the player if configured to do so on player's turn.

tpAfterJumpSuccess

protected void tpAfterJumpSuccess(GamePlayer player,
                      Column column)

Teleport the player if configured to do so after player's success.

tpAfterJumpFail

protected void tpAfterJumpFail(GamePlayer player)

Teleport the player if configured to do so after player's failed jump.