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
 
getNumber(String, Number) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getNumber() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a Number.
getNumber(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the Number value of the named entry.
getNumber(String, Number) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the Number value of the named entry, or the default value if any exception occurs.
getNumberArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getNumberArray(String, Number[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getNumberArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of Numbers.
getNumberArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the Number array value of the named entry.
getNumberArray(String, Number[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the Number array value of the named entry, or the default value if any exception occurs.
getPassword() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Gets the password for the room.
getPassword() - Method in class com.electrotank.electroserver4.extensions.LoginContext
Gets the password from the login attempt.
getPasswordHashId() - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
getPath() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration
 
getPermissionSetId() - Method in class com.electrotank.electroserver4.extensions.LoginContext
Gets the name of the permission set for this user.
getPluginConfigurations() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration
 
getPlugins() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Gets a list of the plug-ins for the room.
getRawValue() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry
Gets the raw (Object) value of the entry.
getRawVariable(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getRawVariable(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the raw value of the named variable, as an Object.
getRequestParameters() - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
getResponseParameters() - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse
Gets the EsObjectRO containing any error messages triggered when a user attempts to join a room and fails.
getResponseParameters() - Method in class com.electrotank.electroserver4.extensions.api.value.UserEnterContext
Gets the responseParameters for the room entry.
getResponseParameters() - Method in class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext
Gets the response parameters for the broadcast message.
getResponseParameters() - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
getRoomConfiguration() - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Gets the room configuration for the game.
getRoomId() - Method in class com.electrotank.electroserver4.extensions.api.GameManagerResponse
Used to get the roomId
getRoomId() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Gets the roomId.
getRoomId() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
getRoomId() - Method in class com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse.ZoneRoomCombo
Gets the roomId of the room that failed to deliver the public message.
getRoomId() - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse
Gets the roomId of the room created.
getRoomId() - Method in class com.electrotank.electroserver4.extensions.api.RoomVariableResponse
Gets the roomId of the room holding the variable.
getRoomId() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Gets the roomId of the room.
getRoomMemberCount() - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse
Gets the number of clients in the room
getRoomName() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Gets the name of the room.
getRoomName() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
getRoomName() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Gets the name of the room.
getRoomPlugin(int, int, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Used to get a reference to another room plugin based on the zone ID and room ID and plugin name.
getRoomPlugin(int, int, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getRooms() - Method in class com.electrotank.electroserver4.extensions.api.value.ZoneConfiguration
Gets a list of the configurations of all the rooms in this zone.
getRoomsInZone(int) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns all the rooms in a given zone.
getRoomsInZone(int) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getRoomsInZoneByName(String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns all the rooms in a given zone.
getRoomsInZoneByName(String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getRoomVariable(int, int, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns a specific room variable.
getRoomVariable(int, int, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getRoomVariables(int, int) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns all room variables in a given room.
getRoomVariables(int, int) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getServerPlugin(String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Used to get a reference to a server level plugin in the same extension, based on the plugin name.
getServerPlugin(String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getShort(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getShort(String, short) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getShort() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a short.
getShort(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the short value of the named entry.
getShort(String, short) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the short value of the named entry, or the default value if any exception occurs.
getShortArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getShortArray(String, short[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getShortArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of shorts.
getShortArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the short array value of the named entry.
getShortArray(String, short[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the short array value of the named entry, or the default value if any exception occurs.
getSize() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getSize() - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the number of values stored in the EsObject.
getStatus() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiResponse
Gets the status of the response.
getString(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getString(String, String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getString() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a string.
getString(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the string value of the named entry.
getString(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the String value of the named entry, or the default value if any exception occurs.
getStringArray(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getStringArray(String, String[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
getStringArray() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of strings.
getStringArray(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the string array value of the named entry.
getStringArray(String, String[]) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Gets the string array value of the named entry, or the default value if any exception occurs.
getType() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration
 
getUser(String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Used to return details on the specified user.
getUser(String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getUserByUserName(String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getUserEsObject(String) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Looks up the EsObject for a given userName.
getUserEsObject(String) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
getUserFromName(String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getUserName() - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Gets the name of the user.
getUserName() - Method in class com.electrotank.electroserver4.extensions.api.value.UserEnterContext
Gets the name of the user who just entered the room.
getUserName() - Method in class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext
Gets the name of the user who broadcast the message.
getUserName() - Method in class com.electrotank.electroserver4.extensions.api.value.UserValue
Gets the name of the user
getUserName() - Method in class com.electrotank.electroserver4.extensions.LoginContext
Gets the username from the login attempt.
getUserPluginVariable(String, Object) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Looks up the plug-in variable for a given user.
getUserPluginVariable(String, Object) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
getUsers() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Gets a Collection of user names.
getUsers() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
getUserServerVariable(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns a user server variable.
getUserServerVariable(String, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getUserServerVariable(String) - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
getUserServerVariables() - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
getUsersInRoom(int, int) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns all the users in a given room.
getUsersInRoom(int, int) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getUserVariable(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns a specific user variable.
getUserVariable(String, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getUserVariable(String) - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
getUserVariableEventHandlerConfigurations() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration
 
getUserVariables(String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns all the user variables for a given user.
getUserVariables(String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
getUserVariables() - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
getValue() - Method in class com.electrotank.electroserver4.extensions.api.ExtensionBoundUserServerVariableResponse
Returns the value of the extension bound user server variable
getValue() - Method in class com.electrotank.electroserver4.extensions.api.UserServerVariableResponse
Gets the user server variable, as an EsObject.
getValue() - Method in class com.electrotank.electroserver4.extensions.api.value.Number
Gets the value of the Number object.
getValue() - Method in interface com.electrotank.electroserver4.extensions.api.value.ReadOnlyRoomVariable
Gets the value of the room variable, as an EsObject.
getValue() - Method in interface com.electrotank.electroserver4.extensions.api.value.ReadOnlyUserVariable
Gets the EsObject value of the user variable.
getVariables() - Method in class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration
Gets the variables for the plugin.
getZoneId() - Method in class com.electrotank.electroserver4.extensions.api.GameManagerResponse
Used to get the zoneId
getZoneId() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Gets the zoneId.
getZoneId() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
getZoneId() - Method in class com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse.ZoneRoomCombo
Gets the zoneId of the zone that failed to deliver the public message.
getZoneId() - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse
Gets the zoneId for the room involved in the request.
getZoneId() - Method in class com.electrotank.electroserver4.extensions.api.RoomVariableResponse
Gets the zoneId of the zone holding the room.
getZoneId() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Gets the zoneId of the zone in which to this room resides.
getZoneId() - Method in class com.electrotank.electroserver4.extensions.api.value.ZoneValue
Gets the unique zoneId for this zone.
getZoneName() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Gets the name of the zone.
getZoneName() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
getZoneName() - Method in class com.electrotank.electroserver4.extensions.api.value.ZoneConfiguration
Gets the unique name of the zone.
getZoneName() - Method in class com.electrotank.electroserver4.extensions.api.value.ZoneValue
Gets the name of the zone.
getZones() - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Looks up and returns all the zones on the server.
getZones() - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 

H

HttpCallback - Interface in com.electrotank.electroserver4.extensions.api
Callback to be invoked once ElectroServerApi.callUrl completes either successfully or not.
httpCallback(HttpResults) - Method in interface com.electrotank.electroserver4.extensions.api.HttpCallback
 
HttpResults - Class in com.electrotank.electroserver4.extensions.api.value
Contains the result of a call to a url, and a variety of methods to interact with the data directly as bytes, convert it to a string, or to even parse the results into a name/value pair map (like LoadVars in Flash).
HttpResults() - Constructor for class com.electrotank.electroserver4.extensions.api.value.HttpResults
Constructs a new instance of HttpResults.

I

init(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.BaseEvent
 
init(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.BaseManagedObjectFactory
 
init(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
init(EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.ExtensionLifeCycle
Automatically invoked when the object class is instantiated, after api is available.
interop(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
interop(EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.PluginInterop
Allows one plugin to send a message to another plugin, in a different extension.
isFloodingFilterResetAfterKick() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Is the flooding filter reset after a kick? If set to true, then the user’s offenses are erased and reset after kicking, so the user would never get banned automatically.
isFloodingFilterSpecified() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Is a specified flooding filter for this room?
isGameHidden() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Is this game hidden?
isGameHidden() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
isGameLocked() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Is this game locked?
isGameLocked() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
isGameRoom() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Is the room for this plug-in a game?
isGameRoom() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
isHidden() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Is this room hidden? If a room is hidden, it will not show in the list of rooms that can be entered.
isLanguageFilterDeliverMessageOnFailure() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
If a message fails the language filter, will it be delivered anyway?
isLanguageFilterResetAfterKick() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Should the language filter reset after a kick? If this is set to yes, then every time the user is kicked, it resets the process as if the user never been kicked.
isLanguageFilterSpecified() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Is there a specified language filter for this room?
isLocked() - Method in interface com.electrotank.electroserver4.extensions.api.value.ReadOnlyRoomVariable
Is the room variable locked? If true then the variable cannot be modified until it is unlocked.
isNonOperatorUpdateAllowed() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Is a user who is not an operator allowed to update the room?
isNonOperatorVariableUpdateAllowed() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Is a user who is not an operator allowed to update room variables?
isPersistent() - Method in interface com.electrotank.electroserver4.extensions.api.value.ReadOnlyRoomVariable
Is this room variable persistent? If true then when the user that creates the room variable leaves the room the variable remains.
isPersistent() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Is this room persistent? If a room is persistent, it will not be deleted when the last person leaves it.
isPersistent() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Is this room persistent? Persistent rooms are created using the web-based administrator and always exist.
isReceivingRoomAttributeUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Is the user receiving room attribute updates?
isReceivingRoomListUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Does this game receive room list updates?
isReceivingRoomListUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Is the user receiving room list updates?
isReceivingRoomVariableUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Does this game receive room variable updates?
isReceivingRoomVariableUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Is the user receiving room variable updates?
isReceivingUserListUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Does this game receive user list updates?
isReceivingUserListUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Is the user receiving user list updates?
isReceivingUserVariableUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Does this game receive user variable updates?
isReceivingUserVariableUpdates() - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Is the user receiving user variable updates?
isReceivingVideoEvents() - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Does this game receive video events?
isReceivingVideoEvents() - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Is the user receiving video events?
isRoomLevel() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
True if the plug-in is a room-level plug-in
isRoomLevel() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
isServerLevel() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
True if the plug-in is a server-level plug-in.
isServerLevel() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
isStringValid() - Method in class com.electrotank.electroserver4.extensions.api.LanguageFilterResponse
Used to get the stringValid field of the object.
isSuccess() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiResponse
Returns true if the response is successful.
isSuccessful() - Method in class com.electrotank.electroserver4.extensions.api.GameManagerResponse
Used to get the isSuccessful field of the object.
isSuccessful() - Method in class com.electrotank.electroserver4.extensions.api.LanguageFilterResponse
Used to get the isSuccessful field of the object.
isUserLoggedIn(String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Determines if a user is currently logged in or not.
isUserLoggedIn(String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
isUsingFloodingFilter() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Does this room use a flooding filter?
isUsingLanguageFilter() - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Does this room use a language filter?
iterator() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Creates an iterator over all the entries in the EsObject.

K

kickUserFromRoom(String, int, int, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Used to kick a user from a room with a specified message.
kickUserFromRoom(String, int, int, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
kickUserFromServer(String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Used to kick a user from the server directly.
kickUserFromServer(String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 

L

LanguageFilterResponse - Class in com.electrotank.electroserver4.extensions.api
LanguageFilterResponse is an object returned by the api.
LanguageFilterResponse(ErrorType) - Constructor for class com.electrotank.electroserver4.extensions.api.LanguageFilterResponse
Creates a new instance of LanguageFilterResponse.
LanguageFilterResponse(boolean) - Constructor for class com.electrotank.electroserver4.extensions.api.LanguageFilterResponse
Creates a new instance of LanguageFilterResponse.
list(String, boolean) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi
Lists the file names of all EsObjects that had been stored previously using the specified path.
LoginContext - Class in com.electrotank.electroserver4.extensions
Contains all information from a client attempting to login.
LoginContext(EsObjectRO, Map<String, Map<Object, Object>>, Map<String, EsObject>, int) - Constructor for class com.electrotank.electroserver4.extensions.LoginContext
Creates a new instance of LoginContext
LoginEventHandler - Interface in com.electrotank.electroserver4.extensions
Custom login event handler.
LogoutEventHandler - Interface in com.electrotank.electroserver4.extensions
Custom logout event handler.

M

ManagedObjectFactory - Interface in com.electrotank.electroserver4.extensions
A managed object factory is a special case object that can be used to create objects that need to be tracked over time.
ManagedObjectFactoryApi - Interface in com.electrotank.electroserver4.extensions.api
The api for a managed object factory.
ManagedObjectFactoryLifeCycle - Interface in com.electrotank.electroserver4.extensions
 

N

Number - Class in com.electrotank.electroserver4.extensions.api.value
Number data type, for consistency in passing Number values to and from ActionScript.
Number(double) - Constructor for class com.electrotank.electroserver4.extensions.api.value.Number
Creates a new instance of Number, with the given value.

P

pauseQueue() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Pauses the queue of messages.
pauseQueue() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
Plugin - Interface in com.electrotank.electroserver4.extensions
A plug-in is the most generic and flexible way to add functionality to ElectroServer.
PluginApi - Interface in com.electrotank.electroserver4.extensions.api
The api for a plug-in.
PluginApiImpl - Class in com.electrotank.electroserver4.extensions.api
Implementation of the api for a plug-in.
PluginApiResponse - Class in com.electrotank.electroserver4.extensions.api
Represents a response from the server in regards to a (generic) plugin request.
PluginApiResponse() - Constructor for class com.electrotank.electroserver4.extensions.api.PluginApiResponse
This constructor will be invoked by the server automatically.
PluginApiResponse.Status - Enum in com.electrotank.electroserver4.extensions.api
Enumeration of status states of a PluginApiResponse.
PluginInterop - Interface in com.electrotank.electroserver4.extensions
 
PluginLifeCycle - Interface in com.electrotank.electroserver4.extensions
Interface for automatic initialization of extensions and plugins.
PluginPrivateMessageResponse - Class in com.electrotank.electroserver4.extensions.api
This class represents a response from the server in regards to a plugin message delivery request.
PluginPrivateMessageResponse() - Constructor for class com.electrotank.electroserver4.extensions.api.PluginPrivateMessageResponse
This constructor will be invoked by the server automatically.
PluginPublicMessageResponse - Class in com.electrotank.electroserver4.extensions.api
This class represents a response from the server in regards to a plugin public message delivery request.
PluginPublicMessageResponse() - Constructor for class com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse
This constructor will be invoked by the server automatically.
PluginPublicMessageResponse.ZoneRoomCombo - Class in com.electrotank.electroserver4.extensions.api
Object class used by PluginPublicMessageResponse to record both the zoneId and roomId of a location that failed to deliver a public message.
PluginPublicMessageResponse.ZoneRoomCombo(int) - Constructor for class com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse.ZoneRoomCombo
Constructs a new ZoneRoomCombo object, suitable for recording a zone that failed to deliver a public message.
PluginPublicMessageResponse.ZoneRoomCombo(int, int) - Constructor for class com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse.ZoneRoomCombo
Constructs a new ZoneRoomCombo object, suitable for recording a room that failed to deliver a public message.
PluginRequest - Interface in com.electrotank.electroserver4.extensions
Provides an interface for communication from clients to a plugin.

R

ReadOnlyRoomVariable - Interface in com.electrotank.electroserver4.extensions.api.value
Room Variables are name/value pairs stored on the server and scoped to a room.
ReadOnlyUserVariable - Interface in com.electrotank.electroserver4.extensions.api.value
A User Variable is a name/value pair stored on the server and scoped to a user.
registerGameConfiguration(String, GameConfiguration) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Used to register a GameConfiguration with the server so that it can be used in conjunction with the GameManager.
registerGameConfiguration(String, GameConfiguration) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
releaseManagedObject(String, Object) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Releases a managed object back to the specified factory.
releaseManagedObject(String, Object) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
releaseObject(Object) - Method in class com.electrotank.electroserver4.extensions.BaseManagedObjectFactory
 
releaseObject(Object) - Method in interface com.electrotank.electroserver4.extensions.ManagedObjectFactory
 
removeAll() - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Removes all variables from the EsObject, leaving it empty.
removeBuddy(String, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Removes a buddy from the specified user's buddy list.
removeBuddy(String, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
removeKeywords(String, String, Collection<String>) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi
Removes a collection of keywords from the DAT file specified by the given path and filename.
removeUserPluginVariable(String, Object) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Removes the specified plug-in variable for this user.
removeUserPluginVariable(String, Object) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
removeVariable(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Removes the named variable from the EsObject.
request(String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
request(String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.PluginRequest
Handles a request from a specific user.
resumeQueue() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Resumes the queue of messages.
resumeQueue() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
RoomConfiguration - Class in com.electrotank.electroserver4.extensions.api.value
Object class that holds the configuration of a single room.
RoomConfiguration() - Constructor for class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Constructs a new instance of RoomConfiguration.
RoomResponse - Class in com.electrotank.electroserver4.extensions.api
This class represents a response from the server in regards to a plugin request to create a room or add users to a room.
RoomResponse() - Constructor for class com.electrotank.electroserver4.extensions.api.RoomResponse
Constructs a new RoomResponse object.
RoomUserEvents - Interface in com.electrotank.electroserver4.extensions
Interface for a custom event handler for room user events.
RoomValue - Class in com.electrotank.electroserver4.extensions.api.value
Object to store information about a particular room.
RoomValue() - Constructor for class com.electrotank.electroserver4.extensions.api.value.RoomValue
 
roomVariableCreated(String, ReadOnlyRoomVariable) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
roomVariableCreated(String, ReadOnlyRoomVariable) - Method in interface com.electrotank.electroserver4.extensions.RoomVariableEvents
 
roomVariableDeleted(String, ReadOnlyRoomVariable) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
roomVariableDeleted(String, ReadOnlyRoomVariable) - Method in interface com.electrotank.electroserver4.extensions.RoomVariableEvents
 
RoomVariableEvents - Interface in com.electrotank.electroserver4.extensions
 
RoomVariableResponse - Class in com.electrotank.electroserver4.extensions.api
This class represents a response from the server in regards to a plugin request to create, update, or delete a room variable.
RoomVariableResponse() - Constructor for class com.electrotank.electroserver4.extensions.api.RoomVariableResponse
 
roomVariableUpdated(String, ReadOnlyRoomVariable, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
roomVariableUpdated(String, ReadOnlyRoomVariable, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.RoomVariableEvents
 

S

ScheduledCallback - Interface in com.electrotank.electroserver4.extensions.api
Contains the scheduledCallback method which will be scheduled for later execution, normally a given number of times at a set interval.
scheduledCallback() - Method in interface com.electrotank.electroserver4.extensions.api.ScheduledCallback
Method to be invoked by the server at the scheduled time.
scheduleExecution(int, int, ScheduledCallback) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Schedules execution of the callback's method at the defined interval.
scheduleExecution(int, int, ScheduledCallback) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
scheduleExecutionFromScript(int, int, String) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Schedules execution of the callback's method at the defined interval.
scheduleExecutionFromScript(int, int, String) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToRoom(int, int, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to all users in a room.
sendPluginMessageToRoom(int, int, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToRooms(Map<Integer, Collection<Integer>>, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to a group of rooms.
sendPluginMessageToRooms(Map<Integer, Collection<Integer>>, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToServer(EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to the entire server.
sendPluginMessageToServer(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToUser(String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to a user.
sendPluginMessageToUser(String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToUsers(Collection<String>, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to a group of users.
sendPluginMessageToUsers(String[], EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to a group of users.
sendPluginMessageToUsers(String[], EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToUsers(Collection<String>, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToZone(int, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to all users in a zone.
sendPluginMessageToZone(int, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToZones(Collection<Integer>, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to a group of zones.
sendPluginMessageToZones(int[], EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sends a plugin message to a group of zones.
sendPluginMessageToZones(int[], EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToZones(Collection<Integer>, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
sendQueuedPluginMessageToRoom(EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Adds the given message to the message queue of each user in the room.
sendQueuedPluginMessageToRoom(String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Adds the given message to the message queue of each user in the room.
sendQueuedPluginMessageToRoom(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToRoom(String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUser(String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Adds the given message to the message queue of the specified user.
sendQueuedPluginMessageToUser(String, String, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Adds the given message to the message queue of the specified user.
sendQueuedPluginMessageToUser(String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUser(String, String, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUsers(Collection<String>, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Adds the given message to the message queue of each user in the Collection.
sendQueuedPluginMessageToUsers(String, Collection<String>, EsObjectRO) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Adds the given message to the message queue of each user in the Collection.
sendQueuedPluginMessageToUsers(Collection<String>, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUsers(String, Collection<String>, EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
setApi(EventApi) - Method in class com.electrotank.electroserver4.extensions.BaseEvent
 
setApi(ManagedObjectFactoryApi) - Method in class com.electrotank.electroserver4.extensions.BaseManagedObjectFactory
 
setApi(PluginApi) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
setApi(EventApi) - Method in interface com.electrotank.electroserver4.extensions.EventHandler
Sets the api.
setApi(ManagedObjectFactoryApi) - Method in interface com.electrotank.electroserver4.extensions.ManagedObjectFactory
 
setApi(PluginApi) - Method in interface com.electrotank.electroserver4.extensions.Plugin
 
setBoolean(String, boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the boolean value.
setBooleanArray(String, boolean[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the boolean array value.
setBuddyListEntries(Map<String, EsObject>) - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
setByte(String, byte) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the byte value.
setByteArray(String, byte[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the byte array value.
setCapacity(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the capacity of the room.
setCapacity(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Sets the capacity of the room.
setChar(String, char) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the char value.
setCharArray(String, char[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the char array value.
setCurrentExtension(String) - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
setDataAsBytes(byte[]) - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults
Sets the data from the url to the given array of bytes.
setDescription(String) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the description of the room.
setDescription(String) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Sets the optional text description of the room.
setDouble(String, double) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the double value.
setDoubleArray(String, double[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the double array value.
setErrorText(String) - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults
Sets the error message.
setEsObject(String, EsObject) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the EsObject value.
setEsObject(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext
Sets the optional EsObject broadcast.
setEsObjectArray(String, EsObject[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the EsObject array value.
setExtensionBoundUserServerVariable(String, String, Object) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sets an extension-bound user server variable on a given user.
setExtensionBoundUserServerVariable(String, String, Object) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
setExtensionName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration
Sets the name of the extension for the plugin.
setFloat(String, float) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the float value.
setFloatArray(String, float[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the float array value.
setFloodingFilterBanDuration(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the amount of time in seconds to ban a user for a flooding filter violation.
setFloodingFilterFailuresBeforeKick(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the total number of flooding filter failures allowed by a user before that user is kicked from the room.
setFloodingFilterKicksBeforeBan(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the total number of times to kick a user for flooding violations before that user is banned.
setFloodingFilterName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the name of the flooding filter.
setFloodingFilterResetAfterKick(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets a boolean indicating whether the flooding filter will be reset after a kick.
setFloodingFilterSpecified(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets whether a flooding filter has been specified for this room.
setGameDetails(EsObject) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Sets the game details.
setGameDetails(EsObject) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
setGameHiddenState(boolean) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Sets the game state to hidden or not.
setGameHiddenState(boolean) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
setGameLockState(boolean) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Sets the game state to locked or not.
setGameLockState(boolean) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
setHandle(String) - Method in class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration
Sets the handle for the plugin.
setHandle(String) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration
 
setHidden(String) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the room to hidden or not.
setHidden(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the room to hidden or not.
setInitialGameDetails(EsObjectRO) - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Sets the initial game details.
setInitParameters(EsObject) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration
 
setInteger(String, int) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the integer value.
setIntegerArray(String, int[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the int array value.
setLanguageFilterBanDuration(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the number of seconds that a user will be banned if the language filter ban is triggered.
setLanguageFilterDeliverMessageOnFailure(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets whether a message that fails the language filter will be delivered anyway.
setLanguageFilterFailuresBeforeKick(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the number of times the user is allowed to send messages that fail the language filter, before he is kicked from the room.
setLanguageFilterKicksBeforeBan(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets 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.
setLanguageFilterName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the name of the room's language filter.
setLanguageFilterResetAfterKick(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets whether the language filter should reset after a kick? If this is set to yes, then every time the user is kicked, it resets the process as if the user never been kicked.
setLanguageFilterSpecified(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets whether there is a specified language filter for this room.
setLoginEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration
 
setLogoutEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration
 
setLong(String, long) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the long value.
setLongArray(String, long[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the long array value.
setManagedObjectConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration
 
setMessage(String) - Method in class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext
Sets the message broadcast.
setName(String) - Method in class com.electrotank.electroserver4.extensions.api.RoomVariableResponse
Sets the name of the room variable.
setName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration
Sets the name of the plugin.
setName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the name of the room.
setName(String) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration
 
setNonOperatorUpdateAllowed(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets whether a user who is a non-operator is allowed to update the room.
setNonOperatorVariableUpdateAllowed(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets whether a user who is not an operator is allowed to update room variables?
setNumber(String, Number) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the Number value.
setNumber(String, double) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the double value, cast as a Number.
setNumber(String, float) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the float value, cast as a Number.
setNumber(String, long) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the long value, cast as a Number.
setNumber(String, int) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the int value, cast as a Number.
setNumberArray(String, Number[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the Number array value.
setPassword(String) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the password for the room.
setPassword(String) - Method in class com.electrotank.electroserver4.extensions.LoginContext
Sets the password, in the LoginContext.
setPasswordHashId(int) - Method in class com.electrotank.electroserver4.extensions.LoginContext
 
setPath(String) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration
 
setPermissionSetId(String) - Method in class com.electrotank.electroserver4.extensions.LoginContext
Sets the name of the permission set for this user.
setPersistent(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets the room to be persistent or not.
setPersistent(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Sets the room to be persistent or not.
setPluginConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration
 
setReceivingRoomAttributeUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Sets whether a user is receiving room attribute updates
setReceivingRoomListUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Sets the game to receive room list updates, or not.
setReceivingRoomListUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Sets if the user is receiving room list updates.
setReceivingRoomVariableUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Sets the game to receive room variable updates.
setReceivingRoomVariableUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Sets if the user is receiving room variable updates.
setReceivingUserListUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Sets the game to receive user list updates.
setReceivingUserListUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Sets if the user is receiving user list updates.
setReceivingUserVariableUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Sets the game to receive user variable updates.
setReceivingUserVariableUpdates(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Sets if the user is receiving user variable updates.
setReceivingVideoEvents(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Sets the game to receive video events.
setReceivingVideoEvents(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Sets whether the user is receiving video events.
setResponseParameters(EsObject) - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse
Sets the responseParameters.
setResponseParameters(EsObject) - Method in class com.electrotank.electroserver4.extensions.api.value.UserEnterContext
Sets the responseParameters for the room entry.
setResponseParameters(EsObject) - Method in class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext
Sets the response parameters for the broadcast message.
setRoomConfiguration(RoomConfiguration) - Method in class com.electrotank.electroserver4.extensions.api.value.GameConfiguration
Sets the room configuration for the game.
setRoomId(int) - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse
Sets the roomId.
setRoomId(int) - Method in class com.electrotank.electroserver4.extensions.api.RoomVariableResponse
Sets the roomId of the room holding the variable.
setRoomId(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Sets the roomId of the room.
setRoomMemberCount(int) - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse
Sets the number of clients in the room
setRoomName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Sets the name of the room.
setShort(String, short) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the short value.
setShortArray(String, short[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the short array value.
setStatus(PluginApiResponse.Status) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiResponse
Set the status of the response to one of the allowed enumerated states.
setString(String, String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the string value.
setStringArray(String, String[]) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
Sets the named entry of the EsObject to the string array value.
setSuccessful(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults
Sets a flag indicating whether the call to a url was successful.
setSynchronization(boolean) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration
 
setType(PluginType) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration
 
setUserName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.UserConfig
Sets the name of the user.
setUserName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext
Sets the name of the user who broadcast the message.
setUserName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.UserValue
Sets the name of the user.
setUserName(String) - Method in class com.electrotank.electroserver4.extensions.LoginContext
Sets the username for the login attempt.
setUserPluginVariable(String, Object, Object) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Sets the specified plug-in variable for a given user.
setUserPluginVariable(String, Object, Object) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
setUserServerVariable(String, String, EsObject) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Sets a user server variable on a given user.
setUserServerVariable(String, String, EsObject) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
setUserVariableEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver4.extensions.config.ExtensionConfiguration
 
setUsingFloodingFilter(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets whether this room uses a flooding filter.
setUsingLanguageFilter(boolean) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomConfiguration
Sets whether this room uses a language filter.
setValue(Object) - Method in class com.electrotank.electroserver4.extensions.api.ExtensionBoundUserServerVariableResponse
Sets the value of the extension bound user server variable
setValue(EsObject) - Method in class com.electrotank.electroserver4.extensions.api.UserServerVariableResponse
Sets the value of the user server variable.
setValue(double) - Method in class com.electrotank.electroserver4.extensions.api.value.Number
Sets the value of the Number object.
setZoneId(int) - Method in class com.electrotank.electroserver4.extensions.api.RoomResponse
Sets the zoneId of the room involved in the request.
setZoneId(int) - Method in class com.electrotank.electroserver4.extensions.api.RoomVariableResponse
Sets the zoneId of the zone holding the room.
setZoneId(int) - Method in class com.electrotank.electroserver4.extensions.api.value.RoomValue
Sets the zoneId of the zone in which this room resides.
setZoneId(int) - Method in class com.electrotank.electroserver4.extensions.api.value.ZoneValue
Sets the zoneId for this room.
setZoneName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.ZoneConfiguration
Sets the name of the zone.
setZoneName(String) - Method in class com.electrotank.electroserver4.extensions.api.value.ZoneValue
Sets the name of the zone.
startQueue(long) - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Starts the queue of messages.
startQueue(long) - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 
stopQueue() - Method in interface com.electrotank.electroserver4.extensions.api.PluginApi
Stops the queue of messages.
stopQueue() - Method in class com.electrotank.electroserver4.extensions.api.PluginApiImpl
 

T

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

U

updateRoomVariable(int, int, String, boolean, EsObject, boolean, boolean) - Method in interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
Updates the specified room variable.
updateRoomVariable(int, int, String, boolean, EsObject, boolean, boolean) - Method in class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
 
userBanned(String, String, int) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
userBanned(String, String, int) - Method in interface com.electrotank.electroserver4.extensions.RoomUserEvents
Actions triggered when a user is banned from the server.
UserConfig - Class in com.electrotank.electroserver4.extensions.api.value
This class defines the configuration of a given user and its relationship with a specific room/zone.
UserConfig() - Constructor for class com.electrotank.electroserver4.extensions.api.value.UserConfig
 
userEnter(UserEnterContext) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
userEnter(UserEnterContext) - Method in interface com.electrotank.electroserver4.extensions.RoomUserEvents
Actions triggered when a user enters the room.
UserEnterContext - Class in com.electrotank.electroserver4.extensions.api.value
Contains the context for a userEnter event.
UserEnterContext(String) - Constructor for class com.electrotank.electroserver4.extensions.api.value.UserEnterContext
Creates a new instance of UserEnterContext for a given userName
userExit(String) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
userExit(String) - Method in interface com.electrotank.electroserver4.extensions.RoomUserEvents
Actions triggered when a user exits the room.
userKicked(String, String) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
userKicked(String, String) - Method in interface com.electrotank.electroserver4.extensions.RoomUserEvents
Actions triggered when a user is kicked from a room.
UserPublicMessageContext - Class in com.electrotank.electroserver4.extensions.api.value
Contains the context for a userPublicMessage event.
UserPublicMessageContext(String, String, EsObjectRO) - Constructor for class com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext
Creates a new instance of UserPublicMessageContext
userSendPublicMessage(UserPublicMessageContext) - Method in class com.electrotank.electroserver4.extensions.BasePlugin
 
userSendPublicMessage(UserPublicMessageContext) - Method in interface com.electrotank.electroserver4.extensions.RoomUserEvents
Actions triggered when a user sends a public message.
UserServerVariableResponse - Class in com.electrotank.electroserver4.extensions.api
This class represents a response from the server in regards to a plugin request to get, set, or delete a user server variable.
UserServerVariableResponse() - Constructor for class com.electrotank.electroserver4.extensions.api.UserServerVariableResponse
 
UserValue - Class in com.electrotank.electroserver4.extensions.api.value
Contains the name of a user who is in a room.
UserValue() - Constructor for class com.electrotank.electroserver4.extensions.api.value.UserValue
 
userVariableCreated(long, ReadOnlyUserVariable) - Method in interface com.electrotank.electroserver4.extensions.UserVariableEventHandler
 
userVariableDeleted(long, ReadOnlyUserVariable) - Method in interface com.electrotank.electroserver4.extensions.UserVariableEventHandler
 
UserVariableEventHandler - Interface in com.electrotank.electroserver4.extensions
 
UserVariableResponse - Class in com.electrotank.electroserver4.extensions.api
This class represents a response from the server in regards to a plugin request to create, update, or delete a user variable.
UserVariableResponse() - Constructor for class com.electrotank.electroserver4.extensions.api.UserVariableResponse
 
userVariableUpdated(long, ReadOnlyUserVariable, ReadOnlyUserVariable) - Method in interface com.electrotank.electroserver4.extensions.UserVariableEventHandler
 
useSynchronization() - Method in class com.electrotank.electroserver4.extensions.config.ExtensionClassConfiguration
 
UTF8 - Static variable in class com.electrotank.electroserver4.extensions.api.value.HttpResults
 

V

valueOf(String) - Static method in enum com.electrotank.electroserver4.extensions.api.PluginApiResponse.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.electrotank.electroserver4.extensions.ChainAction
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.electrotank.electroserver4.extensions.api.PluginApiResponse.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.electrotank.electroserver4.extensions.ChainAction
Returns an array containing the constants of this enum type, in the order they are declared.
variableExists(String) - Method in class com.electrotank.electroserver4.extensions.api.value.EsObject
 
variableExists(String) - Method in interface com.electrotank.electroserver4.extensions.api.value.EsObjectRO
Returns true if an entry exists with the given name.

W

wasSuccessful() - Method in class com.electrotank.electroserver4.extensions.api.value.HttpResults
Gets a flag indicating whether the call to a url was successful.
write(String, String, EsObjectRO, CleanupStrategy, Date) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi
Writes an EsObjectRO object as a file.
write(String, String, EsObjectRO, CleanupStrategy, Date, Collection<String>) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi
Writes an EsObjectRO object as a file.
write(String, String, EsObjectRO, CleanupStrategy) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi
Writes an EsObjectRO object as a file.
write(String, String, EsObjectRO, CleanupStrategy, Collection<String>) - Method in interface com.electrotank.electroserver4.extensions.api.EsFileSystemApi
Writes an EsObjectRO object as a file.

Z

ZoneConfiguration - Class in com.electrotank.electroserver4.extensions.api.value
Object class that holds the configuration of a single zone.
ZoneConfiguration() - Constructor for class com.electrotank.electroserver4.extensions.api.value.ZoneConfiguration
Constructs a new instance of ZoneConfiguration.
ZoneValue - Class in com.electrotank.electroserver4.extensions.api.value
Object to store information about a particular zone.
ZoneValue() - Constructor for class com.electrotank.electroserver4.extensions.api.value.ZoneValue
 

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

Copyright © 2007 Electrotank, Inc. All Rights Reserved.