Package tech.underoaks.coldcase.state

Class InteractionChain

java.lang.Object

tech.underoaks.coldcase.state.InteractionChain

public class InteractionChain
extends Object

Represents a sequence of interactions resulting from a player's action.

Constructor Summary

Constructors

Constructor	Description
InteractionChain(Snapshot snapshot)	Default-Constructor

Method Summary

Modifier and Type	Method	Description
void	addAction(Interaction interaction)	Adds an interaction to be executed by the GameController
void	addGameStateUpdate(GameStateUpdate gsu)	Adds a GameStateUpdate to the interactions chain.
void	addRemoteAction(Interaction interaction)	Adds a remote interaction to be executed by the GameController remotely
Queue<GameStateUpdate>	getGSUQueue()	Gets every GameStateUpdate that has been successfully simulated in this Chain.
Queue<Interaction>	getPendingActions()	Gets every local Interaction that still needs to be simulated before approval.
Queue<Interaction>	getPendingRemoteActions()	Gets every remote Interaction that still needs to be simulated before approval.
Snapshot	getSnapshot()	Get the currently used Deep-Clone of a Map.

Methods inherited from class java.lang.Object

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

Constructor Details

InteractionChain

public InteractionChain(Snapshot snapshot)

Default-Constructor

Parameters:

snapshot - Deep-Clone of a Map that will be the Basis of this Simulation.

Method Details

getSnapshot

public Snapshot getSnapshot()

Get the currently used Deep-Clone of a Map.

Returns:

The current Snapshot

addAction

public void addAction(Interaction interaction)

Adds an interaction to be executed by the GameController

Parameters:

interaction - The interaction to add.

addRemoteAction

public void addRemoteAction(Interaction interaction)

Adds a remote interaction to be executed by the GameController remotely

Parameters:

interaction - The interaction to add.

addGameStateUpdate

public void addGameStateUpdate(GameStateUpdate gsu)
                        throws GameStateUpdateException

Adds a GameStateUpdate to the interactions chain.

Parameters:

gsu - The GameStateUpdate to add.

Throws:

GameStateUpdateException - If the update has failed.

getGSUQueue

public Queue<GameStateUpdate> getGSUQueue()

Gets every GameStateUpdate that has been successfully simulated in this Chain.

Returns:

Every queued GameStateUpdate.

getPendingActions

public Queue<Interaction> getPendingActions()

Gets every local Interaction that still needs to be simulated before approval.

Returns:

Every queued local Interaction.

getPendingRemoteActions

public Queue<Interaction> getPendingRemoteActions()

Gets every remote Interaction that still needs to be simulated before approval.

Returns:

Every queued remote Interaction.