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

G

GAME_INVITATION_FAILURE - com.smartfoxserver.v2.core.SFSEventType
This event is fired after a private SFSGame has finished the cycle of invitations.
GAME_INVITATION_SUCCESS - com.smartfoxserver.v2.core.SFSEventType
This event is fired after a private SFSGame has finished the cycle of invitations.
GAME_NODE_EVENT - com.smartfoxserver.v2.core.SFSEventType
Overcast Cluster Only
GENERATE_NEW - com.smartfoxserver.v2.components.signup.RecoveryMode
 
generateID() - Method in interface com.smartfoxserver.v2.entities.IDGenerator
 
generateID() - Method in class com.smartfoxserver.v2.entities.SFSIDGenerator
 
generateRandom(User) - Method in interface com.smartfoxserver.v2.components.signup.IPasswordManager
 
GENERIC_DB_ERROR - com.smartfoxserver.v2.components.signup.SignUpErrorCodes
 
GENERIC_ERROR - com.smartfoxserver.v2.exceptions.SFSErrorCode
 
GenericInvitationCallback - Class in com.smartfoxserver.v2.game
 
GenericInvitationCallback() - Constructor for class com.smartfoxserver.v2.game.GenericInvitationCallback
 
GenericMessage - Class in com.smartfoxserver.v2.controllers.system
 
GenericMessage - com.smartfoxserver.v2.controllers.SystemRequest
 
GenericMessage() - Constructor for class com.smartfoxserver.v2.controllers.system.GenericMessage
 
get() - Method in interface com.smartfoxserver.v2.entities.IVersion
 
get() - Method in class com.smartfoxserver.v2.entities.SFS2XVersion
 
get(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
 
get(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
get(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
 
get(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getActiveConnections() - Method in class com.smartfoxserver.v2.db.SFSDBManager
Get the number of pooled connections currently active
getAddress() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the session IP address
getAddress() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getAdminHelper() - Method in class com.smartfoxserver.v2.entities.SFSRoom
 
getAdminHelper() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getAdminHelper() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getAdminName() - Method in interface com.smartfoxserver.v2.entities.BannedUser
 
getAdminName() - Method in class com.smartfoxserver.v2.entities.SFSBannedUser
 
getAllMMOItems() - Method in class com.smartfoxserver.v2.mmo.MMORoom
Obtain a list of all MMOItems managed by this Room
getApi() - Method in class com.smartfoxserver.v2.extensions.BaseClientRequestHandler
Get a reference to the main server side API
getApi() - Method in class com.smartfoxserver.v2.extensions.BaseServerEventHandler
Get a reference to the main server side API
getApi() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Get a reference to the main SFS2X Server API, which exposes useful methods for interacting with the server
getAPIManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getApplyBadWordsFilter() - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Check if the current Zone applies the WordFilter to the Buddy messages
getApplyBadWordsFilter() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Check if the current Zone applies the WordFilter to the Buddy messages
getAutoRemoveMode() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the Auto-Remove mode of the Room
getAutoRemoveMode() - Method in interface com.smartfoxserver.v2.entities.Room
Return the auto-remove mode of the Room
getAutoRemoveMode() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Return the auto-remove mode of the Room
getBadWordsWarnings() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getBadWordsWarnings() - Method in interface com.smartfoxserver.v2.entities.User
 
getBanDurationMinutes() - Method in interface com.smartfoxserver.v2.entities.BannedUser
 
getBanDurationMinutes() - Method in class com.smartfoxserver.v2.entities.SFSBannedUser
 
getBanDurationMinutes() - Method in interface com.smartfoxserver.v2.util.IFloodFilter
 
getBanDurationMinutes() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getBanDurationMinutes() - Method in class com.smartfoxserver.v2.util.SFSFloodFilter
 
getBanDurationMinutes() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getBanMessage() - Method in interface com.smartfoxserver.v2.util.IFloodFilter
 
getBanMessage() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getBanMessage() - Method in class com.smartfoxserver.v2.util.SFSFloodFilter
 
getBanMessage() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getBanMode() - Method in interface com.smartfoxserver.v2.util.IFloodFilter
 
getBanMode() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getBanMode() - Method in class com.smartfoxserver.v2.util.SFSFloodFilter
 
getBanMode() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getBannedUserByIp(String) - Method in class com.smartfoxserver.v2.entities.managers.SFSBannedUserManager
 
getBannedUserByName(String, String) - Method in class com.smartfoxserver.v2.entities.managers.SFSBannedUserManager
 
getBannedUserManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getBannedUserManager() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getBannedUserManager() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getBannedUserManger() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getBannedUserManger() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getBannedUsersByIp() - Method in class com.smartfoxserver.v2.entities.managers.SFSBannedUserManager
 
getBannedUsersByName(String) - Method in class com.smartfoxserver.v2.entities.managers.SFSBannedUserManager
 
getBanTimeMillis() - Method in interface com.smartfoxserver.v2.entities.BannedUser
 
getBanTimeMillis() - Method in class com.smartfoxserver.v2.entities.SFSBannedUser
 
getBool(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Boolean.
getBool(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getBool(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as Boolean.
getBool(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getBoolArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Collection of Boolean.
getBoolArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getBoolArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getBoolArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of Booleans.
getBoolArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getBoolArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getBoolValue() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getBoolValue() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
Get the value of the variable as Boolean
getBoolValue() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
Get the value of the variable as Boolean
getBuddies() - Method in interface com.smartfoxserver.v2.buddylist.BuddyList
Get a list of all Buddies in the BuddyList
getBuddies() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyList
 
getBuddy(String) - Method in interface com.smartfoxserver.v2.buddylist.BuddyList
Get a Buddy from the BuddyList by name
getBuddy(String) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyList
 
getBuddyApi() - Method in class com.smartfoxserver.v2.api.APIManager
 
getBuddyApi() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Get a reference to the SFS2X Buddy API, exposing useful methods for working with BuddyLists
getBuddyList(String) - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Get the Buddy List of a specific user
getBuddyList(String) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Get the Buddy List of a specific user
getBuddyListManager() - Method in interface com.smartfoxserver.v2.buddylist.BuddyList
Get a reference to the BuddyManager managing this BuddyList
getBuddyListManager() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyList
 
getBuddyListManager() - Method in interface com.smartfoxserver.v2.buddylist.storage.BuddyStorage
Get a reference to the BuddyManager managing this BuddyStorage class
getBuddyListManager() - Method in class com.smartfoxserver.v2.buddylist.storage.FSBuddyStorage
 
getBuddyListManager() - Method in class com.smartfoxserver.v2.entities.SFSZone
INTERNAL
getBuddyListManager() - Method in interface com.smartfoxserver.v2.entities.Zone
INTERNAL
getBuddyListMaxSize() - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Get the maximum size of a BuddyList
getBuddyListMaxSize() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Get the maximum size of a BuddyList
getBuddyProperties() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getBuddyProperties() - Method in interface com.smartfoxserver.v2.entities.User
Get the BuddyProperty object
getBuddyStates() - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Get a list of custom Buddy states such as "Available", "Occupied", "Be right back" etc...
getBuddyStates() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Get a list of custom Buddy states such as "Available", "Occupied", "Be right back" etc...
getBuddyVariablesData() - Method in interface com.smartfoxserver.v2.buddylist.Buddy
 
getBuddyVariablesData() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddy
 
getByte(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Byte.
getByte(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getByte(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getByte(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as Byte (signed 8 bit).
getByte(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getByte(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getByteArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as byte array.
getByteArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getByteArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of Byte.
getByteArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getBytes(String) - Method in class com.smartfoxserver.v2.util.MD5
Generate binary md5 hash
getByteValue() - Method in enum com.smartfoxserver.v2.util.ClientDisconnectionReason
 
getByteValue() - Method in interface com.smartfoxserver.v2.util.IDisconnectionReason
 
getCallback() - Method in interface com.smartfoxserver.v2.entities.invitation.Invitation
Obtain a reference to the CallBack handler class
getCallback() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitation
 
getCapacity() - Method in interface com.smartfoxserver.v2.entities.Room
Return the capacity of the Room (maximum number of clients that can be contained).
getCapacity() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Return the capacity of the Room (maximum number of clients that can be contained).
getClass(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Class instance.
getClass(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getClass(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Class instance.
getClass(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getClassName() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings.RoomExtensionSettings
Get the fully qualified name of the Extension main class
getClientPassword(ISession, String) - Static method in class com.smartfoxserver.v2.util.CryptoUtils
 
getClientPort() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the client side TCP port number
getClientPort() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getClientsWatchingBuddy(String) - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
 
getClientsWatchingBuddy(String) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
 
getClientsWatchingBuddy(String, boolean) - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
 
getClientsWatchingBuddy(String, boolean) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
 
getCode() - Method in exception com.smartfoxserver.v2.components.signup.SignUpValidationException
Obtain the error code
getCode() - Method in class com.smartfoxserver.v2.exceptions.SFSErrorData
 
getConfig() - Method in class com.smartfoxserver.v2.components.login.LoginAssistantComponent
Obtain the configuration object that allows to setup all the parameters of the Login process.
getConfig() - Method in class com.smartfoxserver.v2.components.signup.SignUpAssistantComponent
 
getConfig() - Method in interface com.smartfoxserver.v2.db.IDBManager
Get the configuration details of the JDBC connection and connection pool
getConfigProperties() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Returns a reference the Properties object loaded from the specified properties file.
getConfigProperties() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
Returns a reference the Properties object loaded from the specified properties file.
getConfiguration() - Method in interface com.smartfoxserver.v2.entities.managers.IMailerService
Obtain the configuration settings of the service
getConfiguration() - Method in class com.smartfoxserver.v2.entities.managers.SFSPostOffice
Obtain the configuration settings of the service
getConfigurator() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getConnection() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getConnection() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getConnection() - Method in interface com.smartfoxserver.v2.db.IDBManager
Get a direct reference to the JDBC connection object.
getConnection() - Method in class com.smartfoxserver.v2.db.SFSDBManager
Get a direct reference to the JDBC connection object.
getCountry() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getCountry() - Method in interface com.smartfoxserver.v2.entities.User
If the geolocation service is enabled in the Zone it will return the location of the user
getCreatedRooms() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getCreatedRooms() - Method in interface com.smartfoxserver.v2.entities.User
Get a list of Rooms created by this User
getCreationTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
The timestamp at which the connection was done (milliseconds Unix Time)
getCreationTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getCryptoKey() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getCryptoKey() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getCurrentFolder() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Return the relative path to the current extension folder
Typically this will return: extensions/{name-of-extension}/
The path is relative to the Server root folder and it can be used to load external data files that are stored together with the extension jar file(s)
getCurrentMMORoom() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getCurrentMMORoom() - Method in interface com.smartfoxserver.v2.entities.User
 
getCustomPlayerIdGeneratorClass() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the PlayerId Generator class.
getDatagramChannel() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getDatagramChannel() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getDays() - Method in class com.smartfoxserver.v2.util.ServerUptime
 
getDbManager() - Method in class com.smartfoxserver.v2.components.signup.SignUpAssistantComponent
 
getDBManager() - Method in class com.smartfoxserver.v2.entities.SFSZone
Obtain a reference to the Zone's Database Manager.
getDBManager() - Method in interface com.smartfoxserver.v2.entities.Zone
Obtain a reference to the Zone's Database Manager.
getDefaultAOI() - Method in class com.smartfoxserver.v2.mmo.CreateMMORoomSettings
 
getDefaultAOI() - Method in class com.smartfoxserver.v2.mmo.MMORoom
Obtain the default Area Of Interest (AOI) of this room.
getDefaultGroups() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the list of Groups that each User will be automatically subscribed to when joining the Zone.
getDefaultGroups() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the list of Groups that each User will be automatically subscribed to when joining the Zone.
getDefaultPlayerIdGeneratorClassName() - Method in class com.smartfoxserver.v2.entities.SFSZone
getDefaultPlayerIdGeneratorClassName() - Method in interface com.smartfoxserver.v2.entities.Zone
 
getDouble(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Double.
getDouble(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getDouble(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as Double (signed decimal 64 bit).
getDouble(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getDoubleArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Collection of Double.
getDoubleArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getDoubleArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getDoubleArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of Double.
getDoubleArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getDoubleArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getDoubleValue() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getDoubleValue() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
Get the value of the variable as Double
getDoubleValue() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
Get the value of the variable as Double
getDroppedMessages() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
The number of messages that were dropped since the connection
getDroppedMessages() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getDump() - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get a detailed dump of the SFSArray structure
getDump() - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get a detailed dump of the SFSObject structure
getDump() - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getDump() - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getDump() - Method in interface com.smartfoxserver.v2.entities.Room
Get a dump of all Room attributes/settings.
getDump() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get a dump of all Room attributes/settings.
getDump() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getDump() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getDump() - Method in interface com.smartfoxserver.v2.entities.User
Return a full dump of the User properties, useful for debugging
getDump() - Method in interface com.smartfoxserver.v2.entities.Zone
 
getDump(boolean) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get a detailed dump of the SFSArray structure
getDump(boolean) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get a detailed dump of the SFSObject structure
getDump(boolean) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getDump(boolean) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getElementAt(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
 
getElementAt(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getErrorData() - Method in exception com.smartfoxserver.v2.exceptions.SFSException
 
getEventManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getExpiryTime() - Method in interface com.smartfoxserver.v2.entities.invitation.Invitation
The expiration timestamp.
getExpiryTime() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitation
 
getExpressionsList() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getExpressionsList() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getExtension() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the Extension attached to the Room
getExtension() - Method in interface com.smartfoxserver.v2.entities.Room
Get the extension connected to this Room, if any
getExtension() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the extension connected to this Room, if any
getExtension() - Method in class com.smartfoxserver.v2.entities.SFSZone
INTERNAL
getExtension() - Method in interface com.smartfoxserver.v2.entities.Zone
INTERNAL
getExtensionFileName() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Get the extension file name
getExtensionFileName() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
Get the extension file name
getExtensionManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getExtFloodWarnings() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getExtFloodWarnings() - Method in interface com.smartfoxserver.v2.entities.User
 
getFilterChain(SystemRequest) - Method in class com.smartfoxserver.v2.entities.SFSZone
Obtain a reference to the Zone's SystemFilterChain.
getFilterChain(SystemRequest) - Method in interface com.smartfoxserver.v2.entities.Zone
Obtain a reference to the Zone's SystemFilterChain.
getFilteredVariables() - Method in class com.smartfoxserver.v2.controllers.filter.ReadOnlyUserVariablesFilter
 
getFilterMode() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getFilterMode() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getFloat(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Float.
getFloat(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getFloat(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getFloat(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as Float (signed decimal 32 bit).
getFloat(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getFloat(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getFloatArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Collection of Float.
getFloatArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getFloatArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getFloatArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of Float.
getFloatArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getFloatArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getFloodFilter() - Method in class com.smartfoxserver.v2.entities.SFSZone
INTERNAL
getFloodFilter() - Method in interface com.smartfoxserver.v2.entities.Zone
INTERNAL
getFloodWarnings() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getFloodWarnings() - Method in interface com.smartfoxserver.v2.entities.User
 
getFreezeTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getFreezeTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getFromAddress() - Method in interface com.smartfoxserver.v2.entities.Email
Get the From address, which represents the sender of the email
getFromAddress() - Method in class com.smartfoxserver.v2.entities.SFSEmail
Get the From address, which represents the sender of the email
getFullIpAddress() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the IPAddress and Port of the user as a String in the format "1.2.3.4:1234"
getFullIpAddress() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getFullServerIpAddress() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the full server address and port to which the user connected to, in the form "1.2.3.4:1234"
getFullServerIpAddress() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getGame() - Method in class com.smartfoxserver.v2.game.BaseGameInvitationCallback
Get the Game
getGameApi() - Method in class com.smartfoxserver.v2.api.APIManager
 
getGameApi() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Get a reference to the SFS2X Game API, exposing useful methods for working with SFSGame classes, invitations and match making.
getGameRoomCount() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getGameRoomCount() - Method in interface com.smartfoxserver.v2.entities.Zone
 
getGroupEvents(String) - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getGroupEvents(String) - Method in interface com.smartfoxserver.v2.entities.Zone
 
getGroupId() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
The name of the Room Group that the new Room will be assigned to.
getGroupId() - Method in interface com.smartfoxserver.v2.entities.Room
Get the Room Group Id.
getGroupId() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the Room Group Id.
getGroups() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the full list of Room Groups available in the Zone.
getGroups() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the full list of Room Groups available in the Zone.
getGuestUserNamePrefix() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the prefix used by the system to auto-generate guest user names.
getGuestUserNamePrefix() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the prefix used by the system to auto-generate guest user names.
getHash(String) - Method in class com.smartfoxserver.v2.util.MD5
Generate the md5 hash
getHashId() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
A unique string token used as an alternative session ID
getHashId() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getHexDump() - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get a pretty-printed hex-dump of the array
getHexDump() - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get a pretty-printed hex-dump of the object
getHexDump() - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getHexDump() - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getHexFileName(String) - Static method in class com.smartfoxserver.v2.util.CryptoUtils
 
getHigherLimit() - Method in class com.smartfoxserver.v2.mmo.CreateMMORoomSettings.MapLimits
Obtain the higher coordinate limit
getHours() - Method in class com.smartfoxserver.v2.util.ServerUptime
 
getHttpServer() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getId() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the unique session Id
getId() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getId() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings.RoomExtensionSettings
Get the extension id
getId() - Method in enum com.smartfoxserver.v2.controllers.SystemRequest
 
getId() - Method in interface com.smartfoxserver.v2.entities.invitation.Invitation
Get the unique invitation ID
getId() - Method in enum com.smartfoxserver.v2.entities.invitation.InvitationResponse
 
getId() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitation
 
getId() - Method in interface com.smartfoxserver.v2.entities.Room
Return the unique Room Id
getId() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Return the unique Room Id
getId() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getId() - Method in class com.smartfoxserver.v2.entities.SFSZone
A numeric ID used by the AdminTool.
getId() - Method in interface com.smartfoxserver.v2.entities.User
Get the unique user ID
getId() - Method in enum com.smartfoxserver.v2.entities.variables.VariableType
 
getId() - Method in interface com.smartfoxserver.v2.entities.Zone
A numeric ID used by the AdminTool.
getId() - Method in interface com.smartfoxserver.v2.exceptions.IErrorCode
 
getId() - Method in enum com.smartfoxserver.v2.exceptions.SFSErrorCode
 
getId() - Method in interface com.smartfoxserver.v2.mmo.IMMOItem
The MMOItem ID
getId() - Method in class com.smartfoxserver.v2.mmo.MMOItem
The MMOItem ID
getId() - Method in enum com.smartfoxserver.v2.security.DefaultPermissionProfile
 
getId() - Method in interface com.smartfoxserver.v2.security.IPermissionProfile
 
getId() - Method in class com.smartfoxserver.v2.security.SFSPermissionProfile
 
getIDGenerator() - Method in interface com.smartfoxserver.v2.entities.invitation.InvitationManager
 
getIDGenerator() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitationManager
 
getIdleConnections() - Method in class com.smartfoxserver.v2.db.SFSDBManager
Get the number of pooled connections currently idle
getInstance() - Static method in class com.smartfoxserver.v2.entities.match.MatchingUtils
 
getInstance() - Static method in class com.smartfoxserver.v2.SmartFoxServer
 
getInstance() - Static method in class com.smartfoxserver.v2.util.MD5
Return the one and only instance of this class
getInt(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Integer.
getInt(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getInt(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as Integer (signed 32 bit).
getInt(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getIntArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Collection of Int.
getIntArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getIntArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getIntArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of Integer.
getIntArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getIntArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getIntValue() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getIntValue() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
Get the value of the variable as Integer
getIntValue() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
Get the value of the variable as Integer
getInvitationExpiryTime() - Method in class com.smartfoxserver.v2.game.CreateSFSGameSettings
The maximum amount of time for an invited Player to accept/refuse an invitation.
getInvitationManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getInvitationParams() - Method in class com.smartfoxserver.v2.game.CreateSFSGameSettings
Get optional SFSObject containing custom invitation parameters.
getInvitedPlayers() - Method in class com.smartfoxserver.v2.game.CreateSFSGameSettings
For private games only: A list of players invited to play in the Game.
getInvitee() - Method in interface com.smartfoxserver.v2.entities.invitation.Invitation
Get the Invitee, the user that receives the invitation
getInvitee() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitation
 
getInviter() - Method in interface com.smartfoxserver.v2.entities.invitation.Invitation
Get the Inviter, the user that started this invitation
getInviter() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitation
 
getIpAddress() - Method in interface com.smartfoxserver.v2.entities.BannedUser
 
getIpAddress() - Method in class com.smartfoxserver.v2.entities.SFSBannedUser
 
getIpAddress() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getIpAddress() - Method in interface com.smartfoxserver.v2.entities.User
Return the User IP address
getIsoCode() - Method in class com.smartfoxserver.v2.util.Country
The ISO code of the country (e.g.
getItemsManager() - Method in class com.smartfoxserver.v2.mmo.MMORoom
private
getJoinedRooms() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getJoinedRooms() - Method in interface com.smartfoxserver.v2.entities.User
A list of Rooms currently joined by the User
getKeys() - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get a Set of all keys
getKeys() - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getKickCount(String, String, int) - Method in class com.smartfoxserver.v2.entities.managers.SFSBannedUserManager
Calculates how many times a user has been kicked in the last amount of time passed in the second argument and expressed in seconds.
getKickMessage() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getKickMessage() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getKicksBeforeBan() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getKicksBeforeBan() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getKicksBeforeBanMinutes() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getKicksBeforeBanMinutes() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getLastActivityTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
The last time that the session has sent a packet (milliseconds Unix Time)
getLastActivityTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getLastJoinedRoom() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getLastJoinedRoom() - Method in interface com.smartfoxserver.v2.entities.User
A reference to the last Room that was joined by this User
getLastLoggedInActivityTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
The last time that the session has sent a request (milliseconds Unix Time)
getLastLoggedInActivityTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getLastLoginTime() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getLastMMOItemsList() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getLastMMOItemsList() - Method in interface com.smartfoxserver.v2.entities.User
 
getLastProxyList() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getLastProxyList() - Method in interface com.smartfoxserver.v2.entities.User
 
getLastReadTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getLastReadTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getLastRequestTime() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getLastRequestTime() - Method in interface com.smartfoxserver.v2.entities.User
 
getLastWriteTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getLastWriteTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getLevel() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Return the level of the extension.
getLevel() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
Return the level of the extension.
getLifeTime() - Method in interface com.smartfoxserver.v2.entities.Room
Obtain the time of existence of the Room
getLifeTime() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Obtain the time of existence of the Room
GetLobbyNode - com.smartfoxserver.v2.controllers.SystemRequest
 
getLogger() - Method in class com.smartfoxserver.v2.extensions.BaseClientRequestHandler
Obtain a direct reference to the Extension's logger
getLogger() - Method in class com.smartfoxserver.v2.extensions.BaseServerEventHandler
Obtain a direct reference to the Extension's logger
getLogger() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Obtain a direct reference to the Extension's logger
getLoginTime() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getLoginTime() - Method in interface com.smartfoxserver.v2.entities.User
Get the user login time (Unix timestamp)
getLong(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Long.
getLong(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getLong(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getLong(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as Long (signed 64 bit).
getLong(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getLong(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getLongArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Collection of Long.
getLongArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getLongArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of Long.
getLongArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getLowerLimit() - Method in class com.smartfoxserver.v2.mmo.CreateMMORoomSettings.MapLimits
Obtain the lower coordinate limit
getLSManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getMailService() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getMapHigherLimit() - Method in class com.smartfoxserver.v2.mmo.MMORoom
Get the map higher limit
getMapLimits() - Method in class com.smartfoxserver.v2.mmo.CreateMMORoomSettings
 
getMapLowerLimit() - Method in class com.smartfoxserver.v2.mmo.MMORoom
Get the map lower limit
getMaskCharacter() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getMaskCharacter() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getMaxAllowedRooms() - Method in class com.smartfoxserver.v2.entities.SFSZone
The maximum number of Rooms that can be created in the Room.
getMaxAllowedRooms() - Method in interface com.smartfoxserver.v2.entities.Zone
The maximum number of Rooms that can be created in the Room.
getMaxAllowedUsers() - Method in class com.smartfoxserver.v2.entities.SFSZone
The maximum number of users allowed to join the Zone.
getMaxAllowedUsers() - Method in interface com.smartfoxserver.v2.entities.Zone
The maximum number of users allowed to join the Zone.
getMaxAllowedVariables() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getMaxAllowedVariables() - Method in interface com.smartfoxserver.v2.entities.User
Get the maximum allowed User Variables for this User
getMaxBadWordsPerMessage() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getMaxBadWordsPerMessage() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getMaxBuddyVariables() - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Get the limit of BuddyVariables that each User can create
getMaxBuddyVariables() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Get the limit of BuddyVariables that each User can create
getMaxFailedLogins() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getMaxFailedLogins() - Method in interface com.smartfoxserver.v2.entities.Zone
The max number of login attempts (in the same session) a user can fail before being disconnected.
getMaxFindRoomResults() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getMaxFindRoomResults() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the max number of "FindRoom" results for a client request.
getMaxFindUserResults() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getMaxFindUserResults() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the max number of "Find User" results for a client request.
getMaxFloodingAttempts() - Method in interface com.smartfoxserver.v2.util.IFloodFilter
 
getMaxFloodingAttempts() - Method in class com.smartfoxserver.v2.util.SFSFloodFilter
 
getMaxIdleTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the maximum time of socket inactivity after which the system will consider the User "idle" and disconnect it.
getMaxIdleTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getMaxInvitationsPerRequest() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the max number of people that can be invited a by a single client side JoinRoomInvitationRequest
getMaxInvitationsPerRequest() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the max number of people that can be invited a by a single client side JoinRoomInvitationRequest
getMaxInvitationsPerUser() - Method in interface com.smartfoxserver.v2.entities.invitation.InvitationManager
 
getMaxInvitationsPerUser() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitationManager
 
getMaxLoggedInIdleTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the maximum time of User inactivity after which the system will consider the session "idle" and disconnect it.
getMaxLoggedInIdleTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getMaxRoomNameChars() - Method in class com.smartfoxserver.v2.entities.SFSZone
The maximum number of characters allowed for a Room name
getMaxRoomNameChars() - Method in interface com.smartfoxserver.v2.entities.Zone
The maximum number of characters allowed for a Room name
getMaxRoomsCreatedPerUserLimit() - Method in class com.smartfoxserver.v2.entities.SFSZone
The maximum number of Rooms that a User can create at once.
getMaxRoomsCreatedPerUserLimit() - Method in interface com.smartfoxserver.v2.entities.Zone
The maximum number of Rooms that a User can create at once.
getMaxRoomVariablesAllowed() - Method in interface com.smartfoxserver.v2.entities.Room
Return the maximum number of Room Variables allowed in the Room.
getMaxRoomVariablesAllowed() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Return the maximum number of Room Variables allowed in the Room.
getMaxRoomVariablesAllowed() - Method in class com.smartfoxserver.v2.entities.SFSZone
The maximum number of Room Variables allowed for each Room.
getMaxRoomVariablesAllowed() - Method in interface com.smartfoxserver.v2.entities.Zone
The maximum number of Room Variables allowed for each Room.
getMaxSpectators() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the maximum number of spectators allowed in the Room (game only)
getMaxSpectators() - Method in interface com.smartfoxserver.v2.entities.Room
Return the maximum number of Spectators allowed in the Room.
getMaxSpectators() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Return the maximum number of Spectators allowed in the Room.
getMaxUserIdleTime() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the max allowed idle time for a User.
getMaxUserIdleTime() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the max allowed idle time for a User.
getMaxUsers() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the maximum number of users allowed in the Room
getMaxUsers() - Method in interface com.smartfoxserver.v2.entities.Room
Return the maximum number of Users allowed in the Room.
getMaxUsers() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Return the maximum number of Users allowed in the Room.
getMaxUserVariablesAllowed() - Method in class com.smartfoxserver.v2.entities.SFSZone
The maximum number of User Variables allowed for each User.
getMaxUserVariablesAllowed() - Method in interface com.smartfoxserver.v2.entities.Zone
The maximum number of User Variables allowed for each User.
getMaxVariablesAllowed() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the maximum number of Room Variables allowed
getMD5Hash(String) - Static method in class com.smartfoxserver.v2.util.CryptoUtils
 
getMessage() - Method in interface com.smartfoxserver.v2.entities.Email
Get the message of the email.
getMessage() - Method in class com.smartfoxserver.v2.entities.SFSEmail
Get the message of the email.
getMinClientApiVersion() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getMinPlayersToStartGame() - Method in class com.smartfoxserver.v2.game.CreateSFSGameSettings
Get the minimum number of players required to start the Game
getMinPlayersToStartGame() - Method in class com.smartfoxserver.v2.game.SFSGame
This is the minimum number of players that are required for the game to start
getMinRoomNameChars() - Method in class com.smartfoxserver.v2.entities.SFSZone
The minimum number of characters allowed for Room name
getMinRoomNameChars() - Method in interface com.smartfoxserver.v2.entities.Zone
The minimum number of characters allowed for Room name
getMinutes() - Method in class com.smartfoxserver.v2.util.ServerUptime
 
getMMOApi() - Method in class com.smartfoxserver.v2.api.APIManager
 
getMMOApi() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Get a reference to the SFS2X MMO API, exposing useful methods for working with MMORoom(s) and MMOItem(s) objects.
getMMOItemById(int) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Obtain an MMOItem managed by this Room via its id
getMode() - Method in interface com.smartfoxserver.v2.entities.BannedUser
 
getMode() - Method in class com.smartfoxserver.v2.entities.SFSBannedUser
 
getName() - Method in class com.smartfoxserver.v2.api.APIManager
 
getName() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the name of the Room.
getName() - Method in interface com.smartfoxserver.v2.buddylist.Buddy
The Buddy name, which corresponds to the User name.
getName() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddy
 
getName() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
 
getName() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getName() - Method in class com.smartfoxserver.v2.controllers.filter.SysControllerFilter
 
getName() - Method in interface com.smartfoxserver.v2.entities.BannedUser
 
getName() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitationManager
 
getName() - Method in class com.smartfoxserver.v2.entities.managers.SFSPostOffice
 
getName() - Method in interface com.smartfoxserver.v2.entities.Room
Get the room name
getName() - Method in class com.smartfoxserver.v2.entities.SFSBannedUser
 
getName() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the room name
getName() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getName() - Method in class com.smartfoxserver.v2.entities.SFSZone
The name of the Zone.
getName() - Method in interface com.smartfoxserver.v2.entities.User
Get the User name
getName() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
getName() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
 
getName() - Method in interface com.smartfoxserver.v2.entities.Zone
The name of the Zone.
getName() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
The extension name
getName() - Method in class com.smartfoxserver.v2.extensions.filter.SFSExtensionFilter
Get the filter name
getName() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
The extension name
getName() - Method in class com.smartfoxserver.v2.security.SFSPermissionProfile
 
getName() - Method in class com.smartfoxserver.v2.util.Country
Name of the country
getName() - Method in class com.smartfoxserver.v2.util.TaskScheduler
Get the service name
getNewScheduler(int) - Method in interface com.smartfoxserver.v2.api.ISFSApi
Creates a new TaskScheduler.
getNewScheduler(int) - Method in class com.smartfoxserver.v2.api.SFSApi
Creates a new TaskScheduler.
getNickName() - Method in interface com.smartfoxserver.v2.buddylist.Buddy
Get the nickname of the Buddy.
getNickName() - Method in interface com.smartfoxserver.v2.buddylist.BuddyProperties
 
getNickName() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddy
 
getNickName() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyProperties
 
getNodeId() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Return the node Id in a cluster
getNodeId() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getObject() - Method in class com.smartfoxserver.v2.entities.data.SFSDataWrapper
 
getOfflineBuddyVariable(String, String) - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
 
getOfflineBuddyVariable(String, String) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
 
getOfflineBuddyVariables(String) - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
 
getOfflineBuddyVariables(String) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
 
getOfflineBuddyVariables(String, boolean) - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
 
getOfflineBuddyVariables(String, boolean) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
 
getOfflineBuddyVariablesCacheSize() - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Get the size of the "offline" Buddy Variables cache.
getOfflineBuddyVariablesCacheSize() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Get the size of the "offline" Buddy Variables cache.
getOfflineVariables(String) - Method in interface com.smartfoxserver.v2.buddylist.storage.BuddyStorage
Load the off-line persistent variables for a specific User.
getOfflineVariables(String) - Method in class com.smartfoxserver.v2.buddylist.storage.FSBuddyStorage
 
getOwnedRoomsCount() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getOwnedRoomsCount() - Method in interface com.smartfoxserver.v2.entities.User
Get the number of Rooms created by the User
getOwner() - Method in interface com.smartfoxserver.v2.buddylist.BuddyList
Get the User that owns this BuddyList
getOwner() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyList
 
getOwner() - Method in interface com.smartfoxserver.v2.entities.Room
Get the owner of the Room (the user that created it)
getOwner() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the owner of the Room (the user that created it)
getOwner() - Method in interface com.smartfoxserver.v2.entities.variables.RoomVariable
Return the User that created the variable.
getOwner() - Method in class com.smartfoxserver.v2.entities.variables.SFSRoomVariable
Return the User that created the variable.
getOwnerAsString() - Method in class com.smartfoxserver.v2.entities.variables.SFSRoomVariable
 
getOwnerName() - Method in interface com.smartfoxserver.v2.buddylist.BuddyList
Get the name of the owner of this BuddyList
getOwnerName() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyList
 
getPacketQueue() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getPacketQueue() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getParameter(ISFSEventParam) - Method in interface com.smartfoxserver.v2.core.ISFSEvent
Get a parameter from the event object
getParameter(ISFSEventParam) - Method in class com.smartfoxserver.v2.core.SFSEvent
Get a parameter from the event object
getParams() - Method in exception com.smartfoxserver.v2.components.signup.SignUpValidationException
Obtain the error message parameters
getParams() - Method in interface com.smartfoxserver.v2.entities.invitation.Invitation
An SFSObject of custom parameters can be attached to the invitation.
getParams() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitation
 
getParams() - Method in class com.smartfoxserver.v2.exceptions.SFSErrorData
 
getParentBuddyList() - Method in interface com.smartfoxserver.v2.buddylist.Buddy
Return the parent BuddyList containing this Buddy
getParentBuddyList() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddy
 
getParentExtension() - Method in class com.smartfoxserver.v2.extensions.BaseClientRequestHandler
Obtain a reference to the parent extension.
getParentExtension() - Method in class com.smartfoxserver.v2.extensions.BaseServerEventHandler
Obtain a reference to the parent extension.
getParentExtension() - Method in interface com.smartfoxserver.v2.extensions.IClientRequestHandler
Obtain a reference to the parent extension.
getParentExtension() - Method in interface com.smartfoxserver.v2.extensions.IServerEventHandler
Obtain a reference to the parent extension.
getParentObject() - Method in class com.smartfoxserver.v2.core.BaseSFSEventListener
 
getParentRoom() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Return the parent Room of the Extension.
getParentRoom() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
Return the parent Room of the Extension.
getParentRoom() - Method in class com.smartfoxserver.v2.util.DefaultPlayerIdGenerator
 
getParentRoom() - Method in interface com.smartfoxserver.v2.util.IPlayerIdGenerator
Get a reference to the parent Room
getParentZone() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Return the parent Zone of the Extension.
getParentZone() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
Return the parent Zone of the Extension.
getPassword() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the Room password.
getPassword() - Method in interface com.smartfoxserver.v2.entities.Room
Get the Room password.
getPassword() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the Room password.
getPermissionProfile(short) - Method in interface com.smartfoxserver.v2.security.PrivilegeManager
 
getPermissionProfile(short) - Method in class com.smartfoxserver.v2.security.SFSPrivilegeManager
 
getPermissionProfile(String) - Method in interface com.smartfoxserver.v2.security.PrivilegeManager
 
getPermissionProfile(String) - Method in class com.smartfoxserver.v2.security.SFSPrivilegeManager
 
getPersistentRoomVarReferences() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getPersistentRoomVarReferences() - Method in interface com.smartfoxserver.v2.entities.User
 
getPersistentVariables() - Method in interface com.smartfoxserver.v2.buddylist.BuddyProperties
 
getPersistentVariables() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyProperties
 
getPlayerId() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getPlayerId() - Method in interface com.smartfoxserver.v2.entities.User
Get the playerId of the User (if applicable).
The User should be currently joined in a Game Room for this method to return a meaningful value.
playerId == 0, if the Room is not a Game Room
playerID > 0, if the Room is a Game Room
getPlayerId(Room) - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getPlayerId(Room) - Method in interface com.smartfoxserver.v2.entities.User
Get the playerId for the User in a specific Room
getPlayerIdGeneratorClassName() - Method in interface com.smartfoxserver.v2.entities.Room
 
getPlayerIdGeneratorClassName() - Method in class com.smartfoxserver.v2.entities.SFSRoom
 
getPlayerIds() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getPlayerIds() - Method in interface com.smartfoxserver.v2.entities.User
Get a map of playerId(s) per Room
This method can be used when a player is currently engaged in multiple games at the same time
getPlayerMatchExpression() - Method in class com.smartfoxserver.v2.game.CreateSFSGameSettings
A match expression to filter Players willing to join the Game.
getPlayerMatchExpression() - Method in class com.smartfoxserver.v2.game.SFSGame
Get the MatchExpression that is going to be checked against any Player joining this Room.
By default this is null and no matching is performed.
getPlayersList() - Method in interface com.smartfoxserver.v2.entities.Room
For Game Rooms: get all Players in the Room (same as all User without the Spectators)
getPlayersList() - Method in class com.smartfoxserver.v2.entities.SFSRoom
For Game Rooms: get all Players in the Room (same as all User without the Spectators)
getPlayersList() - Method in class com.smartfoxserver.v2.mmo.MMORoom
 
getPlayerSlot() - Method in class com.smartfoxserver.v2.util.DefaultPlayerIdGenerator
 
getPlayerSlot() - Method in interface com.smartfoxserver.v2.util.IPlayerIdGenerator
Return a new player slot/id
getPriority() - Method in interface com.smartfoxserver.v2.entities.Email
Get the priority of the email.
getPriority() - Method in class com.smartfoxserver.v2.entities.SFSEmail
Get the priority of the email.
getPrivilegeId() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getPrivilegeId() - Method in interface com.smartfoxserver.v2.entities.User
Return the Privilege ID of the User.
getPrivilegeManager() - Method in class com.smartfoxserver.v2.entities.SFSZone
getPrivilegeManager() - Method in interface com.smartfoxserver.v2.entities.Zone
 
getProperties() - Method in interface com.smartfoxserver.v2.entities.Room
Get the map with all Room properties
getProperties() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the map with all Room properties
getProperties() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getProperties() - Method in interface com.smartfoxserver.v2.entities.User
Get the map with all User properties
getPropertiesFile() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings.RoomExtensionSettings
Get the name of the custom config properties file
getPropertiesFileName() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
Get the name of the properties file that was loaded at init time.
getPropertiesFileName() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
Get the name of the properties file that was loaded at init time.
getProperty(Object) - Method in interface com.smartfoxserver.v2.entities.Room
Get any custom property attached to this Room.
getProperty(Object) - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get any custom property attached to this Room.
getProperty(Object) - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getProperty(Object) - Method in class com.smartfoxserver.v2.entities.SFSZone
Properties are custom values that can be added or removed from the Zone at run-time.
getProperty(Object) - Method in interface com.smartfoxserver.v2.entities.User
Get any custom property attached to this User.
getProperty(Object) - Method in interface com.smartfoxserver.v2.entities.Zone
Properties are custom values that can be added or removed from the Zone at run-time.
getProperty(String) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getProperty(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getProximityItems(User) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Get the list of MMOItems falling within the User's AoI
getProximityItems(User, Vec3D) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Get the list of MMOItems falling within a custom AoI
getProximityItems(Vec3D) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Get the list of MMOItems falling within the MMORoom's AoI at a specific location
getProximityItems(Vec3D, Vec3D) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Get the list of MMOItems at a specific location, falling within a custom AoI
getProximityList(User) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Returns the List of Users falling within the target's AOI
getProximityList(User, Vec3D) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Returns the List of Users falling within the a custom AOI around the target
getProximityList(Vec3D) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Returns the List of Users falling within the AOI of the target position
getProximityList(Vec3D, Vec3D) - Method in class com.smartfoxserver.v2.mmo.MMORoom
Returns the List of Users falling within the custom AOI around the target position
getProximityListUpdateMillis() - Method in class com.smartfoxserver.v2.mmo.CreateMMORoomSettings
 
getProximityListUpdateMillis() - Method in class com.smartfoxserver.v2.mmo.MMORoom
private
getProximityManager() - Method in class com.smartfoxserver.v2.mmo.MMORoom
private
getProxyList() - Method in class com.smartfoxserver.v2.mmo.MMORoom.PreviousMMORoomState
 
getPublicGroups() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get a list of names of the "Public" Room Groups available in the Zone.
getPublicGroups() - Method in interface com.smartfoxserver.v2.entities.Zone
Get a list of names of the "Public" Room Groups available in the Zone.
getReadBytes() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
The amount of data in bytes that the client has sent so far
getReadBytes() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getReason() - Method in interface com.smartfoxserver.v2.entities.BannedUser
 
getReason() - Method in class com.smartfoxserver.v2.entities.SFSBannedUser
 
getRecipientNamesForUpdate(String) - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
 
getRecipientNamesForUpdate(String) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
 
getReconnectionSeconds() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the interval of time allowed for a Session to attempt a reconnection after and abrupt loss of connection.
getReconnectionSeconds() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getReconnectionSeconds() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getReconnectionSeconds() - Method in interface com.smartfoxserver.v2.entities.User
 
getReloadMode() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
getReloadMode() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
 
getRequestTable() - Method in interface com.smartfoxserver.v2.util.IFloodFilter
 
getRequestTable() - Method in class com.smartfoxserver.v2.util.SFSFloodFilter
 
getResponseAPI() - Method in interface com.smartfoxserver.v2.api.ISFSApi
 
getResponseAPI() - Method in interface com.smartfoxserver.v2.api.ISFSBuddyApi
 
getResponseAPI() - Method in interface com.smartfoxserver.v2.api.ISFSGameApi
 
getResponseAPI() - Method in interface com.smartfoxserver.v2.api.ISFSMMOApi
 
getResponseAPI() - Method in class com.smartfoxserver.v2.api.SFSApi
 
getResponseAPI() - Method in class com.smartfoxserver.v2.api.SFSBuddyApi
getResponseAPI() - Method in class com.smartfoxserver.v2.api.SFSGameApi
getResponseAPI() - Method in class com.smartfoxserver.v2.api.SFSMMOApi
getRestartCount() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getRoom() - Method in class com.smartfoxserver.v2.mmo.BaseMMOItem
 
getRoom() - Method in class com.smartfoxserver.v2.mmo.MMOItem
getRoomById(int) - Method in class com.smartfoxserver.v2.entities.SFSZone
Get a Room from its unique ID
getRoomById(int) - Method in interface com.smartfoxserver.v2.entities.Zone
Get a Room from its unique ID
getRoomByName(String) - Method in class com.smartfoxserver.v2.entities.SFSZone
Get a Room from its name
getRoomByName(String) - Method in interface com.smartfoxserver.v2.entities.Zone
Get a Room from its name
getRoomId() - Method in class com.smartfoxserver.v2.mmo.MMORoom.PreviousMMORoomState
 
getRoomList() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the list of Rooms in the Zone
getRoomList() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the list of Rooms in the Zone
GetRoomList - com.smartfoxserver.v2.controllers.SystemRequest
 
getRoomListData() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getRoomListData() - Method in interface com.smartfoxserver.v2.entities.Zone
INTERNAL
getRoomListData(List<String>) - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getRoomListData(List<String>) - Method in interface com.smartfoxserver.v2.entities.Zone
INTERNAL
getRoomListFromGroup(String) - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the list of Rooms from a specific Group
getRoomListFromGroup(String) - Method in interface com.smartfoxserver.v2.entities.Zone
Get the list of Rooms from a specific Group
getRoomListFromGroupList(Collection<String>) - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getRoomListFromGroupList(Collection<String>) - Method in interface com.smartfoxserver.v2.entities.Zone
Obtain a Room list generated by merging all Rooms from the provided group names
getRoomManager() - Method in class com.smartfoxserver.v2.entities.SFSZone
Obtain a reference to the internal Room Manager
getRoomManager() - Method in interface com.smartfoxserver.v2.entities.Zone
Obtain a reference to the internal Room Manager
getRoomPersistenceApi() - Method in class com.smartfoxserver.v2.entities.SFSZone
Obtain the Room Persistence API object.
getRoomPersistenceApi() - Method in interface com.smartfoxserver.v2.entities.Zone
Obtain the Room Persistence API object.
getRoomProperties() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the custom properties attached to the Room object
getRoomSettings() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the advanced settings of the Room.
getRoomVariables() - Method in class com.smartfoxserver.v2.api.CreateRoomSettings
Get the list of Room Variables for the new Room
getRoomVariablesData(boolean) - Method in interface com.smartfoxserver.v2.entities.Room
 
getRoomVariablesData(boolean) - Method in class com.smartfoxserver.v2.entities.SFSRoom
 
getRuntimeSize() - Method in interface com.smartfoxserver.v2.buddylist.BuddyList
Obtain the size of the BuddyList, including the temp buddies
getRuntimeSize() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyList
 
getSearchableRooms() - Method in class com.smartfoxserver.v2.game.CreateSFSGameSettings
A list of Rooms where to search for more players to invite in a private Game.
The players will be matched against the Player Match Expression provided
getSeconds() - Method in class com.smartfoxserver.v2.util.ServerUptime
 
getSecondsBeforeBan() - Method in interface com.smartfoxserver.v2.util.IFloodFilter
 
getSecondsBeforeBan() - Method in class com.smartfoxserver.v2.util.SFSFloodFilter
 
getSecondsBeforeBanOrKick() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getSecondsBeforeBanOrKick() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getSecondsForAnswer() - Method in interface com.smartfoxserver.v2.entities.invitation.Invitation
The amount of seconds given to the invitee to respond to the invitation
getSecondsForAnswer() - Method in class com.smartfoxserver.v2.entities.invitation.SFSInvitation
 
getSectorSize() - Method in class com.smartfoxserver.v2.mmo.MMORoom
private
getSerializer() - Static method in class com.smartfoxserver.v2.buddylist.BuddySerializerFactory
 
getServerAddress() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the server address to which the user connected to
getServerAddress() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getServerAdmin() - Static method in class com.smartfoxserver.v2.util.UsersUtil
 
getServerModerator() - Static method in class com.smartfoxserver.v2.util.UsersUtil
 
getServerPort() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the server port to which the user connected to
getServerPort() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getServiceProvider() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getSession() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getSession() - Method in interface com.smartfoxserver.v2.entities.User
Get the session object linked to this User
getSessionList() - Method in interface com.smartfoxserver.v2.entities.Room
Get all the User Sessions in the Room
getSessionList() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get all the User Sessions in the Room
getSessionList() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the list of Sessions logged in the Zone
getSessionList() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the list of Sessions logged in the Zone
getSessionManager() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getSessionManager() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getSessionManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getSessionsInGroup(String) - Method in class com.smartfoxserver.v2.entities.SFSZone
Get a list of Sessions from all Rooms in the provided Room Group
getSessionsInGroup(String) - Method in interface com.smartfoxserver.v2.entities.Zone
Get a list of Sessions from all Rooms in the provided Room Group
getSessionsListeningToGroup(String) - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getSessionsListeningToGroup(String) - Method in interface com.smartfoxserver.v2.entities.Zone
Get a list of Sessions listening for events in a specific Group
getSFSApi() - Method in class com.smartfoxserver.v2.api.APIManager
 
getSFSArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as ISFSArray.
getSFSArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getSFSArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as ISFSArray.
getSFSArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getSFSArrayValue() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getSFSArrayValue() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
Get the value of the variable as SFSArray
getSFSArrayValue() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
Get the value of the variable as SFSArray
getSFSObject(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as ISFSObject.
getSFSObject(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getSFSObject(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as ISFSObject.
getSFSObject(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getSFSObjectValue() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getSFSObjectValue() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
Get the value of the variable as SFSObject
getSFSObjectValue() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
Get the value of the variable as SFSObject
getShort(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Short.
getShort(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getShort(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getShort(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as Short (signed 16 bit).
getShort(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getShort(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getShortArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Collection of Short.
getShortArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getShortArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getShortArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of Short.
getShortArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getShortArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getSize() - Method in interface com.smartfoxserver.v2.buddylist.BuddyList
Obtain the size of the BuddyList.
getSize() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyList
 
getSize() - Method in interface com.smartfoxserver.v2.entities.Room
Return the current Room size
getSize() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Return the current Room size
getSpectatorCount() - Method in class com.smartfoxserver.v2.entities.RoomSize
Get the number of Spectators
getSpectatorMatchExpression() - Method in class com.smartfoxserver.v2.game.CreateSFSGameSettings
A match expression to filter Spectators willing to join the Game.
getSpectatorMatchExpression() - Method in class com.smartfoxserver.v2.game.SFSGame
Get the MatchExpression that is going to be checked against any Spectator joining this Room.
By default this is null and no matching is performed.
getSpectatorsList() - Method in interface com.smartfoxserver.v2.entities.Room
For Game Rooms: get all Spectators in the Room (same as all User without the Players)
getSpectatorsList() - Method in class com.smartfoxserver.v2.entities.SFSRoom
For Game Rooms: get all Spectators in the Room (same as all User without the Players)
getSpectatorsList() - Method in class com.smartfoxserver.v2.mmo.MMORoom
 
getState() - Method in interface com.smartfoxserver.v2.buddylist.Buddy
Returns the current Buddy State
getState() - Method in interface com.smartfoxserver.v2.buddylist.BuddyProperties
 
getState() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddy
 
getState() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyProperties
 
getState() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getStatsManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getStorageHandler() - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Get a reference to the instance of the BuddyStorage class, which handles the data persistence
getStorageHandler() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Get a reference to the instance of the BuddyStorage class, which handles the data persistence
getStringValue() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getStringValue() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
Get the value of the variable as String
getStringValue() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
Get the value of the variable as String
getSubject() - Method in interface com.smartfoxserver.v2.entities.Email
Get the subject of the email
getSubject() - Method in class com.smartfoxserver.v2.entities.SFSEmail
Get the subject of the email
getSubscribedGroups() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getSubscribedGroups() - Method in interface com.smartfoxserver.v2.entities.User
Get a list of Room Groups subscribed by the User
getSymbol() - Method in enum com.smartfoxserver.v2.entities.match.BoolMatch
getSymbol() - Method in enum com.smartfoxserver.v2.entities.match.NumberMatch
getSymbol() - Method in enum com.smartfoxserver.v2.entities.match.StringMatch
getSystemProperty(String) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getSystemProperty(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getSystemScheduler() - Method in interface com.smartfoxserver.v2.api.ISFSApi
Gets a reference to the global SFS Task Scheduler.
getSystemScheduler() - Method in class com.smartfoxserver.v2.api.SFSApi
Gets a reference to the global SFS Task Scheduler.
getSystemThreadPool() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getTaskScheduler() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getText(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as long String, with a max length of 2 GBytes.
getText(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getText(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as String using UTF-8 encoding.
getText(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getThreadPoolSize() - Method in class com.smartfoxserver.v2.util.TaskScheduler
Obtain the size of the thread pool for this Scheduler
getToAddress() - Method in interface com.smartfoxserver.v2.entities.Email
Get the recipient(s) of the email.
getToAddress() - Method in class com.smartfoxserver.v2.entities.SFSEmail
Get the recipient(s) of the email.
getTotalRoomCount() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getTotalRoomCount() - Method in interface com.smartfoxserver.v2.entities.Zone
 
getTotalUsers() - Method in class com.smartfoxserver.v2.entities.RoomSize
Returns the sum of Users and Spectators
getTraceMonitor() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getType() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the Session type
getType() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getType() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getType() - Method in interface com.smartfoxserver.v2.core.ISFSEvent
Get the type of the event
getType() - Method in class com.smartfoxserver.v2.core.SFSEvent
Get the type of the event
getType() - Method in enum com.smartfoxserver.v2.entities.match.BoolMatch
 
getType() - Method in enum com.smartfoxserver.v2.entities.match.NumberMatch
 
getType() - Method in enum com.smartfoxserver.v2.entities.match.StringMatch
 
getType() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
Return the data type of the variable
getType() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
Return the data type of the variable
getType() - Method in class com.smartfoxserver.v2.extensions.BaseSFSExtension
getType() - Method in interface com.smartfoxserver.v2.extensions.ISFSExtension
 
getTypeId() - Method in class com.smartfoxserver.v2.entities.data.SFSDataWrapper
 
getTypeID() - Method in enum com.smartfoxserver.v2.entities.data.SFSDataType
 
getUCountThrottler() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getUCountThrottler() - Method in interface com.smartfoxserver.v2.entities.Zone
INTERNAL
getUIDGenerator() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getUniqueSessionToken(ISession) - Static method in class com.smartfoxserver.v2.util.CryptoUtils
 
getUnsignedByte(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as an unsigned Integer (bytes are always signed, -127 < b < 127)
It can be null if no element exists for the specified index
getUnsignedByte(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getUnsignedByte(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as unsigned byte.
getUnsignedByte(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getUnsignedByteArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as a Collection of unsigned integers.
getUnsignedByteArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getUnsignedByteArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of unsigned Byte.
getUnsignedByteArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getUptime() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getUserById(int) - Method in interface com.smartfoxserver.v2.api.ISFSApi
Finds a User from its unique ID
getUserById(int) - Method in class com.smartfoxserver.v2.api.SFSApi
Finds a User from its unique ID
getUserById(int) - Method in interface com.smartfoxserver.v2.entities.Room
 
getUserById(int) - Method in class com.smartfoxserver.v2.entities.SFSRoom
getUserById(int) - Method in class com.smartfoxserver.v2.entities.SFSZone
Get a User from its unique ID
getUserById(int) - Method in interface com.smartfoxserver.v2.entities.Zone
Get a User from its unique ID
getUserByName(String) - Method in interface com.smartfoxserver.v2.api.ISFSApi
Finds a User from its name
getUserByName(String) - Method in class com.smartfoxserver.v2.api.SFSApi
Finds a User from its name
getUserByName(String) - Method in interface com.smartfoxserver.v2.entities.Room
 
getUserByName(String) - Method in class com.smartfoxserver.v2.entities.SFSRoom
getUserByName(String) - Method in class com.smartfoxserver.v2.entities.SFSZone
Get a User from its name
getUserByName(String) - Method in interface com.smartfoxserver.v2.entities.Zone
Get a User from its name
getUserByPlayerId(int) - Method in interface com.smartfoxserver.v2.entities.Room
Get the User currently having the specified playerId (Game Room only)
getUserByPlayerId(int) - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the User currently having the specified playerId (Game Room only)
getUserByPlayerId(int) - Method in class com.smartfoxserver.v2.mmo.MMORoom
 
getUserBySession(ISession) - Method in interface com.smartfoxserver.v2.api.ISFSApi
Finds a User from its Session
getUserBySession(ISession) - Method in class com.smartfoxserver.v2.api.SFSApi
Finds a User from its Session
getUserBySession(ISession) - Method in interface com.smartfoxserver.v2.entities.Room
 
getUserBySession(ISession) - Method in class com.smartfoxserver.v2.entities.SFSRoom
getUserBySession(ISession) - Method in class com.smartfoxserver.v2.entities.SFSZone
Get a User from its Session object
getUserBySession(ISession) - Method in interface com.smartfoxserver.v2.entities.Zone
Get a User from its Session object
getUserCount() - Method in class com.smartfoxserver.v2.entities.RoomSize
Get the number of Users/Players in the Room
getUserCount() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the current amount of Users connected to the Zone
getUserCount() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the current amount of Users connected to the Zone
getUserCountChangeUpdateInterval() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the rate (in ms.) at which the UserCountUpdates events are fired to the clients.
getUserCountChangeUpdateInterval() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the rate (in ms.) at which the UserCountUpdates events are fired to the clients.
getUserLimboMaxSeconds() - Method in class com.smartfoxserver.v2.mmo.MMORoom
private
getUserList() - Method in interface com.smartfoxserver.v2.entities.Room
Get all Users in the Room
getUserList() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get all Users in the Room
getUserList() - Method in class com.smartfoxserver.v2.entities.SFSZone
Get the list of Users logged in the Zone
getUserList() - Method in interface com.smartfoxserver.v2.entities.Zone
Get the list of Users logged in the Zone
getUserListData() - Method in interface com.smartfoxserver.v2.entities.Room
 
getUserListData() - Method in class com.smartfoxserver.v2.entities.SFSRoom
 
getUserManager() - Method in interface com.smartfoxserver.v2.entities.Room
 
getUserManager() - Method in class com.smartfoxserver.v2.entities.SFSRoom
 
getUserManager() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getUserManager() - Method in interface com.smartfoxserver.v2.entities.Zone
 
getUserManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getUserMaxLimboSeconds() - Method in class com.smartfoxserver.v2.mmo.CreateMMORoomSettings
 
getUserReconnectionSeconds() - Method in class com.smartfoxserver.v2.entities.SFSZone
Return the amount of seconds available for a User to reconnect to the system in case their socket connection goes down.
getUserReconnectionSeconds() - Method in interface com.smartfoxserver.v2.entities.Zone
Return the amount of seconds available for a User to reconnect to the system in case their socket connection goes down.
getUsersInGroup(String) - Method in class com.smartfoxserver.v2.entities.SFSZone
Get a list of Users from all Rooms in the provided Room Group
getUsersInGroup(String) - Method in interface com.smartfoxserver.v2.entities.Zone
Get a list of Users from all Rooms in the provided Room Group
getUserVariablesData() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getUserVariablesData() - Method in interface com.smartfoxserver.v2.entities.User
 
getUseTempBuddies() - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Check if the current Zone supports temporary Buddies
getUseTempBuddies() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Check if the current Zone supports temporary Buddies
getUtfString(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as String, with a max length of 32 KBytes.
getUtfString(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getUtfString(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as String using UTF-8 encoding.
getUtfString(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getUtfStringArray(int) - Method in interface com.smartfoxserver.v2.entities.data.ISFSArray
Get the element at the specified index as Collection of String.
getUtfStringArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArray
 
getUtfStringArray(int) - Method in class com.smartfoxserver.v2.entities.data.SFSArrayLite
 
getUtfStringArray(String) - Method in interface com.smartfoxserver.v2.entities.data.ISFSObject
Get the element for the specified key as a Collection of String.
getUtfStringArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObject
 
getUtfStringArray(String) - Method in class com.smartfoxserver.v2.entities.data.SFSObjectLite
 
getValue() - Method in enum com.smartfoxserver.bitswarm.data.MessagePriority
 
getValue() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyVariable
 
getValue() - Method in class com.smartfoxserver.v2.entities.variables.SFSUserVariable
Get the value of the variable as Object
getValue() - Method in interface com.smartfoxserver.v2.entities.variables.Variable
Get the value of the variable as Object
getValue() - Method in enum com.smartfoxserver.v2.util.ClientDisconnectionReason
 
getValue() - Method in interface com.smartfoxserver.v2.util.IDisconnectionReason
 
getVariable(String) - Method in interface com.smartfoxserver.v2.buddylist.Buddy
Get a Buddy Variable from its name
getVariable(String) - Method in interface com.smartfoxserver.v2.buddylist.BuddyProperties
 
getVariable(String) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddy
 
getVariable(String) - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyProperties
 
getVariable(String) - Method in interface com.smartfoxserver.v2.entities.Room
Get a Room Variable
getVariable(String) - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get a Room Variable
getVariable(String) - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getVariable(String) - Method in interface com.smartfoxserver.v2.entities.User
Return a UserVariable.
getVariable(String) - Method in interface com.smartfoxserver.v2.mmo.IMMOItem
Obtain a variable from the MMOItem via its name
getVariable(String) - Method in class com.smartfoxserver.v2.mmo.MMOItem
Obtain a variable from the MMOItem via its name
getVariables() - Method in interface com.smartfoxserver.v2.buddylist.Buddy
Get all BuddyVariables
getVariables() - Method in interface com.smartfoxserver.v2.buddylist.BuddyProperties
 
getVariables() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddy
 
getVariables() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyProperties
 
getVariables() - Method in interface com.smartfoxserver.v2.entities.Room
Get the full list of Room Variables in the Room
getVariables() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the full list of Room Variables in the Room
getVariables() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getVariables() - Method in interface com.smartfoxserver.v2.entities.User
Obtain the full list of UserVariables
getVariables() - Method in interface com.smartfoxserver.v2.mmo.IMMOItem
Get a list of all variables attached to the MMOItem
getVariables() - Method in class com.smartfoxserver.v2.mmo.MMOItem
Get a list of all variables attached to the MMOItem
getVariablesCount() - Method in interface com.smartfoxserver.v2.buddylist.BuddyProperties
 
getVariablesCount() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyProperties
 
getVariablesCount() - Method in interface com.smartfoxserver.v2.entities.Room
Get the total amount of Room Variables for this Room
getVariablesCount() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the total amount of Room Variables for this Room
getVariablesCount() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getVariablesCount() - Method in interface com.smartfoxserver.v2.entities.User
Return the number of UserVariables for this User
getVariablesCreatedByUser(User) - Method in interface com.smartfoxserver.v2.entities.Room
Get a list of Room Variables created by a specific User
getVariablesCreatedByUser(User) - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get a list of Room Variables created by a specific User
getVersion() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getWarningMessage() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getWarningMessage() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getWarningsBeforeKick() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getWarningsBeforeKick() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getWordFilter() - Method in class com.smartfoxserver.v2.entities.SFSZone
INTERNAL
getWordFilter() - Method in interface com.smartfoxserver.v2.entities.Zone
INTERNAL
getWordsFile() - Method in interface com.smartfoxserver.v2.util.IWordFilter
 
getWordsFile() - Method in class com.smartfoxserver.v2.util.SFSWordFilter
 
getWrittenBytes() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
The amount of data that was sent to the client so far
getWrittenBytes() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getZone() - Method in interface com.smartfoxserver.v2.buddylist.BuddyListManager
Get the parent Zone
getZone() - Method in class com.smartfoxserver.v2.buddylist.SFSBuddyListManager
Get the parent Zone
getZone() - Method in interface com.smartfoxserver.v2.entities.Room
Get the Zone managing this Room.
getZone() - Method in class com.smartfoxserver.v2.entities.SFSRoom
Get the Zone managing this Room.
getZone() - Method in class com.smartfoxserver.v2.entities.SFSUser
 
getZone() - Method in interface com.smartfoxserver.v2.entities.User
Get the Zone where the User is currently logged in
getZoneManager() - Method in class com.smartfoxserver.v2.entities.SFSZone
 
getZoneManager() - Method in interface com.smartfoxserver.v2.entities.Zone
 
getZoneManager() - Method in class com.smartfoxserver.v2.SmartFoxServer
 
getZoneName() - Method in interface com.smartfoxserver.v2.entities.BannedUser
 
getZoneName() - Method in class com.smartfoxserver.v2.entities.SFSBannedUser
 
globalPrintStackTrace - Static variable in class com.smartfoxserver.v2.exceptions.ExceptionMessageComposer
 
globalUserManager - Variable in class com.smartfoxserver.v2.api.SFSApi
 
goOnline(User, boolean, boolean) - Method in interface com.smartfoxserver.v2.api.ISFSBuddyApi
Activates/De-activates the Buddy ONLINE status of the User.
goOnline(User, boolean, boolean) - Method in class com.smartfoxserver.v2.api.SFSBuddyApi
Activates/De-activates the Buddy ONLINE status of the User.
GoOnline - Class in com.smartfoxserver.v2.controllers.system.buddylist
 
GoOnline - com.smartfoxserver.v2.controllers.SystemRequest
 
GoOnline() - Constructor for class com.smartfoxserver.v2.controllers.system.buddylist.GoOnline
 
GREATER_THAN - com.smartfoxserver.v2.entities.match.NumberMatch
Checks that Num1 > Num2
GREATER_THAN_OR_EQUAL_TO - com.smartfoxserver.v2.entities.match.NumberMatch
Checks that Num1 >= Num2
grid() - Static method in class com.smartfoxserver.v2.SmartFoxServer
 
GROUP_ID - Static variable in class com.smartfoxserver.v2.entities.match.RoomProperties
The Room group id
GUEST - com.smartfoxserver.v2.security.DefaultPermissionProfile
 
A B C D E F G H I J K L M N O P Q R S T U V W Z _ 
All Classes All Packages