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

A

acquireManagedObject(String, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Acquires a managed object from the specified managed object factory.
acquireManagedObject(String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
acquireObject(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.BaseManagedObjectFactory
 
acquireObject(EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.ManagedObjectFactory
 
addAll(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Adds the contents of the argument.
addBuddy(String, String, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Adds a buddy to the specified user's buddy list.
addBuddy(String, String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
addBuddy(String) - Method in class com.electrotank.electroserver5.extensions.api.FindGamesWithBuddiesResponse
 
addError(ErrorType) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiResponse
 
addExtensionBoundUserServerVariable(Object, Object) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
addGame(String, GameRO) - Method in class com.electrotank.electroserver5.extensions.api.FindGamesWithBuddiesResponse
 
addInvalidRoom(int, int) - Method in class com.electrotank.electroserver5.extensions.api.PluginPublicMessageResponse
Adds a room to the list of the failed deliveries.
addInvalidZone(int) - Method in class com.electrotank.electroserver5.extensions.api.PluginPublicMessageResponse
Adds a zone to the list of failed deliveries.
addKeywords(String, String, Collection<String>) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.PluginPrivateMessageResponse
Adds a name to the list of failed deliveries.
addName(String) - Method in class com.electrotank.electroserver5.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.electroserver5.extensions.api.PluginPrivateMessageResponse
Adds a collection of user names to the failed deliveries list.
addPlugin(ExtensionComponentConfiguration) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Adds a plug-in to the list of plug-ins for the room.
addRoom(RoomConfiguration) - Method in class com.electrotank.electroserver5.extensions.api.value.ZoneConfiguration
Adds a room to the zone.
addToQueue(String, EsObjectRO, Message.Reliability) - Method in class com.electrotank.electroserver5.extensions.api.value.MessageQueue
 
addUserServerVariable(String, EsObject) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
addUsersToRoom(int, int, String, Collection<UserConfig>) - Method in interface com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
addUsersToRoom(int, int, String, Collection<UserConfig>) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
addUserVariable(String, EsObject) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
addVariable(RoomVariable) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
 
addVariables(EsObject) - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Add variables to the plugin.
addVariables(Collection<RoomVariable>) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
 
applyLanguageFilterToString(String, String) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
areLoginsEnabled() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns true if users are currently allowed to log in.
areLoginsEnabled() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 

B

banUserFromRoom(String, int, int, int, String) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
BaseBuddyListEventHandler - Class in com.electrotank.electroserver5.extensions
Custom buddy list event handler.
BaseBuddyListEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BaseBuddyListEventHandler
 
BaseEvent - Class in com.electrotank.electroserver5.extensions
 
BaseEvent() - Constructor for class com.electrotank.electroserver5.extensions.BaseEvent
 
BaseExtensionLifecycleEventHandler - Class in com.electrotank.electroserver5.extensions
Custom extension lifecycle event handler.
BaseExtensionLifecycleEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BaseExtensionLifecycleEventHandler
 
BaseLoginEventHandler - Class in com.electrotank.electroserver5.extensions
Custom login event handler.
BaseLoginEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BaseLoginEventHandler
 
BaseLogoutEventHandler - Class in com.electrotank.electroserver5.extensions
Custom logout event handler.
BaseLogoutEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BaseLogoutEventHandler
 
BaseManagedObjectFactory - Class in com.electrotank.electroserver5.extensions
 
BaseManagedObjectFactory() - Constructor for class com.electrotank.electroserver5.extensions.BaseManagedObjectFactory
Creates a new instance of BaseManagedObjectFactory
BasePlugin - Class in com.electrotank.electroserver5.extensions
 
BasePlugin() - Constructor for class com.electrotank.electroserver5.extensions.BasePlugin
Creates a new instance of BasePlugin
BasePrivateMessageEventHandler - Class in com.electrotank.electroserver5.extensions
Custom private message event handler.
BasePrivateMessageEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BasePrivateMessageEventHandler
 
BasePublicMessageEventHandler - Class in com.electrotank.electroserver5.extensions
Custom public message event handler, for processing all public messages even if they are in rooms that have no plugin attached.
BasePublicMessageEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BasePublicMessageEventHandler
 
BaseRoomTrackingEventHandler - Class in com.electrotank.electroserver5.extensions
Custom room tracking event handler.
BaseRoomTrackingEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BaseRoomTrackingEventHandler
 
BaseUserTrackingEventHandler - Class in com.electrotank.electroserver5.extensions
Custom user tracking event handler.
BaseUserTrackingEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BaseUserTrackingEventHandler
 
BaseUserVariableEventHandler - Class in com.electrotank.electroserver5.extensions
Custom user variable event handler.
BaseUserVariableEventHandler() - Constructor for class com.electrotank.electroserver5.extensions.BaseUserVariableEventHandler
 
blockAndCallUrl(String, boolean, Map<String, String>) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
BuddyListEventFactory - Class in com.electrotank.electroserver5.extensions
 
BuddyListEventFactory(ScheduledExecutorService, ApiFactory) - Constructor for class com.electrotank.electroserver5.extensions.BuddyListEventFactory
Creates a new instance of BuddyListEventFactory
BuddyListEventHandler - Interface in com.electrotank.electroserver5.extensions
 
buildExtensionConfiguration(String, String) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfigurationService
 
buildExtensionConfiguration(InputStream) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfigurationService
 
buildExtensionFromConfiguration(String, ExtensionConfiguration) - Method in class com.electrotank.electroserver5.extensions.ExtensionFactory
 

C

callRoomPlugin(int, int, String, EsObjectRO) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
callServerPlugin(String, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to invoke the interop method on the designated server-level plugin.
callServerPlugin(String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
callUrl(String, boolean, Map<String, String>, HttpCallback) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
callUrlFromScript(String, boolean, Map<String, String>, String) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
cancelScheduledExecution(int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Cancels the scheduled execution identified by the ID.
cancelScheduledExecution(int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
carefullyCreateGameForUsers(String, Collection<String>, String, String, boolean, boolean, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to directly create a game for the identified users via the GameManager.
carefullyCreateGameForUsers(String, Collection<String>, String, String, boolean, boolean, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
ChainAction - Enum in com.electrotank.electroserver5.extensions
 
clone() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Constructs a clone of the RoomConfiguration object.
com.electrotank.electroserver5.extensions - package com.electrotank.electroserver5.extensions
Provides classes for basic plug-ins, extensions, and events.
com.electrotank.electroserver5.extensions.api - package com.electrotank.electroserver5.extensions.api
Provides classes for handling the server-side API and responses.
com.electrotank.electroserver5.extensions.api.exceptions - package com.electrotank.electroserver5.extensions.api.exceptions
Provides classes for handling exceptions.
com.electrotank.electroserver5.extensions.api.value - package com.electrotank.electroserver5.extensions.api.value
Provides class for object variables, such as EsObject and GameConfiguration.
com.electrotank.electroserver5.extensions.config - package com.electrotank.electroserver5.extensions.config
Provides classes for handling the configuration of an extension.
compareTo(ExtensionClassConfiguration) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.BuddyListEventFactory
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.ExtensionLifecycleEventFactory
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.LoginEventFactory
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.LogoutEventFactory
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.PrivateMessageEventFactory
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.PublicMessageEventFactory
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.RoomTrackingEventFactory
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.UserTrackingEventFactory
 
createEvent(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager) - Method in class com.electrotank.electroserver5.extensions.UserVariableEventFactory
 
createFactory(ExtensionClassHolder, String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.ManagedObjectFactoryFactory
 
createGameForUsers(String, Collection<String>, String, String, boolean, boolean, EsObject) - Method in interface com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
createGameForUsers(String, String[], String, String, boolean, boolean, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
createOrUpdateUserVariable(String, String, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Creates or updates a user variable as needed.
createOrUpdateUserVariable(String, String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
createPlugin(ExtensionClassHolder, String, String, EsObjectRO, ExtensionManager, boolean, int, int, int) - Method in class com.electrotank.electroserver5.extensions.PluginFactory
 
createRoom(int, RoomConfiguration, Collection<UserConfig>) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Creates a room in the specified zone using the supplied room configuration.
createRoom(int, RoomConfiguration, UserConfig[]) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Creates a room in the specified zone using the supplied room configuration.
createRoom(int, RoomConfiguration, UserConfig[]) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
createRoom(int, RoomConfiguration, Collection<UserConfig>) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
createRoomInNamedZone(String, boolean, RoomConfiguration, Collection<UserConfig>) - Method in interface com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
createRoomInNamedZone(String, boolean, RoomConfiguration, Collection<UserConfig>) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
createRoomVariable(int, int, String, EsObject, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Creates a room variable in the specified room.
createRoomVariable(int, int, String, EsObject, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
createRoomVariableForUser(int, int, String, EsObject, boolean, String, boolean) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 

D

deepClone() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Creates a deep clone of the EsObject.
DEFAULT_ENCODING - Static variable in class com.electrotank.electroserver5.extensions.api.value.HttpResults
 
delete(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.EsFileSystemApi
Deletes the DAT file associated with the given path and filename.
deleteDirectory(String) - Method in interface com.electrotank.electroserver5.extensions.api.EsFileSystemApi
Deletes the directory associated with the given path.
deleteExtensionBoundUserServerVariable(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Deletes an extension-bound user server variable.
deleteExtensionBoundUserServerVariable(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
deleteRoomVariable(int, int, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Deletes the specified room variable.
deleteRoomVariable(int, int, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
deleteUserServerVariable(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Deletes a given user server variable from the specified user.
deleteUserServerVariable(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
deleteUserVariable(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Deletes the specified user variable.
deleteUserVariable(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
destroy() - Method in class com.electrotank.electroserver5.extensions.BaseEvent
 
destroy() - Method in class com.electrotank.electroserver5.extensions.BaseManagedObjectFactory
 
destroy() - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
destroy() - Method in interface com.electrotank.electroserver5.extensions.ExtensionLifeCycle
Automatically invoked when the object class is destroyed.
destroyRoom(int, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Destroys the room specified by the room and zone IDs.
destroyRoom(int, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
disableAllLogins() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Disables users from logging in.
disableAllLogins() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
doHashedPasswordsMatch(String) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
drainQueue() - Method in class com.electrotank.electroserver5.extensions.api.value.MessageQueue
 

E

ElectroServerApi - Interface in com.electrotank.electroserver5.extensions.api
The foundation of all server-side API code in ElectroServer 4.
ElectroServerApiImpl - Class in com.electrotank.electroserver5.extensions.api
The ElectroServerApiImpl provides functionality to all custom code and allows the various extensions to interact with the server directly.
ElectroServerApiImpl(BaseBridge, GatewaySender, RoomManager, People, ScheduledExecutorService, LanguageFilterManager, EsFileSystemApi, GameManager, BuddyListManager, UserEventManager, ExtensionManager) - Constructor for class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
emptyObject - Static variable in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
enableLogins() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Allows users to start logging in again, after disableAllLogins was previously used.
enableLogins() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
EsFileSystemApi - Interface in com.electrotank.electroserver5.extensions.api
All needed file I/O methods.
EsObject - Class in com.electrotank.electroserver5.extensions.api.value
EsObject facilitates the exchange of data between all layers of a multiplayer application.
EsObject() - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObject
Creates a new instance of EsObject
EsObject(Object...) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObject
Creates a new instance of EsObject and fills it with the entries in the Object.
EsObjectDataHolder - Class in com.electrotank.electroserver5.extensions.api.value
 
EsObjectDataHolder(int) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(String) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(double) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(float) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(boolean) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(byte) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(char) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(long) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(short) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(int[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(String[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(double[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(float[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(boolean[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(byte[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(char[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(long[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(short[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(EsObject) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(EsObject[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(Number) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectDataHolder(Number[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
EsObjectEntry - Class in com.electrotank.electroserver5.extensions.api.value
Object class that holds a single entry for an EsObject.
EsObjectEntry(String, EsObject) - Constructor for class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Constructs a new EsObjectEntry object.
EsObjectRO - Interface in com.electrotank.electroserver5.extensions.api.value
EsObjectRO is a read-only copy of an EsObject.
EventApi - Interface in com.electrotank.electroserver5.extensions.api
ElectroServerApi extension used by event handlers.
EventApiImpl - Class in com.electrotank.electroserver5.extensions.api
 
EventApiImpl(BaseBridge, GatewaySender, RoomManager, People, ScheduledExecutorService, LanguageFilterManager, EsFileSystem, GameManager, BuddyListManager, UserEventManager, ExtensionManager) - Constructor for class com.electrotank.electroserver5.extensions.api.EventApiImpl
Creates a new instance of EventApiImpl
EventHandler - Interface in com.electrotank.electroserver5.extensions
 
EventHandlerLifeCycle - Interface in com.electrotank.electroserver5.extensions
 
evictUserFromServer(String, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Synchronously evict a user from the system.
evictUserFromServer(String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
executeLogin(LoginContext) - Method in class com.electrotank.electroserver5.extensions.BaseLoginEventHandler
Custom login event handler.
executeLogin(LoginContext) - Method in interface com.electrotank.electroserver5.extensions.LoginEventHandler
Custom login event handler.
executeLogout(String) - Method in class com.electrotank.electroserver5.extensions.BaseLogoutEventHandler
Custom logout event handler.
executeLogout(String) - Method in interface com.electrotank.electroserver5.extensions.LogoutEventHandler
Custom logout event handler.
ExtensionBoundUserServerVariableResponse - Class in com.electrotank.electroserver5.extensions.api
Data object for an extension bound user server variable.
ExtensionBoundUserServerVariableResponse() - Constructor for class com.electrotank.electroserver5.extensions.api.ExtensionBoundUserServerVariableResponse
 
ExtensionClassConfiguration - Class in com.electrotank.electroserver5.extensions.config
 
ExtensionClassConfiguration() - Constructor for class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
Creates a new instance of ExtensionClassConfiguration
ExtensionComponentConfiguration - Class in com.electrotank.electroserver5.extensions.api.value
Object class that holds the configuration of a single Plugin.
ExtensionComponentConfiguration(Plugin) - Constructor for class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
 
ExtensionComponentConfiguration() - Constructor for class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Constructs a new (empty) instance of ExtensionComponentConfiguration.
ExtensionConfiguration - Class in com.electrotank.electroserver5.extensions.config
 
ExtensionConfiguration() - Constructor for class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
Creates a new instance of ExtensionConfiguration
ExtensionConfigurationService - Class in com.electrotank.electroserver5.extensions.config
 
ExtensionConfigurationService() - Constructor for class com.electrotank.electroserver5.extensions.config.ExtensionConfigurationService
Creates a new instance of ExtensionConfigurationService
ExtensionEventHandler - Interface in com.electrotank.electroserver5.extensions
 
ExtensionFactory - Class in com.electrotank.electroserver5.extensions
 
ExtensionFactory(LoginEventFactory, LogoutEventFactory, ManagedObjectFactoryFactory, PluginFactory, UserVariableEventFactory, PrivateMessageEventFactory, BuddyListEventFactory, UserTrackingEventFactory, RoomTrackingEventFactory, ExtensionLifecycleEventFactory, PublicMessageEventFactory) - Constructor for class com.electrotank.electroserver5.extensions.ExtensionFactory
 
ExtensionLifeCycle - Interface in com.electrotank.electroserver5.extensions
Interface for automatic initialization of extensions and plugins.
ExtensionLifecycleEventFactory - Class in com.electrotank.electroserver5.extensions
 
ExtensionLifecycleEventFactory(ScheduledExecutorService, ApiFactory) - Constructor for class com.electrotank.electroserver5.extensions.ExtensionLifecycleEventFactory
Creates a new instance of PrivateMessageEventFactory
ExtensionLifecycleEventHandler - Interface in com.electrotank.electroserver5.extensions
 
extensionManager - Variable in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 

F

FileSystemApiException - Exception in com.electrotank.electroserver5.extensions.api.exceptions
 
FileSystemApiException() - Constructor for exception com.electrotank.electroserver5.extensions.api.exceptions.FileSystemApiException
 
FileSystemApiException(String) - Constructor for exception com.electrotank.electroserver5.extensions.api.exceptions.FileSystemApiException
 
FileSystemApiException(Throwable) - Constructor for exception com.electrotank.electroserver5.extensions.api.exceptions.FileSystemApiException
 
FileSystemApiException(String, Throwable) - Constructor for exception com.electrotank.electroserver5.extensions.api.exceptions.FileSystemApiException
 
findAllGamesWithBuddies(String, String, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Finds games being played by any buddies of the specified user.
findAllGamesWithBuddies(String, String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
findFilesByKeywords(Collection<String>) - Method in interface com.electrotank.electroserver5.extensions.api.EsFileSystemApi
Finds a collection of EsObjects that had been stored previously using the collection of keywords specified.
findGames(String, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns an array of current games that match the criteria given, whether the games are locked or not.
findGames(String, boolean, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns an array of current games that match the criteria given.
findGames(String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
findGames(String, boolean, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
findGames(SearchCriteria) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
FindGamesWithBuddiesResponse - Class in com.electrotank.electroserver5.extensions.api
FindGamesWithBuddiesResponse is an object returned by ElectroServerApi.
FindGamesWithBuddiesResponse() - Constructor for class com.electrotank.electroserver5.extensions.api.FindGamesWithBuddiesResponse
Creates a new instance of FindGamesWithBuddiesResponse.
findOneGameWithBuddies(String, String, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Finds one game being played by a buddy of the specified user.
findOneGameWithBuddies(String, String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
fromXML(Node, XPath) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Generates an EsObject from XML, assuming it is formatted correctly.
fromXMLString(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Generates an EsObject from a String containing XML, assuming it is formatted correctly.

G

GameConfiguration - Class in com.electrotank.electroserver5.extensions.api.value
Object class that holds the configuration of a single game.
GameConfiguration() - Constructor for class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
 
GameManagerResponse - Class in com.electrotank.electroserver5.extensions.api
GameManagerResponse is an object returned by the GameManager.
GameManagerResponse(boolean, int, int, int, EsObjectRO) - Constructor for class com.electrotank.electroserver5.extensions.api.GameManagerResponse
Creates a new instance of GameManagerResponse.
GameManagerResponse(boolean, ErrorType) - Constructor for class com.electrotank.electroserver5.extensions.api.GameManagerResponse
Creates a new instance of GameManagerResponse.
getAction() - Method in class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
 
getAllConnectedUsers() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns a collection of the usernames of all connected users.
getAllConnectedUsers() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getAllFloodingFilterNames() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns a list of all flooding filter names
getAllFloodingFilterNames() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getAllLanguageFilterNames() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns a list of all language filter names
getAllLanguageFilterNames() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getApi() - Method in class com.electrotank.electroserver5.extensions.BaseEvent
 
getApi() - Method in class com.electrotank.electroserver5.extensions.BaseManagedObjectFactory
 
getApi() - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
getApi() - Method in interface com.electrotank.electroserver5.extensions.EventHandler
Returns the api for any class that implements this interface.
getApi() - Method in interface com.electrotank.electroserver5.extensions.ManagedObjectFactory
 
getApi() - Method in interface com.electrotank.electroserver5.extensions.Plugin
 
getBoolean(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getBoolean(String, boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getBoolean() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a boolean.
getBoolean(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the boolean value of the named entry.
getBoolean(String, boolean) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getBooleanArray(String, boolean[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getBooleanArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of booleans.
getBooleanArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the boolean array value of the named entry.
getBooleanArray(String, boolean[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the boolean array value of the named entry, or the default value if any exception occurs.
getBooleanArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getBooleanValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getBuddies(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets the specified user's buddy list.
getBuddies(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getBuddiesOnline(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets the specified user's buddy list, filtered to show only those buddies that are currently online.
getBuddiesOnline(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getBuddyEsObject(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets the optional EsObject associated with a buddy in the specified user's buddy list.
getBuddyEsObject(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getBuddyListEntries() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getBuddyListEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getBuddyToGamesMap() - Method in class com.electrotank.electroserver5.extensions.api.FindGamesWithBuddiesResponse
Gets a map of all information about buddies and games.
getByte(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getByte(String, byte) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getByte() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a byte.
getByte(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the byte value of the named entry.
getByte(String, byte) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getByteArray(String, byte[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getByteArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of bytes.
getByteArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the byte array value of the named entry.
getByteArray(String, byte[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the byte array value of the named entry, or the default value if any exception occurs.
getByteArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getByteValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getCapacity() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Gets the capacity of the room.
getCapacity() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Gets the capacity of the room.
getChar(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getChar(String, char) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getChar() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a char.
getChar(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the char value of the named entry.
getChar(String, char) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getCharArray(String, char[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getCharArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of chars.
getCharArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the char array value of the named entry.
getCharArray(String, char[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the char array value of the named entry, or the default value if any exception occurs.
getCharArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getCharValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getClientType() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getClientVersion() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getConnectedUsers() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets a list of the usernames of all users currently logged in.
getConnectedUsers() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getDataAsBytes() - Method in class com.electrotank.electroserver5.extensions.api.value.HttpResults
Gets the data from the url as an array of bytes.
getDataAsMap(String) - Method in class com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.HttpResults
Gets the data from the url as a string.
getDataAsString() - Method in class com.electrotank.electroserver5.extensions.api.value.HttpResults
Gets the data from the url as a string, using the default encoding.
getDataType(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getDataType() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getDataType() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
 
getDataType(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
 
getDescription() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Gets a description of the room.
getDescription() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Gets the optional text description of a room.
getDouble(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getDouble(String, double) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getDouble() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a double.
getDouble(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the double value of the named entry.
getDouble(String, double) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getDoubleArray(String, double[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getDoubleArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of doubles.
getDoubleArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the double array value of the named entry.
getDoubleArray(String, double[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the double array value of the named entry, or the default value if any exception occurs.
getDoubleArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getDoubleValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getError() - Method in class com.electrotank.electroserver5.extensions.api.GameManagerResponse
Used to get the error for the request
getError() - Method in class com.electrotank.electroserver5.extensions.api.LanguageFilterResponse
Used to get the error for the request
getErrors() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiResponse
 
getErrorText() - Method in class com.electrotank.electroserver5.extensions.api.value.HttpResults
Gets the error message if the call was unsuccessful.
getEsObject(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.EsFileSystemApi
Gets the EsObject that was stored previously with the given path and filename.
getEsObject(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getEsObject(String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getEsObject() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an EsObject.
getEsObject(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the EsObject value of the named entry.
getEsObject(String, EsObject) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.UserPrivateMessageContext
Gets the optional EsObject to send.
getEsObject() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Gets a read-only copy of the optional EsObject broadcast.
getEsObjectArray(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getEsObjectArray(String, EsObject[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getEsObjectArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of EsObjects.
getEsObjectArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the EsObject array value of the named entry.
getEsObjectArray(String, EsObject[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the EsObject array value of the named entry, or the default value if any exception occurs.
getEsObjectArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getEsObjectValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getExtensionBoundServerVariable(Object) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the ExtensionBoundServerVariable of this name.
getExtensionBoundServerVariable(Object) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getExtensionBoundUserServerVariable(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns an extension-bound user server variable.
getExtensionBoundUserServerVariable(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getExtensionBoundUserServerVariable(Object) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getExtensionLifecycleEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getExtensionName() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to get the name of the extension that contains this component.
getExtensionName() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getExtensionName() - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Gets the name of the extension for the Plugin.
getFailedNames() - Method in class com.electrotank.electroserver5.extensions.api.RoomResponse
Gets collection of names of users who failed to join the room.
getFileSystemApi() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to access the file system API functionality of the server.
getFileSystemApi() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getFloat(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getFloat(String, float) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getFloat() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a float.
getFloat(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the float value of the named entry.
getFloat(String, float) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getFloatArray(String, float[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getFloatArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of floats.
getFloatArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the float array value of the named entry.
getFloatArray(String, float[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the float array value of the named entry, or the default value if any exception occurs.
getFloatArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getFloatValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getFloodingFilterBanDuration() - Method in class com.electrotank.electroserver5.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.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Gets the name of the flooding filter.
getGameCountByType() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns the number of current games of each game type registered by GameManager.
getGameCountByType() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getGameDetails() - Method in class com.electrotank.electroserver5.extensions.api.GameManagerResponse
Used to get a read-only copy of the gameDetails
getGameDetails() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Gets the game details as an EsObject.
getGameDetails() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getGameId() - Method in class com.electrotank.electroserver5.extensions.api.GameManagerResponse
Used to get the gameId
getGameId() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Gets the gameId of the room this plugin is attached to, if this is a game room.
getGameId() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getGameId() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Gets the gameId of the game associated with this room.
getGameId() - Method in class com.electrotank.electroserver5.extensions.api.value.UserTrackingContext
 
getGamesFound() - Method in class com.electrotank.electroserver5.extensions.api.FindGamesWithBuddiesResponse
Gets the list of all games found that have at least one buddy in them.
getGameTypesRegistered() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns a list of all gameTypes registered with GameManager.
getGameTypesRegistered() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getHandle() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to get the handle of this extension component.
getHandle() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getHandle() - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Gets the handle for the plugin.
getHandle() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
getIdleMillisecondsForUser(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns the number of milliseconds that the specified user has been idle.
getIdleMillisecondsForUser(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getInitialGameDetails() - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Gets the initial game details.
getInitParameters() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
getIntArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getInteger(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getInteger(String, int) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getInteger() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an integer.
getInteger(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the integer value of the named entry.
getInteger(String, int) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getIntegerArray(String, int[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getIntegerArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of ints.
getIntegerArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the int array value of the named entry.
getIntegerArray(String, int[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the int array value of the named entry, or the default value if any exception occurs.
getIntValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getInvalidNames() - Method in class com.electrotank.electroserver5.extensions.api.PluginPrivateMessageResponse
Gets a list of failed deliveries by user name.
getInvalidZoneRoomCombos() - Method in class com.electrotank.electroserver5.extensions.api.PluginPublicMessageResponse
Gets a Collection of ZoneRoomCombo objects specifying which zones/rooms failed to deliver the message.
getIpForUser(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets a list of IP addresses the user is connecting from or null if the user is not known.
getIpForUser(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getLanguageFilterBanDuration() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Gets the duration of the ban that the language filter will impose.
getLanguageFilterFailuresBeforeKick() - Method in class com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Gets the name of the room's language filter.
getLogger() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Acquires a logger for the current component.
getLogger() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getLoginEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getLogoutEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getLogoutReason(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
For use in LogoutEventHandler.
getLogoutReason(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getLogoutType(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
For use in LogoutEventHandler.
getLogoutType(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getLong(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getLong(String, long) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getLong() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a long.
getLong(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the long value of the named entry.
getLong(String, long) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getLongArray(String, long[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getLongArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of longs.
getLongArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the long array value of the named entry.
getLongArray(String, long[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the long array value of the named entry, or the default value if any exception occurs.
getLongArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getLongValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getManagedObjectConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getMessage() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPrivateMessageContext
Gets the message being sent
getMessage() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Gets the message broadcast.
getName() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to the get the name of this extension component.
getName() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getName() - Method in class com.electrotank.electroserver5.extensions.api.RoomVariableResponse
Gets the name of the room variable.
getName() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the name of the entry.
getName() - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Gets the name of the plugin.
getName() - Method in interface com.electrotank.electroserver5.extensions.api.value.ReadOnlyRoomVariable
Gets the name of the room variable.
getName() - Method in interface com.electrotank.electroserver5.extensions.api.value.ReadOnlyUserServerVariable
Gets the name of the user server variable.
getName() - Method in interface com.electrotank.electroserver5.extensions.api.value.ReadOnlyUserVariable
Gets the name of the user variable.
getName() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Gets the name of the room.
getName() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getNumber(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getNumber(String, Number) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getNumber() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a Number.
getNumber(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the Number value of the named entry.
getNumber(String, Number) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getNumberArray(String, Number[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getNumberArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of Numbers.
getNumberArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the Number array value of the named entry.
getNumberArray(String, Number[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the Number array value of the named entry, or the default value if any exception occurs.
getNumberArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getNumberValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getOldVariableValue() - Method in class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
 
getPassword() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Gets the password for the room.
getPassword() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
 
getPassword() - Method in class com.electrotank.electroserver5.extensions.LoginContext
Gets the password from the login attempt.
getPasswordHashId() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getPath() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
getPermissionSetId(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns the id of the permission set for this user.
getPermissionSetId(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getPermissionSetId() - Method in class com.electrotank.electroserver5.extensions.LoginContext
Gets the name of the permission set for this user.
getPluginConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getPlugins() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Gets a list of the plug-ins for the room.
getPrivateMessageEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getPublicMessageEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getRandomGame() - Method in class com.electrotank.electroserver5.extensions.api.FindGamesWithBuddiesResponse
Chooses a random game of all games found.
getRawValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getRawValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the raw (Object) value of the entry.
getRawVariable(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getRawVariable(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the raw value of the named variable, as an Object.
getReliability() - Method in class com.electrotank.electroserver5.extensions.RequestContext
 
getRemoteAddress() - Method in class com.electrotank.electroserver5.extensions.LoginContext
Gets the remote IP address of the user
getRequestParameters() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getResponseParameters() - Method in class com.electrotank.electroserver5.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.electroserver5.extensions.api.value.UserEnterContext
Gets the responseParameters for the room entry.
getResponseParameters() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Gets the response parameters for the broadcast message.
getResponseParameters() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getRoom(int, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets information about a single room, given the zoneId and roomId.
getRoom(int, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRoomConfiguration() - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Gets the room configuration for the game.
getRoomCount() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the total number of active rooms in all zones.
getRoomCount() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRoomId() - Method in class com.electrotank.electroserver5.extensions.api.GameManagerResponse
Used to get the roomId
getRoomId() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Gets the roomId.
getRoomId() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getRoomId() - Method in class com.electrotank.electroserver5.extensions.api.PluginPublicMessageResponse.ZoneRoomCombo
Gets the roomId of the room that failed to deliver the public message.
getRoomId() - Method in class com.electrotank.electroserver5.extensions.api.RoomResponse
Gets the roomId of the room created.
getRoomId() - Method in class com.electrotank.electroserver5.extensions.api.RoomVariableResponse
Gets the roomId of the room holding the variable.
getRoomId() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Gets the roomId of the room.
getRoomId() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
 
getRoomId() - Method in class com.electrotank.electroserver5.extensions.api.value.UserTrackingContext
 
getRoomMemberCount() - Method in class com.electrotank.electroserver5.extensions.api.RoomResponse
Gets the number of clients in the room
getRoomName() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Gets the name of the room.
getRoomName() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getRoomName() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Gets the name of the room.
getRoomName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserTrackingContext
 
getRoomOperators(int, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets a list of all users who have room operator status for the given room.
getRoomOperators(int, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRoomPlugin(int, int, String) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
getRooms(int, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets information about all rooms in the zone specified that have the specified room name.
getRooms(String, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets information about all rooms with the specified roomId that are in a zone with the specified zone name.
getRooms(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets information about all rooms with the specified room name that are in a zone with the specified zone name.
getRooms(int, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRooms(String, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRooms(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRooms() - Method in class com.electrotank.electroserver5.extensions.api.value.ZoneConfiguration
Gets a list of the configurations of all the rooms in this zone.
getRoomsInZone(int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns all the rooms in a given zone.
getRoomsInZone(int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRoomsInZoneByName(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns all the rooms in a given zone.
getRoomsInZoneByName(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRoomTrackingEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getRoomVariable(int, int, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns a specific room variable.
getRoomVariable(int, int, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getRoomVariables(int, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns all room variables in a given room.
getRoomVariables(int, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getServerLevel() - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
 
getServerLevel() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
getServerPlugin(String) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
getServerUptime() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the number of milliseconds since the server was started.
getServerUptime() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getServerUptimeString() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the number of days, hours and minutes since the server was started, formatted as a string y:DDD:HH:mm.
getServerUptimeString() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getServerVersion() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the server version.
getServerVersion() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getShort(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getShort(String, short) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getShort() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a short.
getShort(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the short value of the named entry.
getShort(String, short) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getShortArray(String, short[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getShortArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of shorts.
getShortArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the short array value of the named entry.
getShortArray(String, short[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the short array value of the named entry, or the default value if any exception occurs.
getShortArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getShortValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getSize() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getSize() - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the number of values stored in the EsObject.
getStatus() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiResponse
Gets the status of the response.
getString(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getString(String, String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getString() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is a string.
getString(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the string value of the named entry.
getString(String, String) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
getStringArray(String, String[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
getStringArray() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectEntry
Gets the value of the entry, if it is an array of strings.
getStringArray(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the string array value of the named entry.
getStringArray(String, String[]) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Gets the string array value of the named entry, or the default value if any exception occurs.
getStringArrayValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getStringValue() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
getToUserNames() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPrivateMessageContext
Gets the names of users that will hear the message.
getType() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
getUser(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to return details on the specified user.
getUser(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUser() - Method in class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
 
getUserByUserName(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserClientType(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets a String representing the type of client a given user has, such as 'ActionScript3', 'CSharpUnity', etc.
getUserClientType(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserClientVersion(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Gets the version of the client api that a given user's client used, such as '5.3.2'.
getUserClientVersion(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserCount() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the number of users currently logged in.
getUserCount() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserCountByGameType(String, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the number of users playing a certain game (specified by the gameType).
getUserCountByGameType(String, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserCountByZoneId(int, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the number of users in a given zone.
getUserCountByZoneId(int, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserCountByZoneName(String, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the number of users in a given zone.
getUserCountByZoneName(String, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserEsObject(String) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Looks up the EsObject for a given userName.
getUserEsObject(String) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getUserFromName(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserIdFromName(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserIdleDisconnectTimeSeconds() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns the value of the Client Idle Disconnect Time from the ES Admin.
getUserIdleDisconnectTimeSeconds() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserIdleWarningTimeMS(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns the value of the Client Idle Warning Time for the specified user, in milliseconds.
getUserIdleWarningTimeMS(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserIdsFromNameList(Collection<String>) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserJoinedGames(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns a Collection of games that the specified user is currently joined to.
getUserJoinedGames(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserJoinedRooms(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns a Collection of rooms that the specified user is currently joined to.
getUserJoinedRooms(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Gets the name of the user.
getUserName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserEnterContext
Gets the name of the user who just entered the room.
getUserName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPrivateMessageContext
Gets the name of the user who sent the message
getUserName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Gets the name of the user who broadcast the message.
getUserName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserTrackingContext
 
getUserName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserValue
Gets the name of the user
getUserName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
 
getUserName() - Method in class com.electrotank.electroserver5.extensions.LoginContext
Gets the username from the login attempt.
getUserPluginVariable(String, Object) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Looks up the plug-in variable for a given user.
getUserPluginVariable(String, Object) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getUsers() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Gets a Collection of user names.
getUsers() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getUserServerVariable(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns a user server variable.
getUserServerVariable(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserServerVariable(String) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getUserServerVariables(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns all the user server variables for a given user.
getUserServerVariables(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserServerVariables() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getUsersFromNameList(Collection<String>) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUsersInRoom(int, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns all the users in a given room.
getUsersInRoom(int, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserTrackingEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getUserVariable(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns a specific user variable.
getUserVariable(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserVariable(String) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getUserVariableEventHandlerConfigurations() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
getUserVariables(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns all the user variables for a given user.
getUserVariables(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getUserVariables() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
getValue() - Method in class com.electrotank.electroserver5.extensions.api.ExtensionBoundUserServerVariableResponse
Returns the value of the extension bound user server variable
getValue() - Method in class com.electrotank.electroserver5.extensions.api.UserServerVariableResponse
Gets the user server variable, as an EsObject.
getValue() - Method in class com.electrotank.electroserver5.extensions.api.value.Number
Gets the value of the Number object.
getValue() - Method in interface com.electrotank.electroserver5.extensions.api.value.ReadOnlyRoomVariable
Gets the value of the room variable, as an EsObject.
getValue() - Method in interface com.electrotank.electroserver5.extensions.api.value.ReadOnlyUserServerVariable
Gets the EsObject value of the user server variable.
getValue() - Method in interface com.electrotank.electroserver5.extensions.api.value.ReadOnlyUserVariable
Gets the EsObject value of the user variable.
getVariableName() - Method in class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
 
getVariables() - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Gets the variables for the plugin.
getVariables() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
 
getVariableValue() - Method in class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
 
getZoneCount() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the number of active zones.
getZoneCount() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.GameManagerResponse
Used to get the zoneId
getZoneId() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Gets the zoneId.
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.PluginPublicMessageResponse.ZoneRoomCombo
Gets the zoneId of the zone that failed to deliver the public message.
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.RoomResponse
Gets the zoneId for the room involved in the request.
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.RoomVariableResponse
Gets the zoneId of the zone holding the room.
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Gets the zoneId of the zone in which to this room resides.
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
 
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.value.UserTrackingContext
 
getZoneId() - Method in class com.electrotank.electroserver5.extensions.api.value.ZoneValue
Gets the unique zoneId for this zone.
getZoneName() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Gets the name of the zone.
getZoneName() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
getZoneName() - Method in class com.electrotank.electroserver5.extensions.api.value.ZoneConfiguration
Gets the unique name of the zone.
getZoneName() - Method in class com.electrotank.electroserver5.extensions.api.value.ZoneValue
Gets the name of the zone.
getZones() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Looks up and returns all the zones on the server.
getZones() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
grantOperatorStatus(String, int, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Grants room operator status to the given user for the specified room.
grantOperatorStatus(String, int, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 

H

HttpCallback - Interface in com.electrotank.electroserver5.extensions.api
Callback to be invoked once ElectroServerApi.callUrl completes either successfully or not.
httpCallback(HttpResults) - Method in interface com.electrotank.electroserver5.extensions.api.HttpCallback
 
HttpResults - Class in com.electrotank.electroserver5.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.electroserver5.extensions.api.value.HttpResults
Constructs a new instance of HttpResults.

I

init(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.BaseEvent
 
init(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.BaseManagedObjectFactory
 
init(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
init(EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.ExtensionLifeCycle
Automatically invoked when the object class is instantiated, after api is available.
interop(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
interop(EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.PluginInterop
Allows one plugin to send a message to another plugin, in a different extension.
isBuddy(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Determines whether the specified user is buddies with buddyName.
isBuddy(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
isBuddy(String) - Method in class com.electrotank.electroserver5.extensions.api.FindGamesWithBuddiesResponse
Indicates whether the specified username is a buddy and is online.
isEncrypted() - Method in class com.electrotank.electroserver5.extensions.RequestContext
 
isEncryptionEnabled() - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
 
isEncryptionEnabled() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
isFloodingFilterResetAfterKick() - Method in class com.electrotank.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Is a specified flooding filter for this room?
isGameHidden() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Is this game hidden?
isGameHidden() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
isGameLocked() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Is this game locked?
isGameLocked() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
isGameRoom() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Is the room for this plug-in a game?
isGameRoom() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
isHidden() - Method in class com.electrotank.electroserver5.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.
isKicked() - Method in class com.electrotank.electroserver5.extensions.api.value.UserTrackingContext
 
isKickOnFailure() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
isLanguageFilterDeliverMessageOnFailure() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
If a message fails the language filter, will it be delivered anyway?
isLanguageFilterResetAfterKick() - Method in class com.electrotank.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Is there a specified language filter for this room?
isLocked() - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Is a user who is not an operator allowed to update the room?
isNonOperatorVariableUpdateAllowed() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Is a user who is not an operator allowed to update room variables?
isOldVariableExists() - Method in class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
 
isPersistent() - Method in interface com.electrotank.electroserver5.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.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.UserConfig
Is the user receiving room attribute updates?
isReceivingRoomListUpdates() - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Does this game receive room list updates?
isReceivingRoomListUpdates() - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Is the user receiving room list updates?
isReceivingRoomVariableUpdates() - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Does this game receive room variable updates?
isReceivingRoomVariableUpdates() - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Is the user receiving room variable updates?
isReceivingUserListUpdates() - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Does this game receive user list updates?
isReceivingUserListUpdates() - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Is the user receiving user list updates?
isReceivingUserVariableUpdates() - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Does this game receive user variable updates?
isReceivingUserVariableUpdates() - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Is the user receiving user variable updates?
isReceivingVideoEvents() - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Does this game receive video events?
isReceivingVideoEvents() - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Is the user receiving video events?
isRoomLevel() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
True if the plug-in is a room-level plug-in
isRoomLevel() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
isRoomOperator(String, int, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns true if the given user has room operator status for the specified room.
isRoomOperator(String, int, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
isServerLevel() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
True if the plug-in is a server-level plug-in.
isServerLevel() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
isServerLevel() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
isStringValid() - Method in class com.electrotank.electroserver5.extensions.api.LanguageFilterResponse
Used to get the stringValid field of the object.
isSuccess() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiResponse
Returns true if the response is successful.
isSuccessful() - Method in class com.electrotank.electroserver5.extensions.api.GameManagerResponse
Used to get the isSuccessful field of the object.
isSuccessful() - Method in class com.electrotank.electroserver5.extensions.api.LanguageFilterResponse
Used to get the isSuccessful field of the object.
isSuppressBuddyEvents() - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
isSuppressBuddyEventsForUser(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Returns a boolean indicating whether this user's buddy events are suppressed.
isSuppressBuddyEventsForUser(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
isUserLoggedIn(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Determines if a user is currently logged in or not.
isUserLoggedIn(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
isUsingFloodingFilter() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Does this room use a flooding filter?
isUsingLanguageFilter() - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Does this room use a language filter?
iterator() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Creates an iterator over all the entries in the EsObject.

J

joinUserToGame(int, String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Joins a single user to an existing game, given the gameId and the password.
joinUserToGame(int, String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 

K

kickAllUsers() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Kicks all connected users off the server.
kickAllUsers() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
kickUserFromRoom(String, int, int, String) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
kickUserFromServer(String, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to kick a user from the server directly.
kickUserFromServer(String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 

L

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

M

ManagedObjectFactory - Interface in com.electrotank.electroserver5.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.electroserver5.extensions.api
The api for a managed object factory.
ManagedObjectFactoryApiImpl - Class in com.electrotank.electroserver5.extensions.api
 
ManagedObjectFactoryApiImpl(BaseBridge, GatewaySender, RoomManager, People, ScheduledExecutorService, LanguageFilterManager, EsFileSystem, GameManager, BuddyListManager, UserEventManager, ExtensionManager) - Constructor for class com.electrotank.electroserver5.extensions.api.ManagedObjectFactoryApiImpl
 
ManagedObjectFactoryFactory - Class in com.electrotank.electroserver5.extensions
 
ManagedObjectFactoryFactory(ApiFactory, ScheduledExecutorService) - Constructor for class com.electrotank.electroserver5.extensions.ManagedObjectFactoryFactory
 
ManagedObjectFactoryLifeCycle - Interface in com.electrotank.electroserver5.extensions
 
MessageQueue - Class in com.electrotank.electroserver5.extensions.api.value
 
MessageQueue() - Constructor for class com.electrotank.electroserver5.extensions.api.value.MessageQueue
Creates a new instance of MessageQueue

N

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

P

pauseQueue() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Pauses the queue of messages.
pauseQueue() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
Plugin - Interface in com.electrotank.electroserver5.extensions
A plug-in is the most generic and flexible way to add functionality to ElectroServer.
PluginApi - Interface in com.electrotank.electroserver5.extensions.api
The api for a plug-in.
PluginApiImpl - Class in com.electrotank.electroserver5.extensions.api
Implementation of the api for a plug-in.
PluginApiImpl(PluginBridge, GatewaySender, GameManager, RoomManager, People, ScheduledExecutorService, LanguageFilterManager, EsFileSystemApi, BuddyListManager, UserEventManager, ExtensionManager) - Constructor for class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
PluginApiResponse - Class in com.electrotank.electroserver5.extensions.api
Represents a response from the server in regards to a (generic) plugin request.
PluginApiResponse() - Constructor for class com.electrotank.electroserver5.extensions.api.PluginApiResponse
This constructor will be invoked by the server automatically.
PluginApiResponse.Status - Enum in com.electrotank.electroserver5.extensions.api
Enumeration of status states of a PluginApiResponse.
PluginFactory - Class in com.electrotank.electroserver5.extensions
 
PluginFactory(ApiFactory, GatewaySender, ScheduledExecutorService) - Constructor for class com.electrotank.electroserver5.extensions.PluginFactory
 
PluginInterop - Interface in com.electrotank.electroserver5.extensions
 
PluginLifeCycle - Interface in com.electrotank.electroserver5.extensions
Interface for automatic initialization of extensions and plugins.
PluginPrivateMessageResponse - Class in com.electrotank.electroserver5.extensions.api
This class represents a response from the server in regards to a plugin message delivery request.
PluginPrivateMessageResponse() - Constructor for class com.electrotank.electroserver5.extensions.api.PluginPrivateMessageResponse
This constructor will be invoked by the server automatically.
PluginPublicMessageResponse - Class in com.electrotank.electroserver5.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.electroserver5.extensions.api.PluginPublicMessageResponse
This constructor will be invoked by the server automatically.
PluginPublicMessageResponse.ZoneRoomCombo - Class in com.electrotank.electroserver5.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.electroserver5.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.electroserver5.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.electroserver5.extensions
Provides an interface for communication from clients to a plugin.
PrivateMessageEventFactory - Class in com.electrotank.electroserver5.extensions
 
PrivateMessageEventFactory(ScheduledExecutorService, ApiFactory) - Constructor for class com.electrotank.electroserver5.extensions.PrivateMessageEventFactory
Creates a new instance of PrivateMessageEventFactory
PrivateMessageEventHandler - Interface in com.electrotank.electroserver5.extensions
 
PublicMessageEventFactory - Class in com.electrotank.electroserver5.extensions
 
PublicMessageEventFactory(ScheduledExecutorService, ApiFactory) - Constructor for class com.electrotank.electroserver5.extensions.PublicMessageEventFactory
Creates a new instance of PrivateMessageEventFactory
PublicMessageEventHandler - Interface in com.electrotank.electroserver5.extensions
 
putExtensionBoundServerVariable(Object, Object) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Add or update the ExtensionBoundServerVariable of this name.
putExtensionBoundServerVariable(Object, Object) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 

Q

quickJoinGameForUser(String, String, String, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to do a quick join game for the identified user.
quickJoinGameForUser(String, String, String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
quickJoinGameWithBuddyForUser(String, String, String, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Used to do a quick join game for the identified user, with preference given to a game that has a buddy in it.
quickJoinGameWithBuddyForUser(String, String, String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 

R

ReadOnlyRoomVariable - Interface in com.electrotank.electroserver5.extensions.api.value
Room Variables are name/value pairs stored on the server and scoped to a room.
ReadOnlyUserServerVariable - Interface in com.electrotank.electroserver5.extensions.api.value
A User Server Variable is a name/value pair stored on the server and scoped to a user.
ReadOnlyUserVariable - Interface in com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.ElectroServerApiImpl
 
releaseManagedObject(String, Object) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Releases a managed object back to the specified factory.
releaseManagedObject(String, Object) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
releaseObject(Object) - Method in class com.electrotank.electroserver5.extensions.BaseManagedObjectFactory
 
releaseObject(Object) - Method in interface com.electrotank.electroserver5.extensions.ManagedObjectFactory
 
removeAll() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Removes all variables from the EsObject, leaving it empty.
removeBuddy(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Removes a buddy from the specified user's buddy list.
removeBuddy(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
removeKeywords(String, String, Collection<String>) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.PluginApi
Removes the specified plug-in variable for this user.
removeUserPluginVariable(String, Object) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
removeVariable(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Removes the named variable from the EsObject.
request(String, EsObjectRO, RequestContext) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
request(String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
Included for backward compatibility and for convenience when plugins do not care what the request context is.
request(String, EsObjectRO, RequestContext) - Method in interface com.electrotank.electroserver5.extensions.PluginRequest
Handles a request from a specific user.
RequestContext - Class in com.electrotank.electroserver5.extensions
Contains information about a request from a client to a plugin.
RequestContext() - Constructor for class com.electrotank.electroserver5.extensions.RequestContext
 
RequestContext(Message.Reliability, boolean) - Constructor for class com.electrotank.electroserver5.extensions.RequestContext
 
RequestContext(AbstractMessage) - Constructor for class com.electrotank.electroserver5.extensions.RequestContext
 
restartServer() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Restarts the ES5 server, as if the restart button on the ES Admin were clicked.
restartServer() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
resumeIdleKickingForUser(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Enables kicking for idleness for the specified user.
resumeIdleKickingForUser(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
resumeQueue() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Resumes the queue of messages.
resumeQueue() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
revokeOperatorStatus(String, int, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Revokes room operator status to the given user for the specified room.
revokeOperatorStatus(String, int, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
RoomConfiguration - Class in com.electrotank.electroserver5.extensions.api.value
Object class that holds the configuration of a single room.
RoomConfiguration(PersistentRoom) - Constructor for class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
 
RoomConfiguration() - Constructor for class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Constructs a new instance of RoomConfiguration.
roomCreated(RoomValue) - Method in class com.electrotank.electroserver5.extensions.BaseRoomTrackingEventHandler
 
roomCreated(RoomValue) - Method in interface com.electrotank.electroserver5.extensions.RoomTrackingEventHandler
Triggered when a room is created.
roomDestroyed(RoomValue) - Method in class com.electrotank.electroserver5.extensions.BaseRoomTrackingEventHandler
 
roomDestroyed(RoomValue) - Method in interface com.electrotank.electroserver5.extensions.RoomTrackingEventHandler
Triggered when a room is destroyed.
RoomResponse - Class in com.electrotank.electroserver5.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.electroserver5.extensions.api.RoomResponse
Constructs a new RoomResponse object.
RoomTrackingEventFactory - Class in com.electrotank.electroserver5.extensions
 
RoomTrackingEventFactory(ScheduledExecutorService, ApiFactory) - Constructor for class com.electrotank.electroserver5.extensions.RoomTrackingEventFactory
Creates a new instance of RoomTrackingEventFactory
RoomTrackingEventHandler - Interface in com.electrotank.electroserver5.extensions
Custom event handler for tracking rooms being created or destroyed.
RoomUserEvents - Interface in com.electrotank.electroserver5.extensions
Interface for a custom event handler for room user events.
RoomValue - Class in com.electrotank.electroserver5.extensions.api.value
Object to store information about a particular room.
RoomValue() - Constructor for class com.electrotank.electroserver5.extensions.api.value.RoomValue
 
roomVariableCreated(String, ReadOnlyRoomVariable) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
roomVariableCreated(String, ReadOnlyRoomVariable) - Method in interface com.electrotank.electroserver5.extensions.RoomVariableEvents
 
roomVariableDeleted(String, ReadOnlyRoomVariable) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
roomVariableDeleted(String, ReadOnlyRoomVariable) - Method in interface com.electrotank.electroserver5.extensions.RoomVariableEvents
 
RoomVariableEvents - Interface in com.electrotank.electroserver5.extensions
 
RoomVariableResponse - Class in com.electrotank.electroserver5.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.electroserver5.extensions.api.RoomVariableResponse
 
roomVariableUpdated(String, ReadOnlyRoomVariable, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
roomVariableUpdated(String, ReadOnlyRoomVariable, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.RoomVariableEvents
 

S

ScheduledCallback - Interface in com.electrotank.electroserver5.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.electroserver5.extensions.api.ScheduledCallback
Method to be invoked by the server at the scheduled time.
scheduleExecution(int, int, ScheduledCallback) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Schedules execution of the callback's method at the defined interval.
scheduleExecution(int, int, ScheduledCallback) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
scheduleExecutionFromScript(int, int, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Schedules execution of the callback's method at the defined interval.
scheduleExecutionFromScript(int, int, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendCreateOrJoinGameResponse(String, GameManagerResponse) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a CreateOrJoinGameResponse to the specified user, based on the GameManagerResponse.
sendCreateOrJoinGameResponse(String, GameManagerResponse) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendGlobalPluginMessage(EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to every connected user, whether in a room or not.
sendGlobalPluginMessage(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendGlobalPrivateMessage(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a private message to every connected user, whether in a room or not.
sendGlobalPrivateMessage(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToRoom(int, int, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to all users in a room.
sendPluginMessageToRoom(int, int, Message.Reliability, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
 
sendPluginMessageToRoom(int, int, Message.Reliability, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToRoom(int, int, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToRooms(Map<Integer, Collection<Integer>>, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to a group of rooms.
sendPluginMessageToRooms(Map<Integer, Collection<Integer>>, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToServer(EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to the entire server.
sendPluginMessageToServer(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToUser(String, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to a user.
sendPluginMessageToUser(String, Message.Reliability, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to a user.
sendPluginMessageToUser(String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToUser(String, Message.Reliability, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToUsers(Collection<String>, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to a group of users.
sendPluginMessageToUsers(String[], EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to a group of users.
sendPluginMessageToUsers(String[], EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToUsers(Collection<String>, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToZone(int, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to all users in a zone.
sendPluginMessageToZone(int, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToZones(Collection<Integer>, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to a group of zones.
sendPluginMessageToZones(int[], EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a plugin message to a group of zones.
sendPluginMessageToZones(int[], EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPluginMessageToZones(Collection<Integer>, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPrivateMessageToUserFromPlugin(String, String, String, EsObject, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a private chat message to the specified user, marked as coming from the specified userName.
sendPrivateMessageToUserFromPlugin(String, String, String, EsObject, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPrivateMessageToUsersFromPlugin(String, String[], String, EsObject, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a private chat message to the specified array of users, marked as coming from the specified userName.
sendPrivateMessageToUsersFromPlugin(String, String[], String, EsObject, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendPublicMessageToRoomFromPlugin(String, int, int, String, EsObject, boolean, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sends a public message to the specified room, marked as coming from the specified userName.
sendPublicMessageToRoomFromPlugin(String, int, int, String, EsObject, boolean, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
sendQueuedPluginMessageToRoom(EsObjectRO) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of each user in the room.
sendQueuedPluginMessageToRoom(EsObjectRO, Message.Reliability) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of each user in the room.
sendQueuedPluginMessageToRoom(String, EsObjectRO, Message.Reliability) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of each user in the room.
sendQueuedPluginMessageToRoom(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToRoom(String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToRoom(EsObjectRO, Message.Reliability) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToRoom(String, EsObjectRO, Message.Reliability) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUser(String, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of the specified user.
sendQueuedPluginMessageToUser(String, String, EsObjectRO) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of the specified user.
sendQueuedPluginMessageToUser(String, EsObjectRO, Message.Reliability) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of the specified user.
sendQueuedPluginMessageToUser(String, String, EsObjectRO, Message.Reliability) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of the specified user.
sendQueuedPluginMessageToUser(String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUser(String, String, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUser(String, EsObjectRO, Message.Reliability) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUser(String, String, EsObjectRO, Message.Reliability) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUsers(Collection<String>, EsObjectRO) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of each user in the Collection.
sendQueuedPluginMessageToUsers(Collection<String>, EsObjectRO, Message.Reliability) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Adds the given message to the message queue of each user in the Collection.
sendQueuedPluginMessageToUsers(String, Collection<String>, EsObjectRO, Message.Reliability) - Method in interface com.electrotank.electroserver5.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.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUsers(String, Collection<String>, EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUsers(Collection<String>, EsObjectRO, Message.Reliability) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
sendQueuedPluginMessageToUsers(String, Collection<String>, EsObjectRO, Message.Reliability) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
setApi(EventApi) - Method in class com.electrotank.electroserver5.extensions.BaseEvent
 
setApi(ManagedObjectFactoryApi) - Method in class com.electrotank.electroserver5.extensions.BaseManagedObjectFactory
 
setApi(PluginApi) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
setApi(EventApi) - Method in interface com.electrotank.electroserver5.extensions.EventHandler
Sets the api.
setApi(ManagedObjectFactoryApi) - Method in interface com.electrotank.electroserver5.extensions.ManagedObjectFactory
 
setApi(PluginApi) - Method in interface com.electrotank.electroserver5.extensions.Plugin
 
setAutoIdleKickingForUser(String, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
When set to true, this will automatically resume idle kicking for the specified user, as soon as the client sends a message to the server.
setAutoIdleKickingForUser(String, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
setBoolean(String, boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the boolean value.
setBooleanArray(String, boolean[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the boolean array value.
setBooleanArrayValue(boolean[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setBooleanValue(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setBuddyListEntries(Map<String, EsObject>) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
setBuddyListEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setByte(String, byte) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the byte value.
setByteArray(String, byte[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the byte array value.
setByteArrayValue(byte[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setByteValue(byte) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setCapacity(int) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets the capacity of the room.
setCapacity(int) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Sets the capacity of the room.
setChar(String, char) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the char value.
setCharArray(String, char[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the char array value.
setCharArrayValue(char[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setCharValue(char) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setCurrentExtension(String) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
setDataAsBytes(byte[]) - Method in class com.electrotank.electroserver5.extensions.api.value.HttpResults
Sets the data from the url to the given array of bytes.
setDataType(DataType) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setDescription(String) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets the description of the room.
setDescription(String) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Sets the optional text description of the room.
setDouble(String, double) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the double value.
setDoubleArray(String, double[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the double array value.
setDoubleArrayValue(double[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setDoubleValue(double) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setEncrypted() - Method in class com.electrotank.electroserver5.extensions.RequestContext
 
setEncryptionEnabled(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
 
setErrorText(String) - Method in class com.electrotank.electroserver5.extensions.api.value.HttpResults
Sets the error message.
setEsObject(String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the EsObject value.
setEsObject(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Sets the optional EsObject broadcast.
setEsObjectArray(String, EsObject[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the EsObject array value.
setEsObjectArrayValue(EsObject[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setEsObjectValue(EsObject) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setExtensionBoundUserServerVariable(String, String, Object) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sets an extension-bound user server variable on a given user.
setExtensionBoundUserServerVariable(String, String, Object) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
setExtensionLifecycleEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setExtensionName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Sets the name of the extension for the plugin.
setFloat(String, float) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the float value.
setFloatArray(String, float[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the float array value.
setFloatArrayValue(float[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setFloatValue(float) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setFloodingFilterBanDuration(int) - Method in class com.electrotank.electroserver5.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.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Sets the name of the flooding filter.
setFloodingFilterResetAfterKick(boolean) - Method in class com.electrotank.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Sets whether a flooding filter has been specified for this room.
setGameDetails(EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Sets the game details.
setGameDetails(EsObject) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
setGameHiddenState(boolean) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Sets the game state to hidden or not.
setGameHiddenState(boolean) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
setGameId(int) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Sets the gameId of the game associated with this room.
setGameLockState(boolean) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Sets the game state to locked or not.
setGameLockState(boolean) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
setHandle(String) - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Sets the handle for the plugin.
setHandle(String) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
setHidden(String) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets the room to hidden or not.
setHidden(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets the room to hidden or not.
setInitialGameDetails(EsObjectRO) - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Sets the initial game details.
setInitParameters(EsObject) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
setIntArrayValue(int[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setInteger(String, int) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the integer value.
setIntegerArray(String, int[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the int array value.
setIntValue(int) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setKickOnFailure(boolean) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
setLanguageFilterBanDuration(int) - Method in class com.electrotank.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Sets whether a message that fails the language filter will be delivered anyway.
setLanguageFilterFailuresBeforeKick(int) - Method in class com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Sets the name of the room's language filter.
setLanguageFilterResetAfterKick(boolean) - Method in class com.electrotank.electroserver5.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.electroserver5.extensions.api.value.RoomConfiguration
Sets whether there is a specified language filter for this room.
setLoginEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setLogoutEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setLong(String, long) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the long value.
setLongArray(String, long[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the long array value.
setLongArrayValue(long[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setLongValue(long) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setManagedObjectConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setMessage(String) - Method in class com.electrotank.electroserver5.extensions.api.value.UserPrivateMessageContext
Sets the message to send.
setMessage(String) - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Sets the message broadcast.
setName(String) - Method in class com.electrotank.electroserver5.extensions.api.RoomVariableResponse
Sets the name of the room variable.
setName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
Sets the name of the plugin.
setName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets the name of the room.
setName(String) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setNonOperatorUpdateAllowed(boolean) - Method in class com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the Number value.
setNumber(String, double) - Method in class com.electrotank.electroserver5.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.electroserver5.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.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the Number array value.
setNumberArrayValue(Number[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setNumberValue(Number) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setPassword(String) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets the password for the room.
setPassword(String) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
 
setPassword(String) - Method in class com.electrotank.electroserver5.extensions.LoginContext
Sets the password, in the LoginContext.
setPasswordHashId(int) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
setPath(String) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
setPermissionSetId(String, String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sets the permission set id for a given user.
setPermissionSetId(String, String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
setPermissionSetId(String) - Method in class com.electrotank.electroserver5.extensions.LoginContext
Sets the name of the permission set for this user.
setPersistent(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets the room to be persistent or not.
setPersistent(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Sets the room to be persistent or not.
setPluginConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setPrivateMessageEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setPublicMessageEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setRawValue(Object) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setReceivingRoomAttributeUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Sets whether a user is receiving room attribute updates
setReceivingRoomListUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Sets the game to receive room list updates, or not.
setReceivingRoomListUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Sets if the user is receiving room list updates.
setReceivingRoomVariableUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Sets the game to receive room variable updates.
setReceivingRoomVariableUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Sets if the user is receiving room variable updates.
setReceivingUserListUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Sets the game to receive user list updates.
setReceivingUserListUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Sets if the user is receiving user list updates.
setReceivingUserVariableUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Sets the game to receive user variable updates.
setReceivingUserVariableUpdates(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Sets if the user is receiving user variable updates.
setReceivingVideoEvents(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Sets the game to receive video events.
setReceivingVideoEvents(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Sets whether the user is receiving video events.
setRemoteAddress(InetAddress) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
setResponseParameters(EsObject) - Method in class com.electrotank.electroserver5.extensions.api.RoomResponse
Sets the responseParameters.
setResponseParameters(EsObject) - Method in class com.electrotank.electroserver5.extensions.api.value.UserEnterContext
Sets the responseParameters for the room entry.
setResponseParameters(EsObject) - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Sets the response parameters for the broadcast message.
setResponseParameters(EsObject) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
setRoomConfiguration(RoomConfiguration) - Method in class com.electrotank.electroserver5.extensions.api.value.GameConfiguration
Sets the room configuration for the game.
setRoomId(int) - Method in class com.electrotank.electroserver5.extensions.api.RoomResponse
Sets the roomId.
setRoomId(int) - Method in class com.electrotank.electroserver5.extensions.api.RoomVariableResponse
Sets the roomId of the room holding the variable.
setRoomId(int) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Sets the roomId of the room.
setRoomId(int) - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
 
setRoomMemberCount(int) - Method in class com.electrotank.electroserver5.extensions.api.RoomResponse
Sets the number of clients in the room
setRoomName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Sets the name of the room.
setRoomTrackingEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setServerLevel(int) - Method in class com.electrotank.electroserver5.extensions.api.value.ExtensionComponentConfiguration
 
setServerLevel(int) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
setShort(String, short) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the short value.
setShortArray(String, short[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the short array value.
setShortArrayValue(short[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setShortValue(short) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setStatus(PluginApiResponse.Status) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiResponse
Set the status of the response to one of the allowed enumerated states.
setString(String, String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the string value.
setStringArray(String, String[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Sets the named entry of the EsObject to the string array value.
setStringArrayValue(String[]) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setStringValue(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObjectDataHolder
 
setSuccessful(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.HttpResults
Sets a flag indicating whether the call to a url was successful.
setSuppressBuddyEvents(boolean) - Method in class com.electrotank.electroserver5.extensions.LoginContext
 
setSuppressBuddyEventsForUser(String, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sets suppression of buddy events for the given user.
setSuppressBuddyEventsForUser(String, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
setSynchronization(boolean) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
setType(PluginType) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
setUnReliable() - Method in class com.electrotank.electroserver5.extensions.RequestContext
 
setUserIdleWarningTimeMS(String, int) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sets the value of the Client Idle Warning Time for the specified user, in milliseconds.
setUserIdleWarningTimeMS(String, int) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
setUserName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.UserConfig
Sets the name of the user.
setUserName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Sets the name of the user who broadcast the message.
setUserName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.UserValue
Sets the name of the user.
setUserName(String) - Method in class com.electrotank.electroserver5.extensions.LoginContext
Sets the username for the login attempt.
setUserPluginVariable(String, Object, Object) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Sets the specified plug-in variable for a given user.
setUserPluginVariable(String, Object, Object) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
setUserServerVariable(String, String, EsObject) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Sets a user server variable on a given user.
setUserServerVariable(String, String, EsObject) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
setUserTrackingEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setUserVariableEventHandlerConfigurations(List<ExtensionClassConfiguration>) - Method in class com.electrotank.electroserver5.extensions.config.ExtensionConfiguration
 
setUsingFloodingFilter(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets whether this room uses a flooding filter.
setUsingLanguageFilter(boolean) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomConfiguration
Sets whether this room uses a language filter.
setValue(Object) - Method in class com.electrotank.electroserver5.extensions.api.ExtensionBoundUserServerVariableResponse
Sets the value of the extension bound user server variable
setValue(EsObject) - Method in class com.electrotank.electroserver5.extensions.api.UserServerVariableResponse
Sets the value of the user server variable.
setValue(double) - Method in class com.electrotank.electroserver5.extensions.api.value.Number
Sets the value of the Number object.
setVariableValue(EsObject) - Method in class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
 
setZoneId(int) - Method in class com.electrotank.electroserver5.extensions.api.RoomResponse
Sets the zoneId of the room involved in the request.
setZoneId(int) - Method in class com.electrotank.electroserver5.extensions.api.RoomVariableResponse
Sets the zoneId of the zone holding the room.
setZoneId(int) - Method in class com.electrotank.electroserver5.extensions.api.value.RoomValue
Sets the zoneId of the zone in which this room resides.
setZoneId(int) - Method in class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
 
setZoneId(int) - Method in class com.electrotank.electroserver5.extensions.api.value.ZoneValue
Sets the zoneId for this room.
setZoneName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.ZoneConfiguration
Sets the name of the zone.
setZoneName(String) - Method in class com.electrotank.electroserver5.extensions.api.value.ZoneValue
Sets the name of the zone.
shallowClone() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Creates a shallow clone EsObject.
shutdownServer() - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Shuts down the ES5 server, as if the shutdown button on the ES Admin were clicked.
shutdownServer() - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
startQueue(long) - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Starts the queue of messages.
startQueue(long) - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
stopQueue() - Method in interface com.electrotank.electroserver5.extensions.api.PluginApi
Stops the queue of messages.
stopQueue() - Method in class com.electrotank.electroserver5.extensions.api.PluginApiImpl
 
suspendIdleKickingForUser(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Disables kicking for idleness for the specified user.
suspendIdleKickingForUser(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 

T

toString() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
toString(String) - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
 
toXML() - Method in class com.electrotank.electroserver5.extensions.api.value.EsObject
Generates a properly formed XML version of this EsObject, that could be used in Extension.xml or ES Admin screen that needs XML.

U

unregisterGameConfiguration(String, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Removes a GameConfiguration from the GameManager, so that users can no longer create games of this gameType.
unregisterGameConfiguration(String, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
updateRoomVariable(int, int, String, boolean, EsObject, boolean, boolean) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Updates the specified room variable.
updateRoomVariable(int, int, String, boolean, EsObject, boolean, boolean) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
userAddBuddy(User, String, EsObject) - Method in class com.electrotank.electroserver5.extensions.BaseBuddyListEventHandler
 
userAddBuddy(User, String, EsObject) - Method in interface com.electrotank.electroserver5.extensions.BuddyListEventHandler
 
userBanned(String, String, int) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
userBanned(String, String, int) - Method in interface com.electrotank.electroserver5.extensions.RoomUserEvents
Actions triggered when a user is banned.
UserConfig - Class in com.electrotank.electroserver5.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.electroserver5.extensions.api.value.UserConfig
 
userDidEnter(String) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
userDidEnter(String) - Method in interface com.electrotank.electroserver5.extensions.RoomUserEvents
Actions triggered after a user enters the room.
userDidJoinRoom(UserTrackingContext) - Method in class com.electrotank.electroserver5.extensions.BaseUserTrackingEventHandler
 
userDidJoinRoom(UserTrackingContext) - Method in interface com.electrotank.electroserver5.extensions.UserTrackingEventHandler
Custom event handler that is triggered when a user joins a room or game.
userDidLeaveRoom(UserTrackingContext) - Method in class com.electrotank.electroserver5.extensions.BaseUserTrackingEventHandler
 
userDidLeaveRoom(UserTrackingContext) - Method in interface com.electrotank.electroserver5.extensions.UserTrackingEventHandler
Custom event handler that is triggered when a user leaves a room or game.
userDidLogin(String) - Method in class com.electrotank.electroserver5.extensions.BaseLoginEventHandler
 
userDidLogin(String) - Method in interface com.electrotank.electroserver5.extensions.LoginEventHandler
Custom event handler that is triggered after a user logs in successfully.
userEnter(UserEnterContext) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
userEnter(UserEnterContext) - Method in interface com.electrotank.electroserver5.extensions.RoomUserEvents
Actions triggered when a user enters the room.
UserEnterContext - Class in com.electrotank.electroserver5.extensions.api.value
Contains the context for a userEnter event.
UserEnterContext(String) - Constructor for class com.electrotank.electroserver5.extensions.api.value.UserEnterContext
Creates a new instance of UserEnterContext for a given userName
userExit(String) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
userExit(String) - Method in interface com.electrotank.electroserver5.extensions.RoomUserEvents
Actions triggered when a user exits the room normally.
userIdForName(String) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the internal user ID for the specified user name
userIdForName(String) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
userKicked(String, String) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
userKicked(String, String) - Method in interface com.electrotank.electroserver5.extensions.RoomUserEvents
Actions triggered when a user is kicked from a room.
userNameForId(long) - Method in interface com.electrotank.electroserver5.extensions.api.ElectroServerApi
Get the user name for the specified user ID
userNameForId(long) - Method in class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl
 
UserPrivateMessageContext - Class in com.electrotank.electroserver5.extensions.api.value
Contains the context for a UserPrivateMessage event.
UserPrivateMessageContext(String, String, EsObjectRO, String[]) - Constructor for class com.electrotank.electroserver5.extensions.api.value.UserPrivateMessageContext
Creates a new instance of UserPrivateMessageContext
UserPublicMessageContext - Class in com.electrotank.electroserver5.extensions.api.value
Contains the context for a userPublicMessage event.
UserPublicMessageContext(String, String, EsObjectRO, int, int) - Constructor for class com.electrotank.electroserver5.extensions.api.value.UserPublicMessageContext
Creates a new instance of UserPublicMessageContext
userRemoveBuddy(User, String) - Method in class com.electrotank.electroserver5.extensions.BaseBuddyListEventHandler
 
userRemoveBuddy(User, String) - Method in interface com.electrotank.electroserver5.extensions.BuddyListEventHandler
 
userSendPrivateMessage(UserPrivateMessageContext) - Method in class com.electrotank.electroserver5.extensions.BasePrivateMessageEventHandler
 
userSendPrivateMessage(UserPrivateMessageContext) - Method in interface com.electrotank.electroserver5.extensions.PrivateMessageEventHandler
 
userSendPublicMessage(UserPublicMessageContext) - Method in class com.electrotank.electroserver5.extensions.BasePlugin
 
userSendPublicMessage(UserPublicMessageContext) - Method in class com.electrotank.electroserver5.extensions.BasePublicMessageEventHandler
 
userSendPublicMessage(UserPublicMessageContext) - Method in interface com.electrotank.electroserver5.extensions.PublicMessageEventHandler
 
userSendPublicMessage(UserPublicMessageContext) - Method in interface com.electrotank.electroserver5.extensions.RoomUserEvents
Actions triggered when a user sends a public message.
UserServerVariableResponse - Class in com.electrotank.electroserver5.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.electroserver5.extensions.api.UserServerVariableResponse
 
UserTrackingContext - Class in com.electrotank.electroserver5.extensions.api.value
Contains the context for a UserTracking event.
UserTrackingContext(String, int, int, int, String) - Constructor for class com.electrotank.electroserver5.extensions.api.value.UserTrackingContext
Creates a new instance of UserTrackingContext.
UserTrackingContext(String, int, int, int, String, boolean) - Constructor for class com.electrotank.electroserver5.extensions.api.value.UserTrackingContext
Creates a new instance of UserTrackingContext when a user is kicked from a room.
UserTrackingEventFactory - Class in com.electrotank.electroserver5.extensions
 
UserTrackingEventFactory(ScheduledExecutorService, ApiFactory) - Constructor for class com.electrotank.electroserver5.extensions.UserTrackingEventFactory
Creates a new instance of UserTrackingEventFactory
UserTrackingEventHandler - Interface in com.electrotank.electroserver5.extensions
Custom event handler for tracking users joining and leaving rooms.
UserValue - Class in com.electrotank.electroserver5.extensions.api.value
Contains the name of a user who is in a room.
UserValue() - Constructor for class com.electrotank.electroserver5.extensions.api.value.UserValue
 
userVariableCreated(UserVariableUpdateContext) - Method in class com.electrotank.electroserver5.extensions.BaseUserVariableEventHandler
 
userVariableCreated(UserVariableUpdateContext) - Method in interface com.electrotank.electroserver5.extensions.UserVariableEventHandler
 
userVariableDeleted(UserVariableUpdateContext) - Method in class com.electrotank.electroserver5.extensions.BaseUserVariableEventHandler
 
userVariableDeleted(UserVariableUpdateContext) - Method in interface com.electrotank.electroserver5.extensions.UserVariableEventHandler
 
UserVariableEventFactory - Class in com.electrotank.electroserver5.extensions
 
UserVariableEventFactory(ScheduledExecutorService, ApiFactory) - Constructor for class com.electrotank.electroserver5.extensions.UserVariableEventFactory
Creates a new instance of UserVariableEventFactory
UserVariableEventHandler - Interface in com.electrotank.electroserver5.extensions
 
UserVariableResponse - Class in com.electrotank.electroserver5.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.electroserver5.extensions.api.UserVariableResponse
 
UserVariableUpdateContext - Class in com.electrotank.electroserver5.extensions.api.value
Contains the context for a UserVariable (create, update, delete) event.
UserVariableUpdateContext(User, String, EsObject) - Constructor for class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
Creates a new instance of UserVariableUpdateContext, suitable for creating a new user variable.
UserVariableUpdateContext(User, String, EsObject, EsObjectRO) - Constructor for class com.electrotank.electroserver5.extensions.api.value.UserVariableUpdateContext
Creates a new instance of UserVariableUpdateContext, suitable for updating or deleting an existing user variable.
userVariableUpdated(UserVariableUpdateContext) - Method in class com.electrotank.electroserver5.extensions.BaseUserVariableEventHandler
 
userVariableUpdated(UserVariableUpdateContext) - Method in interface com.electrotank.electroserver5.extensions.UserVariableEventHandler
 
useSynchronization() - Method in class com.electrotank.electroserver5.extensions.config.ExtensionClassConfiguration
 
UTF8 - Static variable in class com.electrotank.electroserver5.extensions.api.value.HttpResults
 

V

valueOf(String) - Static method in enum com.electrotank.electroserver5.extensions.api.PluginApiResponse.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.electrotank.electroserver5.extensions.ChainAction
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.electrotank.electroserver5.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.electroserver5.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.electroserver5.extensions.api.value.EsObject
 
variableExists(String) - Method in interface com.electrotank.electroserver5.extensions.api.value.EsObjectRO
Returns true if an entry exists with the given name.

W

wasSuccessful() - Method in class com.electrotank.electroserver5.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.electroserver5.extensions.api.EsFileSystemApi
Writes an EsObjectRO object as a file.
write(String, String, EsObjectRO, CleanupStrategy, Date, Collection<String>) - Method in interface com.electrotank.electroserver5.extensions.api.EsFileSystemApi
Writes an EsObjectRO object as a file.
write(String, String, EsObjectRO, CleanupStrategy) - Method in interface com.electrotank.electroserver5.extensions.api.EsFileSystemApi
Writes an EsObjectRO object as a file.
write(String, String, EsObjectRO, CleanupStrategy, Collection<String>) - Method in interface com.electrotank.electroserver5.extensions.api.EsFileSystemApi
Writes an EsObjectRO object as a file.

Z

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

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

Copyright © 2007-2010 Electrotank, Inc. All Rights Reserved.