com.electrotank.electroserver5.extensions.api
Class PluginApiImpl

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

All Implemented Interfaces:

ElectroServerApi, PluginApi

public class PluginApiImpl
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

Field Summary

Fields inherited from class com.electrotank.electroserver5.extensions.api.ElectroServerApiImpl

extensionManager

Constructor Summary

PluginApiImpl(com.electrotank.electroserver5.entities.PluginBridge pluginBridge, com.electrotank.electroserver5.servers.registry.GatewaySender gateways, com.electrotank.electroserver5.entities.managers.GameManager gameManager, com.electrotank.electroserver5.entities.managers.RoomManager roomManager, com.electrotank.electroserver5.entities.People people, ScheduledExecutorService scheduledExecutorService, com.electrotank.electroserver5.entities.managers.LanguageFilterManager languageFilterManager, EsFileSystemApi fileSystem, com.electrotank.electroserver5.entities.managers.BuddyListManager buddyListManager, com.electrotank.electroserver5.entities.managers.UserEventManager eventManager, com.electrotank.electroserver5.entities.managers.ExtensionManager extensionManager)

Method Summary

EsObject	getGameDetails() Gets the game details as an EsObject.
int	getGameId() Gets the gameId of the room this plugin is attached to, if this is a game room.
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(EsObjectRO variable, com.electrotank.electroserver5.messages.Message.Reliability reliability) 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	sendQueuedPluginMessageToRoom(String messageName, EsObjectRO variable, com.electrotank.electroserver5.messages.Message.Reliability reliability) 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 userName, EsObjectRO variable, com.electrotank.electroserver5.messages.Message.Reliability reliability) 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	sendQueuedPluginMessageToUser(String name, String userName, EsObjectRO variable, com.electrotank.electroserver5.messages.Message.Reliability reliability) 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(Collection<String> userNames, EsObjectRO variable, com.electrotank.electroserver5.messages.Message.Reliability reliability) 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	sendQueuedPluginMessageToUsers(String messageName, Collection<String> userNames, EsObjectRO variable, com.electrotank.electroserver5.messages.Message.Reliability reliability) 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.electroserver5.extensions.api.ElectroServerApiImpl

acquireManagedObject, addBuddy, addUsersToRoom, addUsersToRoom, applyLanguageFilterToString, areLoginsEnabled, banUserFromRoom, blockAndCallUrl, callRoomPlugin, callServerPlugin, callUrl, callUrlFromScript, cancelScheduledExecution, carefullyCreateGameForUsers, createGameForUsers, createGameForUsers, createOrUpdateUserVariable, createRoom, createRoom, createRoomInNamedZone, createRoomInNamedZone, createRoomVariable, createRoomVariableForUser, deleteExtensionBoundUserServerVariable, deleteRoomVariable, deleteUserServerVariable, deleteUserVariable, destroyRoom, disableAllLogins, enableLogins, evictUserFromServer, findAllGamesWithBuddies, findGames, findGames, findGames, findOneGameWithBuddies, getAllConnectedUsers, getAllFloodingFilterNames, getAllLanguageFilterNames, getBuddies, getBuddiesOnline, getBuddyEsObject, getConnectedUsers, getExtensionBoundServerVariable, getExtensionBoundUserServerVariable, getExtensionName, getFileSystemApi, getGameCountByType, getGameTypesRegistered, getHandle, getIdleMillisecondsForUser, getIpForUser, getLogger, getLogoutReason, getLogoutType, getName, getPermissionSetId, getRoom, getRoomCount, getRoomOperators, getRoomPlugin, getRooms, getRooms, getRooms, getRoomsInZone, getRoomsInZoneByName, getRoomVariable, getRoomVariables, getServerPlugin, getServerUptime, getServerUptimeString, getServerVersion, getUser, getUserByUserName, getUserClientType, getUserClientVersion, getUserCount, getUserCountByGameType, getUserCountByZoneId, getUserCountByZoneName, getUserFromName, getUserIdFromName, getUserIdleDisconnectTimeSeconds, getUserIdleWarningTimeMS, getUserIdsFromNameList, getUserJoinedGames, getUserJoinedRooms, getUserServerVariable, getUserServerVariables, getUsersFromNameList, getUsersInRoom, getUserVariable, getUserVariables, getZoneCount, getZones, grantOperatorStatus, isBuddy, isRoomOperator, isSuppressBuddyEventsForUser, isUserLoggedIn, joinUserToGame, kickAllUsers, kickUserFromRoom, kickUserFromServer, liftRoomBanForUser, putExtensionBoundServerVariable, quickJoinGameForUser, quickJoinGameWithBuddyForUser, registerGameConfiguration, releaseManagedObject, removeBuddy, restartServer, resumeIdleKickingForUser, revokeOperatorStatus, scheduleExecution, scheduleExecutionFromScript, sendCreateOrJoinGameResponse, sendGlobalPluginMessage, sendGlobalPrivateMessage, sendPluginMessageToRoom, sendPluginMessageToRoom, sendPluginMessageToRooms, sendPluginMessageToServer, sendPluginMessageToUser, sendPluginMessageToUser, sendPluginMessageToUsers, sendPluginMessageToUsers, sendPluginMessageToZone, sendPluginMessageToZones, sendPluginMessageToZones, sendPrivateMessageToUserFromPlugin, sendPrivateMessageToUsersFromPlugin, sendPublicMessageToRoomFromPlugin, setAutoIdleKickingForUser, setExtensionBoundUserServerVariable, setPermissionSetId, setSuppressBuddyEventsForUser, setUserIdleWarningTimeMS, setUserServerVariable, shutdownServer, suspendIdleKickingForUser, unregisterGameConfiguration, updateRoomVariable, userIdForName, userNameForId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

acquireManagedObject, addBuddy, addUsersToRoom, addUsersToRoom, applyLanguageFilterToString, areLoginsEnabled, banUserFromRoom, blockAndCallUrl, callRoomPlugin, callServerPlugin, callUrl, callUrlFromScript, cancelScheduledExecution, carefullyCreateGameForUsers, createGameForUsers, createGameForUsers, createOrUpdateUserVariable, createRoom, createRoom, createRoomInNamedZone, createRoomInNamedZone, createRoomVariable, createRoomVariableForUser, deleteExtensionBoundUserServerVariable, deleteRoomVariable, deleteUserServerVariable, deleteUserVariable, destroyRoom, disableAllLogins, enableLogins, evictUserFromServer, findAllGamesWithBuddies, findGames, findGames, findOneGameWithBuddies, getAllConnectedUsers, getAllFloodingFilterNames, getAllLanguageFilterNames, getBuddies, getBuddiesOnline, getBuddyEsObject, getConnectedUsers, getExtensionBoundServerVariable, getExtensionBoundUserServerVariable, getExtensionName, getFileSystemApi, getGameCountByType, getGameTypesRegistered, getHandle, getIdleMillisecondsForUser, getIpForUser, getLogger, getLogoutReason, getLogoutType, getName, getPermissionSetId, getRoom, getRoomCount, getRoomOperators, getRoomPlugin, getRooms, getRooms, getRooms, getRoomsInZone, getRoomsInZoneByName, getRoomVariable, getRoomVariables, getServerPlugin, getServerUptime, getServerUptimeString, getServerVersion, getUser, getUserClientType, getUserClientVersion, getUserCount, getUserCountByGameType, getUserCountByZoneId, getUserCountByZoneName, getUserIdleDisconnectTimeSeconds, getUserIdleWarningTimeMS, getUserJoinedGames, getUserJoinedRooms, getUserServerVariable, getUserServerVariables, getUsersInRoom, getUserVariable, getUserVariables, getZoneCount, getZones, grantOperatorStatus, isBuddy, isRoomOperator, isSuppressBuddyEventsForUser, isUserLoggedIn, joinUserToGame, kickAllUsers, kickUserFromRoom, kickUserFromServer, liftRoomBanForUser, putExtensionBoundServerVariable, quickJoinGameForUser, quickJoinGameWithBuddyForUser, registerGameConfiguration, releaseManagedObject, removeBuddy, restartServer, resumeIdleKickingForUser, revokeOperatorStatus, scheduleExecution, scheduleExecutionFromScript, sendCreateOrJoinGameResponse, sendGlobalPluginMessage, sendGlobalPrivateMessage, sendPluginMessageToRoom, sendPluginMessageToRoom, sendPluginMessageToRooms, sendPluginMessageToServer, sendPluginMessageToUser, sendPluginMessageToUser, sendPluginMessageToUsers, sendPluginMessageToUsers, sendPluginMessageToZone, sendPluginMessageToZones, sendPluginMessageToZones, sendPrivateMessageToUserFromPlugin, sendPrivateMessageToUsersFromPlugin, sendPublicMessageToRoomFromPlugin, setAutoIdleKickingForUser, setExtensionBoundUserServerVariable, setPermissionSetId, setSuppressBuddyEventsForUser, setUserIdleWarningTimeMS, setUserServerVariable, shutdownServer, suspendIdleKickingForUser, unregisterGameConfiguration, updateRoomVariable, userIdForName, userNameForId

Constructor Detail

PluginApiImpl

public PluginApiImpl(com.electrotank.electroserver5.entities.PluginBridge pluginBridge,
                     com.electrotank.electroserver5.servers.registry.GatewaySender gateways,
                     com.electrotank.electroserver5.entities.managers.GameManager gameManager,
                     com.electrotank.electroserver5.entities.managers.RoomManager roomManager,
                     com.electrotank.electroserver5.entities.People people,
                     ScheduledExecutorService scheduledExecutorService,
                     com.electrotank.electroserver5.entities.managers.LanguageFilterManager languageFilterManager,
                     EsFileSystemApi fileSystem,
                     com.electrotank.electroserver5.entities.managers.BuddyListManager buddyListManager,
                     com.electrotank.electroserver5.entities.managers.UserEventManager eventManager,
                     com.electrotank.electroserver5.entities.managers.ExtensionManager extensionManager)

Parameters:

pluginBridge -

gateways -

gameManager -

roomManager -

people -

scheduledExecutorService -

languageFilterManager -

fileSystem -

buddyListManager -

eventManager -

Method Detail

isRoomLevel

public boolean isRoomLevel()

Description copied from interface: PluginApi

True if the plug-in is a room-level plug-in

Specified by:

isRoomLevel in interface PluginApi

Returns:

true if the plug-in is a room-level plug-in

isServerLevel

public boolean isServerLevel()

Description copied from interface: PluginApi

True if the plug-in is a server-level plug-in.

Specified by:

isServerLevel in interface PluginApi

Returns:

true if the plug-in is a server-level plug-in

getZoneId

public int getZoneId()

Description copied from interface: PluginApi

Gets the zoneId.

Specified by:

getZoneId in interface PluginApi

Returns:

zoneId

getRoomId

public int getRoomId()

Description copied from interface: PluginApi

Gets the roomId.

Specified by:

getRoomId in interface PluginApi

Returns:

roomId

getZoneName

public String getZoneName()

Description copied from interface: PluginApi

Gets the name of the zone.

Specified by:

getZoneName in interface PluginApi

Returns:

name of the zone

getRoomName

public String getRoomName()

Description copied from interface: PluginApi

Gets the name of the room.

Specified by:

getRoomName in interface PluginApi

Returns:

name of the room

getUserPluginVariable

public Object getUserPluginVariable(String userName,
                                    Object name)

Description copied from interface: PluginApi

Looks up the plug-in variable for a given user.

Specified by:

getUserPluginVariable in interface PluginApi

Parameters:

userName - name of the user

name - name of the plug-in variable

Returns:

plug-in variable

See Also:

setUserPluginVariable, removeUserPluginVariable

setUserPluginVariable

public void setUserPluginVariable(String userName,
                                  Object name,
                                  Object value)

Description copied from interface: PluginApi

Sets the specified plug-in variable for a given user.

Specified by:

setUserPluginVariable in interface PluginApi

Parameters:

userName - name of the user

name - name of the plug-in variable to set

value - new value of the plug-in variable

See Also:

getUserPluginVariable, removeUserPluginVariable

removeUserPluginVariable

public Object removeUserPluginVariable(String userName,
                                       Object name)

Description copied from interface: PluginApi

Removes the specified plug-in variable for this user.

Specified by:

removeUserPluginVariable in interface PluginApi

Parameters:

userName - name of the user

name - name of the variable to remove

Returns:

the value of the variable removed, if found

See Also:

getUserPluginVariable, setUserPluginVariable

getUserEsObject

public EsObject getUserEsObject(String userName)

Description copied from interface: PluginApi

Looks up the EsObject for a given userName.

Specified by:

getUserEsObject in interface PluginApi

Parameters:

userName - name of the user

Returns:

esObject

See Also:

EsObject

getUsers

public Collection<String> getUsers()

Description copied from interface: PluginApi

Gets a Collection of user names.

Specified by:

getUsers in interface PluginApi

Returns:

Collection of user names

sendQueuedPluginMessageToRoom

public void sendQueuedPluginMessageToRoom(EsObjectRO variable)

Description copied from interface: PluginApi

Adds the given message to the message queue of each user in the room.

Specified by:

sendQueuedPluginMessageToRoom in interface PluginApi

Parameters:

variable - unnamed message

See Also:

sendQueuedPluginMessageToUser, sendQueuedPluginMessageToUsers

sendQueuedPluginMessageToRoom

public void sendQueuedPluginMessageToRoom(String messageName,
                                          EsObjectRO variable)

Description copied from interface: PluginApi

Adds the given message to the message queue of each user in the room. A queue is used to aggregate messages, so that several can be sent at once. This is more efficient if there are a lot of messages to be sent in a very short period of time, but results in a delay of the first message.

Specified by:

sendQueuedPluginMessageToRoom in interface PluginApi

Parameters:

messageName - name of the message

variable - message

See Also:

sendQueuedPluginMessageToUser, sendQueuedPluginMessageToUsers

sendQueuedPluginMessageToUsers

public void sendQueuedPluginMessageToUsers(Collection<String> userNames,
                                           EsObjectRO variable)

Description copied from interface: PluginApi

Adds the given message to the message queue of each user in the Collection.

Specified by:

sendQueuedPluginMessageToUsers in interface PluginApi

Parameters:

userNames - Collection of names of users

variable - unnamed message

See Also:

sendQueuedPluginMessageToRoom, sendQueuedPluginMessageToUser

sendQueuedPluginMessageToUsers

public void sendQueuedPluginMessageToUsers(String messageName,
                                           Collection<String> userNames,
                                           EsObjectRO variable)

Description copied from interface: PluginApi

Adds the given message to the message queue of each user in the Collection.

Specified by:

sendQueuedPluginMessageToUsers in interface PluginApi

Parameters:

messageName - name of the message

userNames - Collection of names of users

variable - message

See Also:

sendQueuedPluginMessageToRoom, sendQueuedPluginMessageToUser

sendQueuedPluginMessageToUser

public void sendQueuedPluginMessageToUser(String userName,
                                          EsObjectRO variable)

Description copied from interface: PluginApi

Adds the given message to the message queue of the specified user.

Specified by:

sendQueuedPluginMessageToUser in interface PluginApi

Parameters:

userName - name of the user

variable - unnamed message

See Also:

sendQueuedPluginMessageToRoom, sendQueuedPluginMessageToUsers

sendQueuedPluginMessageToUser

public void sendQueuedPluginMessageToUser(String name,
                                          String userName,
                                          EsObjectRO variable)

Description copied from interface: PluginApi

Adds the given message to the message queue of the specified user.

Specified by:

sendQueuedPluginMessageToUser in interface PluginApi

Parameters:

name - name of the message

userName - name of the user

variable - message

See Also:

sendQueuedPluginMessageToRoom, sendQueuedPluginMessageToUsers

sendQueuedPluginMessageToRoom

public void sendQueuedPluginMessageToRoom(EsObjectRO variable,
                                          com.electrotank.electroserver5.messages.Message.Reliability reliability)

Description copied from interface: PluginApi

Adds the given message to the message queue of each user in the room.

Specified by:

sendQueuedPluginMessageToRoom in interface PluginApi

Parameters:

variable - unnamed message

reliability - message reliability

See Also:

sendQueuedPluginMessageToUser, sendQueuedPluginMessageToUsers

sendQueuedPluginMessageToRoom

public void sendQueuedPluginMessageToRoom(String messageName,
                                          EsObjectRO variable,
                                          com.electrotank.electroserver5.messages.Message.Reliability reliability)

Description copied from interface: PluginApi

Adds the given message to the message queue of each user in the room. A queue is used to aggregate messages, so that several can be sent at once. This is more efficient if there are a lot of messages to be sent in a very short period of time, but results in a delay of the first message.

Specified by:

sendQueuedPluginMessageToRoom in interface PluginApi

Parameters:

messageName - name of the message

variable - message

reliability - message reliability

See Also:

sendQueuedPluginMessageToUser, sendQueuedPluginMessageToUsers

sendQueuedPluginMessageToUsers

public void sendQueuedPluginMessageToUsers(Collection<String> userNames,
                                           EsObjectRO variable,
                                           com.electrotank.electroserver5.messages.Message.Reliability reliability)

Description copied from interface: PluginApi

Adds the given message to the message queue of each user in the Collection.

Specified by:

sendQueuedPluginMessageToUsers in interface PluginApi

Parameters:

userNames - Collection of names of users

variable - unnamed message

reliability - message reliability

See Also:

sendQueuedPluginMessageToRoom, sendQueuedPluginMessageToUser

sendQueuedPluginMessageToUsers

public void sendQueuedPluginMessageToUsers(String messageName,
                                           Collection<String> userNames,
                                           EsObjectRO variable,
                                           com.electrotank.electroserver5.messages.Message.Reliability reliability)

Description copied from interface: PluginApi

Adds the given message to the message queue of each user in the Collection.

Specified by:

sendQueuedPluginMessageToUsers in interface PluginApi

Parameters:

messageName - name of the message

userNames - Collection of names of users

variable - message

reliability - message reliability

See Also:

sendQueuedPluginMessageToRoom, sendQueuedPluginMessageToUser

sendQueuedPluginMessageToUser

public void sendQueuedPluginMessageToUser(String userName,
                                          EsObjectRO variable,
                                          com.electrotank.electroserver5.messages.Message.Reliability reliability)

Description copied from interface: PluginApi

Adds the given message to the message queue of the specified user.

Specified by:

sendQueuedPluginMessageToUser in interface PluginApi

Parameters:

userName - name of the user

variable - unnamed message

reliability - message reliability

See Also:

sendQueuedPluginMessageToRoom, sendQueuedPluginMessageToUsers

sendQueuedPluginMessageToUser

public void sendQueuedPluginMessageToUser(String name,
                                          String userName,
                                          EsObjectRO variable,
                                          com.electrotank.electroserver5.messages.Message.Reliability reliability)

Description copied from interface: PluginApi

Adds the given message to the message queue of the specified user.

Specified by:

sendQueuedPluginMessageToUser in interface PluginApi

Parameters:

name - name of the message

userName - name of the user

variable - message

reliability - message reliability

See Also:

sendQueuedPluginMessageToRoom, sendQueuedPluginMessageToUsers

startQueue

public void startQueue(long frequency)

Description copied from interface: PluginApi

Starts the queue of messages. A queue is used to aggregate messages, so that several can be sent at once. This is more efficient if there are a lot of messages to be sent in a very short period of time, but results in a delay of the first message.

Specified by:

startQueue in interface PluginApi

Parameters:

frequency - scheduling rate in milliseconds

See Also:

stopQueue, pauseQueue, resumeQueue

stopQueue

public void stopQueue()

Description copied from interface: PluginApi

Stops the queue of messages. Cancels scheduled (future) messages.

Specified by:

stopQueue in interface PluginApi

See Also:

startQueue, pauseQueue, resumeQueue

pauseQueue

public void pauseQueue()

Description copied from interface: PluginApi

Pauses the queue of messages.

Specified by:

pauseQueue in interface PluginApi

See Also:

startQueue, stopQueue, resumeQueue

resumeQueue

public void resumeQueue()

Description copied from interface: PluginApi

Resumes the queue of messages.

Specified by:

resumeQueue in interface PluginApi

See Also:

startQueue, stopQueue, pauseQueue

isGameRoom

public boolean isGameRoom()

Description copied from interface: PluginApi

Is the room for this plug-in a game?

Specified by:

isGameRoom in interface PluginApi

Returns:

true if this is a game

setGameLockState

public void setGameLockState(boolean newLockValue)

Description copied from interface: PluginApi

Sets the game state to locked or not.

Specified by:

setGameLockState in interface PluginApi

Parameters:

newLockValue - true if the game will now be locked.

See Also:

isGameLocked

isGameLocked

public boolean isGameLocked()

Description copied from interface: PluginApi

Is this game locked?

Specified by:

isGameLocked in interface PluginApi

Returns:

true if the game is locked.

See Also:

setGameLockState

setGameHiddenState

public void setGameHiddenState(boolean newHiddenValue)

Description copied from interface: PluginApi

Sets the game state to hidden or not.

Specified by:

setGameHiddenState in interface PluginApi

Parameters:

newHiddenValue - true if game will now be hidden.

See Also:

isGameHidden

isGameHidden

public boolean isGameHidden()

Description copied from interface: PluginApi

Is this game hidden?

Specified by:

isGameHidden in interface PluginApi

Returns:

true if the game is hidden.

See Also:

setGameHiddenState

getGameDetails

public EsObject getGameDetails()

Description copied from interface: PluginApi

Gets the game details as an EsObject.

Specified by:

getGameDetails in interface PluginApi

Returns:

gameDetails

See Also:

setGameDetails, EsObject

setGameDetails

public void setGameDetails(EsObject gameDetails)

Description copied from interface: PluginApi

Sets the game details.

Specified by:

setGameDetails in interface PluginApi

Parameters:

gameDetails - EsObject with the new value for gameDetails

See Also:

getGameDetails, EsObject

getGameId

public int getGameId()

Description copied from interface: PluginApi

Gets the gameId of the room this plugin is attached to, if this is a game room. If not a game room, returns -1.

Specified by:

getGameId in interface PluginApi

Returns:

gameId