StateBasedGame (Slick - The 2D Library)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.newdawn.slick.state
Class StateBasedGame

java.lang.Object
  org.newdawn.slick.state.StateBasedGame

All Implemented Interfaces:: ControlledInputReciever, ControllerListener, Game, InputListener, KeyListener, MouseListener

Direct Known Subclasses:: StateBasedTest, TransitionTest

public abstract class StateBasedGame
extends java.lang.Object
implements Game, InputListener
extends java.lang.Object
implements Game, InputListener

A state based game isolated different stages of the game (menu, ingame, hiscores, etc) into different states so they can be easily managed and maintained.

Author:: kevin

Constructor Summary
`StateBasedGame(java.lang.String name)` Create a new state based game

Method Summary
`void`	`addState(GameState state)` Add a state to the game.
`boolean`	`closeRequested()` Notification that a game close has been requested
`void`	`controllerButtonPressed(int controller, int button)` Notification that a button control has been pressed on the controller.
`void`	`controllerButtonReleased(int controller, int button)` Notification that a button control has been released on the controller.
`void`	`controllerDownPressed(int controller)` Notification that the down control has been pressed on the controller.
`void`	`controllerDownReleased(int controller)` Notification that the down control has been released on the controller.
`void`	`controllerLeftPressed(int controller)` Notification that the left control has been pressed on the controller.
`void`	`controllerLeftReleased(int controller)` Notification that the left control has been released on the controller.
`void`	`controllerRightPressed(int controller)` Notification that the right control has been pressed on the controller.
`void`	`controllerRightReleased(int controller)` Notification that the right control has been released on the controller.
`void`	`controllerUpPressed(int controller)` Notification that the up control has been pressed on the controller.
`void`	`controllerUpReleased(int controller)` Notification that the up control has been released on the controller.
`void`	`enterState(int id)` Enter a particular game state with no transition
`void`	`enterState(int id, Transition leave, Transition enter)` Enter a particular game state with the transitions provided
`GameContainer`	`getContainer()` Get the container holding this game
`GameState`	`getCurrentState()` Get the state the game is currently in
`int`	`getCurrentStateID()` Get the ID of the state the game is currently in
`GameState`	`getState(int id)` Get a state based on it's identifier
`int`	`getStateCount()` Get the number of states that have been added to this game
`java.lang.String`	`getTitle()` Get the title of this game
`void`	`init(GameContainer container)` Initialise the game.
`abstract void`	`initStatesList(GameContainer container)` Initialise the list of states making up this game
`void`	`inputEnded()` Notification that all input events have been sent for this frame
`void`	`inputStarted()` Notification that input is about to be processed
`boolean`	`isAcceptingInput()` Check if this input listener is accepting input
`void`	`keyPressed(int key, char c)` Notification that a key was pressed
`void`	`keyReleased(int key, char c)` Notification that a key was released
`void`	`mouseClicked(int button, int x, int y, int clickCount)` Notification that a mouse button was clicked.
`void`	`mouseDragged(int oldx, int oldy, int newx, int newy)` Notification that mouse cursor was dragged
`void`	`mouseMoved(int oldx, int oldy, int newx, int newy)` Notification that mouse cursor was moved
`void`	`mousePressed(int button, int x, int y)` Notification that a mouse button was pressed
`void`	`mouseReleased(int button, int x, int y)` Notification that a mouse button was released
`void`	`mouseWheelMoved(int newValue)` Notification that the mouse wheel position was updated
`protected void`	`postRenderState(GameContainer container, Graphics g)` User hook for rendering at the game level after the current state and/or transition have been rendered
`protected void`	`postUpdateState(GameContainer container, int delta)` User hook for rendering at the game level after the current state and/or transition have been updated
`protected void`	`preRenderState(GameContainer container, Graphics g)` User hook for rendering at the before the current state and/or transition have been rendered
`protected void`	`preUpdateState(GameContainer container, int delta)` User hook for updating at the game before the current state and/or transition have been updated
`void`	`render(GameContainer container, Graphics g)` Render the game's screen here.
`void`	`setInput(Input input)` Set the input that events are being sent from
`void`	`update(GameContainer container, int delta)` Update the game logic here.

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

Constructor Detail

StateBasedGame

public StateBasedGame(java.lang.String name)

Create a new state based game

Parameters:: name - The name of the game

Method Detail

inputStarted

public void inputStarted()

Description copied from interface: ControlledInputReciever

Notification that input is about to be processed

Specified by:: inputStarted in interface ControlledInputReciever

See Also:: ControlledInputReciever.inputStarted()

getStateCount

public int getStateCount()

Get the number of states that have been added to this game

Returns:: The number of states that have been added to this game

getCurrentStateID

public int getCurrentStateID()

Get the ID of the state the game is currently in

Returns:: The ID of the state the game is currently in

getCurrentState

public GameState getCurrentState()

Get the state the game is currently in

Returns:: The state the game is currently in

setInput

public void setInput(Input input)

Description copied from interface: ControlledInputReciever

Set the input that events are being sent from

Specified by:: setInput in interface ControlledInputReciever

Parameters:: input - The input instance sending events
See Also:: ControlledInputReciever.setInput(org.newdawn.slick.Input)

addState

public void addState(GameState state)

Add a state to the game. The state will be updated and maintained by the game

Parameters:: state - The state to be added

getState

public GameState getState(int id)

Get a state based on it's identifier

Parameters:: id - The ID of the state to retrieve
Returns:: The state requested or null if no state with the specified ID exists

enterState

public void enterState(int id)

Enter a particular game state with no transition

Parameters:: id - The ID of the state to enter

enterState

public void enterState(int id,
                       Transition leave,
                       Transition enter)

Enter a particular game state with the transitions provided

Parameters:: id - The ID of the state to enter; leave - The transition to use when leaving the current state; enter - The transition to use when entering the new state

init

public final void init(GameContainer container)
                throws SlickException

Description copied from interface: Game

Initialise the game. This can be used to load static resources. It's called before the game loop starts

Specified by:: init in interface Game

Parameters:: container - The container holding the game
Throws:: SlickException - Throw to indicate an internal error
See Also:: BasicGame.init(org.newdawn.slick.GameContainer)

initStatesList

public abstract void initStatesList(GameContainer container)
                             throws SlickException

Initialise the list of states making up this game

Parameters:: container - The container holding the game
Throws:: SlickException - Indicates a failure to initialise the state based game resources

render

public final void render(GameContainer container,
                         Graphics g)
                  throws SlickException

Description copied from interface: Game

Render the game's screen here.

Specified by:: render in interface Game

Parameters:: container - The container holing this game; g - The graphics context that can be used to render. However, normal rendering routines can also be used.
Throws:: SlickException - Throw to indicate a internal error
See Also:: Game.render(org.newdawn.slick.GameContainer, org.newdawn.slick.Graphics)

preRenderState

protected void preRenderState(GameContainer container,
                              Graphics g)
                       throws SlickException

User hook for rendering at the before the current state and/or transition have been rendered

Parameters:: container - The container in which the game is hosted; g - The graphics context on which to draw
Throws:: SlickException - Indicates a failure within render

postRenderState

protected void postRenderState(GameContainer container,
                               Graphics g)
                        throws SlickException

User hook for rendering at the game level after the current state and/or transition have been rendered

Parameters:: container - The container in which the game is hosted; g - The graphics context on which to draw
Throws:: SlickException - Indicates a failure within render

update

public final void update(GameContainer container,
                         int delta)
                  throws SlickException

Description copied from interface: Game

Update the game logic here. No rendering should take place in this method though it won't do any harm.

Specified by:: update in interface Game

Parameters:: container - The container holing this game; delta - The amount of time thats passed since last update in milliseconds
Throws:: SlickException - Throw to indicate an internal error
See Also:: BasicGame.update(org.newdawn.slick.GameContainer, int)

preUpdateState

protected void preUpdateState(GameContainer container,
                              int delta)
                       throws SlickException

User hook for updating at the game before the current state and/or transition have been updated

Parameters:: container - The container in which the game is hosted; delta - The amount of time in milliseconds since last update
Throws:: SlickException - Indicates a failure within render

postUpdateState

protected void postUpdateState(GameContainer container,
                               int delta)
                        throws SlickException

User hook for rendering at the game level after the current state and/or transition have been updated

Parameters:: container - The container in which the game is hosted; delta - The amount of time in milliseconds since last update
Throws:: SlickException - Indicates a failure within render

closeRequested

public boolean closeRequested()

Description copied from interface: Game

Notification that a game close has been requested

Specified by:: closeRequested in interface Game

Returns:: True if the game should close
See Also:: Game.closeRequested()

getTitle

public java.lang.String getTitle()

Description copied from interface: Game

Get the title of this game

Specified by:: getTitle in interface Game

Returns:: The title of the game
See Also:: Game.getTitle()

getContainer

public GameContainer getContainer()

Get the container holding this game

Returns:: The game container holding this game