CellGame

java.lang.Object
- org.cell2d.CellGame

```
public abstract class CellGame
extends java.lang.Object
```
A CellGame is a game made with Cell2D. A certain number of times per second, a CellGame executes a frame, in which it processes input, updates the logic of the game, and renders visuals.

A CellGame has one or more GameStates, each with a non-negative integer ID that is unique within the CellGame. A CellGame is in exactly one of these GameStates at any given time, and can transition between them. Each GameState has its own actions to take every frame and in response to specific events, but it only takes these actions while the CellGame is in it. If a GameState is created with an ID that another GameState of the same CellGame already has, the old GameState can no longer be entered.

A CellGame renders visuals on a rectangular grid of pixels called its screen. Points on the screen have x-coordinates that increase from left to right, as well as y-coordinates that increase from top to bottom. The dimensions of the screen are not necessarily the same as the dimensions of the CellGame's program window, as the screen may be scaled to different apparent sizes using the CellGame's scale factor. A CellGame may be displayed in windowed or fullscreen mode.

While a CellGame is rendering visuals, the region of the Graphics context to which it is rendering that is outside its screen cannot be drawn to. When drawn to the Graphics context, shapes and Drawables will automatically be clipped so that they do not extend beyond the screen.

A CellGame processes input in the form of a fixed number of binary commands, numbered from 0 to getNumCommands() - 1 inclusive, as well as the position of the mouse cursor on the screen and the movement of the mouse wheel. Controls, which represent keys, controller buttons, etc. may be bound to at most one command at a time so that when they are pressed, held, and released, so too are the commands to which they are bound. If an attempt is made to bind a Control that is already bound, it will be unbound from its current command first. A CellGame considers Controls to be the same Control if they are equal - that is, if they represent the same input. A CellGame also allows for the temporary processing of input as assignments of Controls to specific commands, or as the typing of text to a specific String.

A CellGame also controls the playing and stopping of Music tracks. It contains a data structure called a music stack in which different integer priority values may be assigned one or more Music tracks each. Only the Music tracks assigned to the greatest priority in the stack will play at any given time. If a currently playing Music track finishes, it will automatically be removed from the top of the music stack.

See Also:

GameState, Control, Music

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String VERSION
The version number of Cell2D, currently 2.1.1.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`VERSION` The version number of Cell2D, currently 2.1.1.

Constructor Summary

Constructors
Constructor and Description
`CellGame(java.lang.String title, int numCommands, int fps, int screenWidth, int screenHeight, double scaleFactor, boolean fullscreen, java.lang.String iconPath)` Constructs a CellGame.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMusic(int priority, Music music, boolean loop)` Adds the specified Music track to the specified priority in this CellGame's music stack, replacing and removing all other Music tracks assigned to that priority.
`void`	`addMusic(int priority, Music music, boolean loop, boolean replace)` Adds the specified Music track to the specified priority in this CellGame's music stack.
`void`	`addMusic(int priority, Music music, double speed, double volume, boolean loop)` Adds the specified Music track to the specified priority in this CellGame's music stack, replacing and removing all other Music tracks assigned to that priority.
`void`	`addMusic(int priority, Music music, double speed, double volume, boolean loop, boolean replace)` Adds the specified Music track to the specified priority in this CellGame's music stack.
`void`	`addMusic(Music music, boolean loop)` Adds the specified Music track to the greatest priority in this CellGame's music stack, replacing and removing all other Music tracks assigned to that priority, or to priority 0 if the music stack is empty.
`void`	`addMusic(Music music, boolean loop, boolean replace)` Adds the specified Music track to the greatest priority in this CellGame's music stack, or to priority 0 if the music stack is empty.
`void`	`addMusic(Music music, double speed, double volume, boolean loop)` Adds the specified Music track to the greatest priority in this CellGame's music stack, replacing and removing all other Music tracks assigned to that priority, or to priority 0 if the music stack is empty.
`void`	`addMusic(Music music, double speed, double volume, boolean loop, boolean replace)` Adds the specified Music track to the greatest priority in this CellGame's music stack, or to priority 0 if the music stack is empty.
`void`	`beginTypingString(int maxLength)` Instructs this CellGame to interpret all inputs as typing a String with a specified maximum length until further notice.
`void`	`beginTypingString(java.lang.String initialString, int maxLength)` Instructs this CellGame to interpret all inputs as typing a String with a specified initial value and maximum length until further notice.
`void`	`bindControl(int commandNum, Control control)` Binds the specified Control to the specified command.
`void`	`cancelBindToCommand()` Cancels this CellGame's instruction to bind the next valid Control pressed to a specified command, if it has been instructed to do so.
`void`	`cancelTypingString()` Instructs this CellGame to stop interpreting inputs as typing a String, if it was doing so, and consider the typing canceled.
`void`	`clearControls(int commandNum)` Unbinds all of the specified command's Controls from it.
`void`	`clearMusic()` Removes from this CellGame's music stack all Music tracks assigned to any priority, leaving the stack empty.
`void`	`close()` Instructs this CellGame to close itself the next time it finishes a game logic update.
`boolean`	`commandHeld(int commandNum)` Returns whether the specified command is being held this frame.
`boolean`	`commandPressed(int commandNum)` Returns whether the specified command was pressed this frame.
`boolean`	`commandReleased(int commandNum)` Returns whether the specified command was released this frame.
`void`	`enterState(int id)` Instructs this CellGame to enter its GameState with the specified ID the next time it finishes a game logic update.
`void`	`enterState(int id, Color fadeColor, int fadeOutTime, int fadeInTime)` Instructs this CellGame to enter its GameState with the specified ID the next time it finishes a game logic update, using a visual fade-out/fade-in effect to transition to it from the current GameState.
`int`	`getBindingCommandNum()` Returns the number of the command to which this CellGame has been instructed to bind the next valid Control pressed, or -1 if there is none.
`java.util.Set<Control>`	`getControlsFor(int commandNum)` Returns an unmodifiable Set view of all of the Controls that are bound to the specified command.
`GameState`	`getCurrentState()` Returns the GameState that this CellGame is currently in.
`int`	`getFPS()` Returns the number of frames that this CellGame executes per second.
`java.lang.String`	`getIconPath()` Returns the relative path to the image file that this CellGame's program window uses as its icon, or null if the window uses the default LWJGL 2 icon.
`int`	`getMaxTypingStringLength()` Returns the maximum length in characters of the String that this CellGame is being used to type, or 0 if this CellGame is not being used to type a String.
`int`	`getMouseWheelChange()` Returns the change in the position of the mouse wheel since last frame.
`int`	`getMouseX()` Returns the x-coordinate in pixels of the mouse cursor on this CellGame's screen.
`int`	`getMouseY()` Returns the y-coordinate in pixels of the mouse cursor on this CellGame's screen.
`Music`	`getMusic()` Returns the Music track assigned to the greatest priority in this CellGame's music stack, if the music stack is not empty and there is exactly one such Music track, or null otherwise.
`Music`	`getMusic(int priority)` Returns the Music track assigned to the specified priority in this CellGame's music stack, if there is exactly one such Music track, or null otherwise.
`int`	`getMusicStackTop()` Returns the greatest priority in this CellGame's music stack to which any Music tracks are assigned, or 0 if the music stack is empty.
`java.util.Set<Music>`	`getMusicTracks()` Returns an unmodifiable Set view of the Music tracks that are assigned to the greatest priority in this CellGame's music stack, or an unmodifiable empty Set if the music stack is empty.
`java.util.Set<Music>`	`getMusicTracks(int priority)` Returns an unmodifiable Set view of the Music tracks that are assigned to the specified priority in this CellGame's music stack, or an unmodifiable empty Set if the music stack is empty.
`int`	`getNumCommands()` Returns how many commands this CellGame has.
`double`	`getScaleFactor()` Returns the factor by which this CellGame's screen is scaled to make the size of the program window.
`int`	`getScreenHeight()` Returns the height in pixels of this CellGame's screen.
`int`	`getScreenWidth()` Returns the width in pixels of this CellGame's screen.
`GameState`	`getState(int id)` Returns this CellGame's GameState with the specified ID, or null if there is none.
`java.lang.String`	`getTypingString()` Returns the String that this CellGame is being used to type, or null if there is none.
`abstract void`	`initActions()` Actions for this CellGame to take when initializing itself before entering its first GameState.
`boolean`	`isFullscreen()` Returns whether this CellGame is in fullscreen mode.
`void`	`loadLoadingAssets()` Loads any assets that are used in renderLoadingVisuals().
`static void`	`loadNatives(java.lang.String path)` Loads the native libraries that are necessary for LWJGL 2, and thus Cell2D, to run.
`boolean`	`musicIsAtPriority(int priority, Music music)` Returns whether the specified Music track is assigned to the specified priority in this CellGame's music stack.
`void`	`removeMusic()` Removes from the greatest priority in this CellGame's music stack all of the Music tracks currently assigned to it, if the music stack is not empty.
`void`	`removeMusic(int priority)` Removes from the specified priority in this CellGame's music stack all of the Music tracks currently assigned to it.
`void`	`removeMusic(int priority, Music music)` Removes the specified Music track from the specified priority in this CellGame's music stack if it is currently assigned to that priority.
`void`	`removeMusic(Music music)` Removes the specified Music track from the greatest priority in this CellGame's music stack if it is currently assigned to that priority.
`void`	`renderActions(Graphics g, int x1, int y1, int x2, int y2)` Actions for this CellGame to take each frame to render visuals after its current GameState has finished rendering.
`void`	`renderLoadingVisuals(Graphics g, int x1, int y1, int x2, int y2)` Renders the visuals that this CellGame will display while its initActions() are in progress.
`void`	`setFPS(int fps)` Sets the number of frames that this CellGame executes per second to the specified value.
`void`	`setFullscreen(boolean fullscreen)` Sets whether this CellGame is in fullscreen mode.
`void`	`setScaleFactor(double scaleFactor)` Sets the factor by which this CellGame's screen is scaled to make the size of the program window to the specified value.
`void`	`setScreenHeight(int screenHeight)` Sets the height in pixels of this CellGame's screen to the specified value.
`void`	`setScreenWidth(int screenWidth)` Sets the width in pixels of this CellGame's screen to the specified value.
`static void`	`startGame(CellGame game)` Starts a CellGame.
`void`	`unbindControl(Control control)` Unbinds the specified Control from its command, if it is bound to one.
`void`	`waitToBindToCommand(int commandNum)` Instructs this CellGame to bind the next valid Control pressed to the specified command.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final java.lang.String VERSION
```
    The version number of Cell2D, currently 2.1.1.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CellGame
```
public CellGame(java.lang.String title,
                int numCommands,
                int fps,
                int screenWidth,
                int screenHeight,
                double scaleFactor,
                boolean fullscreen,
                java.lang.String iconPath)
```
    Constructs a CellGame.
    
    Parameters:
    
    title - The title of this CellGame as seen on its program window
    
    numCommands - The total number of input commands that this CellGame needs to keep track of
    
    fps - The number of frames that this CellGame will execute every second
    
    screenWidth - The initial width of this CellGame's screen in pixels
    
    screenHeight - The initial height of this CellGame's screen in pixels
    
    scaleFactor - The initial factor by which the screen should be scaled to make the size of the program window
    
    fullscreen - Whether this CellGame should start in fullscreen mode
    
    iconPath - The relative path to the image file that this CellGame's program window should use as its icon, or null if the window should use the default LWJGL 2 icon
- Method Detail
  - loadNatives
```
public static void loadNatives(java.lang.String path)
```
    Loads the native libraries that are necessary for LWJGL 2, and thus Cell2D, to run. This method should be called exactly once before any CellGames are created.
    
    Parameters:
    
    path - The relative path to the folder containing the native libraries
  - startGame
```
public static void startGame(CellGame game)
```
    Starts a CellGame. Once the started CellGame is closed, the program will end.
    
    Parameters:
    
    game - The CellGame to start
  - close
```
public final void close()
```
    Instructs this CellGame to close itself the next time it finishes a game logic update.
  - getState
```
public final GameState getState(int id)
```
    Returns this CellGame's GameState with the specified ID, or null if there is none.
    
    Parameters:
    
    id - The ID of the GameState to return
    
    Returns:
    
    The GameState with the specified ID
  - getCurrentState
```
public final GameState getCurrentState()
```
    Returns the GameState that this CellGame is currently in.
    
    Returns:
    
    The GameState that this CellGame is currently in
  - enterState
```
public final void enterState(int id)
```
    Instructs this CellGame to enter its GameState with the specified ID the next time it finishes a game logic update. If this CellGame has no GameState with the specified ID, this method will do nothing.
    
    Parameters:
    
    id - The ID of the GameState to enter
  - enterState
```
public final void enterState(int id,
                             Color fadeColor,
                             int fadeOutTime,
                             int fadeInTime)
```
    Instructs this CellGame to enter its GameState with the specified ID the next time it finishes a game logic update, using a visual fade-out/fade-in effect to transition to it from the current GameState. If this CellGame has no GameState with the specified ID, this method will do nothing.
    
    Parameters:
    
    id - The ID of the GameState to enter
    
    fadeColor - The color of the fade effect
    
    fadeOutTime - The number of frames to be spent fading out from the current GameState
    
    fadeInTime - The number of frames to be spent fading in to the new GameState
  - loadLoadingAssets
```
public void loadLoadingAssets()
```
    Loads any assets that are used in renderLoadingVisuals(). This method is called automatically exactly once before renderLoadingVisuals() is.
  - renderLoadingVisuals
```
public void renderLoadingVisuals(Graphics g,
                                 int x1,
                                 int y1,
                                 int x2,
                                 int y2)
```
    Renders the visuals that this CellGame will display while its initActions() are in progress. This method is called automatically before initActions() is, so it cannot use assets that are first loaded in initActions(). Any assets used should be loaded in loadLoadingAssets() instead.
    
    Parameters:
    
    g - The Graphics context to which this CellGame is rendering the loading visuals
    
    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
  - initActions
```
public abstract void initActions()
```
    Actions for this CellGame to take when initializing itself before entering its first GameState. This should include creating at least one GameState for it, binding Controls to its commands, loading assets, etc. enterState() must be called during this method to tell the CellGame which GameState to start out in, or an Exception will be thrown.
  - renderActions
```
public void renderActions(Graphics g,
                          int x1,
                          int y1,
                          int x2,
                          int y2)
```
    Actions for this CellGame to take each frame to render visuals after its current GameState has finished rendering.
    
    Parameters:
    
    g - The Graphics context to which this CellGame 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
  - getNumCommands
```
public final int getNumCommands()
```
    Returns how many commands this CellGame has.
    
    Returns:
    
    How many commands this CellGame has
  - getControlsFor
```
public final java.util.Set<Control> getControlsFor(int commandNum)
```
    Returns an unmodifiable Set view of all of the Controls that are bound to the specified command.
    
    Parameters:
    
    commandNum - The number of the command whose controls are to be returned
    
    Returns:
    
    The Controls that are bound to the specified command
  - bindControl
```
public final void bindControl(int commandNum,
                              Control control)
```
    Binds the specified Control to the specified command. If the Control is already bound to a command, it will be unbound first.
    
    Parameters:
    
    commandNum - The command to bind the specified Control to
    
    control - The Control to bind to the specified command
  - unbindControl
```
public final void unbindControl(Control control)
```
    Unbinds the specified Control from its command, if it is bound to one.
    
    Parameters:
    
    control - The Control to be unbound
  - clearControls
```
public final void clearControls(int commandNum)
```
    Unbinds all of the specified command's Controls from it.
    
    Parameters:
    
    commandNum - The number of the command whose Controls are to be unbound
  - getBindingCommandNum
```
public final int getBindingCommandNum()
```
    Returns the number of the command to which this CellGame has been instructed to bind the next valid Control pressed, or -1 if there is none.
    
    Returns:
    
    The number of the command to which this CellGame has been instructed to bind the next valid Control pressed
  - waitToBindToCommand
```
public final void waitToBindToCommand(int commandNum)
```
    Instructs this CellGame to bind the next valid Control pressed to the specified command. After that Control is bound, the bindFinishedActions() method of this CellGame's current GameState will be called. This method will throw an Exception if this CellGame is already being used to type a String.
    
    Parameters:
    
    commandNum - The number of the command to which the next valid Control pressed should be bound
  - cancelBindToCommand
```
public final void cancelBindToCommand()
```
    Cancels this CellGame's instruction to bind the next valid Control pressed to a specified command, if it has been instructed to do so.
  - commandPressed
```
public final boolean commandPressed(int commandNum)
```
    Returns whether the specified command was pressed this frame. This is the case if one of the command's bound Controls was pressed while none of its other Controls were held.
    
    Parameters:
    
    commandNum - The number of the command to examine
    
    Returns:
    
    Whether the specified command was pressed this frame
  - commandHeld
```
public final boolean commandHeld(int commandNum)
```
    Returns whether the specified command is being held this frame. This is the case if any of the command's bound Controls are being held.
    
    Parameters:
    
    commandNum - The number of the command to examine
    
    Returns:
    
    Whether the specified command is being held this frame
  - commandReleased
```
public final boolean commandReleased(int commandNum)
```
    Returns whether the specified command was released this frame. This is the case if one of the command's bound Controls was released while none of its other Controls were held.
    
    Parameters:
    
    commandNum - The number of the command to examine
    
    Returns:
    
    Whether the specified command was released this frame
  - getMouseX
```
public final int getMouseX()
```
    Returns the x-coordinate in pixels of the mouse cursor on this CellGame's screen.
    
    Returns:
    
    The x-coordinate in pixels of the mouse cursor on this CellGame's screen
  - getMouseY
```
public final int getMouseY()
```
    Returns the y-coordinate in pixels of the mouse cursor on this CellGame's screen.
    
    Returns:
    
    The y-coordinate in pixels of the mouse cursor on this CellGame's screen
  - getMouseWheelChange
```
public final int getMouseWheelChange()
```
    Returns the change in the position of the mouse wheel since last frame. This value will be positive if the mouse wheel is being rotated up, negative if it is being rotated down, and zero if it is not being rotated.
    
    Returns:
    
    The change in the position of the mouse wheel since last frame
  - getTypingString
```
public final java.lang.String getTypingString()
```
    Returns the String that this CellGame is being used to type, or null if there is none.
    
    Returns:
    
    The String that this CellGame is being used to type
  - getMaxTypingStringLength
```
public final int getMaxTypingStringLength()
```
    Returns the maximum length in characters of the String that this CellGame is being used to type, or 0 if this CellGame is not being used to type a String.
    
    Returns:
    
    The maximum length of the String that this CellGame is being used to type
  - beginTypingString
```
public final void beginTypingString(int maxLength)
```
    Instructs this CellGame to interpret all inputs as typing a String with a specified maximum length until further notice. While typing, the Backspace key deletes individual characters, the Delete key resets the String to the empty String, the Escape key calls cancelTypingString(), and the Enter key finishes the typing and calls the stringFinishedActions() method of this CellGame's current GameState. This method will throw an Exception if this CellGame has already been instructed to bind the next Control pressed to a specified command.
    
    Parameters:
    
    maxLength - The maximum length in characters of the String to be typed
  - beginTypingString
```
public final void beginTypingString(java.lang.String initialString,
                                    int maxLength)
```
    Instructs this CellGame to interpret all inputs as typing a String with a specified initial value and maximum length until further notice. While typing, the Backspace key deletes individual characters, the Delete key resets the String to the empty String, the Escape key calls cancelTypingString(), and the Enter key finishes the typing and calls the stringFinishedActions() method of this CellGame's current GameState.
    
    Parameters:
    
    initialString - The initial value of the String to be typed, or null if the String should be empty initially
    
    maxLength - The maximum length in characters of the String to be typed
    
    Throws:
    
    java.lang.RuntimeException - if this CellGame has already been instructed to bind the next Control pressed to a command
  - cancelTypingString
```
public final void cancelTypingString()
```
    Instructs this CellGame to stop interpreting inputs as typing a String, if it was doing so, and consider the typing canceled. This will call the stringCanceledActions() method of this CellGame's current GameState.
  - getFPS
```
public final int getFPS()
```
    Returns the number of frames that this CellGame executes per second.
    
    Returns:
    
    The number of frames that this CellGame executes per second
  - setFPS
```
public final void setFPS(int fps)
```
    Sets the number of frames that this CellGame executes per second to the specified value.
    
    Parameters:
    
    fps - The new number of frames per second
  - getScreenWidth
```
public final int getScreenWidth()
```
    Returns the width in pixels of this CellGame's screen.
    
    Returns:
    
    The width in pixels of this CellGame's screen
  - setScreenWidth
```
public final void setScreenWidth(int screenWidth)
```
    Sets the width in pixels of this CellGame's screen to the specified value.
    
    Parameters:
    
    screenWidth - The new screen width
  - getScreenHeight
```
public final int getScreenHeight()
```
    Returns the height in pixels of this CellGame's screen.
    
    Returns:
    
    The height in pixels of this CellGame's screen
  - setScreenHeight
```
public final void setScreenHeight(int screenHeight)
```
    Sets the height in pixels of this CellGame's screen to the specified value.
    
    Parameters:
    
    screenHeight - The new screen height
  - getScaleFactor
```
public final double getScaleFactor()
```
    Returns the factor by which this CellGame's screen is scaled to make the size of the program window.
    
    Returns:
    
    This CellGame's screen scale factor
  - setScaleFactor
```
public final void setScaleFactor(double scaleFactor)
```
    Sets the factor by which this CellGame's screen is scaled to make the size of the program window to the specified value.
    
    Parameters:
    
    scaleFactor - The new screen scale factor
  - isFullscreen
```
public final boolean isFullscreen()
```
    Returns whether this CellGame is in fullscreen mode.
    
    Returns:
    
    Whether this CellGame is in fullscreen mode
  - setFullscreen
```
public final void setFullscreen(boolean fullscreen)
```
    Sets whether this CellGame is in fullscreen mode.
    
    Parameters:
    
    fullscreen - Whether this CellGame should be in fullscreen mode
  - getIconPath
```
public final java.lang.String getIconPath()
```
    Returns the relative path to the image file that this CellGame's program window uses as its icon, or null if the window uses the default LWJGL 2 icon.
    
    Returns:
    
    The relative path to the image file that this CellGame's program window uses as its icon
  - getMusicStackTop
```
public final int getMusicStackTop()
```
    Returns the greatest priority in this CellGame's music stack to which any Music tracks are assigned, or 0 if the music stack is empty. The Music tracks assigned to this priority are those that are currently playing.
    
    Returns:
    
    The greatest music stack priority to which any Music tracks are assigned
  - getMusicTracks
```
public final java.util.Set<Music> getMusicTracks(int priority)
```
    Returns an unmodifiable Set view of the Music tracks that are assigned to the specified priority in this CellGame's music stack, or an unmodifiable empty Set if the music stack is empty.
    
    Parameters:
    
    priority - The priority of the Music tracks to return
    
    Returns:
    
    The Set of Music tracks assigned to the specified priority
  - getMusicTracks
```
public final java.util.Set<Music> getMusicTracks()
```
    Returns an unmodifiable Set view of the Music tracks that are assigned to the greatest priority in this CellGame's music stack, or an unmodifiable empty Set if the music stack is empty. These Music tracks are those that are currently playing.
    
    Returns:
    
    The Set of Music tracks assigned to the music stack's greatest priority
  - getMusic
```
public final Music getMusic(int priority)
```
    Returns the Music track assigned to the specified priority in this CellGame's music stack, if there is exactly one such Music track, or null otherwise.
    
    Parameters:
    
    priority - The priority of the Music track to return
    
    Returns:
    
    The Music track assigned to the specified priority
  - getMusic
```
public final Music getMusic()
```
    Returns the Music track assigned to the greatest priority in this CellGame's music stack, if the music stack is not empty and there is exactly one such Music track, or null otherwise.
    
    Returns:
    
    The Music track assigned to the music stack's greatest priority
  - musicIsAtPriority
```
public final boolean musicIsAtPriority(int priority,
                                       Music music)
```
    Returns whether the specified Music track is assigned to the specified priority in this CellGame's music stack.
    
    Parameters:
    
    priority - The priority to examine
    
    music - The Music track to search for
    
    Returns:
    
    Whether the specified Music track is assigned to the specified priority in the music stack
  - addMusic
```
public final void addMusic(int priority,
                           Music music,
                           boolean loop,
                           boolean replace)
```
    Adds the specified Music track to the specified priority in this CellGame's music stack. If that priority is the music stack's greatest, the Music track will automatically begin playing.
    
    Parameters:
    
    priority - The priority to assign the specified Music track to
    
    music - The Music track to add
    
    loop - If true, the Music track will loop indefinitely until stopped when it plays; otherwise, it will play once
    
    replace - If true, all other Music tracks assigned to the specified priority will be removed from it
  - addMusic
```
public final void addMusic(int priority,
                           Music music,
                           double speed,
                           double volume,
                           boolean loop,
                           boolean replace)
```
    Adds the specified Music track to the specified priority in this CellGame's music stack. If that priority is the music stack's greatest, the Music track will automatically begin playing.
    
    Parameters:
    
    priority - The priority to assign the specified Music track to
    
    music - The Music track to add
    
    speed - The speed at which to play the specified Music track when it plays
    
    volume - The volume at which to play the specified Music track when it plays
    
    loop - If true, the Music track will loop indefinitely until stopped when it plays; otherwise, it will play once
    
    replace - If true, all other Music tracks assigned to the specified priority will be removed from it
  - addMusic
```
public final void addMusic(int priority,
                           Music music,
                           boolean loop)
```
    Adds the specified Music track to the specified priority in this CellGame's music stack, replacing and removing all other Music tracks assigned to that priority. If that priority is the music stack's greatest, the Music track will automatically begin playing.
    
    Parameters:
    
    priority - The priority to assign the specified Music track to
    
    music - The Music track to add
    
    loop - If true, the Music track will loop indefinitely until stopped when it plays; otherwise, it will play once
  - addMusic
```
public final void addMusic(int priority,
                           Music music,
                           double speed,
                           double volume,
                           boolean loop)
```
    Adds the specified Music track to the specified priority in this CellGame's music stack, replacing and removing all other Music tracks assigned to that priority. If that priority is the music stack's greatest, the Music track will automatically begin playing.
    
    Parameters:
    
    priority - The priority to assign the specified Music track to
    
    music - The Music track to add
    
    speed - The speed at which to play the specified Music track when it plays
    
    volume - The volume at which to play the specified Music track when it plays
    
    loop - If true, the Music track will loop indefinitely until stopped when it plays; otherwise, it will play once
  - addMusic
```
public final void addMusic(Music music,
                           boolean loop,
                           boolean replace)
```
    Adds the specified Music track to the greatest priority in this CellGame's music stack, or to priority 0 if the music stack is empty. The Music track will automatically begin playing.
    
    Parameters:
    
    music - The Music track to add
    
    loop - If true, the Music track will loop indefinitely until stopped when it plays; otherwise, it will play once
    
    replace - If true, all other Music tracks assigned to the priority to which the specified Music track is added will be removed from it
  - addMusic
```
public final void addMusic(Music music,
                           double speed,
                           double volume,
                           boolean loop,
                           boolean replace)
```
    Adds the specified Music track to the greatest priority in this CellGame's music stack, or to priority 0 if the music stack is empty. The Music track will automatically begin playing.
    
    Parameters:
    
    music - The Music track to add
    
    speed - The speed at which to play the specified Music track when it plays
    
    volume - The volume at which to play the specified Music track when it plays
    
    loop - If true, the Music track will loop indefinitely until stopped when it plays; otherwise, it will play once
    
    replace - If true, all other Music tracks assigned to the priority to which the specified Music track is added will be removed from it
  - addMusic
```
public final void addMusic(Music music,
                           boolean loop)
```
    Adds the specified Music track to the greatest priority in this CellGame's music stack, replacing and removing all other Music tracks assigned to that priority, or to priority 0 if the music stack is empty. The Music track will automatically begin playing.
    
    Parameters:
    
    music - The Music track to add
    
    loop - If true, the Music track will loop indefinitely until stopped when it plays; otherwise, it will play once
  - addMusic
```
public final void addMusic(Music music,
                           double speed,
                           double volume,
                           boolean loop)
```
    Adds the specified Music track to the greatest priority in this CellGame's music stack, replacing and removing all other Music tracks assigned to that priority, or to priority 0 if the music stack is empty. The Music track will automatically begin playing.
    
    Parameters:
    
    music - The Music track to add
    
    speed - The speed at which to play the specified Music track when it plays
    
    volume - The volume at which to play the specified Music track when it plays
    
    loop - If true, the Music track will loop indefinitely until stopped when it plays; otherwise, it will play once
  - removeMusic
```
public final void removeMusic(int priority,
                              Music music)
```
    Removes the specified Music track from the specified priority in this CellGame's music stack if it is currently assigned to that priority. If that priority is the music stack's greatest, the specified Music track will automatically stop.
    
    Parameters:
    
    priority - The priority from which to remove the specified Music track
    
    music - The Music track to remove
  - removeMusic
```
public final void removeMusic(int priority)
```
    Removes from the specified priority in this CellGame's music stack all of the Music tracks currently assigned to it. If that priority is the music stack's greatest, the removed Music tracks will automatically stop.
    
    Parameters:
    
    priority - The priority from which to remove all Music tracks
  - removeMusic
```
public final void removeMusic(Music music)
```
    Removes the specified Music track from the greatest priority in this CellGame's music stack if it is currently assigned to that priority. The specified Music track will automatically stop.
    
    Parameters:
    
    music - The Music track to remove
  - removeMusic
```
public final void removeMusic()
```
    Removes from the greatest priority in this CellGame's music stack all of the Music tracks currently assigned to it, if the music stack is not empty. The removed Music tracks will automatically stop.
  - clearMusic
```
public final void clearMusic()
```
    Removes from this CellGame's music stack all Music tracks assigned to any priority, leaving the stack empty.

Class CellGame

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

Constructor Detail

CellGame

Method Detail

loadNatives

startGame

close

getState

getCurrentState

enterState

enterState

loadLoadingAssets

renderLoadingVisuals

initActions

renderActions

getNumCommands

getControlsFor

bindControl

unbindControl

clearControls

getBindingCommandNum

waitToBindToCommand

cancelBindToCommand

commandPressed

commandHeld

commandReleased

getMouseX

getMouseY

getMouseWheelChange

getTypingString

getMaxTypingStringLength

beginTypingString

beginTypingString

cancelTypingString

getFPS

setFPS

getScreenWidth

setScreenWidth

getScreenHeight

setScreenHeight

getScaleFactor

setScaleFactor

isFullscreen

setFullscreen

getIconPath

getMusicStackTop

getMusicTracks

getMusicTracks

getMusic

getMusic

musicIsAtPriority

addMusic

addMusic

addMusic

addMusic

addMusic

addMusic

addMusic

addMusic

removeMusic

removeMusic

removeMusic

removeMusic

clearMusic