com.bonzaiengine.gamekit

Class GameScreen

java.lang.Object

com.bonzaiengine.gamekit.GameScreen

public final class GameScreen
extends java.lang.Object

A GameScreen is defined by a GameObject SceneGraph.
A screen can be a menu, a level/world or the entire game.
Game only maintains in memory one GameScreen. This means the current GameScreen will be fully unload before the next GameScreen will becomes active.
Init steps:

• init:
• start:

Render loop steps:

• updateStep: physic simulation fixed step update (can be called 0 to multiple time per loop, depending on delta time)
• processInputs: game object input processing
• update: game object update (called 0 or once per loop, depending on delta time)
• updateEnd: game object update end(called once if update has been called)
• render: game object rendering

Constructor Summary

Constructors

Constructor and Description
GameScreen(java.lang.String name, ILoader<GameScreen> loader)

Method Summary

Modifier and Type	Method and Description
void	add(GameObject gameObject)
void	delay(java.lang.Runnable runnable)
protected void	doReload()
GameObject	find(java.lang.String name)
AssetManager	getAssets()
PhysicWorld	getPhysic()
AssetManager	getUiAssets()
boolean	isDebugRenderPhysic()
boolean	isRendererSortPackets()
protected void	load(Game game) Load this GameScreen now
void	log(GameObject gameObject, java.lang.Throwable t)
void	registerUi(UI ui)
void	reload() Reload this GameScreen Note: Reload will actually be done at the end of update
void	remove(GameObject gameObject) Equivalent to GameObject.destroy()
protected void	render(IGLApi glApi)
void	setDebugRenderPhysic(boolean debugRenderPhysic)
void	setRendererSortPackets(boolean sort)
protected void	unload(IGLApi glApi)
protected void	update(long timePassedMs, IInput input)

Methods inherited from class java.lang.Object

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

Constructor Detail

GameScreen

public GameScreen(java.lang.String name,
                  ILoader<GameScreen> loader)

Parameters:

name - name of this GameScreen

loader - this GameScreen loader

Method Detail

setRendererSortPackets

public final void setRendererSortPackets(boolean sort)

Parameters:

sort - true to sort packets. Default: true

isRendererSortPackets

public final boolean isRendererSortPackets()

add

public final void add(GameObject gameObject)

Parameters:

gameObject - GameObject to add

See Also:

#add(GameObject, boolean)

remove

public final void remove(GameObject gameObject)

Equivalent to GameObject.destroy()

Parameters:

gameObject - GameObject to remove/destroy

See Also:

GameObject.destroy()

find

public final GameObject find(java.lang.String name)

Parameters:

name - name of the GameObject to search

Returns:

the first GameObject found with the specified name, if any

load

protected final void load(Game game)

Load this GameScreen now

reload

public final void reload()

Reload this GameScreen
Note: Reload will actually be done at the end of update

doReload

protected final void doReload()

unload

protected final void unload(IGLApi glApi)

getPhysic

public final PhysicWorld getPhysic()

Returns:

the PhysicWorld of this GameScreen.
Only available if the requested at GameScreen construction.

See Also:

GameScreen(String, ILoader)

getAssets

public final AssetManager getAssets()

Returns:

get or create AssetManager

getUiAssets

public final AssetManager getUiAssets()

Returns:

get or create AssetManager for UI

registerUi

public final void registerUi(UI ui)

Parameters:

ui - register the specified UI to receive events

isDebugRenderPhysic

public final boolean isDebugRenderPhysic()

Returns:

true if debug mode for rendering physic collision shape and contacts

setDebugRenderPhysic

public final void setDebugRenderPhysic(boolean debugRenderPhysic)

Parameters:

debugRenderPhysic - set the debugRenderPhysic flag

See Also:

isDebugRenderPhysic()

update

protected final void update(long timePassedMs,
                            IInput input)

Parameters:

timePassedMs -

input -

delay

public void delay(java.lang.Runnable runnable)

render

protected final void render(IGLApi glApi)

log

public final void log(GameObject gameObject,
                      java.lang.Throwable t)