com.bonzaiengine.gamekit.component

Class ScriptComponent

java.lang.Object

com.bonzaiengine.gamekit.component.ScriptComponent

All Implemented Interfaces:

IComponent

public abstract class ScriptComponent
extends java.lang.Object
implements IComponent

General script to attach to a GameObject.
The script can override various pre-defined methods:

• init()
• updateStep(long)
• processInputs(IInput)
• update(long)
• updateEnd(long)

Editable fiels should use the SerializableField annotation.

Constructor Summary

Constructors

Constructor and Description
ScriptComponent()

Method Summary

Modifier and Type	Method and Description
<T extends IService> T	getService(java.lang.Class<T> clazz)
void	init() Called when the script is initialized
void	init(GameObject gameObject) internal - don't call
void	onActivate() Called when the GameObject is activated
void	onDeactivate() Called when the GameObject is deactivated
void	onDestroy() Called when the GameObject is destroyed.
void	processInputs(IInput input) Called to process input events
void	start() Called when the script is starten
void	update(long timePassedMs) Called to do usual update, based on framerate / delta time
void	updateEnd(long timePassedMs) Called after update(long) of all GameObject
void	updateStep(long timeStepMs) Called at each physic simulation steps

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bonzaiengine.gamekit.component.IComponent

getGameObject

Constructor Detail

ScriptComponent

public ScriptComponent()

Method Detail

getService

public final <T extends IService> T getService(java.lang.Class<T> clazz)

init

public final void init(GameObject gameObject)

internal - don't call

Specified by:

init in interface IComponent

onActivate

public void onActivate()

Called when the GameObject is activated

Specified by:

onActivate in interface IComponent

onDeactivate

public void onDeactivate()

Called when the GameObject is deactivated

Specified by:

onDeactivate in interface IComponent

onDestroy

public void onDestroy()

Called when the GameObject is destroyed.
If overrided by user script, call super.onDestroy() at the end of the overrided method.

Specified by:

onDestroy in interface IComponent

init

public void init()

Called when the script is initialized

See Also:

GameScreen

start

public void start()

Called when the script is starten

Specified by:

start in interface IComponent

See Also:

GameScreen

updateStep

public void updateStep(long timeStepMs)

Called at each physic simulation steps

See Also:

GameScreen

processInputs

public void processInputs(IInput input)

Called to process input events

update

public void update(long timePassedMs)

Called to do usual update, based on framerate / delta time

updateEnd

public void updateEnd(long timePassedMs)

Called after update(long) of all GameObject