Class GameEngine

java.lang.Object

processing.core.PApplet

GameEngine

public class GameEngine
extends processing.core.PApplet

This class manages an entire game: loading and playing a sequence of Levels, providing access to user input, and setting up the infrastructure for creating, drawing, and colliding many Graphic objects.

Method Summary

Modifier and Type	Method and Description
static int	getHeight() This method retrieves the height in pixels of the game's window display.
static int	getMouseX() This method retrieves the x-position of the mouse in pixels within the game window.
static int	getMouseY() This method retrieves the y-position of the mouse in pixels within the game window.
static int	getWidth() This method retrieves the width in pixels of the game's window display.
static boolean	isKeyHeld(java.lang.String key) This method retrieves whether a key is currently being held by the user.
static boolean	isKeyPressed(java.lang.String key) This method retrieves whether a key has been just pressed by the user.
static void	start(java.lang.Integer rngSeed, java.lang.String[] levels) This method creates a single Engine, and begins playing through the specified sequence of levels.

Methods inherited from class java.lang.Object

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

Method Detail

start

public static void start(java.lang.Integer rngSeed,
                         java.lang.String[] levels)

This method creates a single Engine, and begins playing through the specified sequence of levels. If a seed is provided, it will be used within the sole Random number generator used by this game. This method should be called before any of the other GameEngine methods.

Parameters:

rngSeed - - is an optional seed for a random number generator. Passing null sets this seed to a value that is likely different upon each invocation.

levels - - is the list of level file names that you would like the player to progress through in this game.

getWidth

public static int getWidth()

This method retrieves the width in pixels of the game's window display.

Returns:

The width of the graphical display (in pixels), or -1 if GameEngine.start() has not yet been called.

getHeight

public static int getHeight()

This method retrieves the height in pixels of the game's window display.

Returns:

The height of the graphical display (in pixels), or -1 if GameEngine.start() has not yet been called.

isKeyPressed

public static boolean isKeyPressed(java.lang.String key)

This method retrieves whether a key has been just pressed by the user. This will only be true once for each complete press and release of a key.

Parameters:

key - - is the key (or mouse) that you would like to retrieve the current status of. Most keys are retrieved by their face character: "Q", "W', "1", "2", etc. Some other keys that can be detected by name include: "TAB", "ENTER", "SHIFT", "SPACE", "LEFT", "UP", "RIGHT", "DOWN", and "MOUSE" (where "MOUSE" represents the left mouse button).

Returns:

true when the key has just been pressed, and false otherwise. Returns false when GameEngine.start() has not yet been called.

isKeyHeld

public static boolean isKeyHeld(java.lang.String key)

This method retrieves whether a key is currently being held by the user. This will remain true for as long as the key continues to be held down.

Parameters:

key - - is the key (or mouse) that you would like to retrieve the current status of. Most keys are retrieved by their face character: "Q", "W', "1", "2", etc. Some other keys that can be detected by name include: "TAB", "ENTER", "SHIFT", "SPACE", "LEFT", "UP", "RIGHT", "DOWN", and "MOUSE" (where "MOUSE" represents the left mouse button).

Returns:

true while the key is being held, and false otherwise. Returns false when GameEngine.start() has not yet been called.

getMouseX

public static int getMouseX()

This method retrieves the x-position of the mouse in pixels within the game window. Zero corresponds to the left-most column of pixels, and GameEngine.getWidth()-1 corresponds to the right-most column of pixels.

Returns:

The x-coordinate of the mouse in pixels within the display, or returns -1 when GameEngine.start() has not yet been called.

getMouseY

public static int getMouseY()

This method retrieves the y-position of the mouse in pixels within the game window. Zero corresponds to the top-most row of pixels, and GameEngine.getHeight()-1 corresponds to the bottom-most row of pixels.

Returns:

The y-coordinate of the mouse in pixels within the display, or returns -1 when GameEngine.start() has not yet been called.