Class EnvironmentScript

java.lang.Object

de.gurkenlabs.litiengine.scripting.AbstractScript<Environment>

de.gurkenlabs.litiengine.scripting.EnvironmentScript

All Implemented Interfaces:

ScriptInstance

public abstract class EnvironmentScript
extends AbstractScript<Environment>

Base class for scripts attached to one loaded environment.

Field Summary

Fields inherited from class AbstractScript

globals

Constructor Summary

Constructors

Constructor	Description
EnvironmentScript()

Method Summary

Modifier and Type	Method	Description
protected final void	attached()	Called after the context is installed and the script becomes active.
protected final void	detached()	Called before context-owned resources are released.
protected void	onCleared()	Called when the attached environment is cleared while it remains active.
protected void	onEntityAdded(IEntity entity)	Called when an entity is added to the attached environment.
protected void	onEntityRemoved(IEntity entity)	Called when an entity is removed from the attached environment.
protected void	onLoaded()	Called after the environment has loaded and is the current world environment.
protected void	onUnloaded()	Called when the environment binding is detached during unload.

Methods inherited from class AbstractScript

attach, camera, context, detach, environment, globals, host, input, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheel, onRender, render, spawn, spawn, spawn, spawn, spawnCreature, spawnCreature, spawner, spawnProp, spawnProp, ui

Methods inherited from class Object

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

Methods inherited from interface ScriptInstance

update

Constructor Details

EnvironmentScript

public EnvironmentScript()

Method Details

attached

protected final void attached()
                       throws Exception

Description copied from class: AbstractScript

Called after the context is installed and the script becomes active.

Overrides:

attached in class AbstractScript<Environment>

Throws:

Exception - if initialization fails.

detached

protected final void detached()
                       throws Exception

Description copied from class: AbstractScript

Called before context-owned resources are released.

Overrides:

detached in class AbstractScript<Environment>

Throws:

Exception - if cleanup fails.

onLoaded

protected void onLoaded()
                 throws Exception

Called after the environment has loaded and is the current world environment.

Throws:

Exception

onUnloaded

protected void onUnloaded()
                   throws Exception

Called when the environment binding is detached during unload.

Throws:

Exception

onCleared

protected void onCleared()
                  throws Exception

Called when the attached environment is cleared while it remains active.

Throws:

Exception

onEntityAdded

protected void onEntityAdded(IEntity entity)
                      throws Exception

Called when an entity is added to the attached environment.

Throws:

Exception

onEntityRemoved

protected void onEntityRemoved(IEntity entity)
                        throws Exception

Called when an entity is removed from the attached environment.

Throws:

Exception

classapijava