sc.api.plugins

Interface IGameInstance

All Known Implementing Classes:

AbstractGame, Game

public IGameInstance

Constructor Detail

IGameInstance

public IGameInstance()

Method Detail

onPlayerJoined

@NotNull
Player onPlayerJoined()

Returns:

the player that joined

Throws:

TooManyPlayersException - when game is already full

onPlayerLeft

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

onAction

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 - ProtocolMessage with the action

Throws:

GameLogicException - if any invalid action is done

InvalidMoveException - if the received move violates the rules

addGameListener

void addGameListener(@NotNull
                     IGameListener listener)

removeGameListener

void removeGameListener(@NotNull
                        IGameListener listener)

start

void start()

Server or an administrator requests the game to start now.

destroy

void destroy()

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

loadFromFile

void loadFromFile(@NotNull
                  java.lang.String file)

The game is requested to load itself from a file. Similar to a replay but with actual clients.

Parameters:

file - File the game should be loaded from

loadFromFile

void loadFromFile(@NotNull
                  java.lang.String file,
                  int turn)

The game is requested to load itself from a file. Similar to a replay but with actual clients.

Parameters:

file - File where the game should be loaded from

turn - The turn to load from the replay

loadGameInfo

void loadGameInfo(@NotNull
                  java.lang.Object gameInfo)

The game is requested to load itself from a given game information object.

Parameters:

gameInfo - the stored gameInformation

getWinners

@NotNull
java.util.List<sc.framework.plugins.Player> getWinners()

Returns the players that have won the game, empty if the game has no winners, or null if the game has not yet finished.

getPluginUUID

@NotNull
java.lang.String getPluginUUID()

Used for generating replay name.

getPlayers

@NotNull
java.util.List<sc.framework.plugins.Player> getPlayers()

Returns:

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

getPlayerScores

@NotNull
java.util.List<sc.shared.PlayerScore> getPlayerScores()

Returns:

the PlayerScores for both players