A B C D E F G I K L M P R S U W Z

A

AbstractEventHandler - class com.electrotank.electroserver.plugins.AbstractEventHandler.

This abstract class represents either a login or logout event handler.

AbstractEventHandler() - Constructor for class com.electrotank.electroserver.plugins.AbstractEventHandler

AbstractPlugin - class com.electrotank.electroserver.plugins.AbstractPlugin.

The AbstractPlugin represents an abstract class that must be extended for all Java plugins.

AbstractPlugin() - Constructor for class com.electrotank.electroserver.plugins.AbstractPlugin

addResponseVariable(String, String) - Method in class com.electrotank.electroserver.plugins.utilities.EventResponse

Adds a single response variable to the response variable Map.

addUserServerVariable(Object, Object) - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Adds a single user server variable to the LoginResponse.

B

BaseExtensionHelper - class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper.

The BaseExtensionHelper is a class that exposes internal functionality of ElectroServer to extensions.

BaseExtensionHelper(String, People, Places) - Constructor for class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

The is an interally-used constructor.

ban(String, long) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Bans the user from the server for the specified period.

C

callRemotePlugin(String, Map) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Calls a remote server-level plugin specified by the name.

callRemoteRoomPlugin(String, String, String, Map) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Calls a remote room-level plugin specified by the name.

com.electrotank.electroserver.plugins - package com.electrotank.electroserver.plugins

com.electrotank.electroserver.plugins.entities - package com.electrotank.electroserver.plugins.entities

com.electrotank.electroserver.plugins.utilities - package com.electrotank.electroserver.plugins.utilities

config(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a "config" entry in the server log file.

createDirectory(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates the directory and all needed parent directories specified by the path.

createRoom(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Progamatically creates a room with no users in it.

createRoomVariable(String, String, boolean, String, String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a room variable in a given zone/room combination.

createUserVariable(String, String, String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a user variable for the specified user.

D

deleteDirectory(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Deletes the directory specified by the path.

deleteFile(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Deletes the file specified by the path.

deleteRoomVariable(String, String, String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Deletes a given room variable from the system.

deleteUserVariable(String, String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Deletes the specified user variable.

doesDirectoryExist(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Determines if a directory exists.

doesFileExist(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Determines if a file exists.

E

EXECUTING_USER_NAME - Static variable in class com.electrotank.electroserver.plugins.AbstractPlugin

The name of the client that has made this request.

EventException - exception com.electrotank.electroserver.plugins.EventException.

Creates a new EventException that is used to represent any exceptions that occured within an event.

EventException() - Constructor for class com.electrotank.electroserver.plugins.EventException

Creates a new instance of EventException without detail message.

EventException(String) - Constructor for class com.electrotank.electroserver.plugins.EventException

Constructs an instance of EventException with the specified detail message.

EventHelper - class com.electrotank.electroserver.plugins.utilities.EventHelper.

EventHelper(String, People, Places) - Constructor for class com.electrotank.electroserver.plugins.utilities.EventHelper

EventResponse - class com.electrotank.electroserver.plugins.utilities.EventResponse.

This is the base class from which all event responses, like LoginResponse, are derived.

EventResponse(String) - Constructor for class com.electrotank.electroserver.plugins.utilities.EventResponse

Creates a new EventResponse and passes in the return message.

eventInit(Map) - Method in class com.electrotank.electroserver.plugins.AbstractEventHandler

Invoked automatically at server start-up.

F

fine(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a "fine" entry in the server log file.

finer(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a "finer" entry in the server log file.

finest(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a "finest" entry in the server log file.

G

getAllZones() - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Gets all zones on the server.

getCpuPercentUsed() - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

getEventHelper() - Method in class com.electrotank.electroserver.plugins.AbstractEventHandler

Gets a reference to an EventHelper that can be used to interact with the server.

getLoggedInUserCount() - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Returns a count of all users currently logged into the server.

getLogger() - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Returns the server-wide logger that can be used to log anything needed

getMessage() - Method in class com.electrotank.electroserver.plugins.utilities.EventResponse

Gets the message that will be returned to the caller.

getName() - Method in class com.electrotank.electroserver.plugins.entities.RoomStub

Gets the name of the room represented by this stub

getName() - Method in class com.electrotank.electroserver.plugins.entities.UserStub

Gets the name of the user represented by this stub

getName() - Method in class com.electrotank.electroserver.plugins.entities.ZoneStub

Gets the name of the zone represented by this stub

getName() - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Returns the name of the extension (plugin or event handler)

getPassowrd() - Method in class com.electrotank.electroserver.plugins.entities.RoomStub

getPhysicalMemoryAvailable() - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

getPluginHelper() - Method in class com.electrotank.electroserver.plugins.AbstractPlugin

Allows a plugin to get an instance of its PluginHelper.

getResponseVariables() - Method in class com.electrotank.electroserver.plugins.utilities.EventResponse

Gets a Map of the response variables for this event.

getRoomName() - Method in class com.electrotank.electroserver.plugins.utilities.PluginHelper

Gets the name of the room that contains this plugin.

getRoomVariables(String, String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Gets all room variables for a zone/room combination.Updating the RoomVariable objects returned by this call will NOT update the actual room variables.

getRoomsInZone(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Gets all rooms in a given zone.

getServerTime() - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Gets the current time of the server.

getUserServerVariable(String, Object) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Returns the specified user server variable.

getUserServerVariable(String, Object, Object) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Returns the specified user server variable.

getUserServerVariables() - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Returns the Map that contains the userServerVariables defined by the event handler.

getUserVariables(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Returns all user variables associated with the specified user.

getUserVariablesAsMap(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Gets a Map of all user variables tied to this user.

getUsername() - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Gets the username from the LoginResponse.

getUsersInRoom(String, String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Returns a list of users from a given zone/room combination.

getZoneName() - Method in class com.electrotank.electroserver.plugins.utilities.PluginHelper

Gets the name of the zone that contains this plugin.

I

info(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a "info" entry in the server log file.

isDirectory(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Determines if the specified path is a directory.

isFile(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Determines if the specified path is a file.

isHidden() - Method in class com.electrotank.electroserver.plugins.entities.RoomStub

Gets the hidden or visible status of this room.

isLoginSuccessful() - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Returns the value of the loginSuccessful boolean.

isModerator() - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Returns the value of the isModerator boolean.

isUserLoggedIn(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Determines if the user is logged in or not.

K

kick(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Kicks the user specified from the server.

L

LogOutEventInterface - interface com.electrotank.electroserver.plugins.LogOutEventInterface.

The LogOutEventInterface is used to define a class as a log out event handler.

LoginEventInterface - interface com.electrotank.electroserver.plugins.LoginEventInterface.

The LoginEventInterface is used to define a class as a login event handler.

LoginResponse - class com.electrotank.electroserver.plugins.utilities.LoginResponse.

Represents the response from a LoginEventHandler.

LoginResponse(boolean, String) - Constructor for class com.electrotank.electroserver.plugins.utilities.LoginResponse

Constructs a new LoginResponse and sets the loginSuccess boolean as well as the message that will be returned to the user.

logOut(String) - Method in interface com.electrotank.electroserver.plugins.LogOutEventInterface

invoked when a user logs out of the server.

login(String, String, Map) - Method in interface com.electrotank.electroserver.plugins.LoginEventInterface

invoked when a user attempts to log into the server.

M

MESSAGE_TEXT - Static variable in class com.electrotank.electroserver.plugins.AbstractPlugin

The exact textual data sent from the client.

METHOD - Static variable in class com.electrotank.electroserver.plugins.AbstractPlugin

The name of the method that the client wishes to execute.

moveToRoom(String, String, String, String, boolean) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Moves a user into a room progamatically.

P

PluginException - exception com.electrotank.electroserver.plugins.PluginException.

Used to represent any exceptions that come out of plugins.

PluginException() - Constructor for class com.electrotank.electroserver.plugins.PluginException

Creates a new PluginException with no specific message.

PluginException(Throwable) - Constructor for class com.electrotank.electroserver.plugins.PluginException

Creates a new PluginException with a root cause.

PluginException(String) - Constructor for class com.electrotank.electroserver.plugins.PluginException

Creates a new PluginException with a given message.

PluginException(String, Throwable) - Constructor for class com.electrotank.electroserver.plugins.PluginException

Creates a new PluginException with a given message and a cause.

PluginHelper - class com.electrotank.electroserver.plugins.utilities.PluginHelper.

The plugin helper class provides commonly used functionality to all plugins.

PluginHelper(Room, String, People, Places) - Constructor for class com.electrotank.electroserver.plugins.utilities.PluginHelper

This is an internal constructor.

pluginDestroy() - Method in class com.electrotank.electroserver.plugins.AbstractPlugin

Called when the plugin is to be unloaded.

pluginInit(Map) - Method in class com.electrotank.electroserver.plugins.AbstractPlugin

Called when the plugin is first initialized.

pluginInterop(Map) - Method in class com.electrotank.electroserver.plugins.AbstractPlugin

Called by another plugin using the PluginHelper method "callRemotePlugin".

pluginRequest(Map) - Method in class com.electrotank.electroserver.plugins.AbstractPlugin

Called when a client requests something from the server.

pluginUserEnter(String, int) - Method in class com.electrotank.electroserver.plugins.AbstractPlugin

Allows for a plugin to be notified when a user enters this room.

pluginUserExit(String, int) - Method in class com.electrotank.electroserver.plugins.AbstractPlugin

Allows for a plugin to be notified when a user leaves this room.

R

RoomStub - class com.electrotank.electroserver.plugins.entities.RoomStub.

The RoomStub object is a read only representation of a Room.

RoomStub(Room) - Constructor for class com.electrotank.electroserver.plugins.entities.RoomStub

Creates a new instance of RoomStub.

readFile(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Reads the specified file and returns the contents as a String.

removeResponseVariable(String) - Method in class com.electrotank.electroserver.plugins.utilities.EventResponse

Removes the specified response variable from the Map.

removeUserServerVariable(String, Object) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Removes a user server variable from a given user.

removeUserServerVariable(Object) - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Removes a specific user server variable based on the key.

S

sendPrivateMessage(String, String, Map) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Sends a private message to the userName.

sendPrivateMessgeToMany(String[], String, Map) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Sends a private message to the specified users.

sendPublicMessage(String, Map) - Method in class com.electrotank.electroserver.plugins.utilities.PluginHelper

Sends a message to the room that this plugin is in.

sendPublicMessageToRoom(String, String, String, Map) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Sends a plugin message to the given zone/room combination.

sendPublicMessageToServer(String, Map) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Sends a public message to the entire server.

sendPublicMessageToZone(String, String, Map) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Sends a public message to a zone.

sendRawPrivateMessage(String, String) - Method in class com.electrotank.electroserver.plugins.utilities.PluginHelper

Sends a private message to the user.

sendRawPrivateMessgeToMany(String[], String) - Method in class com.electrotank.electroserver.plugins.utilities.PluginHelper

Sends a private message to the specified users.

sendRawPublicMessage(String) - Method in class com.electrotank.electroserver.plugins.utilities.PluginHelper

Sends a message to the room that this plugin is in.

setLoginSuccessful(boolean) - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Sets the value of the loginSuccessful boolean.

setMessage(String) - Method in class com.electrotank.electroserver.plugins.utilities.EventResponse

Sets the message that will be returned to the caller.

setModerator(boolean) - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Sets the value of the isModerator boolean.

setResponseVariables(Map) - Method in class com.electrotank.electroserver.plugins.utilities.EventResponse

Sets the response variables with a Map.

setUserServerVariable(String, Object, Object) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Sets a variable on a user.

setUserServerVariables(Map) - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Sets the user server variables with a Map.

setUsername(String) - Method in class com.electrotank.electroserver.plugins.utilities.LoginResponse

Sets the username on the LoginResponse.

severe(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a "severe" entry in the server log file.

stringContainsVulgarity(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Tests the given string for vulgarity using the LanguageFilter and the settings initialized in the configuration.xml file.

U

UserStub - class com.electrotank.electroserver.plugins.entities.UserStub.

The UserStub object is a read-only representation of a User.

UserStub(User) - Constructor for class com.electrotank.electroserver.plugins.entities.UserStub

Creates a new instance of UserStub.

updateRoomVariable(String, String, boolean, String, String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Updates a given user variables settings and values.

updateUserVariable(String, String, String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Updates a given user variable with the new data.

W

warning(String) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Creates a "warning" entry in the server log file.

writeFile(String, String, boolean) - Method in class com.electrotank.electroserver.plugins.utilities.BaseExtensionHelper

Writes a file to the specified location.

Z

ZoneStub - class com.electrotank.electroserver.plugins.entities.ZoneStub.

The ZoneStub object is a read only representation of a Zone.

ZoneStub(Zone) - Constructor for class com.electrotank.electroserver.plugins.entities.ZoneStub

Creates a new instance of ZoneStub.

A B C D E F G I K L M P R S U W Z