org.cell2d

Class GameState<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>

java.lang.Object

org.cell2d.Thinker<T,U,V>

org.cell2d.GameState<T,U,V>

Type Parameters:

T - The type of CellGame that uses this GameState

U - The type of GameState that this GameState is for SubThinker interaction purposes

V - The type of SubThinker that can be assigned to this GameState

Direct Known Subclasses:

BasicState, SpaceState

public abstract class GameState<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>
extends Thinker<T,U,V>

A GameState represents one state that a CellGame can be in, such as the main menu, the options menu, in the middle of a level, etc. GameStates are permanent parts of a specific CellGame and referenced by a specific non-negative integer ID, both of which are specified upon the GameState's creation. If a CellGame is in a GameState, that GameState is considered active.

A GameState is also a Thinker that is considered assigned to itself. This means that it has timers, frameActions(), frame events, etc. If its time factor is negative, a GameState will use a time factor of one fracunit. A GameState will take its frameActions() immediately after all Thinkers have experienced all of their time units for that frame, first among the Thinkers assigned to it.

AnimationInstances may be assigned to one GameState each. An AnimationInstance may be assigned to a GameState with or without an integer ID in the context of that GameState. Only one AnimationInstance may be assigned to a given GameState with a given ID at once.

The GameState class is intended to be extended by classes U that extend GameState<T,U,V> and interact with SubThinkers of class V. BasicState is an example of such a class. This allows a GameState's SubThinkers to interact with it in ways unique to its subclass of GameState.

See Also:

CellGame, AnimationInstance

Constructor Summary

Constructors

Constructor and Description
GameState(java.lang.Class<T> gameClass, java.lang.Class<U> stateClass, java.lang.Class<V> subThinkerClass, T game, int id) Constructs a GameState of the specified CellGame with the specified ID.

Method Summary

Modifier and Type	Method and Description
AnimationInstance	addAnimInstance(Animation animation) Adds a new AnimationInstance of the specified Animation to this GameState without an ID.
boolean	addAnimInstance(AnimationInstance instance) Adds the specified AnimationInstance to this GameState without an ID, if it is not already assigned to a GameState.
void	bindFinishedActions(T game, int commandNum) Actions for this GameState to take immediately after its CellGame has bound the last valid control pressed to a specified command.
void	charDeletedActions(T game, char c) Actions for this GameState to take immediately after a character is deleted from its CellGame's typed String.
void	charTypedActions(T game, char c) Actions for this GameState to take immediately after a character is typed to its CellGame's typed String.
void	clearAnimInstances() Removes from this GameState all AnimationInstances that are currently assigned to it, with or without IDs.
void	enteredActions(T game) Actions for this GameState to take immediately after being entered.
Animation	getAnimation(int id) Returns the Animation of the AnimationInstance assigned to this GameState with the specified ID, or Animation.BLANK if there is none.
AnimationInstance	getAnimInstance(int id) Returns the AnimationInstance that is assigned to this GameState with the specified ID, or AnimationInstance.BLANK if there is none.
long	getEffectiveTimeFactor() Returns this Thinker's effective time factor; that is, the average number of time units it experiences every frame.
T	getGame() Returns the CellGame of the GameState to which this Thinker is assigned, or null if it is not assigned to a GameState.
U	getGameState() Returns the GameState to which this Thinker is assigned, or null if it is not assigned to one.
int	getID() Returns this GameState's ID.
int	getNumAnimInstances() Returns the number of AnimationInstances that are assigned to this GameState, with or without IDs.
U	getThis() Returns this GameState as a U, rather than as a GameState<T,U,V>.
boolean	isActive() Returns whether this GameState is active.
void	leftActions(T game) Actions for this GameState to take immediately before being exited.
boolean	removeAnimInstance(AnimationInstance instance) Removes the specified AnimationInstance from this GameState if it is currently assigned to this GameState without an ID.
void	renderActions(T game, Graphics g, int x1, int y1, int x2, int y2) Actions for this GameState to take each frame to render its visuals.
AnimationInstance	setAnimation(int id, Animation animation) Sets the AnimationInstance that is assigned to this GameState with the specified ID to a new AnimationInstance of the specified Animation, if there is not already an AnimationInstance of that Animation assigned with that ID.
boolean	setAnimInstance(int id, AnimationInstance instance) Sets the AnimationInstance that is assigned to this GameState with the specified ID to the specified AnimationInstance, if it is not already assigned to a GameState.
void	stringBeganActions(T game, java.lang.String s) Actions for this GameState to take immediately after its CellGame begins typing a new String.
void	stringCanceledActions(T game, java.lang.String s) Actions for this GameState to take immediately after its CellGame's typed String is canceled.
void	stringDeletedActions(T game, java.lang.String s) Actions for this GameState to take immediately after its CellGame's typed String is deleted and reset to the empty String.
void	stringFinishedActions(T game, java.lang.String s) Actions for this GameState to take immediately after its CellGame's typed String is finished.

Methods inherited from class org.cell2d.Thinker

addSubThinker, addSubThinkerActions, clearLineages, clearSubThinkers, frameActions, getFrameEvents, getGameClass, getNumSubThinkers, getStateClass, getSubThinkerClass, getTimeFactor, getTimerValue, iteratingThroughSubThinkers, removeLineage, removeSubThinker, removeSubThinkerActions, setTimeFactor, setTimerValue, subThinkerIterator

Methods inherited from class java.lang.Object

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

Constructor Detail

GameState

public GameState(java.lang.Class<T> gameClass,
                 java.lang.Class<U> stateClass,
                 java.lang.Class<V> subThinkerClass,
                 T game,
                 int id)

Constructs a GameState of the specified CellGame with the specified ID. GameStates automatically register themselves with their CellGames upon creation.

Parameters:

gameClass - The Class object representing the type of CellGame that uses this GameState

stateClass - The Class object representing the type of GameState that this GameState is for SubThinker interaction purposes

subThinkerClass - The Class object representing the type of SubThinker that can be assigned to this GameState

game - The CellGame to which this GameState belongs

id - This GameState's ID

Method Detail

getThis

public final U getThis()

Returns this GameState as a U, rather than as a GameState<T,U,V>.

Returns:

This GameState as a U

getGame

public final T getGame()

Description copied from class: Thinker

Returns the CellGame of the GameState to which this Thinker is assigned, or null if it is not assigned to a GameState.

Specified by:

getGame in class Thinker<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>

Returns:

This Thinker's GameState's CellGame

getGameState

public final U getGameState()

Description copied from class: Thinker

Returns the GameState to which this Thinker is assigned, or null if it is not assigned to one.

Specified by:

getGameState in class Thinker<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>

Returns:

The GameState to which this Thinker is assigned

getEffectiveTimeFactor

public final long getEffectiveTimeFactor()

Description copied from class: Thinker

Returns this Thinker's effective time factor; that is, the average number of time units it experiences every frame. If it is not assigned to a GameState, this will be 0.

Specified by:

getEffectiveTimeFactor in class Thinker<T extends CellGame,U extends GameState<T,U,V>,V extends SubThinker<T,U,V>>

Returns:

This Thinker's effective time factor

getID

public final int getID()

Returns this GameState's ID.

Returns:

This GameState's ID

isActive

public final boolean isActive()

Returns whether this GameState is active.

Returns:

Whether this GameState is active

getNumAnimInstances

public final int getNumAnimInstances()

Returns the number of AnimationInstances that are assigned to this GameState, with or without IDs.

Returns:

The number of AnimationInstances that are assigned to this GameState

addAnimInstance

public final boolean addAnimInstance(AnimationInstance instance)

Adds the specified AnimationInstance to this GameState without an ID, if it is not already assigned to a GameState.

Parameters:

instance - The AnimationInstance to add

Returns:

Whether the addition occurred

addAnimInstance

public final AnimationInstance addAnimInstance(Animation animation)

Adds a new AnimationInstance of the specified Animation to this GameState without an ID.

Parameters:

animation - The Animation to add a new AnimationInstance of

Returns:

The new AnimationInstance

removeAnimInstance

public final boolean removeAnimInstance(AnimationInstance instance)

Removes the specified AnimationInstance from this GameState if it is currently assigned to this GameState without an ID.

Parameters:

instance - The AnimationInstance to remove

Returns:

Whether the removal occurred

getAnimInstance

public final AnimationInstance getAnimInstance(int id)

Returns the AnimationInstance that is assigned to this GameState with the specified ID, or AnimationInstance.BLANK if there is none.

Parameters:

id - The ID of the AnimationInstance to be returned

Returns:

The AnimationInstance that is assigned to this GameState with the specified ID

setAnimInstance

public final boolean setAnimInstance(int id,
                                     AnimationInstance instance)

Sets the AnimationInstance that is assigned to this GameState with the specified ID to the specified AnimationInstance, if it is not already assigned to a GameState. If there is already an AnimationInstance assigned with the specified ID, it will be removed from this GameState.

Parameters:

id - The ID with which to assign the specified AnimationInstance

instance - The AnimationInstance to add with the specified ID

Returns:

Whether the change occurred

getAnimation

public final Animation getAnimation(int id)

Returns the Animation of the AnimationInstance assigned to this GameState with the specified ID, or Animation.BLANK if there is none.

Parameters:

id - The ID of the AnimationInstance whose Animation is to be returned

Returns:

The Animation of the AnimationInstance assigned to this GameState with the specified ID

setAnimation

public final AnimationInstance setAnimation(int id,
                                            Animation animation)

Sets the AnimationInstance that is assigned to this GameState with the specified ID to a new AnimationInstance of the specified Animation, if there is not already an AnimationInstance of that Animation assigned with that ID. In other words, this method will not replace an AnimationInstance with another of the same Animation. If there is already an AnimationInstance assigned with the specified ID, it will be removed from this GameState.

Parameters:

id - The ID with which to assign the new AnimationInstance

animation - The Animation to add a new AnimationInstance of

Returns:

The AnimationInstance assigned with the specified ID, or AnimationInstance.BLANK if there is none

clearAnimInstances

public final void clearAnimInstances()

Removes from this GameState all AnimationInstances that are currently assigned to it, with or without IDs.

enteredActions

public void enteredActions(T game)

Actions for this GameState to take immediately after being entered.

Parameters:

game - This GameState's CellGame

leftActions

public void leftActions(T game)

Actions for this GameState to take immediately before being exited.

Parameters:

game - This GameState's CellGame

renderActions

public void renderActions(T game,
                          Graphics g,
                          int x1,
                          int y1,
                          int x2,
                          int y2)

Actions for this GameState to take each frame to render its visuals.

Parameters:

game - This GameState's CellGame

g - The Graphics context to which this GameState is rendering its visuals this frame

x1 - The x-coordinate in pixels of the screen's left edge on the Graphics context

y1 - The y-coordinate in pixels of the screen's top edge on the Graphics context

x2 - The x-coordinate in pixels of the screen's right edge on the screen on the Graphics context

y2 - The y-coordinate in pixels of the screen's bottom edge on the Graphics context

bindFinishedActions

public void bindFinishedActions(T game,
                                int commandNum)

Actions for this GameState to take immediately after its CellGame has bound the last valid control pressed to a specified command.

Parameters:

game - This GameState's CellGame

commandNum - The number of the command that was bound to

stringBeganActions

public void stringBeganActions(T game,
                               java.lang.String s)

Actions for this GameState to take immediately after its CellGame begins typing a new String.

Parameters:

game - This GameState's CellGame

s - The initial value of the typed String

charTypedActions

public void charTypedActions(T game,
                             char c)

Actions for this GameState to take immediately after a character is typed to its CellGame's typed String.

Parameters:

game - This GameState's CellGame

c - The character that was just typed

charDeletedActions

public void charDeletedActions(T game,
                               char c)

Actions for this GameState to take immediately after a character is deleted from its CellGame's typed String.

Parameters:

game - This GameState's CellGame

c - The character that was just deleted

stringDeletedActions

public void stringDeletedActions(T game,
                                 java.lang.String s)

Actions for this GameState to take immediately after its CellGame's typed String is deleted and reset to the empty String.

Parameters:

game - This GameState's CellGame

s - The String that was just deleted

stringFinishedActions

public void stringFinishedActions(T game,
                                  java.lang.String s)

Actions for this GameState to take immediately after its CellGame's typed String is finished.

Parameters:

game - This GameState's CellGame

s - The String that was just finished

stringCanceledActions

public void stringCanceledActions(T game,
                                  java.lang.String s)

Actions for this GameState to take immediately after its CellGame's typed String is canceled.

Parameters:

game - This GameState's CellGame

s - The String that was just canceled