sc.framework.plugins

Class AbstractGame<P extends Player>

sc.framework.plugins.AbstractGame<P>

All Implemented Interfaces:

IGameInstance

Direct Known Subclasses:

Game

public class AbstractGame<P extends Player>
implements IGameInstance

Field Detail

Companion

public static sc.framework.plugins.AbstractGame.Companion Companion

Constructor Detail

AbstractGame

public AbstractGame(@NotNull
                    java.lang.String pluginUUID)

Parameters:

pluginUUID - Used for generating replay name.

Method Detail

getPlayers

@NotNull
public java.util.List<P> getPlayers()

Returns:

the two players, the startplayer will be first in the List

getActivePlayer

@Nullable
public P getActivePlayer()

setActivePlayer

protected void setActivePlayer(@Nullable
                               P p)

getListeners

@NotNull
protected java.util.List<sc.api.plugins.host.IGameListener> getListeners()

isPaused

public boolean isPaused()

setPaused

public void setPaused(boolean p)

afterPause

public void afterPause()

onAction

public void onAction(@NotNull
                     Player fromPlayer,
                     @NotNull
                     ProtocolMessage data)

Called by the Server once an action was received.

Parameters:

fromPlayer - The player who invoked this action.

data - The plugin-specific data.

Throws:

GameLogicException - if no move has been requested from the given class Player

InvalidMoveException - when the given Move is not possible

onRoundBasedAction

public void onRoundBasedAction(@NotNull
                               Player fromPlayer,
                               @NotNull
                               ProtocolMessage data)

Called by onAction to execute a move of a Player.

See Also:

onAction

checkWinCondition

@Nullable
public WinCondition checkWinCondition()

Returns a WinCondition if the Game is over. Checks:

• if a win condition in the current game state is met

• round limit and end of round (and playerStats)

• whether goal is reached

Returns:

WinCondition, or null if no win condition is met yet.

destroy

public void destroy()

At any time this method might be invoked by the server. Any open handles should be removed. No events should be sent out (GameOver etc) after this method has been called.

start

public void start()

Starts the game by sending a class WelcomeMessage to all players and calling next.

See Also:

class WelcomeMessage, next

onPlayerLeft

public void onPlayerLeft(@NotNull
                         Player player,
                         @Nullable
                         ScoreCause cause)

Handle leave of a player.

Parameters:

player - the player that left.

cause - the cause for the leave. If none is provided, then it will either be {@link ScoreCause#RULE_VIOLATION} or {$link ScoreCause#LEFT}, depending on whether the player has {@link Player#hasViolated()}.

next

protected void next(@Nullable
                    P nextPlayer)

Advances the Game to nextPlayer.

• sends out a state update

• invokes notifyOnGameOver if the game is over

• updates activePlayer to nextPlayer

• requests a new move if isPaused is false

See Also:

nextPlayer, notifyOnGameOver, activePlayer, nextPlayer, isPaused

getScoreFor

@NotNull
public PlayerScore getScoreFor(@NotNull
                                        P player)

getCurrentState

@NotNull
public IGameState getCurrentState()

Returns:

the current state representation.

notifyActivePlayer

protected void notifyActivePlayer()

Notifies the active player that it's their time to make a move.

requestMove

protected void requestMove(@NotNull
                           P player)

Sends a MoveRequest directly to the given player. Does not consider the pause state.

getTimeoutFor

@NotNull
protected ActionTimeout getTimeoutFor(@NotNull
                                               P player)

generateScoreMap

@NotNull
public java.util.Map<sc.framework.plugins.Player,sc.shared.PlayerScore> generateScoreMap()

addGameListener

public void addGameListener(@NotNull
                            IGameListener listener)

Extends the set of listeners.

Parameters:

listener - GameListener to be added

removeGameListener

public void removeGameListener(@NotNull
                               IGameListener listener)

Removes listener

Parameters:

listener - GameListener to be removed

notifyOnGameOver

protected void notifyOnGameOver(@NotNull
                                java.util.Map<sc.framework.plugins.Player,sc.shared.PlayerScore> map)

notifyOnNewState

protected void notifyOnNewState(@NotNull
                                IGameState mementoState,
                                boolean observersOnly)

getPluginUUID

@NotNull
public java.lang.String getPluginUUID()

Used for generating replay name.