Package games.stendhal.server.script

Class AbstractOfflineAction

java.lang.Object

games.stendhal.server.core.scripting.ScriptImpl

games.stendhal.server.script.AbstractOfflineAction

All Implemented Interfaces:

Script

Direct Known Subclasses:

OfflineAdminlevel, OfflineClearSentence

public abstract class AbstractOfflineAction
extends ScriptImpl

An abstract super class for actions on offline players

Author:

hendrik

Field Summary

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

sandbox

Constructor Summary

Constructors

Constructor	Description
AbstractOfflineAction()

Method Summary

Modifier and Type	Method	Description
void	execute(Player admin, List<String> args)	Executes this script.
abstract void	process(Player admin, RPObject object, List<String> args)	processes the requested operation on the loaded object
abstract boolean	validateParameters(Player admin, List<String> args)	validates the parameters, sends an error message, if something is wrong with them

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

load, unload

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractOfflineAction

public AbstractOfflineAction()

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

Overrides:

execute 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.

validateParameters

public abstract boolean validateParameters(Player admin,
 List<String> args)

validates the parameters, sends an error message, if something is wrong with them

Parameters:

admin - admin executing the script

args - arguments for the script

Returns:

true if the parameters are valid, false otherwise

process

public abstract void process(Player admin,
 RPObject object,
 List<String> args)

processes the requested operation on the loaded object

Parameters:

admin - admin executing the script

object - the RPObject of the player loaded from the database

args - arguments for the script