org.mini2Dx.core.game

Class ScreenBasedGame

java.lang.Object

org.mini2Dx.core.game.GameContainer

org.mini2Dx.core.game.ScreenBasedGame

public abstract class ScreenBasedGame
extends GameContainer

An implementation of GameContainer that allows for separation of a game into multiple GameScreens and provides support for Transitions between such screens via a ScreenManager

Field Summary

Fields inherited from class org.mini2Dx.core.game.GameContainer

graphics, height, MAXIMUM_DELTA, polygonSpriteBatch, shapeRenderer, spriteBatch, TARGET_FPS, width

Constructor Summary

Constructors

Constructor and Description
ScreenBasedGame()

Method Summary

Modifier and Type	Method and Description
void	addScreen(GameScreen screen) Add a GameScreen to this game
void	enterGameScreen(int id, Transition transitionOut, Transition transitionIn) Begins a transition to a new GameScreen
abstract int	getInitialScreenId() Returns the identifier of the GameScreen that should be shown when the game starts
ScreenManager<GameScreen>	getScreenManager() Returns the ScreenManager used by this game
void	interpolate(float alpha) Interpolate the game state
void	onPause()
void	onResume()
protected void	postinit() Internal post-initialisation code
protected void	preinit(Graphics g) Internal pre-initialisation code
void	render(Graphics g) Render the game
void	update(float delta) Update the game

Methods inherited from class org.mini2Dx.core.game.GameContainer

addResizeListener, createStage, dispose, getHeight, getWidth, initialise, removeResizeListener, render, resize, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenBasedGame

public ScreenBasedGame()

Method Detail

getInitialScreenId

public abstract int getInitialScreenId()

Returns the identifier of the GameScreen that should be shown when the game starts

Returns:

The GameScreen identifier via GameScreen.getId()

update

public void update(float delta)

Description copied from class: GameContainer

Update the game

Specified by:

update in class GameContainer

Parameters:

delta - The time in seconds since the last update

interpolate

public void interpolate(float alpha)

Description copied from class: GameContainer

Interpolate the game state

Specified by:

interpolate in class GameContainer

Parameters:

alpha - The alpha value to use during interpolation

render

public void render(Graphics g)

Description copied from class: GameContainer

Render the game

Specified by:

render in class GameContainer

Parameters:

g - The Graphics context available for rendering

onPause

public void onPause()

Specified by:

onPause in class GameContainer

onResume

public void onResume()

Specified by:

onResume in class GameContainer

addScreen

public void addScreen(GameScreen screen)

Add a GameScreen to this game

Parameters:

screen - The GameScreen to be added

enterGameScreen

public void enterGameScreen(int id,
                            Transition transitionOut,
                            Transition transitionIn)

Begins a transition to a new GameScreen

Parameters:

id - The id of the GameScreen to transition to

transitionOut - The outgoing Transition, e.g. fade out

transitionIn - The incoming Transition, e.g. fade in

preinit

protected void preinit(Graphics g)

Description copied from class: GameContainer

Internal pre-initialisation code

Overrides:

preinit in class GameContainer

postinit

protected void postinit()

Description copied from class: GameContainer

Internal post-initialisation code

Overrides:

postinit in class GameContainer

getScreenManager

public ScreenManager<GameScreen> getScreenManager()

Returns the ScreenManager used by this game

Returns: