Package games.stendhal.server.core.scripting

Class ScriptImpl

java.lang.Object

games.stendhal.server.core.scripting.ScriptImpl

All Implemented Interfaces:

Script

Direct Known Subclasses:

AbstractOfflineAction, AdminMaker, AdminPortal, AdminSign, AlterLoot, AlterQuest, BetManager, BugInspect, ChangeMap, ContMoveAndStrengthenOnlinePlayers, CountObjects, CountUnusedSprites, CreateRaid, CreaturesRatioCalculator, DBLogging, Debuggera, DeepInspect, DisableFeature, DropPlayerItems, DumpCharacterFromDatabase, DumpConditions, DumpDeletionCandidates, DumpItems, DumpOpenDBTransactions, DumpTransitions, DumpTransitionsEx, DumpTurnListenerEvents, EasterBunny, EasyRPAction, EnableFeature, Enchant, EntitySearch, EventTest, ExecuteLua, ExecuteSQL, FieldInspect, FindBrokenCorpses, FishInspect, FixDM, FixNegativeHp, FreezeHell, GC, HandleTransitions, Herald, ItemRarity, ListNPCs, ListRaids, ListZones, Log4J, LogoutPlayer, Maria, MineTown, MoveAndStrengthenOnlinePlayers, NameChange, NPCPathCheck, NPCShout, NPCShoutZone, Observer, Plague, PlayerPositionMonitoring, RemoveClient, RemoveVisitedZone, RemoveZone, ResetSlot, ResetTutorial, RestoreOriginalOutfit, Santa, SaveAllPlayers, ServerDown, ServerReset, ServerShutdown, SetNPCPath, SetNPCPathReversible, SetWelcomeText, SokobanReload, SokobanWatcher, SummonChest, SummonSpell, TeleportAllPlayers, TeleportNPC, TestShowItemList, TPPNextPhase, TPPShowQuestState, Unblock, UnblockTradeTable, WhereWho, ZoneCollisionCheck, ZoneStatistics

public class ScriptImpl
extends Object
implements Script

Default implementation of the Script interface.

Author:

hendrik

Field Summary

Fields

Modifier and Type	Field	Description
protected ScriptingSandbox	sandbox	all modifications must be done using this object to be undoable on unload.

Constructor Summary

Constructors

Constructor	Description
ScriptImpl()

Method Summary

Modifier and Type	Method	Description
void	execute(Player admin, List<String> args)	Executes this script.
void	load(Player admin, List<String> args, ScriptingSandbox sandbox)	Initial load of this script.
void	unload(Player admin, List<String> args)	Unloads this script.

Methods inherited from class java.lang.Object

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

Field Details

sandbox

protected ScriptingSandbox sandbox

all modifications must be done using this object to be undoable on unload.

Constructor Details

ScriptImpl

public ScriptImpl()

Method Details

execute

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

Description copied from interface: Script

Executes this script.

Specified by:

execute in interface Script

Parameters:

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

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

load

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

Description copied from interface: Script

Initial load of this script.

Specified by:

load in interface Script

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

Parameters:

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

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