Package games.stendhal.server.script

Class Herald

java.lang.Object

games.stendhal.server.core.scripting.ScriptImpl

games.stendhal.server.script.Herald

All Implemented Interfaces:

Script

public class Herald
extends ScriptImpl

A herald which will tell news to citizens.

Author:

yoriy

Field Summary

Fields

Modifier and Type	Field	Description
final String	HeraldName

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

sandbox

Constructor Summary

Constructors

Constructor	Description
Herald()

Method Summary

Modifier and Type	Method	Description
void	load(Player admin, List<String> args, ScriptingSandbox sandbox)	invokes by /script -load Herald.class, placing herald near calling admin.
void	unload(Player admin, List<String> args)	Unloads this script.
void	workWithCounters(int id)	function invokes by HeraldListener.onTurnReached each time when herald have to speech.

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

execute

Methods inherited from class java.lang.Object

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

Field Details

HeraldName

public final String HeraldName

See Also:

• Constant Field Values

Constructor Details

Herald

public Herald()

Method Details

load

public void load(Player admin,
 List<String> args,
 ScriptingSandbox sandbox)

invokes by /script -load Herald.class, placing herald near calling admin.

Specified by:

load in interface Script

Overrides:

load in class ScriptImpl

Parameters:

admin - the admin who load it or null on server start.

args - the arguments the admin specified or null on server start.

sandbox - all modifications to the game must be done using this object in order for the script to be unloadable

unload

public void unload(Player admin,
 List<String> args)

Description copied from interface: Script

Unloads this script.

Specified by:

unload in interface Script

Overrides:

unload in class ScriptImpl

Parameters:

admin - the admin who load it or null on server start.

args - the arguments the admin specified or null on server start.

workWithCounters

public void workWithCounters(int id)

function invokes by HeraldListener.onTurnReached each time when herald have to speech.

Parameters:

id - - ID for news in news list