Package games.stendhal.server.core.scripting.lua

Class LuaWorldHelper

java.lang.Object

games.stendhal.server.core.scripting.ScriptingSandbox

games.stendhal.server.core.scripting.lua.LuaWorldHelper

public class LuaWorldHelper
extends ScriptingSandbox

Field Summary

Fields inherited from class games.stendhal.server.core.scripting.ScriptingSandbox

filename

Method Summary

Modifier and Type	Method	Description
GameEvent	createEvent(String source, String event, String... params)	Creates a new game event.
GameEvent	createEvent(String source, String event, org.luaj.vm2.LuaTable params)	Creates a new game event.
static LuaWorldHelper	get()	Retrieves singleton instance.
boolean	load(Player player, List<String> args)
void	raiseEvent(String source, String event, String... params)	Executes a new game event.
void	raiseEvent(String source, String event, org.luaj.vm2.LuaTable params)	Executes a new game event.
void	runAfter(int turns, org.luaj.vm2.LuaFunction func)	Executes a function after a specified number of turns.
void	setMusic(String filename)	Sets the background music for the current zone.
void	setMusic(String filename, org.luaj.vm2.LuaTable args)	Sets the background music for the current zone.

Methods inherited from class games.stendhal.server.core.scripting.ScriptingSandbox

add, add, add, add, addGameEvent, execute, getCreature, getCreatures, getItem, getItems, getMessage, getZone, getZone, modify, playerIsInZone, postExecute, preExecute, privateText, remove, remove, setMessage, setZone, setZone, unload

Methods inherited from class java.lang.Object

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

Method Details

get

public static LuaWorldHelper get()

Retrieves singleton instance.

load

public boolean load(Player player,
 List<String> args)

Specified by:

load in class ScriptingSandbox

setMusic

public void setMusic(String filename,
 org.luaj.vm2.LuaTable args)

Sets the background music for the current zone.

Parameters:

filename - File basename excluding .ogg extension.

args - Lua table of key=value integer values. Valid keys are `volume`, `x`, `y`, & `radius`.

setMusic

public void setMusic(String filename)

Sets the background music for the current zone.

Parameters:

filename - File basename excluding .ogg extension.

runAfter

public void runAfter(int turns,
 org.luaj.vm2.LuaFunction func)

Executes a function after a specified number of turns.

Parameters:

turns - Number of turns to wait.

func - The function to be executed.

createEvent

public GameEvent createEvent(String source,
 String event,
 String... params)

Creates a new game event.

Parameters:

source - Source of the event, usually a character.

event - Name of event.

params - List of event parameters.

Returns:

New `games.stendhal.server.core.engine.GameEvent` instance.

createEvent

public GameEvent createEvent(String source,
 String event,
 org.luaj.vm2.LuaTable params)

Creates a new game event.

Parameters:

source - Source of the event, usually a character.

event - Name of event.

params - List of event parameters.

Returns:

New `games.stendhal.server.core.engine.GameEvent` instance.

raiseEvent

public void raiseEvent(String source,
 String event,
 String... params)

Executes a new game event.

Parameters:

source - Source of the event, usually a character.

event - Name of event.

params - List of event parameters.

raiseEvent

public void raiseEvent(String source,
 String event,
 org.luaj.vm2.LuaTable params)

Executes a new game event.

Parameters:

source - Source of the event, usually a character.

event - Name of event.

params - List of event parameters.