Class GameScript

java.lang.Object

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

de.gurkenlabs.litiengine.scripting.GameScript

All Implemented Interfaces:

ScriptInstance

public abstract class GameScript
extends AbstractScript<Object>

Base class for scripts attached to the game lifecycle.

Field Summary

Fields inherited from class AbstractScript

globals

Constructor Summary

Constructors

Constructor	Description
GameScript()

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.
void	exit()	Exits and terminates the game.
void	loadMap(IMap map)	Loads an environment map.
void	loadMap(String mapName)	Loads an environment map by map name.
protected void	onStarted()	Called after the binding enters the running game lifecycle.
protected void	onStopped()	Called before the binding leaves the game lifecycle.
void	playMusic(String musicName)	Plays a background music track by resource name.
void	playSound(String soundName)	Plays a sound effect by resource name.
void	stopMusic()	Stops currently playing music.

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

GameScript

public GameScript()

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<Object>

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<Object>

Throws:

Exception - if cleanup fails.

onStarted

protected void onStarted()
                  throws Exception

Called after the binding enters the running game lifecycle.

Throws:

Exception

onStopped

protected void onStopped()
                  throws Exception

Called before the binding leaves the game lifecycle.

Throws:

Exception

loadMap

public void loadMap(String mapName)

Loads an environment map by map name.

loadMap

public void loadMap(IMap map)

Loads an environment map.

playSound

public void playSound(String soundName)

Plays a sound effect by resource name.

playMusic

public void playMusic(String musicName)

Plays a background music track by resource name.

stopMusic

public void stopMusic()

Stops currently playing music.

exit

public void exit()

Exits and terminates the game.

classapijava