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

A

acquireManagedObject(String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Acquires a managed object from the specified managed object factory.

acquireManagedObject(String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

acquireObject(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.BaseManagedObjectFactory

acquireObject(EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.ManagedObjectFactory

addAll(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

Adds the contents of the argument.

addBuddy(String, String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Adds a buddy to the specified user's buddy list.

addBuddy(String, String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

addExtensionBoundUserServerVariable(Object, Object) - Method in class com.electrotank.electroserver4.extensions.LoginContext

addInvalidRoom(int, int) - Method in class com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse

Adds a room to the list of the failed deliveries.

addInvalidZone(int) - Method in class com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse

Adds a zone to the list of failed deliveries.

addKeywords(String, String, Collection<String>) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi

Associates a collection of keywords with DAT file specified by the given path and filename.

addName(String) - Method in class com.electrotank.electroserver4.extensions.api.PluginPrivateMessageResponse

Adds a name to the list of failed deliveries.

addName(String) - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse

Adds a userName to the collection of users who failed to join the room.

addNames(Collection<String>) - Method in class com.electrotank.electroserver4.extensions.api.PluginPrivateMessageResponse

Adds a collection of user names to the failed deliveries list.

addPlugin(ExtensionComponentConfiguration) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Adds a plug-in to the list of plug-ins for the room.

addRoom(RoomConfiguration) - Method in class com.electrotank.electroserver4.extensions.api.value.ZoneConfiguration

Adds a room to the zone.

addUserServerVariable(String, EsObject) - Method in class com.electrotank.electroserver4.extensions.LoginContext

addUsersToRoom(int, int, String, Collection<UserConfig>) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Adds the users defined in the UserConfig collection to the specified room.

addUsersToRoom(int, int, String, UserConfig[]) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Adds the users defined in the UserConfig array to the specified room.

addUsersToRoom(int, int, String, UserConfig[]) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

addUsersToRoom(int, int, String, Collection<UserConfig>) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

addUserVariable(String, EsObject) - Method in class com.electrotank.electroserver4.extensions.LoginContext

addVariables(EsObject) - Method in class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration

Add variables to the plugin.

applyLanguageFilterToString(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to call one of the configured language filters to determine if a given string is valid or not.

applyLanguageFilterToString(String, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

B

banUserFromRoom(String, int, int, int, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to kick and ban a user from a room with a specified message.

banUserFromRoom(String, int, int, int, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

BaseEvent - Class in com.electrotank.electroserver4.extensions

BaseEvent() - Constructor for class com.electrotank.electroserver4.extensions.BaseEvent

BaseLoginEventHandler - Class in com.electrotank.electroserver4.extensions

Custom login event handler.

BaseLoginEventHandler() - Constructor for class com.electrotank.electroserver4.extensions.BaseLoginEventHandler

BaseLogoutEventHandler - Class in com.electrotank.electroserver4.extensions

Custom logout event handler.

BaseLogoutEventHandler() - Constructor for class com.electrotank.electroserver4.extensions.BaseLogoutEventHandler

BaseManagedObjectFactory - Class in com.electrotank.electroserver4.extensions

BaseManagedObjectFactory() - Constructor for class com.electrotank.electroserver4.extensions.BaseManagedObjectFactory

Creates a new instance of BaseManagedObjectFactory

BasePlugin - Class in com.electrotank.electroserver4.extensions

BasePlugin() - Constructor for class com.electrotank.electroserver4.extensions.BasePlugin

Creates a new instance of BasePlugin

blockAndCallUrl(String, boolean, Map<String, String>) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Calls a URL and blocks the current thread of execution until a response is recieved or a global timeout is reached.

blockAndCallUrl(String, boolean, Map<String, String>) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

buildExtensionConfiguration(String, String) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfigurationService

buildExtensionConfiguration(InputStream) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfigurationService

C

callRoomPlugin(int, int, String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to invoke the interop method on the designated server-level plugin.

callRoomPlugin(int, int, String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

callServerPlugin(String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to invoke the interop method on the designated server-level plugin.

callServerPlugin(String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

callUrl(String, boolean, Map<String, String>, HttpCallback) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Calls a URL asynchronously and invokes the callback once the call completes.

callUrl(String, boolean, Map<String, String>, HttpCallback) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

callUrlFromScript(String, boolean, Map<String, String>, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Calls a URL asynchronously and invokes the method defined by the callback name once the call completes.

callUrlFromScript(String, boolean, Map<String, String>, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

cancelScheduledExecution(int) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Cancels the scheduled execution identified by the ID.

cancelScheduledExecution(int) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

ChainAction - Enum in com.electrotank.electroserver4.extensions

clone() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Constructs a clone of the RoomConfiguration object.

com.electrotank.electroserver4.extensions - package com.electrotank.electroserver4.extensions

Provides classes for basic plug-ins, extensions, and events.

com.electrotank.electroserver4.extensions.api - package com.electrotank.electroserver4.extensions.api

Provides classes for handling the server-side API and responses.

com.electrotank.electroserver4.extensions.api.exceptions - package com.electrotank.electroserver4.extensions.api.exceptions

Provides classes for handling exceptions.

com.electrotank.electroserver4.extensions.api.value - package com.electrotank.electroserver4.extensions.api.value

Provides class for object variables, such as EsObject and GameConfiguration.

com.electrotank.electroserver4.extensions.config - package com.electrotank.electroserver4.extensions.config

Provides classes for handling the configuration of an extension.

createGameForUsers(String, Collection<String>, String, String, boolean, boolean, EsObject) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to directly create a game for the identified users via the GameManager.

createGameForUsers(String, String[], String, String, boolean, boolean, EsObject) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to directly create a game for the identified users via the GameManager.

createGameForUsers(String, Collection<String>, String, String, boolean, boolean, EsObject) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

createGameForUsers(String, String[], String, String, boolean, boolean, EsObject) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

createOrUpdateUserVariable(String, String, EsObject) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Creates or updates a user variable as needed.

createOrUpdateUserVariable(String, String, EsObject) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

createRoom(int, RoomConfiguration, Collection<UserConfig>) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Creates a room in the specified zone using the supplied room configuration.

createRoom(int, RoomConfiguration, UserConfig[]) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Creates a room in the specified zone using the supplied room configuration.

createRoom(int, RoomConfiguration, UserConfig[]) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

createRoom(int, RoomConfiguration, Collection<UserConfig>) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

createRoomInNamedZone(String, boolean, RoomConfiguration, Collection<UserConfig>) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Creates a room in the specified zone using the supplied room configuration.

createRoomInNamedZone(String, boolean, RoomConfiguration, UserConfig[]) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Creates a room in the specified zone using the supplied room configuration.

createRoomInNamedZone(String, boolean, RoomConfiguration, UserConfig[]) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

createRoomInNamedZone(String, boolean, RoomConfiguration, Collection<UserConfig>) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

createRoomVariable(int, int, String, EsObject, boolean) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Creates a room variable in the specified room.

createRoomVariable(int, int, String, EsObject, boolean) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

createRoomVariableForUser(int, int, String, EsObject, boolean, String, boolean) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Creates a room variable in the specified room, tied to a given user.

createRoomVariableForUser(int, int, String, EsObject, boolean, String, boolean) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

D

DEFAULT_ENCODING - Static variable in class com.electrotank.electroserver4.extensions.api.value.HttpResults

delete(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi

Deletes the DAT file associated with the given path and filename.

deleteDirectory(String) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi

Deletes the directory associated with the given path.

deleteExtensionBoundUserServerVariable(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Deletes an extension-bound user server variable.

deleteExtensionBoundUserServerVariable(String, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

deleteRoomVariable(int, int, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Deletes the specified room variable.

deleteRoomVariable(int, int, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

deleteUserServerVariable(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Deletes a given user server variable from the specified user.

deleteUserServerVariable(String, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

deleteUserVariable(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Deletes the specified user variable.

deleteUserVariable(String, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

destroy() - Method in class com.electrotank.electroserver4.extensions.BaseEvent

destroy() - Method in class com.electrotank.electroserver4.extensions.BaseManagedObjectFactory

destroy() - Method in class com.electrotank.electroserver4.extensions.BasePlugin

destroy() - Method in interface com.electrotank.electroserver4.extensions.ExtensionLifeCycle

Automatically invoked when the object class is destroyed.

destroyRoom(int, int) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Destroys the room specified by the room and zone IDs.

destroyRoom(int, int) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

doHashedPasswordsMatch(String) - Method in class com.electrotank.electroserver4.extensions.LoginContext

E

ElectroServerApi - Interface in com.electrotank.electroserver4.extensions.api

The foundation of all server-side API code in ElectroServer 4.

ElectroServerApiImpl - Class in com.electrotank.electroserver4.extensions.api

The ElectroServerApiImpl provides functionality to all custom code and allows the various extensions to interact with the server directly.

emptyObject - Static variable in class com.electrotank.electroserver4.extensions.api.value.EsObject

EsFileSystemApi - Interface in com.electrotank.electroserver4.extensions.api

All needed file I/O methods.

EsObject - Class in com.electrotank.electroserver4.extensions.api.value

EsObject facilitates the exchange of data between all layers of a multiplayer application.

EsObject() - Constructor for class com.electrotank.electroserver4.extensions.api.value.EsObject

Creates a new instance of EsObject

EsObject(Object...) - Constructor for class com.electrotank.electroserver4.extensions.api.value.EsObject

Creates a new instance of EsObject and fills it with the entries in the Object.

EsObjectEntry - Class in com.electrotank.electroserver4.extensions.api.value

Object class that holds a single entry for an EsObject.

EsObjectEntry(String, EsObject) - Constructor for class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Constructs a new EsObjectEntry object.

EsObjectRO - Interface in com.electrotank.electroserver4.extensions.api.value

EsObjectRO is a read-only copy of an EsObject.

EventApi - Interface in com.electrotank.electroserver4.extensions.api

ElectroServerApi extension used by event handlers.

EventApiImpl - Class in com.electrotank.electroserver4.extensions.api

EventApiImpl(BaseBridge, Gateways, RoomManager, People, ScheduledExecutorService, LanguageFilterManager, EsFileSystem, GameManager, BuddyListManager, UserEventManager) - Constructor for class com.electrotank.electroserver4.extensions.api.EventApiImpl

Creates a new instance of EventApiImpl

EventHandler - Interface in com.electrotank.electroserver4.extensions

EventHandlerLifeCycle - Interface in com.electrotank.electroserver4.extensions

executeLogin(LoginContext) - Method in class com.electrotank.electroserver4.extensions.BaseLoginEventHandler

Custom login event handler.

executeLogin(LoginContext) - Method in interface com.electrotank.electroserver4.extensions.LoginEventHandler

Custom login event handler.

executeLogout(String) - Method in class com.electrotank.electroserver4.extensions.BaseLogoutEventHandler

Custom logout event handler.

executeLogout(String) - Method in interface com.electrotank.electroserver4.extensions.LogoutEventHandler

Custom logout event handler.

ExtensionBoundUserServerVariableResponse - Class in com.electrotank.electroserver4.extensions.api

Data object for an extension bound user server variable.

ExtensionBoundUserServerVariableResponse() - Constructor for class com.electrotank.electroserver4.extensions.api.ExtensionBoundUserServerVariableResponse

ExtensionClassConfiguration - Class in com.electrotank.electroserver4.extensions.config

ExtensionClassConfiguration() - Constructor for class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration

Creates a new instance of ExtensionClassConfiguration

ExtensionComponentConfiguration - Class in com.electrotank.electroserver4.extensions.api.value

Object class that holds the configuration of a single Plugin.

ExtensionComponentConfiguration() - Constructor for class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration

Constructs a new (empty) instance of ExtensionComponentConfiguration.

ExtensionConfiguration - Class in com.electrotank.electroserver4.extensions.config

ExtensionConfiguration() - Constructor for class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration

Creates a new instance of ExtensionConfiguration

ExtensionConfigurationService - Class in com.electrotank.electroserver4.extensions.config

ExtensionConfigurationService() - Constructor for class com.electrotank.electroserver4.extensions.config.ExtensionConfigurationService

Creates a new instance of ExtensionConfigurationService

ExtensionEventHandler - Interface in com.electrotank.electroserver4.extensions

ExtensionLifeCycle - Interface in com.electrotank.electroserver4.extensions

Interface for automatic initialization of extensions and plugins.

F

FileSystemApiException - Exception in com.electrotank.electroserver4.extensions.api.exceptions

FileSystemApiException() - Constructor for exception com.electrotank.electroserver4.extensions.api.exceptions.FileSystemApiException

FileSystemApiException(String) - Constructor for exception com.electrotank.electroserver4.extensions.api.exceptions.FileSystemApiException

FileSystemApiException(Throwable) - Constructor for exception com.electrotank.electroserver4.extensions.api.exceptions.FileSystemApiException

FileSystemApiException(String, Throwable) - Constructor for exception com.electrotank.electroserver4.extensions.api.exceptions.FileSystemApiException

findFilesByKeywords(Collection<String>) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi

Finds a collection of EsObjects that had been stored previously using the collection of keywords specified.

fromXML(Node, XPath) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

G

GameConfiguration - Class in com.electrotank.electroserver4.extensions.api.value

Object class that holds the configuration of a single game.

GameConfiguration() - Constructor for class com.electrotank.electroserver4.extensions.api.value.GameConfiguration

GameManagerResponse - Class in com.electrotank.electroserver4.extensions.api

GameManagerResponse is an object returned by the GameManager.

GameManagerResponse(boolean, int, int, int, EsObjectRO) - Constructor for class com.electrotank.electroserver4.extensions.api.GameManagerResponse

Creates a new instance of GameManagerResponse.

GameManagerResponse(boolean, ErrorType) - Constructor for class com.electrotank.electroserver4.extensions.api.GameManagerResponse

Creates a new instance of GameManagerResponse.

getApi() - Method in class com.electrotank.electroserver4.extensions.BaseEvent

getApi() - Method in class com.electrotank.electroserver4.extensions.BaseManagedObjectFactory

getApi() - Method in class com.electrotank.electroserver4.extensions.BasePlugin

getApi() - Method in interface com.electrotank.electroserver4.extensions.EventHandler

Returns the api for any class that implements this interface.

getApi() - Method in interface com.electrotank.electroserver4.extensions.ManagedObjectFactory

getApi() - Method in interface com.electrotank.electroserver4.extensions.Plugin

getBoolean(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getBoolean(String, boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getBoolean() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is a boolean.

getBoolean(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the boolean value of the named entry.

getBoolean(String, boolean) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the boolean value of the named entry, or the default value if any exception occurs.

getBooleanArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getBooleanArray(String, boolean[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getBooleanArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an array of booleans.

getBooleanArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the boolean array value of the named entry.

getBooleanArray(String, boolean[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the boolean array value of the named entry, or the default value if any exception occurs.

getBuddyListEntries() - Method in class com.electrotank.electroserver4.extensions.LoginContext

getByte(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getByte(String, byte) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getByte() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is a byte.

getByte(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the byte value of the named entry.

getByte(String, byte) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the byte value of the named entry, or the default value if any exception occurs.

getByteArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getByteArray(String, byte[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getByteArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an array of bytes.

getByteArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the byte array value of the named entry.

getByteArray(String, byte[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the byte array value of the named entry, or the default value if any exception occurs.

getCapacity() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the capacity of the room.

getCapacity() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue

Gets the capacity of the room.

getChar(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getChar(String, char) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getChar() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is a char.

getChar(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the char value of the named entry.

getChar(String, char) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the char value of the named entry, or the default value if any exception occurs.

getCharArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getCharArray(String, char[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getCharArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an array of chars.

getCharArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the char array value of the named entry.

getCharArray(String, char[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the char array value of the named entry, or the default value if any exception occurs.

getDataAsBytes() - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults

Gets the data from the url as an array of bytes.

getDataAsMap(String) - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults

Gets the data from the url as a name/value pair map (like LoadVars in Flash).

getDataAsMap() - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults

Gets the data from the url as a name/value pair map (like LoadVars in Flash).

getDataAsString(String) - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults

Gets the data from the url as a string.

getDataAsString() - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults

Gets the data from the url as a string, using the default encoding.

getDescription() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets a description of the room.

getDescription() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue

Gets the optional text description of a room.

getDouble(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getDouble(String, double) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getDouble() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is a double.

getDouble(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the double value of the named entry.

getDouble(String, double) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the double value of the named entry, or the default value if any exception occurs.

getDoubleArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getDoubleArray(String, double[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getDoubleArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an array of doubles.

getDoubleArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the double array value of the named entry.

getDoubleArray(String, double[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the double array value of the named entry, or the default value if any exception occurs.

getError() - Method in class com.electrotank.electroserver4.extensions.api.GameManagerResponse

Used to get the error for the request

getError() - Method in class com.electrotank.electroserver4.extensions.api.LanguageFilterResponse

Used to get the error for the request

getErrorText() - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults

Gets the error message if the call was unsuccessful.

getEsObject(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi

Gets the EsObject that was stored previously with the given path and filename.

getEsObject(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getEsObject(String, EsObject) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getEsObject() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an EsObject.

getEsObject(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the EsObject value of the named entry.

getEsObject(String, EsObject) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the EsObject value of the named entry, or the default value if any exception occurs.

getEsObject() - Method in class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext

Gets a read-only copy of the optional EsObject broadcast.

getEsObjectArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getEsObjectArray(String, EsObject[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getEsObjectArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an array of EsObjects.

getEsObjectArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the EsObject array value of the named entry.

getEsObjectArray(String, EsObject[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the EsObject array value of the named entry, or the default value if any exception occurs.

getExtensionBoundUserServerVariable(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Looks up and returns an extension-bound user server variable.

getExtensionBoundUserServerVariable(String, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

getExtensionBoundUserServerVariable(Object) - Method in class com.electrotank.electroserver4.extensions.LoginContext

getExtensionName() - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to get the name of the extension that contains this component.

getExtensionName() - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

getExtensionName() - Method in class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration

Gets the name of the extension for the Plugin.

getFailedNames() - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse

Gets collection of names of users who failed to join the room.

getFileSystemApi() - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to access the file system API functionality of the server.

getFileSystemApi() - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

getFloat(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getFloat(String, float) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getFloat() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is a float.

getFloat(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the float value of the named entry.

getFloat(String, float) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the float value of the named entry, or the default value if any exception occurs.

getFloatArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getFloatArray(String, float[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getFloatArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an array of floats.

getFloatArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the float array value of the named entry.

getFloatArray(String, float[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the float array value of the named entry, or the default value if any exception occurs.

getFloodingFilterBanDuration() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the amount of time in seconds to ban a user for a flooding filter violation.

getFloodingFilterFailuresBeforeKick() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the total number of flooding filter failures allowed by a user before that user is kicked from the room.

getFloodingFilterKicksBeforeBan() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the total number of times to kick a user for flooding violations before that user is banned.

getFloodingFilterName() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the name of the flooding filter.

getGameDetails() - Method in class com.electrotank.electroserver4.extensions.api.GameManagerResponse

Used to get a read-only copy of the gameDetails

getGameDetails() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi

Gets the game details as an EsObject.

getGameDetails() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl

getGameId() - Method in class com.electrotank.electroserver4.extensions.api.GameManagerResponse

Used to get the gameId

getHandle() - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to get the handle of this extension component.

getHandle() - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

getHandle() - Method in class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration

Gets the handle for the plugin.

getHandle() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration

getInitialGameDetails() - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration

Gets the initial game details.

getInitParameters() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration

getInteger(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getInteger(String, int) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getInteger() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an integer.

getInteger(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the integer value of the named entry.

getInteger(String, int) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the integer value of the named entry, or the default value if any exception occurs.

getIntegerArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getIntegerArray(String, int[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getIntegerArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an array of ints.

getIntegerArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the int array value of the named entry.

getIntegerArray(String, int[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the int array value of the named entry, or the default value if any exception occurs.

getInvalidNames() - Method in class com.electrotank.electroserver4.extensions.api.PluginPrivateMessageResponse

Gets a list of failed deliveries by user name.

getInvalidZoneRoomCombos() - Method in class com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse

Gets a Collection of ZoneRoomCombo objects specifying which zones/rooms failed to deliver the message.

getLanguageFilterBanDuration() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the duration of the ban that the language filter will impose.

getLanguageFilterFailuresBeforeKick() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the number of times the user is allowed to send messages that fail the language filter, before he is kicked from the room.

getLanguageFilterKicksBeforeBan() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the number of times the user can be kicked due to language filter failures before he is disconnected from the server and banned from returning.

getLanguageFilterName() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the name of the room's language filter.

getLogger() - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Acquires a logger for the current component.

getLogger() - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

getLoginEventHandlerConfigurations() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration

getLogoutEventHandlerConfigurations() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration

getLong(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getLong(String, long) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getLong() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is a long.

getLong(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the long value of the named entry.

getLong(String, long) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the long value of the named entry, or the default value if any exception occurs.

getLongArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getLongArray(String, long[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject

getLongArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the value of the entry, if it is an array of longs.

getLongArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the long array value of the named entry.

getLongArray(String, long[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO

Gets the long array value of the named entry, or the default value if any exception occurs.

getManagedObjectConfigurations() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration

getMessage() - Method in class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext

Gets the message broadcast.

getName() - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

Used to the get the name of this extension component.

getName() - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

getName() - Method in class com.electrotank.electroserver4.extensions.api.RoomVariableResponse

Gets the name of the room variable.

getName() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry

Gets the name of the entry.

getName() - Method in class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration

Gets the name of the plugin.

getName() - Method in interface com.electrotank.electroserver4.extensions.api.value.ReadOnlyRoomVariable

Gets the name of the room variable.

getName() - Method in interface com.electrotank.electroserver4.extensions.api.value.ReadOnlyUserVariable

Gets the name of the user variable.

getName() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration

Gets the name of the room.

getName() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration

getNumber(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject