org.achtern.AchternEngine.core

Class Game

java.lang.Object

org.achtern.AchternEngine.core.Game

All Implemented Interfaces:

EngineHolder<CoreEngine>, Renderable, Updatable

public abstract class Game
extends Object
implements Updatable, Renderable, EngineHolder<CoreEngine>

The abstract Game.

Constructor Summary

Constructors

Constructor and Description
Game()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Node node) Adds a node the scenegraph.
void	add(Node node, boolean forceName) Adds a node the scenegraph.
Node	get(String nodeName) Retrives a node by it's name.
GameDebugger	getDebugger()
CoreEngine	getEngine() Retrieves the stored engine
InputManager	getInputManager()
Texture	getSplashScreen() Returns the loading/splash image.
abstract Dimension	getWindowDimensions() Returns the dimensions of the window.
abstract String	getWindowTitle() Returns the title of the window.
boolean	has(Node node) Checks if a node exists in the scenegraph.
abstract void	init(CoreEngine engine) The Game should load all resources and setup the scene here.
boolean	isDebug() Is this game in debug mode?
void	preInit(CoreEngine engine) Injects the engine into game and scenegraph and inits the user's game.
void	preRender(RenderEngine renderEngine) This method will get called before each render
void	remove(Node node) Removes a node from the scenegraph.
boolean	remove(String nodeName) Removes a node from the scenegraph by it's name.
void	renderSceneGraph(RenderEngine renderEngine) Renders the scenegraph
void	setDebug(boolean debug) Enabled or disables the GameDebugger.
void	setEngine(CoreEngine engine) Inject the engine
void	setInputManager(InputManager inputManager)
void	updateSceneGraph(float delta) Delegates to the scenegraph and debugger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.achtern.AchternEngine.core.scenegraph.Updatable

update

Methods inherited from interface org.achtern.AchternEngine.core.rendering.Renderable

render

Constructor Detail

Game

public Game()

Method Detail

getWindowDimensions

public abstract Dimension getWindowDimensions()

Returns the dimensions of the window.

Returns:

The new window dimensions

getWindowTitle

public abstract String getWindowTitle()

Returns the title of the window.

Returns:

The window title

updateSceneGraph

public void updateSceneGraph(float delta)

Delegates to the scenegraph and debugger

Parameters:

delta - The delta time

preInit

public final void preInit(CoreEngine engine)

Injects the engine into game and scenegraph and inits the user's game.

Parameters:

engine - The CoreEngine instance (parent)

init

public abstract void init(CoreEngine engine)

The Game should load all resources and setup the scene here. A loading screen will get shown during this init process.

Parameters:

engine - The CoreEngine instance (parent)

renderSceneGraph

public final void renderSceneGraph(RenderEngine renderEngine)

Renders the scenegraph

Parameters:

renderEngine - The active RenderEngine instance

preRender

public void preRender(RenderEngine renderEngine)

This method will get called before each render

Parameters:

renderEngine - The active RenderEngine instance

add

public void add(Node node)

Adds a node the scenegraph. Keep a reference to it, or the node's name, in order to retrieve the node at a later point easily.

Parameters:

node - The node which should get added.

add

public void add(Node node,
       boolean forceName)

Adds a node the scenegraph. Keep a reference to it, or the node's name, in order to retrieve the node at a later point easily.

Parameters:

node - The node which should get added.

get

public Node get(String nodeName)

Retrives a node by it's name. If you want to get nested nodes, sperate the Nodes names with a slash (/).

Parameters:

nodeName - The node's name

Returns:

The node or null if not found

has

public boolean has(Node node)

Checks if a node exists in the scenegraph. Only checks the top level and NOT sup-nodes

Parameters:

node - The node to check

Returns:

whether node has been found

remove

public void remove(Node node)

Removes a node from the scenegraph. Doesn't search in sub-nodes!

Parameters:

node - The node to remove

remove

public boolean remove(String nodeName)

Removes a node from the scenegraph by it's name. Doesn't search in sub-nodes!

Parameters:

nodeName - The node's name

Returns:

Whether the removing was successful

getSplashScreen

public Texture getSplashScreen()

Returns the loading/splash image. Should only do minimal stuff! FAST FAST FAST If the texture is null, the engine's default image will get shown.

Returns:

A texture | null

getEngine

public CoreEngine getEngine()

Description copied from interface: EngineHolder

Retrieves the stored engine

Specified by:

getEngine in interface EngineHolder<CoreEngine>

Returns:

The stored engine

See Also:

EngineHolder.getEngine()

setEngine

public void setEngine(CoreEngine engine)

Description copied from interface: EngineHolder

Inject the engine

Specified by:

setEngine in interface EngineHolder<CoreEngine>

Parameters:

engine - The engine to store

See Also:

EngineHolder.setEngine(Object)

isDebug

public boolean isDebug()

Is this game in debug mode?

Returns:

whether debug is enabled

setDebug

public void setDebug(boolean debug)

Enabled or disables the GameDebugger. On Disable the debugger will get destroyed and on re-enable a new one will get initiated.

Parameters:

debug - To turn debug mode on or off (true | false)

getDebugger

public GameDebugger getDebugger()

getInputManager

public InputManager getInputManager()

setInputManager

public void setInputManager(InputManager inputManager)