PluginApiImpl (ElectroServer 4

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.electrotank.electroserver4.extensions.api
Class PluginApiImpl

java.lang.Object
  com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
      com.electrotank.electroserver4.extensions.api.PluginApiImpl

All Implemented Interfaces:: ElectroServerApi, PluginApi

public class PluginApiImpl
extends ElectroServerApiImpl
implements PluginApi
extends ElectroServerApiImpl
implements PluginApi

Implementation of the api for a plug-in.

A plug-in is the most generic and flexible way to add functionality to ElectroServer. Simply put, a plug-in is a piece of code that can be tied to the server itself or a room and can then be called via clients to directly ask it to perform an action. As a special case, room-level plug-ins have the ability to listen to many events that occur in a room such as room variable changes or public messages. These are the bread and butter of multi-player game development.

See Also:: PluginApi, Plugin, BasePlugin, ElectroServerApi

Method Summary
`EsObject`	`getGameDetails()` Gets the game details as an EsObject.
`int`	`getRoomId()` Gets the roomId.
`String`	`getRoomName()` Gets the name of the room.
`EsObject`	`getUserEsObject(String userName)` Looks up the EsObject for a given userName.
`Object`	`getUserPluginVariable(String userName, Object name)` Looks up the plug-in variable for a given user.
`Collection<String>`	`getUsers()` Gets a Collection of user names.
`int`	`getZoneId()` Gets the zoneId.
`String`	`getZoneName()` Gets the name of the zone.
`boolean`	`isGameHidden()` Is this game hidden?
`boolean`	`isGameLocked()` Is this game locked?
`boolean`	`isGameRoom()` Is the room for this plug-in a game?
`boolean`	`isRoomLevel()` True if the plug-in is a room-level plug-in
`boolean`	`isServerLevel()` True if the plug-in is a server-level plug-in.
`void`	`pauseQueue()` Pauses the queue of messages.
`Object`	`removeUserPluginVariable(String userName, Object name)` Removes the specified plug-in variable for this user.
`void`	`resumeQueue()` Resumes the queue of messages.
`void`	`sendQueuedPluginMessageToRoom(EsObjectRO variable)` Adds the given message to the message queue of each user in the room.
`void`	`sendQueuedPluginMessageToRoom(String messageName, EsObjectRO variable)` Adds the given message to the message queue of each user in the room.
`void`	`sendQueuedPluginMessageToUser(String userName, EsObjectRO variable)` Adds the given message to the message queue of the specified user.
`void`	`sendQueuedPluginMessageToUser(String name, String userName, EsObjectRO variable)` Adds the given message to the message queue of the specified user.
`void`	`sendQueuedPluginMessageToUsers(Collection<String> userNames, EsObjectRO variable)` Adds the given message to the message queue of each user in the Collection.
`void`	`sendQueuedPluginMessageToUsers(String messageName, Collection<String> userNames, EsObjectRO variable)` Adds the given message to the message queue of each user in the Collection.
`void`	`setGameDetails(EsObject gameDetails)` Sets the game details.
`void`	`setGameHiddenState(boolean newHiddenValue)` Sets the game state to hidden or not.
`void`	`setGameLockState(boolean newLockValue)` Sets the game state to locked or not.
`void`	`setUserPluginVariable(String userName, Object name, Object value)` Sets the specified plug-in variable for a given user.
`void`	`startQueue(long frequency)` Starts the queue of messages.
`void`	`stopQueue()` Stops the queue of messages.

Methods inherited from class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl
acquireManagedObject, addBuddy, addUsersToRoom, addUsersToRoom, applyLanguageFilterToString, banUserFromRoom, blockAndCallUrl, callRoomPlugin, callServerPlugin, callUrl, callUrlFromScript, cancelScheduledExecution, createGameForUsers, createGameForUsers, createOrUpdateUserVariable, createRoom, createRoom, createRoomInNamedZone, createRoomInNamedZone, createRoomVariable, createRoomVariableForUser, deleteExtensionBoundUserServerVariable, deleteRoomVariable, deleteUserServerVariable, deleteUserVariable, destroyRoom, getExtensionBoundUserServerVariable, getExtensionName, getFileSystemApi, getHandle, getLogger, getName, getRoomPlugin, getRoomsInZone, getRoomsInZoneByName, getRoomVariable, getRoomVariables, getServerPlugin, getUser, getUserByUserName, getUserFromName, getUserServerVariable, getUsersInRoom, getUserVariable, getUserVariables, getZones, isUserLoggedIn, kickUserFromRoom, kickUserFromServer, registerGameConfiguration, releaseManagedObject, removeBuddy, scheduleExecution, scheduleExecutionFromScript, sendPluginMessageToRoom, sendPluginMessageToRooms, sendPluginMessageToServer, sendPluginMessageToUser, sendPluginMessageToUsers, sendPluginMessageToUsers, sendPluginMessageToZone, sendPluginMessageToZones, sendPluginMessageToZones, setExtensionBoundUserServerVariable, setUserServerVariable, updateRoomVariable

Methods inherited from class com.electrotank.electroserver4.extensions.api.ElectroServerApiImpl

acquireManagedObject, addBuddy, addUsersToRoom, addUsersToRoom, applyLanguageFilterToString, banUserFromRoom, blockAndCallUrl, callRoomPlugin, callServerPlugin, callUrl, callUrlFromScript, cancelScheduledExecution, createGameForUsers, createGameForUsers, createOrUpdateUserVariable, createRoom, createRoom, createRoomInNamedZone, createRoomInNamedZone, createRoomVariable, createRoomVariableForUser, deleteExtensionBoundUserServerVariable, deleteRoomVariable, deleteUserServerVariable, deleteUserVariable, destroyRoom, getExtensionBoundUserServerVariable, getExtensionName, getFileSystemApi, getHandle, getLogger, getName, getRoomPlugin, getRoomsInZone, getRoomsInZoneByName, getRoomVariable, getRoomVariables, getServerPlugin, getUser, getUserByUserName, getUserFromName, getUserServerVariable, getUsersInRoom, getUserVariable, getUserVariables, getZones, isUserLoggedIn, kickUserFromRoom, kickUserFromServer, registerGameConfiguration, releaseManagedObject, removeBuddy, scheduleExecution, scheduleExecutionFromScript, sendPluginMessageToRoom, sendPluginMessageToRooms, sendPluginMessageToServer, sendPluginMessageToUser, sendPluginMessageToUsers, sendPluginMessageToUsers, sendPluginMessageToZone, sendPluginMessageToZones, sendPluginMessageToZones, setExtensionBoundUserServerVariable, setUserServerVariable, updateRoomVariable

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.electrotank.electroserver4.extensions.api.ElectroServerApi
acquireManagedObject, addBuddy, addUsersToRoom, addUsersToRoom, applyLanguageFilterToString, banUserFromRoom, blockAndCallUrl, callRoomPlugin, callServerPlugin, callUrl, callUrlFromScript, cancelScheduledExecution, createGameForUsers, createGameForUsers, createOrUpdateUserVariable, createRoom, createRoom, createRoomInNamedZone, createRoomInNamedZone, createRoomVariable, createRoomVariableForUser, deleteExtensionBoundUserServerVariable, deleteRoomVariable, deleteUserServerVariable, deleteUserVariable, destroyRoom, getExtensionBoundUserServerVariable, getExtensionName, getFileSystemApi, getHandle, getLogger, getName, getRoomPlugin, getRoomsInZone, getRoomsInZoneByName, getRoomVariable, getRoomVariables, getServerPlugin, getUser, getUserServerVariable, getUsersInRoom, getUserVariable, getUserVariables, getZones, isUserLoggedIn, kickUserFromRoom, kickUserFromServer, registerGameConfiguration, releaseManagedObject, removeBuddy, scheduleExecution, scheduleExecutionFromScript, sendPluginMessageToRoom, sendPluginMessageToRooms, sendPluginMessageToServer, sendPluginMessageToUser, sendPluginMessageToUsers, sendPluginMessageToUsers, sendPluginMessageToZone, sendPluginMessageToZones, sendPluginMessageToZones, setExtensionBoundUserServerVariable, setUserServerVariable, updateRoomVariable

Methods inherited from interface com.electrotank.electroserver4.extensions.api.ElectroServerApi

acquireManagedObject, addBuddy, addUsersToRoom, addUsersToRoom, applyLanguageFilterToString, banUserFromRoom, blockAndCallUrl, callRoomPlugin, callServerPlugin, callUrl, callUrlFromScript, cancelScheduledExecution, createGameForUsers, createGameForUsers, createOrUpdateUserVariable, createRoom, createRoom, createRoomInNamedZone, createRoomInNamedZone, createRoomVariable, createRoomVariableForUser, deleteExtensionBoundUserServerVariable, deleteRoomVariable, deleteUserServerVariable, deleteUserVariable, destroyRoom, getExtensionBoundUserServerVariable, getExtensionName, getFileSystemApi, getHandle, getLogger, getName, getRoomPlugin, getRoomsInZone, getRoomsInZoneByName, getRoomVariable, getRoomVariables, getServerPlugin, getUser, getUserServerVariable, getUsersInRoom, getUserVariable, getUserVariables, getZones, isUserLoggedIn, kickUserFromRoom, kickUserFromServer, registerGameConfiguration, releaseManagedObject, removeBuddy, scheduleExecution, scheduleExecutionFromScript, sendPluginMessageToRoom, sendPluginMessageToRooms, sendPluginMessageToServer, sendPluginMessageToUser, sendPluginMessageToUsers, sendPluginMessageToUsers, sendPluginMessageToZone, sendPluginMessageToZones, sendPluginMessageToZones, setExtensionBoundUserServerVariable, setUserServerVariable, updateRoomVariable

Method Detail