Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _ 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abs() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector with all components in absolute values.
abs() - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector with all components in absolute values.
ACCEPT - Enum constant in enum class com.smartfoxserver.entities.invitation.InvitationResponse
Accept the invitation
ACTIVATION_INVALID_CODE - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
ACTIVATION_NO_ID - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
activationCodeField - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
(Optional) The name of the field used to store the auto-generate activation code.
activationCodeLength - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
(Optional) If the activationCodeField is used this property will indicate the length of the activation hash code.
activationErrorMessage - Variable in class com.smartfoxserver.components.login.LoginConfiguration
Customizable error message for inactive accounts
activationField - Variable in class com.smartfoxserver.components.login.LoginConfiguration
An optional field to check if the user account was activated.
active - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
active - Variable in class com.smartfoxserver.db.SFSDBManager
 
active - Variable in class com.smartfoxserver.db.DBConfig
Toggles the DBManager
add(SFSDataWrapper) - Method in interface com.smartfoxserver.entities.data.ISFSArray
 
add(SFSDataWrapper) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addBool(boolean) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a boolean
addBool(boolean) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addBoolArray(Collection<Boolean>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add an collection of boolean
addBoolArray(Collection<Boolean>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addBuddy(Buddy) - Method in interface com.smartfoxserver.buddylist.BuddyList
Used by the BuddyManager only.
addBuddy(Buddy) - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
addBuddy(User, String, boolean, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSBuddyApi
Adds a new buddy to the BuddyList of the specified User.
addBuddy(User, String, boolean, boolean, boolean) - Method in class com.smartfoxserver.api.SFSBuddyApi
Adds a new buddy to the BuddyList of the specified User.
addBuddy(String, String, boolean) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Use the SFSBuddyAPI
addBuddy(String, String, boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Use the SFSBuddyAPI
AddBuddy - Class in com.smartfoxserver.controllers.system.buddylist
 
AddBuddy - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
AddBuddy() - Constructor for class com.smartfoxserver.controllers.system.buddylist.AddBuddy
 
addByte(byte) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a byte (signed 8-bit)
addByte(byte) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addByteArray(byte[]) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add an array of bytes
addByteArray(byte[]) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addCreatedRoom(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
addCreatedRoom(Room) - Method in interface com.smartfoxserver.entities.User
 
addDouble(double) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a byte (signed decimal 64-bit)
addDouble(double) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addDoubleArray(Collection<Double>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of double
addDoubleArray(Collection<Double>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addEventHandler(SFSEventType, IServerEventHandler) - Method in class com.smartfoxserver.extensions.SFSExtension
 
addEventHandler(SFSEventType, Class<?>) - Method in class com.smartfoxserver.extensions.SFSExtension
Add a request handler for a specific event type.
addEventListener(SFSEventType, ISFSEventListener) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Allows to add a listener for a specific server event.
addEventListener(SFSEventType, ISFSEventListener) - Method in interface com.smartfoxserver.extensions.ISFSExtension
Allows to add a listener for a specific server event.
addExpression(String) - Method in class com.smartfoxserver.util.SFSWordFilter
Add a new regular expression to match unwanted words for the BLACK_LIST mode
addFilter(String, SysControllerFilter) - Method in interface com.smartfoxserver.controllers.filter.ISystemFilterChain
Add a filter to the Filter Chain.
addFilter(String, SysControllerFilter) - Method in class com.smartfoxserver.controllers.filter.SysControllerFilterChain
 
addFilter(String, SFSExtensionFilter) - Method in interface com.smartfoxserver.extensions.filter.IFilterChain
Add a filter to the Filter Chain.
addFilter(String, SFSExtensionFilter) - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilterChain
Add a filter to the Filter Chain.
addFilter(String, SFSExtensionFilter) - Method in class com.smartfoxserver.extensions.SFSExtension
Add a filter to the Extension
addFloat(float) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a byte (signed decimal 32-bit)
addFloat(float) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addFloatArray(Collection<Float>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of float
addFloatArray(Collection<Float>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addInfo(String) - Method in class com.smartfoxserver.exceptions.ExceptionMessageComposer
 
addInt(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a byte (signed 32-bit)
addInt(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addIntArray(Collection<Integer>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of int
addIntArray(Collection<Integer>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addJoinedRoom(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
addJoinedRoom(Room) - Method in interface com.smartfoxserver.entities.User
 
addLong(long) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a byte (signed 64-bit)
addLong(long) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addLongArray(Collection<Long>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of long
addLongArray(Collection<Long>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addNull() - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a null field to the Object.
addNull() - Method in class com.smartfoxserver.entities.data.SFSArray
 
addParameter(String) - Method in class com.smartfoxserver.exceptions.SFSErrorData
 
addPersistentRoomVarReference(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
addPersistentRoomVarReference(Room) - Method in interface com.smartfoxserver.entities.User
 
addReadBytes(long) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
addReadBytes(long) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
addRequestFilter(SystemRequest, int) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
addRequestFilter(T, int) - Method in interface com.smartfoxserver.util.IFloodFilter
 
addRequestHandler(String, IClientRequestHandler) - Method in class com.smartfoxserver.extensions.SFSExtension
 
addRequestHandler(String, Class<?>) - Method in class com.smartfoxserver.extensions.SFSExtension
Add a request handler for a specific request id.
addRoom(Room) - Method in class com.smartfoxserver.entities.SFSZone
 
addRoom(Room) - Method in interface com.smartfoxserver.entities.Zone
 
addSFSArray(ISFSArray) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a nested ISFSArray
addSFSArray(ISFSArray) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addSFSObject(ISFSObject) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a nested ISFSObject
addSFSObject(ISFSObject) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addShort(short) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a byte (signed 16-bit)
addShort(short) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addShortArray(Collection<Short>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of short
addShortArray(Collection<Short>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addShortString(String) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a UTF encoded string with max length of 255 bytes
addShortString(String) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addShortStringArray(Collection<String>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of UTF encoded strings, each string limited to a max of 255 bytes The collection is also limited to a max of 32768 elements
addShortStringArray(Collection<String>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addString(String) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a UTF encoded string with max length of 32768 bytes
addString(String) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addStringArray(Collection<String>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of UTF encoded strings, each string limited to a max of 32768 bytes The collection is also limited to a max of 32768 elements
addStringArray(Collection<String>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addTcpDroppedPackets(int) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
addTcpDroppedPackets(int) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
addText(String) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a UTF encoded long String with max length of 2 GBytes
addText(String) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addUdpDroppedPackets(int) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
addUdpDroppedPackets(int) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
addUser(User) - Method in interface com.smartfoxserver.entities.Room
 
addUser(User) - Method in class com.smartfoxserver.entities.SFSRoom
addUser(User, boolean) - Method in interface com.smartfoxserver.entities.Room
 
addUser(User, boolean) - Method in class com.smartfoxserver.entities.SFSRoom
addUser(User, boolean) - Method in class com.smartfoxserver.game.SFSGame
 
addUser(User, boolean) - Method in class com.smartfoxserver.mmo.MMORoom
 
addUser(String, int, TimeUnit) - Method in class com.smartfoxserver.entities.RoomBanLedger
 
addVariable(String) - Method in class com.smartfoxserver.controllers.filter.ReadOnlyUserVariablesFilter
Add a new User Variable name to be set as read-only
addVector2(SFSVector2) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a SFSVector2 (2x float 32bit)
addVector2(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addVector2Array(Collection<SFSVector2>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of SFSVector2
addVector2Array(Collection<SFSVector2>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addVector3(SFSVector3) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a SFSVector3 (3x float 32bit)
addVector3(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addVector3Array(Collection<SFSVector3>) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Add a collection of SFSVector3
addVector3Array(Collection<SFSVector3>) - Method in class com.smartfoxserver.entities.data.SFSArray
 
addWrittenBytes(long) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
addWrittenBytes(long) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
ADMINISTRATOR - Enum constant in enum class com.smartfoxserver.security.DefaultPermissionProfile
 
AdminMessage - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
adminName - Variable in class com.smartfoxserver.entities.SFSBannedUser
 
Advanced features - Search tag in class com.smartfoxserver.entities.match.MatchExpression
Section
Advanced Settings - Search tag in class com.smartfoxserver.api.CreateRoomSettings
Section
Advanced Topics - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
allowAudioStreaming() - Method in class com.smartfoxserver.api.CreateRoomSettings
If true, audio streaming is allowed in the Room.
allowedRecoveryFields - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.PasswordRecovery
Allows to specify which field in the DB should be used for password recovery.
allowGuests - Variable in class com.smartfoxserver.components.login.LoginConfiguration
If set to true it will allow guest users to enter with a temporary name.
allowOfflineBuddyVariables() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Check if the "offline" (persistent) Buddy Variables are supported in the current Zone
allowOfflineBuddyVariables() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Check if the "offline" (persistent) Buddy Variables are supported in the current Zone
allowOwnerOnlyInvitation() - Method in class com.smartfoxserver.api.CreateRoomSettings
If false, any User joined in the Room will be able to invite players in the Room.
and(String, IMatcher, Object) - Method in class com.smartfoxserver.entities.match.MatchExpression
Concatenates two expressions with the logical AND operator.
angle() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns the angle of this vector in radians, measured from the positive x-axis.
APIManager - Class in com.smartfoxserver.api
Provides access to the standard server API and the specialized API such as BuddyAPI, GameApi, MMOApi
APIManager() - Constructor for class com.smartfoxserver.api.APIManager
 
apply(String) - Method in class com.smartfoxserver.util.SFSWordFilter
Applies the filter to a generic string
apply(String, User) - Method in class com.smartfoxserver.util.SFSWordFilter
Applies the filter to a message/string of a User.
ARRAY - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
aspect() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns the aspect ratio of this vector, the ratio of x to y.
AUTO - Enum constant in enum class com.smartfoxserver.extensions.ExtensionReloadMode
Extension is reloaded automatically, when a change in the relative .jar file is detected
AutoJoin - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 

B

BAN - Enum constant in enum class com.smartfoxserver.util.ClientDisconnectionReason
The client was banned (by a mod or admin User)
banDurationMinutes - Variable in class com.smartfoxserver.entities.SFSBannedUser
 
BanMode - Enum Class in com.smartfoxserver.entities.managers
 
BANNED_IN_ROOM - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
BannedUser - Interface in com.smartfoxserver.entities
 
banTimeMillis - Variable in class com.smartfoxserver.entities.SFSBannedUser
 
banUser(User, int, TimeUnit) - Method in interface com.smartfoxserver.entities.Room
 
banUser(User, int, TimeUnit) - Method in class com.smartfoxserver.entities.SFSRoom
banUser(User, User, int, BanMode, String, String, int) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
banUser(User, User, String, BanMode, int, int) - Method in interface com.smartfoxserver.api.ISFSApi
Ban a User.
banUser(User, User, String, BanMode, int, int) - Method in class com.smartfoxserver.api.SFSApi
Ban a User.
banUser(User, User, String, String, BanMode, int, int) - Method in interface com.smartfoxserver.api.ISFSApi
Ban a User.
banUser(User, User, String, String, BanMode, int, int) - Method in class com.smartfoxserver.api.SFSApi
Ban a User.
banUser(String, String, int, BanMode, String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
banUser(String, String, int, BanMode, String, String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
BanUser - Class in com.smartfoxserver.controllers.system
 
BanUser - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
BanUser() - Constructor for class com.smartfoxserver.controllers.system.BanUser
 
banUserFromRoom(List<User>, Room, String, int, TimeUnit) - Method in interface com.smartfoxserver.api.ISFSApi
Bans a User from a Room.
banUserFromRoom(List<User>, Room, String, int, TimeUnit) - Method in class com.smartfoxserver.api.SFSApi
Bans a User from a Room.
BanUsersFromRoom - Class in com.smartfoxserver.controllers.system
 
BanUsersFromRoom - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
BanUsersFromRoom() - Constructor for class com.smartfoxserver.controllers.system.BanUsersFromRoom
 
BaseClientRequestHandler - Class in com.smartfoxserver.extensions
Using SFSExtension as the base class for an Extension we can register separate request handlers for every supported client request.
BaseClientRequestHandler() - Constructor for class com.smartfoxserver.extensions.BaseClientRequestHandler
 
baseDataFolder - Variable in class com.smartfoxserver.persistence.room.FileRoomStorageConfig
The default path for Room data is server/data/RoomData.
BaseGameInvitationCallback - Class in com.smartfoxserver.game
Basic invitation
BaseGameInvitationCallback(Room, boolean) - Constructor for class com.smartfoxserver.game.BaseGameInvitationCallback
Create a new Callback object keeping track of the Game Room
BaseMMOItem - Class in com.smartfoxserver.mmo
 
BaseMMOItem() - Constructor for class com.smartfoxserver.mmo.BaseMMOItem
 
BaseServerEventHandler - Class in com.smartfoxserver.extensions
Using SFSExtension as the base class for an Extension we can register separate handlers for different server side events.
BaseServerEventHandler() - Constructor for class com.smartfoxserver.extensions.BaseServerEventHandler
 
BaseSFSExtension - Class in com.smartfoxserver.extensions
SFSExtension's base class.
Use SFSExtension instead
BaseSFSExtension() - Constructor for class com.smartfoxserver.extensions.BaseSFSExtension
 
BaseStorageConfig - Class in com.smartfoxserver.persistence.room
Base class for Storage Configuration
BaseStorageConfig() - Constructor for class com.smartfoxserver.persistence.room.BaseStorageConfig
 
Basic Settings - Search tag in class com.smartfoxserver.api.CreateRoomSettings
Section
BB_REMOTE_IP - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 
BBCLIENT - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 
blockBuddy(User, String, boolean, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSBuddyApi
Block/Unblock a Buddy in the owner's BuddyList Blocked buddies won't be able to see the owner online status or send messages to that User
blockBuddy(User, String, boolean, boolean, boolean) - Method in class com.smartfoxserver.api.SFSBuddyApi
Block/Unblock a Buddy in the owner's BuddyList Blocked buddies won't be able to see the owner online status or send messages to that User
BlockBuddy - Class in com.smartfoxserver.controllers.system.buddylist
 
BlockBuddy - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
BlockBuddy() - Constructor for class com.smartfoxserver.controllers.system.buddylist.BlockBuddy
 
Blocked Buddies - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
BLUEBOX - Enum constant in enum class com.smartfoxserver.bitswarm.sessions.SessionType
A http tunneled session, not using persistent socket.
BOOL - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
BOOL - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
BOOL_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
BoolMatch - Enum Class in com.smartfoxserver.entities.match
This matcher is used in MatchExpressions to check boolean conditions
Buddy - Interface in com.smartfoxserver.buddylist
 
BUDDY - Enum constant in enum class com.smartfoxserver.buddylist.SFSBuddyEventParam
A Buddy item in a Buddy List
BUDDY_ADD - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a User is added in the Buddy List of another client.
BUDDY_BLOCK - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a Buddy is blocked in User's Buddy List.
BUDDY_BLOCK_FAILURE - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
BUDDY_BLOCK_STAUTS - Enum constant in enum class com.smartfoxserver.buddylist.SFSBuddyEventParam
The "blocked" status of a Buddy in a BuddyList
BUDDY_IS_ONLINE - Enum constant in enum class com.smartfoxserver.buddylist.SFSBuddyEventParam
The Online state of a Buddy in a BuddyList
BUDDY_LIST - Enum constant in enum class com.smartfoxserver.buddylist.SFSBuddyEventParam
A User's Buddy List
BUDDY_LIST_FULL - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
BUDDY_LIST_INIT - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a client initializes its Buddy List.
BUDDY_LIST_LOAD_FAILURE - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
BUDDY_MESSAGE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a Buddy Message is received in the Zone.
BUDDY_ONLINE_STATE_CHANGE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a Buddy changes its online state.
BUDDY_REMOVE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a User is removed in the Buddy List of another client.
BUDDY_STATE - Enum constant in enum class com.smartfoxserver.buddylist.SFSBuddyEventParam
The custom state of a Buddy in a BuddyList
BUDDY_TOO_MANY_VARIABLES - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
BUDDY_VARIABLES_UPDATE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a Buddy Variables are set by a User.
buddyApi - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
BuddyList - Interface in com.smartfoxserver.buddylist
 
BuddyListManager - Interface in com.smartfoxserver.buddylist
 
buddyLists - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
BuddyMessage - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
BuddyOnlineState - Enum Class in com.smartfoxserver.buddylist
 
BuddyProperties - Interface in com.smartfoxserver.buddylist
The BuddyProperties class is attached to each User and represents the Buddy status of each User.
BuddySerializerFactory - Class in com.smartfoxserver.buddylist
 
BuddySerializerFactory() - Constructor for class com.smartfoxserver.buddylist.BuddySerializerFactory
 
Buddy State message - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
buddyStates - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
buddyStorage - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
BuddyStorage - Interface in com.smartfoxserver.buddylist.storage
 
BuddyUtils - Class in com.smartfoxserver.buddylist
 
BuddyUtils() - Constructor for class com.smartfoxserver.buddylist.BuddyUtils
 
BuddyVariable - Interface in com.smartfoxserver.buddylist
 
build() - Method in class com.smartfoxserver.entities.SFSVersion
 
BV_NICKNAME - Static variable in class com.smartfoxserver.buddylist.ReservedBuddyVariables
 
BV_ONLINE - Static variable in class com.smartfoxserver.buddylist.ReservedBuddyVariables
 
BV_STATE - Static variable in class com.smartfoxserver.buddylist.ReservedBuddyVariables
 
bvCacheSize - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
BY_ADDRESS - Enum constant in enum class com.smartfoxserver.entities.managers.BanMode
 
BY_NAME - Enum constant in enum class com.smartfoxserver.entities.managers.BanMode
 
BYTE - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
BYTE - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
BYTE_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 

C

CAPACITY_CHANGE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomSettings
Toggles the ability to change the capacity of a Room at runtime
ceil() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector with all components rounded up to the nearest integer.
ceil() - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector with all components rounded up to the nearest integer.
changeRoomCapacity(Room, int, int) - Method in class com.smartfoxserver.entities.SFSZone
changeRoomCapacity(Room, int, int) - Method in interface com.smartfoxserver.entities.Zone
 
changeRoomCapacity(User, Room, int, int) - Method in interface com.smartfoxserver.api.ISFSApi
Changes the capacity (max number of Users and Spectators) in the Room.
changeRoomCapacity(User, Room, int, int) - Method in class com.smartfoxserver.api.SFSApi
Changes the capacity (max number of Users and Spectators) in the Room.
ChangeRoomCapacity - Class in com.smartfoxserver.controllers.system
 
ChangeRoomCapacity - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
ChangeRoomCapacity() - Constructor for class com.smartfoxserver.controllers.system.ChangeRoomCapacity
 
changeRoomName(Room, String) - Method in class com.smartfoxserver.entities.SFSZone
changeRoomName(Room, String) - Method in interface com.smartfoxserver.entities.Zone
 
changeRoomName(User, Room, String) - Method in interface com.smartfoxserver.api.ISFSApi
Rename an existing Room.
changeRoomName(User, Room, String) - Method in class com.smartfoxserver.api.SFSApi
Rename an existing Room.
ChangeRoomName - Class in com.smartfoxserver.controllers.system
 
ChangeRoomName - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
ChangeRoomName() - Constructor for class com.smartfoxserver.controllers.system.ChangeRoomName
 
changeRoomPassword(User, Room, String) - Method in interface com.smartfoxserver.api.ISFSApi
Changes the Room password and the Room password-state.
changeRoomPassword(User, Room, String) - Method in class com.smartfoxserver.api.SFSApi
Changes the Room password and the Room password-state.
ChangeRoomPassword - Class in com.smartfoxserver.controllers.system
 
ChangeRoomPassword - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
ChangeRoomPassword() - Constructor for class com.smartfoxserver.controllers.system.ChangeRoomPassword
 
changeRoomPasswordState(Room, String) - Method in class com.smartfoxserver.entities.SFSZone
changeRoomPasswordState(Room, String) - Method in interface com.smartfoxserver.entities.Zone
 
checkAndRemove(Room) - Method in class com.smartfoxserver.entities.SFSZone
 
checkAndRemove(Room) - Method in interface com.smartfoxserver.entities.Zone
 
checkForDuplicateEmails - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Checks that a user is not registering with an existing email address.
checkForDuplicateUserNames - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Checks that a user is not registering with an existing user name.
checkSecurePassword(ISession, String, String) - Method in interface com.smartfoxserver.api.ISFSApi
Check an encrypted password sent by the User at login time.
checkSecurePassword(ISession, String, String) - Method in class com.smartfoxserver.api.SFSApi
Check an encrypted password sent by the User at login time.
clearAll() - Method in interface com.smartfoxserver.buddylist.BuddyList
 
clearAll() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
clearAll() - Method in interface com.smartfoxserver.controllers.filter.ISystemFilterChain
Remove all current filter
clearAll() - Method in class com.smartfoxserver.controllers.filter.SysControllerFilterChain
 
clearAllFilters() - Method in interface com.smartfoxserver.util.IFloodFilter
 
clearAllFilters() - Method in class com.smartfoxserver.util.SFSFloodFilter
 
clearAllHandlers() - Method in class com.smartfoxserver.extensions.SFSExtension
Removes all event and request handlers
clearExpressions() - Method in class com.smartfoxserver.util.SFSWordFilter
Clears all expressions
clearFilter() - Method in class com.smartfoxserver.controllers.filter.ReadOnlyUserVariablesFilter
Resets the filter: all variable names are removed.
clearFilters() - Method in class com.smartfoxserver.extensions.SFSExtension
Removes all filters from the Extension
ClientDisconnectionReason - Enum Class in com.smartfoxserver.util
 
clientIncomingData - Variable in class com.smartfoxserver.components.login.LoginData
The optional SFSObject sent by the client with his LoginRequest
clientOutGoingData - Variable in class com.smartfoxserver.components.login.LoginData
The optional outgoing SFSObject that will be sent to the client with the Login response
clone() - Method in class com.smartfoxserver.buddylist.SFSBuddyVariable
 
clone() - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
Deprecated.
close() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
close() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
CLUSTER_EVENT_PARAMS - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
A Map<String,Object> of parameters sent from a Node in the Overcast Cluster All values in the Map must be Serializable
ClusterCreateGame - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
ClusterInviteUsers - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
ClusterJoinGame - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
ClusterJoinOrCreate - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
com.smartfoxserver.annotations - package com.smartfoxserver.annotations
 
com.smartfoxserver.buddylist - package com.smartfoxserver.buddylist
 
com.smartfoxserver.buddylist.storage - package com.smartfoxserver.buddylist.storage
 
com.smartfoxserver.components.login - package com.smartfoxserver.components.login
 
com.smartfoxserver.components.signup - package com.smartfoxserver.components.signup
 
com.smartfoxserver.controllers.filter - package com.smartfoxserver.controllers.filter
 
com.smartfoxserver.controllers.system - package com.smartfoxserver.controllers.system
 
com.smartfoxserver.controllers.system.buddylist - package com.smartfoxserver.controllers.system.buddylist
 
com.smartfoxserver.controllers.system.game - package com.smartfoxserver.controllers.system.game
 
com.smartfoxserver.db - package com.smartfoxserver.db
 
com.smartfoxserver.entities - package com.smartfoxserver.entities
 
com.smartfoxserver.entities.data - package com.smartfoxserver.entities.data
 
com.smartfoxserver.entities.invitation - package com.smartfoxserver.entities.invitation
 
com.smartfoxserver.exceptions - package com.smartfoxserver.exceptions
 
com.smartfoxserver.extensions.filter - package com.smartfoxserver.extensions.filter
 
com.smartfoxserver.game - package com.smartfoxserver.game
 
com.smartfoxserver.security - package com.smartfoxserver.security
 
COMMAND_PREFIX - Static variable in class com.smartfoxserver.components.signup.SignUpAssistantComponent
 
config - Variable in class com.smartfoxserver.db.SFSDBManager
 
connectionString - Variable in class com.smartfoxserver.db.DBConfig
The connection string to the database, according to the JDBC standard notation.
contains(Object) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Checks if a specific element is contained in the array
contains(Object) - Method in class com.smartfoxserver.entities.data.SFSArray
 
CONTAINS - Enum constant in enum class com.smartfoxserver.entities.match.StringMatch
Check that Str1.indexOf(Str2) > -1
containsBuddy(String) - Method in interface com.smartfoxserver.buddylist.BuddyList
Checks if a Buddy is contained in the BuddyList
containsBuddy(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
containsGroup(String) - Method in class com.smartfoxserver.entities.SFSZone
Check if the Zone contains the specified Group
containsGroup(String) - Method in interface com.smartfoxserver.entities.Zone
Check if the Zone contains the specified Group
containsKey(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Looks for a specific key in the object
containsKey(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
containsMMOItem(int) - Method in class com.smartfoxserver.mmo.MMORoom
Check if the provided MMOItem id is managed by this Room
containsMMOItem(BaseMMOItem) - Method in class com.smartfoxserver.mmo.MMORoom
Check if the provided MMOItem is managed by this Room
containsPermissionProfile(short) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
containsPermissionProfile(short) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
containsPermissionProfile(String) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
containsPermissionProfile(String) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
containsProperty(Object) - Method in interface com.smartfoxserver.entities.Room
Checks whether a custom property exists or not
containsProperty(Object) - Method in class com.smartfoxserver.entities.SFSRoom
Checks whether a custom property exists or not
containsProperty(Object) - Method in class com.smartfoxserver.entities.SFSUser
 
containsProperty(Object) - Method in class com.smartfoxserver.entities.SFSZone
Checks the existence of a Zone property
containsProperty(Object) - Method in interface com.smartfoxserver.entities.User
Checks whether a custom property exists or not
containsProperty(Object) - Method in interface com.smartfoxserver.entities.Zone
Checks the existence of a Zone property
containsProperty(String) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
containsProperty(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
containsPublicGroup(String) - Method in class com.smartfoxserver.entities.SFSZone
Check if the Zone contains the specified public Group
containsPublicGroup(String) - Method in interface com.smartfoxserver.entities.Zone
Check if the Zone contains the specified public Group
containsSystemProperty(String) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
containsSystemProperty(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
containsUser(User) - Method in interface com.smartfoxserver.entities.Room
Checks if the specified User is joined in the Room
containsUser(User) - Method in class com.smartfoxserver.entities.SFSRoom
Checks if the specified User is joined in the Room
containsUser(String) - Method in interface com.smartfoxserver.entities.Room
Checks if the specified User is joined in the Room
containsUser(String) - Method in class com.smartfoxserver.entities.SFSRoom
Checks if the specified User is joined in the Room
containsVariable(String) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
containsVariable(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
containsVariable(String) - Method in interface com.smartfoxserver.entities.Room
Checks if a certain Room Variable name exists
containsVariable(String) - Method in class com.smartfoxserver.entities.SFSRoom
Checks if a certain Room Variable name exists
containsVariable(String) - Method in class com.smartfoxserver.entities.SFSUser
 
containsVariable(String) - Method in interface com.smartfoxserver.entities.User
Checks whether or not the User has a specific UserVariable set
CONTINUE - Enum constant in enum class com.smartfoxserver.extensions.filter.FilterAction
Allow the Filter Chain to continue executing
Country - Class in com.smartfoxserver.util
Provides country name and iso code for geolocation.
Country(Country) - Constructor for class com.smartfoxserver.util.Country
 
CREATE_ROOM_BAD_GROUP - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
CREATE_ROOM_EXCEED_USER_LIMIT - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
CREATE_ROOM_WRONG_PARAMETER - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
CREATE_ROOM_ZONE_FULL - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
createGame(Zone, CreateSFSGameSettings, User) - Method in interface com.smartfoxserver.api.ISFSGameApi
Create an SFSGame Room and automatically update the clients and trigger a server event
createGame(Zone, CreateSFSGameSettings, User) - Method in class com.smartfoxserver.api.SFSGameApi
Create an SFSGame Room and automatically update the clients and trigger a server event
createGame(Zone, CreateSFSGameSettings, User, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSGameApi
Create an SFSGame Room.
createGame(Zone, CreateSFSGameSettings, User, boolean, boolean) - Method in class com.smartfoxserver.api.SFSGameApi
Create an SFSGame Room.
CreateMMORoomSettings - Class in com.smartfoxserver.mmo
The MMORoom Settings extends the CreateRoomSettings adding new functionalities that are unique to an MMORoom.
CreateMMORoomSettings() - Constructor for class com.smartfoxserver.mmo.CreateMMORoomSettings
 
CreateMMORoomSettings.MapLimits - Class in com.smartfoxserver.mmo
Container data class that holds the minimum and maximum coordinates available in virtual World.
createNewRoom(CreateRoomSettings) - Method in class com.smartfoxserver.entities.DefaultRoomFactory
 
createNewRoom(CreateRoomSettings) - Method in interface com.smartfoxserver.entities.IRoomFactory
 
createNPC(String, Zone) - Method in interface com.smartfoxserver.api.ISFSApi
Create a connection-less NPC (Non-Player Character).
createNPC(String, Zone) - Method in class com.smartfoxserver.api.SFSApi
Create a connection-less NPC (Non-Player Character).
createNPC(String, Zone, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Create a connection-less NPC (Non-Player Character).
createNPC(String, Zone, boolean) - Method in class com.smartfoxserver.api.SFSApi
Create a connection-less NPC (Non-Player Character).
createRoom(CreateRoomSettings) - Method in class com.smartfoxserver.entities.SFSZone
createRoom(CreateRoomSettings) - Method in interface com.smartfoxserver.entities.Zone
 
createRoom(CreateRoomSettings, User) - Method in class com.smartfoxserver.entities.SFSZone
createRoom(CreateRoomSettings, User) - Method in interface com.smartfoxserver.entities.Zone
 
createRoom(Zone, CreateRoomSettings, User) - Method in interface com.smartfoxserver.api.ISFSApi
Create a new Room
createRoom(Zone, CreateRoomSettings, User) - Method in class com.smartfoxserver.api.SFSApi
Create a new Room
createRoom(Zone, CreateRoomSettings, User, boolean, Room) - Method in interface com.smartfoxserver.api.ISFSApi
Create a new Room
createRoom(Zone, CreateRoomSettings, User, boolean, Room) - Method in class com.smartfoxserver.api.SFSApi
Create a new Room
createRoom(Zone, CreateRoomSettings, User, boolean, Room, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
 
createRoom(Zone, CreateRoomSettings, User, boolean, Room, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
CreateRoom - Class in com.smartfoxserver.controllers.system
 
CreateRoom - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
CreateRoom() - Constructor for class com.smartfoxserver.controllers.system.CreateRoom
 
CreateRoomSettings - Class in com.smartfoxserver.api
This class specifies the configuration of a Room that we want to create: from its name and user capacity, to the events it can triggers, to its permissions and lots more.
CreateRoomSettings() - Constructor for class com.smartfoxserver.api.CreateRoomSettings
 
CreateRoomSettings.RoomExtensionSettings - Class in com.smartfoxserver.api
Define the Extension settings of the Room
CreateSFSGame - Class in com.smartfoxserver.controllers.system.game
 
CreateSFSGame - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
CreateSFSGame() - Constructor for class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
CreateSFSGameSettings - Class in com.smartfoxserver.game
This class provides all the settings required to create an SFSGame.
CreateSFSGameSettings() - Constructor for class com.smartfoxserver.game.CreateSFSGameSettings
 
createTableSQL - Variable in class com.smartfoxserver.persistence.room.DBRoomStorageConfig
This is the SQL statement used for creating the table, if it doesn't exist.
cross(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns the 2D cross product (also known as the perpendicular dot product or wedge product) of this vector and the specified vector.
cross(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns the cross product of this vector and the specified vector.
CUSTOM - Enum constant in enum class com.smartfoxserver.persistence.room.RoomStorageMode
Uses custom implemented storage class
CUSTOM_ERROR - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
customDbManager - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
(Optional) A custom Database Manager in case you don't want to use the default Zone's DB Manager.
customDBManager - Variable in class com.smartfoxserver.components.login.LoginConfiguration
ADVANCED
customEmailFields - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.EmailConfig
(Optional) a map of place holders and relative values to be populated in the email body.
CustomFieldPasswordRecovery - Class in com.smartfoxserver.components.signup
 
CustomFieldPasswordRecovery() - Constructor for class com.smartfoxserver.components.signup.CustomFieldPasswordRecovery
 
customLogin(ISFSObject, IRequest, Zone) - Method in class com.smartfoxserver.controllers.system.Login
 
customPasswordCheck - Variable in class com.smartfoxserver.components.login.LoginConfiguration
Allows to bypass the default password check.
customStorageClassName - Variable in class com.smartfoxserver.persistence.room.BaseStorageConfig
Populate this field only If you want to bypass the standard storage classes with a custom implementation.

D

DATA_BUFFER - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 
DB_STORAGE - Enum constant in enum class com.smartfoxserver.persistence.room.RoomStorageMode
Uses database-driven storage
DBConfig - Class in com.smartfoxserver.db
The DBConfig class describes all the settings necessary to setup a JDBC connection to the database and to configure the connection pool.
DBConfig() - Constructor for class com.smartfoxserver.db.DBConfig
 
dbManager - Variable in class com.smartfoxserver.persistence.room.DBRoomStorageConfig
An custom DBManager, by default the one configured in the Zone is used
DBRoomStorageConfig - Class in com.smartfoxserver.persistence.room
Provides configuration settings for the Database based Room persistence API
DBRoomStorageConfig() - Constructor for class com.smartfoxserver.persistence.room.DBRoomStorageConfig
 
DEBUG - Enum constant in enum class com.smartfoxserver.extensions.ExtensionLogLevel
 
debugSQL - Variable in class com.smartfoxserver.persistence.room.DBRoomStorageConfig
When set to true it will log the SQL of each performed query
DEFAULT - Enum constant in enum class com.smartfoxserver.entities.SFSRoomRemoveMode
The default mode works in two different ways depending on the type of Room: Regular: the room is removed when the Room is empty and its creator is not connected anymore Game: the room is removed when the Room is empty
DEFAULT_AS_SPECT - Static variable in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
DEFAULT_EXPIRY_SEC - Static variable in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
DefaultBuddySerializer - Class in com.smartfoxserver.buddylist
 
DefaultBuddySerializer() - Constructor for class com.smartfoxserver.buddylist.DefaultBuddySerializer
 
DefaultPermissionProfile - Enum Class in com.smartfoxserver.security
 
DefaultPlayerIdGenerator - Class in com.smartfoxserver.util
 
DefaultPlayerIdGenerator() - Constructor for class com.smartfoxserver.util.DefaultPlayerIdGenerator
 
DefaultRoomFactory - Class in com.smartfoxserver.entities
 
DefaultRoomFactory() - Constructor for class com.smartfoxserver.entities.DefaultRoomFactory
 
destroy() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
destroy() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
destroy() - Method in interface com.smartfoxserver.buddylist.storage.BuddyStorage
Destroy the Storage class.
destroy() - Method in class com.smartfoxserver.buddylist.storage.FSBuddyStorage
 
destroy() - Method in class com.smartfoxserver.components.login.LoginAssistantComponent
Releases the Component's resources.
destroy() - Method in interface com.smartfoxserver.entities.Room
 
destroy() - Method in class com.smartfoxserver.entities.SFSRoom
 
destroy() - Method in interface com.smartfoxserver.extensions.filter.IFilter
This is invoked when the Extension is destroyed
destroy() - Method in interface com.smartfoxserver.extensions.filter.IFilterChain
Shut down the Filter Chain.
destroy() - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilterChain
Shut down the Filter Chain.
destroy() - Method in interface com.smartfoxserver.extensions.ISFSExtension
This method is called once by the Server when the Extension must be shut down (e.g. before a server restart or before the Extension code is reloaded)
destroy() - Method in class com.smartfoxserver.extensions.SFSExtension
 
destroy() - Method in class com.smartfoxserver.mmo.MMORoom
 
destroy() - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Invoked by the system when the Storage class is being removed The method is your last chance to release open resources such as local files, database connections etc...
destroy(Object) - Method in class com.smartfoxserver.api.APIManager
 
destroy(Object) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
destroy(Object) - Method in class com.smartfoxserver.db.EmbeddedDBService
 
destroy(Object) - Method in class com.smartfoxserver.db.SFSDBManager
 
destroy(Object) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
destroy(Object) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
destroy(Object) - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
 
destroy(Object) - Method in class com.smartfoxserver.util.SFSWordFilter
 
destroy(Object) - Method in class com.smartfoxserver.util.TaskScheduler
 
disconnect(ISession) - Method in interface com.smartfoxserver.api.ISFSApi
Disconnect a Session abruptly.
disconnect(ISession) - Method in class com.smartfoxserver.api.SFSApi
Removes a Session and the User connected with that session, if one exists
disconnect(ISession, int) - Method in interface com.smartfoxserver.api.ISFSApi
Works like ISFSApi.disconnect(ISession) with an extra delay in seconds
disconnect(ISession, int) - Method in class com.smartfoxserver.api.SFSApi
 
disconnect(IDisconnectionReason) - Method in class com.smartfoxserver.entities.SFSUser
 
disconnect(IDisconnectionReason) - Method in interface com.smartfoxserver.entities.User
 
DISCONNECTION_REASON - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
A reason for the disconnection event, where applicable ( ClientDisconnectionReason )
disconnectUser(User) - Method in interface com.smartfoxserver.api.ISFSApi
Disconnect the User abruptly.
disconnectUser(User) - Method in class com.smartfoxserver.api.SFSApi
Disconnect the User abruptly.
disconnectUser(User, IDisconnectionReason) - Method in interface com.smartfoxserver.api.ISFSApi
Disconnect a User indicating a specific disconnection reason (for example because the User was Idle).
disconnectUser(User, IDisconnectionReason) - Method in class com.smartfoxserver.api.SFSApi
Disconnect a User indicating a specific disconnection reason (for example because the User was Idle).
disconnectUser(User, IDisconnectionReason, int) - Method in interface com.smartfoxserver.api.ISFSApi
Works like ISFSApi.disconnectUser(User, IDisconnectionReason) with an extra delay in seconds
disconnectUser(User, IDisconnectionReason, int) - Method in class com.smartfoxserver.api.SFSApi
Works like ISFSApi.disconnectUser(User, IDisconnectionReason) with an extra delay in seconds
distanceSquaredTo(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns the squared distance between this vector and the specified vector.
distanceSquaredTo(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns the squared distance between this vector and the specified vector.
distanceTo(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns the Euclidean distance between this vector and the specified vector.
distanceTo(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns the Euclidean distance between this vector and the specified vector.
divide(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector that is the component-wise division of this vector by the specified vector.
divide(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector that is the component-wise division of this vector by the specified vector.
doFinalize(User) - Method in interface com.smartfoxserver.entities.ILoginFinalizer
 
doFinalize(User) - Method in class com.smartfoxserver.entities.LoginFinalizer
 
doLogin(LoginData) - Method in interface com.smartfoxserver.entities.Loggable
 
dot(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns the dot product of this vector and the specified vector.
dot(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns the dot product of this vector and the specified vector.
Dot syntax - Search tag in com.smartfoxserver.extensions.SFSExtension.addRequestHandler(String, Class<?>)
Section
DOUBLE - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
DOUBLE - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
DOUBLE_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
driverName - Variable in class com.smartfoxserver.db.DBConfig
Fully qualified name of the database driver, for example com.mysql.jdbc.Driver
dump() - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
DURATION - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
Duration of an event, for example a User ban

E

email - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.PasswordRecovery
The email configuration
Email - Interface in com.smartfoxserver.entities
 
EMAIL_ALREADY_IN_USE - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
EmailConfig() - Constructor for class com.smartfoxserver.components.signup.SignUpConfiguration.EmailConfig
 
emailField - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
The name of the field used to store the user's email.
emailResponse - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Configure the automated email responses
EmbeddedDBService - Class in com.smartfoxserver.db
 
EmbeddedDBService() - Constructor for class com.smartfoxserver.db.EmbeddedDBService
 
empty() - Static method in class com.smartfoxserver.entities.data.SFSVector2
 
empty() - Static method in class com.smartfoxserver.entities.data.SFSVector3
 
emptyRoom(Room) - Method in interface com.smartfoxserver.api.ISFSApi
Removes all Users from the target Room.
emptyRoom(Room) - Method in class com.smartfoxserver.api.SFSApi
Removes all Users from the target Room.
emptyRoom(Room, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Removes all Users from the target Room.
emptyRoom(Room, boolean) - Method in class com.smartfoxserver.api.SFSApi
Removes all Users from the target Room.
emptyRoom(Room, boolean, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Removes all Users from the target Room.
emptyRoom(Room, boolean, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
Removes all Users from the target Room.
enableAudioManager() - Method in interface com.smartfoxserver.entities.Room
 
enableAudioManager() - Method in class com.smartfoxserver.entities.SFSRoom
 
enableAudioManager() - Method in class com.smartfoxserver.mmo.MMORoom
 
encodeBuddy(Buddy) - Static method in class com.smartfoxserver.buddylist.BuddyUtils
 
encodeBuddyVariables(List<BuddyVariable>) - Static method in class com.smartfoxserver.buddylist.BuddyUtils
 
encodePassword(String) - Method in interface com.smartfoxserver.components.signup.IPasswordManager
 
ENCRYPTION_ENABLED - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 
ENDS_WITH - Enum constant in enum class com.smartfoxserver.entities.match.StringMatch
Check that Str1.endsWith(Str2)
equals(Object) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
equals(Object) - Method in class com.smartfoxserver.entities.data.SFSVector2
 
equals(Object) - Method in class com.smartfoxserver.entities.data.SFSVector3
 
equals(Object) - Method in class com.smartfoxserver.entities.SFSRoom
 
equals(Object) - Method in class com.smartfoxserver.entities.SFSUser
 
EQUALS - Enum constant in enum class com.smartfoxserver.entities.match.BoolMatch
Checks that Bool1 == Bool2
EQUALS - Enum constant in enum class com.smartfoxserver.entities.match.NumberMatch
Checks that Num1 == Num2
EQUALS - Enum constant in enum class com.smartfoxserver.entities.match.StringMatch
Check that Str1.equals(Str2)
ERROR - Enum constant in enum class com.smartfoxserver.extensions.ExtensionLogLevel
 
errorMessages - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
A map of customizable error messages associated with the the SignUpAssistant default error codes.
Example: - Search tag in com.smartfoxserver.api.ISFSApi.createNPC(String, Zone)
Section
Example: - Search tag in com.smartfoxserver.api.ISFSApi.createNPC(String, Zone)
Section
Example: - Search tag in com.smartfoxserver.api.ISFSApi.createNPC(String, Zone, boolean)
Section
Example: - Search tag in com.smartfoxserver.api.ISFSApi.createNPC(String, Zone, boolean)
Section
Example of usage - Search tag in class com.smartfoxserver.components.signup.SignUpAssistantComponent
Section
ExceptionMessageComposer - Class in com.smartfoxserver.exceptions
 
ExceptionMessageComposer(Throwable) - Constructor for class com.smartfoxserver.exceptions.ExceptionMessageComposer
 
ExceptionMessageComposer(Throwable, boolean) - Constructor for class com.smartfoxserver.exceptions.ExceptionMessageComposer
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.BanUser
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.BanUsersFromRoom
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.AddBuddy
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.BlockBuddy
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.GoOnline
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.InitBuddyList
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.RemoveBuddy
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.SetBuddyVariables
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.ChangeRoomCapacity
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.ChangeRoomName
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.ChangeRoomPassword
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.CreateRoom
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.FindRooms
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.FindUsers
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.game.InvitationReply
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.game.InviteUser
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.game.QuickJoinGame
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.GenericMessage
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.Handshake
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.JoinRoom
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.KickUser
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.LeaveRoom
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.Login
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.Logout
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.ManualDisconnection
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.PingPong
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.PlayerToSpectator
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.QuickJoinOrCreateRoom
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.SetRoomVariables
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.SetUserPosition
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.SetUserVariables
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.SpectatorToPlayer
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.SubscribeRoomGroup
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.UdpInit
 
execute(IRequest) - Method in class com.smartfoxserver.controllers.system.UnsubscribeRoomGroup
 
execute(LoginData) - Method in interface com.smartfoxserver.components.login.ILoginAssistantPlugin
This is the method that executes the custom plugin logic.
execute(User, ISFSObject, SignUpConfiguration) - Method in interface com.smartfoxserver.components.signup.ISignUpAssistantPlugin
Handles the execution of the plugin logic
executeInsert(String, Object[]) - Method in interface com.smartfoxserver.db.IDBManager
Executes a SQL INSERT command returning the key of the inserted row
executeInsert(String, Object[]) - Method in class com.smartfoxserver.db.SFSDBManager
Executes a SQL INSERT command returning the key of the inserted row
executeQuery(String) - Method in interface com.smartfoxserver.db.IDBManager
This is a small variation on IDBManager.executeQuery(String, Object[]) where no additional SQL parameter is used.
executeQuery(String) - Method in class com.smartfoxserver.db.SFSDBManager
This is a small variation on IDBManager.executeQuery(String, Object[]) where no additional SQL parameter is used.
executeQuery(String, Object[]) - Method in interface com.smartfoxserver.db.IDBManager
Perform a SQL query and return a structured object based on SFSArray and SFSObject.
executeQuery(String, Object[]) - Method in class com.smartfoxserver.db.SFSDBManager
Perform a SQL query and return a structured object based on SFSArray and SFSObject.
executeUpdate(String) - Method in interface com.smartfoxserver.db.IDBManager
Executes a non-query SQL command such as INSERT, UPDATE, DELETE etc...
executeUpdate(String) - Method in class com.smartfoxserver.db.SFSDBManager
Executes a non-query SQL command such as INSERT, UPDATE, DELETE etc...
executeUpdate(String, Object[]) - Method in interface com.smartfoxserver.db.IDBManager
Executes a non-query SQL command such as INSERT, UPDATE, DELETE etc...
executeUpdate(String, Object[]) - Method in class com.smartfoxserver.db.SFSDBManager
Executes a non-query SQL command such as INSERT, UPDATE, DELETE etc...
EXPIRED - Enum constant in enum class com.smartfoxserver.entities.invitation.InvitationResponse
Invitation expired
ExtensionCalls - Enum constant in enum class com.smartfoxserver.security.SystemPermission
 
ExtensionLogLevel - Enum Class in com.smartfoxserver.extensions
 
ExtensionReloadMode - Enum Class in com.smartfoxserver.extensions
 
extraFields - Variable in class com.smartfoxserver.components.login.LoginConfiguration
An optional list of other field names to be loaded in the query and sent back in the optional SFSObject passed with the login response.
extraFields - Variable in class com.smartfoxserver.components.login.LoginData
The optional extra fields extracted from the database, if specified in the LoginAssistant configuration (might be null)
extraFields - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
(Optional) A list of other field names to be stored in the user account.

F

FILE_STORAGE - Enum constant in enum class com.smartfoxserver.persistence.room.RoomStorageMode
Uses local file system storage
FILE_UPLOAD - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when one or more files have been uploaded by a User connected in the current Zone.
FileRoomStorageConfig - Class in com.smartfoxserver.persistence.room
Provides configuration settings for the File based Room persistence API
FileRoomStorageConfig() - Constructor for class com.smartfoxserver.persistence.room.FileRoomStorageConfig
 
FilterAction - Enum Class in com.smartfoxserver.extensions.filter
 
filterRequest(SystemRequest, User) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
filterRequest(T, User) - Method in interface com.smartfoxserver.util.IFloodFilter
 
findById(int) - Method in interface com.smartfoxserver.entities.invitation.InvitationManager
Find an invitation from its id
findById(int) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
findItemLocation(BaseMMOItem) - Method in class com.smartfoxserver.mmo.MMORoom
 
findRooms(Collection<Room>, MatchExpression, int) - Method in interface com.smartfoxserver.api.ISFSApi
Find one or more Room(s) in the specified collection of Rooms.
findRooms(Collection<Room>, MatchExpression, int) - Method in class com.smartfoxserver.api.SFSApi
Find one or more Room(s) in the specified collection of Rooms.
FindRooms - Class in com.smartfoxserver.controllers.system
 
FindRooms - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
FindRooms() - Constructor for class com.smartfoxserver.controllers.system.FindRooms
 
findUserLocation(User) - Method in class com.smartfoxserver.mmo.MMORoom
 
findUsers(Collection<User>, MatchExpression, int) - Method in interface com.smartfoxserver.api.ISFSApi
Find one or more User(s) in the specified collection of Users.
findUsers(Collection<User>, MatchExpression, int) - Method in class com.smartfoxserver.api.SFSApi
Find one or more User(s) in the specified collection of Users.
FindUsers - Class in com.smartfoxserver.controllers.system
 
FindUsers - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
FindUsers() - Constructor for class com.smartfoxserver.controllers.system.FindUsers
 
findVariable(List<BuddyVariable>, String) - Static method in class com.smartfoxserver.buddylist.BuddyUtils
 
FLOAT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
FLOAT - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
FLOAT_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
floatX() - Method in class com.smartfoxserver.mmo.Vec3D
Get the X coordinate as float
floatY() - Method in class com.smartfoxserver.mmo.Vec3D
Get the Y coordinate as float
floatZ() - Method in class com.smartfoxserver.mmo.Vec3D
Get the Z coordinate as float
floor() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector with all components rounded down to the nearest integer.
floor() - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector with all components rounded down to the nearest integer.
forceLogout - Variable in class com.smartfoxserver.entities.LoginData
 
freePlayerSlot(int) - Method in class com.smartfoxserver.util.DefaultPlayerIdGenerator
 
freePlayerSlot(int) - Method in interface com.smartfoxserver.util.IPlayerIdGenerator
This method is called by the parent Room when a Player leaves the game and his player slot can be freed up.
freeze() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
freeze() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
fromAddress - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.EmailConfig
The email's from address
fromFloatArray(List<Float>) - Static method in class com.smartfoxserver.mmo.Vec3D
 
fromId(int) - Static method in enum class com.smartfoxserver.entities.invitation.InvitationResponse
 
fromId(int) - Static method in enum class com.smartfoxserver.entities.managers.BanMode
 
fromId(int) - Static method in enum class com.smartfoxserver.entities.variables.VariableType
 
fromId(short) - Static method in enum class com.smartfoxserver.security.DefaultPermissionProfile
 
fromId(Object) - Static method in enum class com.smartfoxserver.controllers.SystemRequest
 
fromIntArray(List<Integer>) - Static method in class com.smartfoxserver.mmo.Vec3D
 
fromName(String) - Static method in enum class com.smartfoxserver.bitswarm.data.TransportType
 
fromSFSArray(ISFSArray) - Static method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
fromSFSArray(ISFSArray) - Static method in class com.smartfoxserver.entities.match.MatchExpression
 
fromSFSObject(ISFSObject) - Static method in class com.smartfoxserver.buddylist.BuddyUtils
 
fromString(String) - Static method in enum class com.smartfoxserver.entities.managers.BanMode
 
fromString(String) - Static method in enum class com.smartfoxserver.entities.SFSRoomRemoveMode
 
fromString(String) - Static method in enum class com.smartfoxserver.entities.variables.VariableType
 
fromSymbol(String) - Static method in enum class com.smartfoxserver.entities.match.BoolMatch
 
fromSymbol(String) - Static method in enum class com.smartfoxserver.entities.match.NumberMatch
 
fromSymbol(String) - Static method in enum class com.smartfoxserver.entities.match.StringMatch
 
fromTypeId(int) - Static method in enum class com.smartfoxserver.entities.data.SFSDataType
Get the SFSDataType enum from its type id
FSBuddyStorage - Class in com.smartfoxserver.buddylist.storage
Default (file system based) BuddyStorage class
FSBuddyStorage() - Constructor for class com.smartfoxserver.buddylist.storage.FSBuddyStorage
 

G

GAME_INVITATION_FAILURE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a private SFSGame has finished the cycle of invitations.
GAME_INVITATION_SUCCESS - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a private SFSGame has finished the cycle of invitations.
GAME_NODE_EVENT - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Overcast Cluster Only
Game State - Search tag in class com.smartfoxserver.game.SFSGame
Section
GENERATE_NEW - Enum constant in enum class com.smartfoxserver.components.signup.RecoveryMode
 
generateID() - Method in interface com.smartfoxserver.entities.IDGenerator
 
generateID() - Method in class com.smartfoxserver.entities.SFSIDGenerator
 
generateRandom(User) - Method in interface com.smartfoxserver.components.signup.IPasswordManager
 
GENERIC_DB_ERROR - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
GENERIC_ERROR - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
GenericInvitationCallback - Class in com.smartfoxserver.game
 
GenericInvitationCallback() - Constructor for class com.smartfoxserver.game.GenericInvitationCallback
 
GenericMessage - Class in com.smartfoxserver.controllers.system
 
GenericMessage - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
GenericMessage() - Constructor for class com.smartfoxserver.controllers.system.GenericMessage
 
get() - Method in interface com.smartfoxserver.entities.IVersion
 
get() - Method in class com.smartfoxserver.entities.SFSVersion
 
get(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
 
get(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
get(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
 
get(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getActiveConnections() - Method in class com.smartfoxserver.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.entities.SFSRoom
 
getAdminHelper() - Method in class com.smartfoxserver.entities.SFSUser
 
getAdminHelper() - Method in class com.smartfoxserver.entities.SFSZone
 
getAdminName() - Method in interface com.smartfoxserver.entities.BannedUser
 
getAdminName() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
getAllMMOItems() - Method in class com.smartfoxserver.mmo.MMORoom
Obtain a list of all MMOItems managed by this Room
getAnalyticsDataManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getApi() - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Get a reference to the main server side API
getApi() - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Get a reference to the main server side API
getApi() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Get a reference to the main SmartFoxServer Server API, which exposes useful methods for interacting with the server
getAPIManager() - Method in class com.smartfoxserver.SmartFoxServer
The API Manager gives access to all the specialized server API such as the BuddyAPI, GameAPI, MMOAPI
getApplyBadWordsFilter() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Check if the current Zone applies the WordFilter to the Buddy messages
getApplyBadWordsFilter() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Check if the current Zone applies the WordFilter to the Buddy messages
getAudioManager() - Method in interface com.smartfoxserver.entities.Room
 
getAudioManager() - Method in class com.smartfoxserver.entities.SFSRoom
 
getAudioStreamInfo() - Method in class com.smartfoxserver.entities.SFSUser
 
getAudioStreamInfo() - Method in interface com.smartfoxserver.entities.User
 
getAutoRemoveMode() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the Auto-Remove mode of the Room
getAutoRemoveMode() - Method in interface com.smartfoxserver.entities.Room
Return the auto-remove mode of the Room
getAutoRemoveMode() - Method in class com.smartfoxserver.entities.SFSRoom
Return the auto-remove mode of the Room
getBadWordsWarnings() - Method in class com.smartfoxserver.entities.SFSUser
 
getBadWordsWarnings() - Method in interface com.smartfoxserver.entities.User
 
getBanDurationMinutes() - Method in interface com.smartfoxserver.entities.BannedUser
 
getBanDurationMinutes() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
getBanDurationMinutes() - Method in interface com.smartfoxserver.util.IFloodFilter
 
getBanDurationMinutes() - Method in class com.smartfoxserver.util.SFSFloodFilter
 
getBanDurationMinutes() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getBanMessage() - Method in interface com.smartfoxserver.util.IFloodFilter
 
getBanMessage() - Method in class com.smartfoxserver.util.SFSFloodFilter
 
getBanMessage() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getBanMode() - Method in interface com.smartfoxserver.util.IFloodFilter
 
getBanMode() - Method in class com.smartfoxserver.util.SFSFloodFilter
 
getBanMode() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getBannedUserByIp(String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
getBannedUserByName(String, String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
getBannedUserIds() - Method in interface com.smartfoxserver.entities.Room
Returns the id of every User currently banned in this Room.
getBannedUserIds() - Method in class com.smartfoxserver.entities.RoomBanLedger
 
getBannedUserIds() - Method in class com.smartfoxserver.entities.SFSRoom
Returns the id of every User currently banned in this Room.
getBannedUserManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getBannedUserManager() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getBannedUserManger() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getBannedUsersByIp() - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
getBannedUsersByName(String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
getBanTimeMillis() - Method in interface com.smartfoxserver.entities.BannedUser
 
getBanTimeMillis() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
getBase64Hash(String) - Method in class com.smartfoxserver.util.SHA256
 
getBool(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Boolean.
getBool(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getBool(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as Boolean.
getBool(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getBoolArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of Boolean.
getBoolArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getBoolArray(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getBoolArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Booleans.
getBoolArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getBoolArray(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getBoolValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Boolean
getBuddies() - Method in interface com.smartfoxserver.buddylist.BuddyList
Get a list of all Buddies in the BuddyList
getBuddies() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
getBuddy(String) - Method in interface com.smartfoxserver.buddylist.BuddyList
Get a Buddy from the BuddyList by name
getBuddy(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
getBuddyApi() - Method in class com.smartfoxserver.api.APIManager
The Buddy API to manage buddies and buddy lists
getBuddyApi() - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Get a reference to the server side Buddy List API
getBuddyApi() - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Get a reference to the server side Buddy List API
getBuddyApi() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Get a reference to the SmartFoxServer Buddy API, exposing useful methods for working with BuddyLists
getBuddyList(String) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Get the Buddy List of a specific user
getBuddyList(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Get the Buddy List of a specific user
getBuddyListManager() - Method in interface com.smartfoxserver.buddylist.BuddyList
Get a reference to the BuddyManager managing this BuddyList
getBuddyListManager() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
getBuddyListManager() - Method in interface com.smartfoxserver.buddylist.storage.BuddyStorage
Get a reference to the BuddyManager managing this BuddyStorage class
getBuddyListManager() - Method in class com.smartfoxserver.buddylist.storage.FSBuddyStorage
 
getBuddyListManager() - Method in class com.smartfoxserver.entities.SFSZone
getBuddyListManager() - Method in interface com.smartfoxserver.entities.Zone
 
getBuddyListMaxSize() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Get the maximum size of a BuddyList
getBuddyListMaxSize() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Get the maximum size of a BuddyList
getBuddyProperties() - Method in class com.smartfoxserver.entities.SFSUser
 
getBuddyProperties() - Method in interface com.smartfoxserver.entities.User
Get the BuddyProperty object
getBuddyStates() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Get a list of custom Buddy states such as "Available", "Occupied", "Be right back" etc...
getBuddyStates() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Get a list of custom Buddy states such as "Available", "Occupied", "Be right back" etc...
getBuddyVariablesData() - Method in interface com.smartfoxserver.buddylist.Buddy
 
getBuddyVariablesData() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
getByte(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Byte.
getByte(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getByte(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getByte(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as Byte (signed 8 bit).
getByte(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getByte(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getByteArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as byte array.
getByteArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getByteArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Byte.
getByteArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getByteValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Byte
getByteValue() - Method in enum class com.smartfoxserver.util.ClientDisconnectionReason
 
getByteValue() - Method in interface com.smartfoxserver.util.IDisconnectionReason
 
getCallback() - Method in interface com.smartfoxserver.entities.invitation.Invitation
Obtain a reference to the CallBack handler class
getCallback() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
getCapacity() - Method in interface com.smartfoxserver.entities.Room
Return the capacity of the Room (maximum number of clients that can be contained).
getCapacity() - Method in class com.smartfoxserver.entities.SFSRoom
Return the capacity of the Room (maximum number of clients that can be contained).
getClassName() - Method in class com.smartfoxserver.api.CreateRoomSettings.RoomExtensionSettings
Get the fully qualified name of the Extension main class
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.buddylist.BuddyListManager
 
getClientsWatchingBuddy(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
getClientsWatchingBuddy(String, boolean) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
getClientsWatchingBuddy(String, boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
getClientType() - Method in class com.smartfoxserver.entities.SFSUser
 
getClientType() - Method in interface com.smartfoxserver.entities.User
By default each client API sends a different "signature" identifying the client technology (e.g.
getCode() - Method in exception class com.smartfoxserver.components.signup.SignUpValidationException
Obtain the error code
getCode() - Method in class com.smartfoxserver.exceptions.SFSErrorData
 
getConfig() - Method in class com.smartfoxserver.components.login.LoginAssistantComponent
Obtain the configuration object that allows to setup all the parameters of the Login process.
getConfig() - Method in class com.smartfoxserver.components.signup.SignUpAssistantComponent
 
getConfig() - Method in class com.smartfoxserver.db.SFSDBManager
 
getConfig() - Method in interface com.smartfoxserver.db.IDBManager
Get the configuration details of the JDBC connection and connection pool
getConfigProperties() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Returns a reference the Properties object loaded from the specified properties file.
getConfigProperties() - Method in interface com.smartfoxserver.extensions.ISFSExtension
Returns a reference the Properties object loaded from the specified properties file.
getConfiguration() - Method in interface com.smartfoxserver.entities.managers.IMailerService
Obtain the configuration settings of the service
getConfiguration() - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
Obtain the configuration settings of the service
getConfigurator() - Method in class com.smartfoxserver.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.db.IDBManager
Get a direct reference to the JDBC connection object.
getConnection() - Method in class com.smartfoxserver.db.SFSDBManager
Get a direct reference to the JDBC connection object.
getCountry() - Method in class com.smartfoxserver.entities.SFSUser
 
getCountry() - Method in interface com.smartfoxserver.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.entities.SFSUser
 
getCreatedRooms() - Method in interface com.smartfoxserver.entities.User
Get a list of Rooms created by this User
getCreationTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
The Session's creation time as Unix Time in milliseconds.
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.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.entities.SFSUser
 
getCurrentMMORoom() - Method in interface com.smartfoxserver.entities.User
 
getCustomPlayerIdGeneratorClass() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the PlayerId Generator class.
getDatagramOutQueue() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getDatagramOutQueue() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getDbManager() - Method in class com.smartfoxserver.components.signup.SignUpAssistantComponent
 
getDBManager() - Method in class com.smartfoxserver.db.EmbeddedDBService
 
getDBManager() - Method in class com.smartfoxserver.entities.SFSZone
Obtain a reference to the Zone's Database Manager.
getDBManager() - Method in interface com.smartfoxserver.entities.Zone
Obtain a reference to the Zone's Database Manager.
getDefaultAOI() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
 
getDefaultAOI() - Method in class com.smartfoxserver.mmo.MMORoom
Obtain the default Area Of Interest (AOI) of this room.
getDefaultGroups() - Method in class com.smartfoxserver.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.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.entities.SFSZone
getDefaultPlayerIdGeneratorClassName() - Method in interface com.smartfoxserver.entities.Zone
 
getDouble(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Double.
getDouble(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getDouble(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as Double (signed decimal 64 bit).
getDouble(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getDoubleArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of Double.
getDoubleArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getDoubleArray(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getDoubleArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Double.
getDoubleArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getDoubleArray(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getDoubleValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Double
getDump() - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get a detailed dump of the SFSArray structure
getDump() - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get a detailed dump of the SFSObject structure
getDump() - Method in class com.smartfoxserver.entities.data.SFSArray
 
getDump() - Method in class com.smartfoxserver.entities.data.SFSObject
 
getDump() - Method in interface com.smartfoxserver.entities.Room
 
getDump() - Method in class com.smartfoxserver.entities.SFSRoom
getDump() - Method in class com.smartfoxserver.entities.SFSUser
 
getDump() - Method in class com.smartfoxserver.entities.SFSZone
 
getDump() - Method in interface com.smartfoxserver.entities.User
Return a full dump of the User properties, useful for debugging
getDump() - Method in interface com.smartfoxserver.entities.Zone
 
getDump(boolean) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get a detailed dump of the SFSArray structure
getDump(boolean) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get a detailed dump of the SFSObject structure
getDump(boolean) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getDump(boolean) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getElementAt(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
 
getElementAt(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getEmbeddeDB() - Method in class com.smartfoxserver.SmartFoxServer
 
getErrorData() - Method in exception class com.smartfoxserver.exceptions.SFSException
 
getEventManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getEventThreadPool() - Method in class com.smartfoxserver.SmartFoxServer
 
getExpiryTime() - Method in interface com.smartfoxserver.entities.invitation.Invitation
The expiration timestamp.
getExpiryTime() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
getExpressionsList() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getExtension() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the Extension attached to the Room
getExtension() - Method in interface com.smartfoxserver.entities.Room
Get the extension connected to this Room, if any
getExtension() - Method in class com.smartfoxserver.entities.SFSRoom
Get the extension connected to this Room, if any
getExtension() - Method in class com.smartfoxserver.entities.SFSZone
getExtension() - Method in interface com.smartfoxserver.entities.Zone
 
getExtensionFileName() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Get the extension file name
getExtensionFileName() - Method in interface com.smartfoxserver.extensions.ISFSExtension
Get the extension file name
getExtensionManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getExtFloodWarnings() - Method in class com.smartfoxserver.entities.SFSUser
 
getExtFloodWarnings() - Method in interface com.smartfoxserver.entities.User
 
getFilterChain(SystemRequest) - Method in class com.smartfoxserver.entities.SFSZone
Obtain a reference to the Zone's SystemFilterChain.
getFilterChain(SystemRequest) - Method in interface com.smartfoxserver.entities.Zone
Obtain a reference to the Zone's SystemFilterChain.
getFilteredVariables() - Method in class com.smartfoxserver.controllers.filter.ReadOnlyUserVariablesFilter
 
getFilterMode() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getFloat(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Float.
getFloat(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getFloat(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getFloat(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as Float (signed decimal 32 bit).
getFloat(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getFloat(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getFloatArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of Float.
getFloatArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getFloatArray(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getFloatArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Float.
getFloatArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getFloatArray(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getFloatValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Float
getFloodFilter() - Method in class com.smartfoxserver.entities.SFSZone
getFloodFilter() - Method in interface com.smartfoxserver.entities.Zone
 
getFloodWarnings() - Method in class com.smartfoxserver.entities.SFSUser
 
getFloodWarnings() - Method in interface com.smartfoxserver.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.entities.Email
Get the From address, which represents the sender of the email
getFromAddress() - Method in class com.smartfoxserver.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.game.BaseGameInvitationCallback
Get the Game
getGameApi() - Method in class com.smartfoxserver.api.APIManager
The advanced game API for match-making, invitations etc...
getGameApi() - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Get a reference to the server side Game API
getGameApi() - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Get a reference to the server side Game API
getGameApi() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Get a reference to the SmartFoxServer Game API, exposing useful methods for working with SFSGame classes, invitations and match making.
getGameRoomCount() - Method in class com.smartfoxserver.entities.SFSZone
 
getGameRoomCount() - Method in interface com.smartfoxserver.entities.Zone
 
getGroupEvents(String) - Method in class com.smartfoxserver.entities.SFSZone
 
getGroupEvents(String) - Method in interface com.smartfoxserver.entities.Zone
 
getGroupId() - Method in class com.smartfoxserver.api.CreateRoomSettings
The name of the Room Group that the new Room will be assigned to.
getGroupId() - Method in interface com.smartfoxserver.entities.Room
Get the Room Group Id.
getGroupId() - Method in class com.smartfoxserver.entities.SFSRoom
Get the Room Group Id.
getGroups() - Method in class com.smartfoxserver.entities.SFSZone
Get the full list of Room Groups available in the Zone.
getGroups() - Method in interface com.smartfoxserver.entities.Zone
Get the full list of Room Groups available in the Zone.
getGuestUserNamePrefix() - Method in class com.smartfoxserver.entities.SFSZone
Get the prefix used by the system to auto-generate guest user names.
getGuestUserNamePrefix() - Method in interface com.smartfoxserver.entities.Zone
Get the prefix used by the system to auto-generate guest user names.
getHash(String) - Method in class com.smartfoxserver.util.SHA256
Generate the SHA256 hash
getHashId() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
A unique string token that identifies the Session
getHashId() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getHexDump() - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get a pretty-printed hex-dump of the array
getHexDump() - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get a pretty-printed hex-dump of the object
getHexDump() - Method in class com.smartfoxserver.entities.data.SFSArray
 
getHexDump() - Method in class com.smartfoxserver.entities.data.SFSObject
 
getHigherLimit() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings.MapLimits
Obtain the higher coordinate limit
getHttpServer() - Method in class com.smartfoxserver.SmartFoxServer
 
getId() - Method in class com.smartfoxserver.api.CreateRoomSettings.RoomExtensionSettings
Get the extension id
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 enum class com.smartfoxserver.controllers.SystemRequest
 
getId() - Method in interface com.smartfoxserver.entities.invitation.Invitation
Get the unique invitation ID
getId() - Method in enum class com.smartfoxserver.entities.invitation.InvitationResponse
 
getId() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
getId() - Method in enum class com.smartfoxserver.entities.managers.BanMode
 
getId() - Method in interface com.smartfoxserver.entities.Room
Return the unique Room Id
getId() - Method in class com.smartfoxserver.entities.SFSRoom
Return the unique Room Id
getId() - Method in class com.smartfoxserver.entities.SFSUser
 
getId() - Method in class com.smartfoxserver.entities.SFSZone
getId() - Method in interface com.smartfoxserver.entities.User
Get the unique user ID
getId() - Method in enum class com.smartfoxserver.entities.variables.VariableType
 
getId() - Method in interface com.smartfoxserver.entities.Zone
 
getId() - Method in interface com.smartfoxserver.exceptions.IErrorCode
 
getId() - Method in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
getId() - Method in interface com.smartfoxserver.mmo.IMMOItem
The MMOItem ID
getId() - Method in class com.smartfoxserver.mmo.MMOItem
 
getId() - Method in enum class com.smartfoxserver.security.DefaultPermissionProfile
 
getId() - Method in interface com.smartfoxserver.security.IPermissionProfile
 
getId() - Method in class com.smartfoxserver.security.SFSPermissionProfile
 
getIDGenerator() - Method in interface com.smartfoxserver.entities.invitation.InvitationManager
 
getIDGenerator() - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
getIdleConnections() - Method in class com.smartfoxserver.db.SFSDBManager
Get the number of pooled connections currently idle
getInSeqProcessor() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getInSeqProcessor() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getInstance() - Static method in class com.smartfoxserver.SmartFoxServer
Obtain a reference to the current server instance
getInt(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Integer.
getInt(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getInt(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as Integer (signed 32 bit).
getInt(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getIntArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of Int.
getIntArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getIntArray(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getIntArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Integer.
getIntArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getIntArray(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getIntValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Integer
getInvitationExpiryTime() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
The maximum amount of time for an invited Player to accept/refuse an invitation.
getInvitationManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getInvitationParams() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
Get optional SFSObject containing custom invitation parameters.
getInvitedPlayers() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
For private games only: A list of players invited to play in the Game.
getInvitee() - Method in interface com.smartfoxserver.entities.invitation.Invitation
Get the Invitee, the user that receives the invitation
getInvitee() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
getInviter() - Method in interface com.smartfoxserver.entities.invitation.Invitation
Get the Inviter, the user that started this invitation
getInviter() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
getIpAddress() - Method in interface com.smartfoxserver.entities.BannedUser
 
getIpAddress() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
getIpAddress() - Method in class com.smartfoxserver.entities.SFSUser
 
getIpAddress() - Method in interface com.smartfoxserver.entities.User
Return the User IP address
getIsoCode() - Method in class com.smartfoxserver.util.Country
The ISO code of the country (e.g.
getItemsManager() - Method in class com.smartfoxserver.mmo.MMORoom
 
getJoinedRooms() - Method in class com.smartfoxserver.entities.SFSUser
 
getJoinedRooms() - Method in interface com.smartfoxserver.entities.User
A list of Rooms currently joined by the User
getKeys() - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get a set of all keys
getKeys() - Method in class com.smartfoxserver.entities.data.SFSObject
 
getKickCount(String, String, int) - Method in class com.smartfoxserver.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 class com.smartfoxserver.util.SFSWordFilter
 
getKicksBeforeBan() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getKicksBeforeBanMinutes() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getLastActivityTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
The last time that the client Session has sent a packet (milliseconds Unix Time)
getLastActivityTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getLastJoinedRoom() - Method in class com.smartfoxserver.entities.SFSUser
 
getLastJoinedRoom() - Method in interface com.smartfoxserver.entities.User
A reference to the last Room that was joined by this User
getLastLocation() - Method in class com.smartfoxserver.mmo.MMOItem
 
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.entities.SFSUser
 
getLastMMOItemsList() - Method in class com.smartfoxserver.entities.SFSUser
 
getLastMMOItemsList() - Method in interface com.smartfoxserver.entities.User
 
getLastProxyList() - Method in class com.smartfoxserver.entities.SFSUser
 
getLastProxyList() - Method in interface com.smartfoxserver.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.entities.SFSUser
 
getLastRequestTime() - Method in interface com.smartfoxserver.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.extensions.BaseSFSExtension
Return the level of the extension.
getLevel() - Method in interface com.smartfoxserver.extensions.ISFSExtension
Return the level of the extension.
getLifeTime() - Method in interface com.smartfoxserver.entities.Room
Obtain the time of existence of the Room
getLifeTime() - Method in class com.smartfoxserver.entities.SFSRoom
Obtain the time of existence of the Room
GetLobbyNode - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
getLogger() - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Obtain a direct reference to the Extension's logger
getLogger() - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Obtain a direct reference to the Extension's logger
getLogger() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Obtain a direct reference to the Extension's logger
getLoginTime() - Method in class com.smartfoxserver.entities.SFSUser
 
getLoginTime() - Method in interface com.smartfoxserver.entities.User
Get the user login time (Unix timestamp in milliseconds)
getLong(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Long.
getLong(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getLong(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getLong(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as Long (signed 64 bit).
getLong(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getLong(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getLongArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of Long.
getLongArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getLongArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Long.
getLongArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getLongValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Long
getLowerLimit() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings.MapLimits
Obtain the lower coordinate limit
getLSManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getMailService() - Method in interface com.smartfoxserver.api.ISFSApi
Access the SFSPostOffice to send email notifications and messages
getMailService() - Method in class com.smartfoxserver.api.SFSApi
Access the SFSPostOffice to send email notifications and messages
getMailService() - Method in class com.smartfoxserver.SmartFoxServer
Provides a reference to the Mail Service
getMapHigherLimit() - Method in class com.smartfoxserver.mmo.MMORoom
Get the map higher limit
getMapLimits() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
 
getMapLowerLimit() - Method in class com.smartfoxserver.mmo.MMORoom
Get the map lower limit
getMaskCharacter() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getMaxAllowedRooms() - Method in class com.smartfoxserver.entities.SFSZone
The maximum number of Rooms that can be created in the Room.
getMaxAllowedRooms() - Method in interface com.smartfoxserver.entities.Zone
The maximum number of Rooms that can be created in the Room.
getMaxAllowedUsers() - Method in class com.smartfoxserver.entities.SFSZone
The maximum number of users allowed to join the Zone.
getMaxAllowedUsers() - Method in interface com.smartfoxserver.entities.Zone
The maximum number of users allowed to join the Zone.
getMaxAllowedVariables() - Method in class com.smartfoxserver.entities.SFSUser
 
getMaxAllowedVariables() - Method in interface com.smartfoxserver.entities.User
Get the maximum allowed User Variables for this User
getMaxBadWordsPerMessage() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getMaxBuddyVariables() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Get the limit of BuddyVariables that each User can create
getMaxBuddyVariables() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Get the limit of BuddyVariables that each User can create
getMaxFailedLogins() - Method in class com.smartfoxserver.entities.SFSZone
 
getMaxFailedLogins() - Method in interface com.smartfoxserver.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.entities.SFSZone
 
getMaxFindRoomResults() - Method in interface com.smartfoxserver.entities.Zone
Get the max number of "FindRoom" results for a client request.
getMaxFindUserResults() - Method in class com.smartfoxserver.entities.SFSZone
 
getMaxFindUserResults() - Method in interface com.smartfoxserver.entities.Zone
Get the max number of "Find User" results for a client request.
getMaxFloodingAttempts() - Method in interface com.smartfoxserver.util.IFloodFilter
 
getMaxFloodingAttempts() - Method in class com.smartfoxserver.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 Session "idle" and disconnect it
getMaxIdleTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getMaxInvitationsPerRequest() - Method in class com.smartfoxserver.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.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.entities.invitation.InvitationManager
 
getMaxInvitationsPerUser() - Method in class com.smartfoxserver.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.entities.SFSZone
The maximum number of characters allowed for a Room name
getMaxRoomNameChars() - Method in interface com.smartfoxserver.entities.Zone
The maximum number of characters allowed for a Room name
getMaxRoomsCreatedPerUserLimit() - Method in class com.smartfoxserver.entities.SFSZone
The maximum number of Rooms that a User can create at once.
getMaxRoomsCreatedPerUserLimit() - Method in interface com.smartfoxserver.entities.Zone
The maximum number of Rooms that a User can create at once.
getMaxRoomVariablesAllowed() - Method in interface com.smartfoxserver.entities.Room
Return the maximum number of Room Variables allowed in the Room.
getMaxRoomVariablesAllowed() - Method in class com.smartfoxserver.entities.SFSRoom
Return the maximum number of Room Variables allowed in the Room.
getMaxRoomVariablesAllowed() - Method in class com.smartfoxserver.entities.SFSZone
The maximum number of Room Variables allowed for each Room.
getMaxRoomVariablesAllowed() - Method in interface com.smartfoxserver.entities.Zone
The maximum number of Room Variables allowed for each Room.
getMaxSpectators() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the maximum number of spectators allowed in the Room (game only)
getMaxSpectators() - Method in interface com.smartfoxserver.entities.Room
Return the maximum number of Spectators allowed in the Room.
getMaxSpectators() - Method in class com.smartfoxserver.entities.SFSRoom
Return the maximum number of Spectators allowed in the Room.
getMaxUdpIdleSeconds() - Method in class com.smartfoxserver.entities.SFSZone
Get the max allowed idle seconds for the UDP connection.
getMaxUdpIdleSeconds() - Method in interface com.smartfoxserver.entities.Zone
Get the max allowed idle seconds for the UDP connection.
getMaxUdpIdleTime() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Get the maximum idle time for User's UDP connection before it is considered disconnected
getMaxUdpIdleTime() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getMaxUserIdleTime() - Method in class com.smartfoxserver.entities.SFSZone
Get the max allowed idle time for a User.
getMaxUserIdleTime() - Method in interface com.smartfoxserver.entities.Zone
Get the max allowed idle time for a User.
getMaxUserNameChars() - Method in class com.smartfoxserver.entities.SFSZone
The maximum number of characters allowed for a User names
getMaxUserNameChars() - Method in interface com.smartfoxserver.entities.Zone
The maximum number of characters allowed for a User names
getMaxUsers() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the maximum number of users allowed in the Room
getMaxUsers() - Method in interface com.smartfoxserver.entities.Room
Return the maximum number of Users allowed in the Room.
getMaxUsers() - Method in class com.smartfoxserver.entities.SFSRoom
Return the maximum number of Users allowed in the Room.
getMaxUserVariablesAllowed() - Method in class com.smartfoxserver.entities.SFSZone
The maximum number of User Variables allowed for each User.
getMaxUserVariablesAllowed() - Method in interface com.smartfoxserver.entities.Zone
The maximum number of User Variables allowed for each User.
getMaxVariablesAllowed() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the maximum number of Room Variables allowed
getMessage() - Method in interface com.smartfoxserver.entities.Email
Get the message of the email.
getMessage() - Method in class com.smartfoxserver.entities.SFSEmail
Get the message of the email.
getMinClientApiVersion() - Method in class com.smartfoxserver.SmartFoxServer
 
getMinPlayersToStartGame() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
Get the minimum number of players required to start the Game
getMinPlayersToStartGame() - Method in class com.smartfoxserver.game.SFSGame
This is the minimum number of players that are required for the game to start
getMinRoomNameChars() - Method in class com.smartfoxserver.entities.SFSZone
The minimum number of characters allowed for Room name
getMinRoomNameChars() - Method in interface com.smartfoxserver.entities.Zone
The minimum number of characters allowed for Room name
getMMOApi() - Method in class com.smartfoxserver.api.APIManager
API to create and manage MMORooms
getMMOApi() - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Get a reference to the server side MMO API
getMMOApi() - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Get a reference to the server side MMO API
getMMOApi() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Get a reference to the SmartFoxServer MMO API, exposing useful methods for working with MMORoom(s) and MMOItem(s) objects.
getMMOItemById(int) - Method in class com.smartfoxserver.mmo.MMORoom
Obtain an MMOItem managed by this Room via its id
getMode() - Method in interface com.smartfoxserver.entities.BannedUser
 
getMode() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
getName() - Method in class com.smartfoxserver.api.APIManager
 
getName() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the name of the Room.
getName() - Method in interface com.smartfoxserver.buddylist.Buddy
The Buddy name, which corresponds to the User name.
getName() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
getName() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
getName() - Method in class com.smartfoxserver.controllers.filter.SysControllerFilter
 
getName() - Method in class com.smartfoxserver.db.SFSDBManager
 
getName() - Method in class com.smartfoxserver.db.EmbeddedDBService
 
getName() - Method in interface com.smartfoxserver.entities.BannedUser
 
getName() - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
getName() - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
 
getName() - Method in interface com.smartfoxserver.entities.Room
Get the room name
getName() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
getName() - Method in class com.smartfoxserver.entities.SFSRoom
Get the room name
getName() - Method in class com.smartfoxserver.entities.SFSUser
 
getName() - Method in class com.smartfoxserver.entities.SFSZone
The name of the Zone.
getName() - Method in interface com.smartfoxserver.entities.User
Get the User name
getName() - Method in interface com.smartfoxserver.entities.variables.Variable
 
getName() - Method in interface com.smartfoxserver.entities.Zone
The name of the Zone.
getName() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
The extension name
getName() - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilter
Get the filter name
getName() - Method in interface com.smartfoxserver.extensions.ISFSExtension
The extension name
getName() - Method in class com.smartfoxserver.security.SFSPermissionProfile
 
getName() - Method in class com.smartfoxserver.util.Country
Name of the country
getName() - Method in class com.smartfoxserver.util.TaskScheduler
 
getNickName() - Method in interface com.smartfoxserver.buddylist.Buddy
Get the nickname of the Buddy.
getNickName() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
getNickName() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
getNickName() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
getObject() - Method in class com.smartfoxserver.entities.data.SFSDataWrapper
 
getOfflineBuddyVariable(String, String) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
getOfflineBuddyVariable(String, String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
getOfflineBuddyVariables(String) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
getOfflineBuddyVariables(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
getOfflineBuddyVariables(String, boolean) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
getOfflineBuddyVariables(String, boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
getOfflineBuddyVariablesCacheSize() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Get the size of the "offline" Buddy Variables cache.
getOfflineBuddyVariablesCacheSize() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Get the size of the "offline" Buddy Variables cache.
getOfflineVariables(String) - Method in interface com.smartfoxserver.buddylist.storage.BuddyStorage
Load the offline persistent variables for a specific User.
getOfflineVariables(String) - Method in class com.smartfoxserver.buddylist.storage.FSBuddyStorage
 
getOwnedRoomsCount() - Method in class com.smartfoxserver.entities.SFSUser
 
getOwnedRoomsCount() - Method in interface com.smartfoxserver.entities.User
Get the number of Rooms created by the User
getOwner() - Method in interface com.smartfoxserver.buddylist.BuddyList
Get the User that owns this BuddyList
getOwner() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
getOwner() - Method in interface com.smartfoxserver.entities.Room
Get the owner of the Room (the user that created it)
getOwner() - Method in class com.smartfoxserver.entities.SFSRoom
Get the owner of the Room (the user that created it)
getOwner() - Method in interface com.smartfoxserver.entities.variables.RoomVariable
Return the User that created the variable.
getOwner() - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
Return the User that created the variable.
getOwnerAsString() - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
 
getOwnerName() - Method in interface com.smartfoxserver.buddylist.BuddyList
Get the name of the owner of this BuddyList
getOwnerName() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
getOwnerName() - Method in interface com.smartfoxserver.entities.Room
Returns the name of user that created the Room.
getOwnerName() - Method in class com.smartfoxserver.entities.SFSRoom
 
getPacketOutQueue() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getPacketOutQueue() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getParameter(ISFSEventParam) - Method in interface com.smartfoxserver.core.ISFSEvent
Get the value for a specific parameter, or null if no such parameter exists.
getParameter(ISFSEventParam) - Method in class com.smartfoxserver.core.SFSEvent
Get the value for a specific parameter, or null if no such parameter exists.
getParams() - Method in exception class com.smartfoxserver.components.signup.SignUpValidationException
Obtain the error message parameters
getParams() - Method in interface com.smartfoxserver.entities.invitation.Invitation
An SFSObject of custom parameters can be attached to the invitation.
getParams() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
getParams() - Method in class com.smartfoxserver.exceptions.SFSErrorData
 
getParentBuddyList() - Method in interface com.smartfoxserver.buddylist.Buddy
Return the parent BuddyList containing this Buddy
getParentBuddyList() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
getParentExtension() - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Obtain a reference to the parent extension.
getParentExtension() - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Obtain a reference to the parent extension.
getParentExtension() - Method in interface com.smartfoxserver.extensions.IClientRequestHandler
Obtain a reference to the parent extension.
getParentExtension() - Method in interface com.smartfoxserver.extensions.IServerEventHandler
Obtain a reference to the parent extension.
getParentRoom() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Return the parent Room of the Extension.
getParentRoom() - Method in interface com.smartfoxserver.extensions.ISFSExtension
Return the parent Room of the Extension.
getParentRoom() - Method in class com.smartfoxserver.util.DefaultPlayerIdGenerator
 
getParentRoom() - Method in interface com.smartfoxserver.util.IPlayerIdGenerator
Get a reference to the parent Room
getParentZone() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Return the parent Zone of the Extension.
getParentZone() - Method in interface com.smartfoxserver.extensions.ISFSExtension
Return the parent Zone of the Extension.
getPassword() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the Room password.
getPassword() - Method in interface com.smartfoxserver.entities.Room
Get the Room password.
getPassword() - Method in class com.smartfoxserver.entities.SFSRoom
Get the Room password.
getPermissionProfile(short) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
getPermissionProfile(short) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
getPermissionProfile(String) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
getPermissionProfile(String) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
getPersistentRoomVarReferences() - Method in class com.smartfoxserver.entities.SFSUser
 
getPersistentRoomVarReferences() - Method in interface com.smartfoxserver.entities.User
 
getPersistentVariables() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
getPersistentVariables() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
getPlayerId() - Method in class com.smartfoxserver.entities.SFSUser
 
getPlayerId() - Method in interface com.smartfoxserver.entities.User
Get the playerId of the User (if applicable).
getPlayerId(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
getPlayerId(Room) - Method in interface com.smartfoxserver.entities.User
Get the playerId for the User in a specific Room
getPlayerIdGeneratorClassName() - Method in interface com.smartfoxserver.entities.Room
 
getPlayerIdGeneratorClassName() - Method in class com.smartfoxserver.entities.SFSRoom
 
getPlayerIds() - Method in class com.smartfoxserver.entities.SFSUser
 
getPlayerIds() - Method in interface com.smartfoxserver.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.game.CreateSFSGameSettings
A match expression to filter Players willing to join the Game.
getPlayerMatchExpression() - Method in class com.smartfoxserver.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.entities.Room
For Game Rooms: get all Players in the Room (same as all User without the Spectators)
getPlayersList() - Method in class com.smartfoxserver.entities.SFSRoom
For Game Rooms: get all Players in the Room (same as all User without the Spectators)
getPlayersList() - Method in class com.smartfoxserver.mmo.MMORoom
 
getPlayerSlot() - Method in class com.smartfoxserver.util.DefaultPlayerIdGenerator
 
getPlayerSlot() - Method in interface com.smartfoxserver.util.IPlayerIdGenerator
Return a new player slot/id
getPriority() - Method in interface com.smartfoxserver.entities.Email
Get the priority of the email.
getPriority() - Method in class com.smartfoxserver.entities.SFSEmail
Get the priority of the email.
getPrivilegeId() - Method in class com.smartfoxserver.entities.SFSUser
 
getPrivilegeId() - Method in interface com.smartfoxserver.entities.User
Return the Privilege ID of the User.
getPrivilegeManager() - Method in class com.smartfoxserver.entities.SFSZone
getPrivilegeManager() - Method in interface com.smartfoxserver.entities.Zone
 
getProperties() - Method in interface com.smartfoxserver.entities.Room
Get the map with all Room properties
getProperties() - Method in class com.smartfoxserver.entities.SFSRoom
Get the map with all Room properties
getProperties() - Method in class com.smartfoxserver.entities.SFSUser
 
getProperties() - Method in interface com.smartfoxserver.entities.User
Get the map with all User properties
getPropertiesFile() - Method in class com.smartfoxserver.api.CreateRoomSettings.RoomExtensionSettings
Get the name of the custom config properties file
getPropertiesFileName() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Get the name of the properties file that was loaded at init time.
getPropertiesFileName() - Method in interface com.smartfoxserver.extensions.ISFSExtension
Get the name of the properties file that was loaded at init time.
getProperty(Object) - Method in interface com.smartfoxserver.entities.Room
Get any custom property attached to this Room.
getProperty(Object) - Method in class com.smartfoxserver.entities.SFSRoom
Get any custom property attached to this Room.
getProperty(Object) - Method in class com.smartfoxserver.entities.SFSUser
 
getProperty(Object) - Method in class com.smartfoxserver.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.entities.User
Get any custom property attached to this User.
getProperty(Object) - Method in interface com.smartfoxserver.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
Get a custom property from the Session
getProperty(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getProximityItems(User) - Method in class com.smartfoxserver.mmo.MMORoom
Get the list of MMOItems falling within the User's AoI
getProximityItems(User, Vec3D) - Method in class com.smartfoxserver.mmo.MMORoom
Get the list of MMOItems falling within a custom AoI
getProximityItems(Vec3D) - Method in class com.smartfoxserver.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.mmo.MMORoom
Get the list of MMOItems at a specific location, falling within a custom AoI
getProximityList(User) - Method in class com.smartfoxserver.mmo.MMORoom
Returns the List of Users falling within the target's AOI
getProximityList(User, Vec3D) - Method in class com.smartfoxserver.mmo.MMORoom
Returns the List of Users falling within the a custom AOI around the target
getProximityList(Vec3D) - Method in class com.smartfoxserver.mmo.MMORoom
Returns the List of Users falling within the AOI of the target position
getProximityList(Vec3D, Vec3D) - Method in class com.smartfoxserver.mmo.MMORoom
Returns the List of Users falling within the custom AOI around the target position
getProximityListUpdateMillis() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
getProximityListUpdateMillis() - Method in class com.smartfoxserver.mmo.MMORoom
 
getProximityManager() - Method in class com.smartfoxserver.mmo.MMORoom
 
getProxyList() - Method in class com.smartfoxserver.mmo.MMORoom.PreviousMMORoomState
 
getPublicGroups() - Method in class com.smartfoxserver.entities.SFSZone
Get a list of names of the "Public" Room Groups available in the Zone.
getPublicGroups() - Method in interface com.smartfoxserver.entities.Zone
Get a list of names of the "Public" Room Groups available in the Zone.
getPwdPlaceholder() - Method in class com.smartfoxserver.db.DBConfig
Method used by AdminTool extension to hide password sent to the client via descriptor.
getRdpTxConfig() - Method in class com.smartfoxserver.entities.SFSZone
 
getRdpTxConfig() - Method in interface com.smartfoxserver.entities.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.entities.BannedUser
 
getReason() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
getRecipientNamesForUpdate(String) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
getRecipientNamesForUpdate(String) - Method in class com.smartfoxserver.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.entities.SFSUser
 
getReconnectionSeconds() - Method in interface com.smartfoxserver.entities.User
 
getReloadMode() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
getReloadMode() - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
getRequestTable() - Method in interface com.smartfoxserver.util.IFloodFilter
 
getRequestTable() - Method in class com.smartfoxserver.util.SFSFloodFilter
 
getResponseAPI() - Method in interface com.smartfoxserver.api.ISFSApi
 
getResponseAPI() - Method in interface com.smartfoxserver.api.ISFSBuddyApi
 
getResponseAPI() - Method in interface com.smartfoxserver.api.ISFSGameApi
 
getResponseAPI() - Method in interface com.smartfoxserver.api.ISFSMMOApi
 
getResponseAPI() - Method in class com.smartfoxserver.api.SFSApi
getResponseAPI() - Method in class com.smartfoxserver.api.SFSBuddyApi
getResponseAPI() - Method in class com.smartfoxserver.api.SFSGameApi
getResponseAPI() - Method in class com.smartfoxserver.api.SFSMMOApi
getRestartCount() - Method in class com.smartfoxserver.SmartFoxServer
 
getRoom() - Method in class com.smartfoxserver.mmo.BaseMMOItem
Get the Room associated with this MMOItem
getRoom() - Method in class com.smartfoxserver.mmo.MMOItem
 
getRoomById(int) - Method in class com.smartfoxserver.entities.SFSZone
Get a Room from its unique ID
getRoomById(int) - Method in interface com.smartfoxserver.entities.Zone
Get a Room from its unique ID
getRoomByName(String) - Method in class com.smartfoxserver.entities.SFSZone
Get a Room from its name
getRoomByName(String) - Method in interface com.smartfoxserver.entities.Zone
Get a Room from its name
getRoomId() - Method in class com.smartfoxserver.mmo.MMORoom.PreviousMMORoomState
 
getRoomList() - Method in class com.smartfoxserver.entities.SFSZone
Get the list of Rooms in the Zone
getRoomList() - Method in interface com.smartfoxserver.entities.Zone
Get the list of Rooms in the Zone
GetRoomList - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
getRoomListData() - Method in class com.smartfoxserver.entities.SFSZone
 
getRoomListData() - Method in interface com.smartfoxserver.entities.Zone
 
getRoomListData(List<String>) - Method in class com.smartfoxserver.entities.SFSZone
 
getRoomListData(List<String>) - Method in interface com.smartfoxserver.entities.Zone
 
getRoomListFromGroup(String) - Method in class com.smartfoxserver.entities.SFSZone
Get the list of Rooms from a specific Group
getRoomListFromGroup(String) - Method in interface com.smartfoxserver.entities.Zone
Get the list of Rooms from a specific Group
getRoomListFromGroupList(Collection<String>) - Method in class com.smartfoxserver.entities.SFSZone
 
getRoomListFromGroupList(Collection<String>) - Method in interface com.smartfoxserver.entities.Zone
Obtain a Room list generated by merging all Rooms from the provided group names
getRoomManager() - Method in class com.smartfoxserver.entities.SFSZone
getRoomManager() - Method in interface com.smartfoxserver.entities.Zone
 
getRoomPersistenceApi() - Method in class com.smartfoxserver.entities.SFSZone
Obtain the Room Persistence API object.
getRoomPersistenceApi() - Method in interface com.smartfoxserver.entities.Zone
Obtain the Room Persistence API object.
getRoomProperties() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the custom properties attached to the Room object
getRoomSettings() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the advanced settings of the Room.
getRoomVariables() - Method in class com.smartfoxserver.api.CreateRoomSettings
Get the list of Room Variables for the new Room
getRoomVariablesData(boolean) - Method in interface com.smartfoxserver.entities.Room
 
getRoomVariablesData(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
 
getRuntimeSize() - Method in interface com.smartfoxserver.buddylist.BuddyList
Obtain the size of the BuddyList, including the temp buddies
getRuntimeSize() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
getScheduler() - Method in interface com.smartfoxserver.api.ISFSApi
Gets a reference to the global Task Scheduler.
getScheduler() - Method in class com.smartfoxserver.api.SFSApi
Gets a reference to the global Task Scheduler.
getSearchableRooms() - Method in class com.smartfoxserver.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
getSecondsBeforeBan() - Method in interface com.smartfoxserver.util.IFloodFilter
 
getSecondsBeforeBan() - Method in class com.smartfoxserver.util.SFSFloodFilter
 
getSecondsBeforeBanOrKick() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getSecondsForAnswer() - Method in interface com.smartfoxserver.entities.invitation.Invitation
The amount of seconds given to the invitee to respond to the invitation
getSecondsForAnswer() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
getSectorSize() - Method in class com.smartfoxserver.mmo.MMORoom
 
getSerializer() - Static method in class com.smartfoxserver.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.util.UsersUtil
Provides a default Server Admin User
getServerModerator() - Static method in class com.smartfoxserver.util.UsersUtil
Provides a default Server Moderator User
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.SmartFoxServer
 
getSession() - Method in class com.smartfoxserver.entities.SFSUser
 
getSession() - Method in interface com.smartfoxserver.entities.User
Get the session object linked to this User
getSessionList() - Method in interface com.smartfoxserver.entities.Room
Get all the User Sessions in the Room
getSessionList() - Method in class com.smartfoxserver.entities.SFSRoom
Get all the User Sessions in the Room
getSessionList() - Method in class com.smartfoxserver.entities.SFSZone
Get the list of Sessions logged in the Zone
getSessionList() - Method in interface com.smartfoxserver.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.SmartFoxServer
 
getSessionsInGroup(String) - Method in class com.smartfoxserver.entities.SFSZone
Get a list of Sessions from all Rooms in the provided Room Group
getSessionsInGroup(String) - Method in interface com.smartfoxserver.entities.Zone
Get a list of Sessions from all Rooms in the provided Room Group
getSessionsListeningToGroup(String) - Method in class com.smartfoxserver.entities.SFSZone
 
getSessionsListeningToGroup(String) - Method in interface com.smartfoxserver.entities.Zone
Get a list of Sessions listening for events in a specific Group
getSFS() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Get a reference to the Server's main object
getSFSApi() - Method in class com.smartfoxserver.api.APIManager
The standard SFS API for Extensions
getSFSArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as ISFSArray.
getSFSArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getSFSArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as ISFSArray.
getSFSArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getSFSArrayValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as SFSArray
getSFSObject(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as ISFSObject.
getSFSObject(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getSFSObject(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as ISFSObject.
getSFSObject(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getSFSObjectValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as SFSObject
getSFSVersion() - Method in interface com.smartfoxserver.api.ISFSApi
Provides the current SmartFoxServer version
getSFSVersion() - Method in class com.smartfoxserver.api.SFSApi
 
getShort(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Short.
getShort(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getShort(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getShort(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as Short (signed 16 bit).
getShort(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getShort(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getShortArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of Short.
getShortArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getShortArray(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getShortArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Short.
getShortArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getShortArray(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getShortString(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as short string, with a max length of 255 bytes It can be null if no element exists for the specified index
getShortString(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getShortString(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as String using UTF-8 encoding.
getShortString(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getShortStringArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of String.
getShortStringArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getShortStringArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Strings.
getShortStringArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getShortValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Short
getSize() - Method in interface com.smartfoxserver.buddylist.BuddyList
Obtain the size of the BuddyList.
getSize() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
getSize() - Method in interface com.smartfoxserver.entities.Room
Return the current Room size
getSize() - Method in class com.smartfoxserver.entities.SFSRoom
Return the current Room size
getSpectatorCount() - Method in class com.smartfoxserver.entities.RoomSize
Get the number of Spectators
getSpectatorMatchExpression() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
A match expression to filter Spectators willing to join the Game.
getSpectatorMatchExpression() - Method in class com.smartfoxserver.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.entities.Room
For Game Rooms: get all Spectators in the Room (same as all User without the Players)
getSpectatorsList() - Method in class com.smartfoxserver.entities.SFSRoom
For Game Rooms: get all Spectators in the Room (same as all User without the Players)
getSpectatorsList() - Method in class com.smartfoxserver.mmo.MMORoom
 
getState() - Method in interface com.smartfoxserver.buddylist.Buddy
Returns the current Buddy State
getState() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
getState() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
getState() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
getStatsManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getStorageHandler() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Get a reference to the instance of the BuddyStorage class, which handles the data persistence
getStorageHandler() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Get a reference to the instance of the BuddyStorage class, which handles the data persistence
getString(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as string, with a max length of 32768 bytes It can be null if no element exists for the specified index
getString(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getString(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as String using UTF-8 encoding.
getString(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getStringArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of String.
getStringArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getStringArray(int) - Method in class com.smartfoxserver.entities.data.SFSArrayLite
 
getStringArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of Strings.
getStringArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getStringArray(String) - Method in class com.smartfoxserver.entities.data.SFSObjectLite
 
getStringValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as String
getSubject() - Method in interface com.smartfoxserver.entities.Email
Get the subject of the email
getSubject() - Method in class com.smartfoxserver.entities.SFSEmail
Get the subject of the email
getSubscribedGroups() - Method in class com.smartfoxserver.entities.SFSUser
 
getSubscribedGroups() - Method in interface com.smartfoxserver.entities.User
Get a list of Room Groups subscribed by the User
getSymbol() - Method in enum class com.smartfoxserver.entities.match.BoolMatch
 
getSymbol() - Method in enum class com.smartfoxserver.entities.match.NumberMatch
 
getSymbol() - Method in enum class com.smartfoxserver.entities.match.StringMatch
 
getSystemProperty(String) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getSystemProperty(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getTaskScheduler() - Method in class com.smartfoxserver.SmartFoxServer
 
getTcpDroppedPackets() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getTcpDroppedPackets() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getText(int) - Method in interface com.smartfoxserver.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.entities.data.SFSArray
 
getText(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as String using UTF-8 encoding.
getText(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getThreadsAwaitingConnections() - Method in class com.smartfoxserver.db.SFSDBManager
Get the number of threads awaiting on a connection
getToAddress() - Method in interface com.smartfoxserver.entities.Email
Get the recipient(s) of the email.
getToAddress() - Method in class com.smartfoxserver.entities.SFSEmail
Get the recipient(s) of the email.
getTotalConnections() - Method in class com.smartfoxserver.db.SFSDBManager
Get the total number of connections
getTotalRoomCount() - Method in class com.smartfoxserver.entities.SFSZone
 
getTotalRoomCount() - Method in interface com.smartfoxserver.entities.Zone
 
getTotalUsers() - Method in class com.smartfoxserver.entities.RoomSize
Returns the sum of Users and Spectators
getTraceMonitor() - Method in class com.smartfoxserver.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 interface com.smartfoxserver.core.ISFSEvent
Get the type of the event
getType() - Method in class com.smartfoxserver.core.SFSEvent
Get the type of the event
getType() - Method in enum class com.smartfoxserver.entities.match.BoolMatch
 
getType() - Method in enum class com.smartfoxserver.entities.match.NumberMatch
 
getType() - Method in enum class com.smartfoxserver.entities.match.StringMatch
 
getType() - Method in interface com.smartfoxserver.entities.variables.Variable
Return the data type of the variable
getType() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
getType() - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
getTypeId() - Method in class com.smartfoxserver.entities.data.SFSDataWrapper
 
getTypeID() - Method in enum class com.smartfoxserver.entities.data.SFSDataType
 
getUCountThrottler() - Method in class com.smartfoxserver.entities.SFSZone
 
getUCountThrottler() - Method in interface com.smartfoxserver.entities.Zone
 
getUdpConnection() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getUdpConnection() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getUdpDroppedPackets() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
getUdpDroppedPackets() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
getUIDGenerator() - Method in class com.smartfoxserver.SmartFoxServer
 
getUnsignedByte(int) - Method in interface com.smartfoxserver.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.entities.data.SFSArray
 
getUnsignedByteArray(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as a Collection of unsigned integers.
getUnsignedByteArray(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getUnsignedByteArray(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of unsigned Byte.
getUnsignedByteArray(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getUptime() - Method in interface com.smartfoxserver.api.ISFSApi
Provides the server's uptime
getUptime() - Method in class com.smartfoxserver.api.SFSApi
 
getUptime() - Method in class com.smartfoxserver.SmartFoxServer
 
getUserById(int) - Method in interface com.smartfoxserver.api.ISFSApi
Finds a User from its unique ID
getUserById(int) - Method in class com.smartfoxserver.api.SFSApi
Finds a User from its unique ID
getUserById(int) - Method in interface com.smartfoxserver.entities.Room
 
getUserById(int) - Method in class com.smartfoxserver.entities.SFSRoom
getUserById(int) - Method in class com.smartfoxserver.entities.SFSZone
Get a User from its unique ID
getUserById(int) - Method in interface com.smartfoxserver.entities.Zone
Get a User from its unique ID
getUserByName(String) - Method in interface com.smartfoxserver.api.ISFSApi
Finds a User from its name
getUserByName(String) - Method in class com.smartfoxserver.api.SFSApi
Finds a User from its name
getUserByName(String) - Method in interface com.smartfoxserver.entities.Room
 
getUserByName(String) - Method in class com.smartfoxserver.entities.SFSRoom
getUserByName(String) - Method in class com.smartfoxserver.entities.SFSZone
Get a User from its name
getUserByName(String) - Method in interface com.smartfoxserver.entities.Zone
Get a User from its name
getUserByPlayerId(int) - Method in interface com.smartfoxserver.entities.Room
Get the User currently having the specified playerId (Game Room only)
getUserByPlayerId(int) - Method in class com.smartfoxserver.entities.SFSRoom
Get the User currently having the specified playerId (Game Room only)
getUserByPlayerId(int) - Method in class com.smartfoxserver.mmo.MMORoom
 
getUserBySession(ISession) - Method in interface com.smartfoxserver.api.ISFSApi
Finds a User from its Session
getUserBySession(ISession) - Method in class com.smartfoxserver.api.SFSApi
Finds a User from its Session
getUserBySession(ISession) - Method in interface com.smartfoxserver.entities.Room
 
getUserBySession(ISession) - Method in class com.smartfoxserver.entities.SFSRoom
getUserBySession(ISession) - Method in class com.smartfoxserver.entities.SFSZone
Get a User from its Session object
getUserBySession(ISession) - Method in interface com.smartfoxserver.entities.Zone
Get a User from its Session object
getUserCount() - Method in class com.smartfoxserver.entities.RoomSize
Get the number of Users/Players in the Room
getUserCount() - Method in class com.smartfoxserver.entities.SFSZone
Get the current amount of Users connected to the Zone
getUserCount() - Method in interface com.smartfoxserver.entities.Zone
Get the current amount of Users connected to the Zone
getUserCountChangeUpdateInterval() - Method in class com.smartfoxserver.entities.SFSZone
Get the rate (in ms.) at which the UserCountUpdates events are fired to the clients.
getUserCountChangeUpdateInterval() - Method in interface com.smartfoxserver.entities.Zone
Get the rate (in ms.) at which the UserCountUpdates events are fired to the clients.
getUserLimboMaxSeconds() - Method in class com.smartfoxserver.mmo.MMORoom
 
getUserList() - Method in interface com.smartfoxserver.entities.Room
Get all Users in the Room
getUserList() - Method in class com.smartfoxserver.entities.SFSRoom
Get all Users in the Room
getUserList() - Method in class com.smartfoxserver.entities.SFSZone
Get the list of Users logged in the Zone
getUserList() - Method in interface com.smartfoxserver.entities.Zone
Get the list of Users logged in the Zone
getUserListData() - Method in interface com.smartfoxserver.entities.Room
 
getUserListData() - Method in class com.smartfoxserver.entities.SFSRoom
 
getUserManager() - Method in interface com.smartfoxserver.entities.Room
 
getUserManager() - Method in class com.smartfoxserver.entities.SFSRoom
 
getUserManager() - Method in class com.smartfoxserver.entities.SFSZone
 
getUserManager() - Method in interface com.smartfoxserver.entities.Zone
 
getUserManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getUserMaxLimboSeconds() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
getUserReconnectionSeconds() - Method in class com.smartfoxserver.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.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.entities.SFSZone
Get a list of Users from all Rooms in the provided Room Group
getUsersInGroup(String) - Method in interface com.smartfoxserver.entities.Zone
Get a list of Users from all Rooms in the provided Room Group
getUserVariablesData() - Method in class com.smartfoxserver.entities.SFSUser
 
getUserVariablesData() - Method in interface com.smartfoxserver.entities.User
 
getUserVariablesData(boolean) - Method in class com.smartfoxserver.entities.SFSUser
 
getUseTempBuddies() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Check if the current Zone supports temporary Buddies
getUseTempBuddies() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Check if the current Zone supports temporary Buddies
getValue() - Method in enum class com.smartfoxserver.bitswarm.data.MessagePriority
 
getValue() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Object
getValue() - Method in enum class com.smartfoxserver.util.ClientDisconnectionReason
 
getValue() - Method in interface com.smartfoxserver.util.IDisconnectionReason
 
getVariable(String) - Method in interface com.smartfoxserver.buddylist.Buddy
Get a Buddy Variable from its name
getVariable(String) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
getVariable(String) - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
getVariable(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
getVariable(String) - Method in interface com.smartfoxserver.entities.Room
Get a Room Variable
getVariable(String) - Method in class com.smartfoxserver.entities.SFSRoom
Get a Room Variable
getVariable(String) - Method in class com.smartfoxserver.entities.SFSUser
 
getVariable(String) - Method in interface com.smartfoxserver.entities.User
Returns the UserVariable with the provided name.
getVariable(String) - Method in interface com.smartfoxserver.mmo.IMMOItem
Obtain a variable from the MMOItem via its name
getVariable(String) - Method in class com.smartfoxserver.mmo.MMOItem
 
getVariables() - Method in interface com.smartfoxserver.buddylist.Buddy
Get all BuddyVariables
getVariables() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
getVariables() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
getVariables() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
getVariables() - Method in interface com.smartfoxserver.entities.Room
Get the full list of Room Variables in the Room
getVariables() - Method in class com.smartfoxserver.entities.SFSRoom
Get the full list of Room Variables in the Room
getVariables() - Method in class com.smartfoxserver.entities.SFSUser
 
getVariables() - Method in interface com.smartfoxserver.entities.User
Obtain the full list of UserVariables
getVariables() - Method in interface com.smartfoxserver.mmo.IMMOItem
Get a list of all variables attached to the MMOItem
getVariables() - Method in class com.smartfoxserver.mmo.MMOItem
 
getVariablesCount() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
getVariablesCount() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
getVariablesCount() - Method in interface com.smartfoxserver.entities.Room
Get the total amount of Room Variables for this Room
getVariablesCount() - Method in class com.smartfoxserver.entities.SFSRoom
Get the total amount of Room Variables for this Room
getVariablesCount() - Method in class com.smartfoxserver.entities.SFSUser
 
getVariablesCount() - Method in interface com.smartfoxserver.entities.User
Return the number of UserVariables for this User
getVariablesCreatedByUser(User) - Method in interface com.smartfoxserver.entities.Room
Get a list of Room Variables created by a specific User
getVariablesCreatedByUser(User) - Method in class com.smartfoxserver.entities.SFSRoom
Get a list of Room Variables created by a specific User
getVector2(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as SFSVector2.
getVector2(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getVector2(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as SFSVector2.
getVector2(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getVector2Array(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of SFSVector2.
getVector2Array(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getVector2Array(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of SFSVector2.
getVector2Array(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getVector2Value() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Vector2
getVector3(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as SFSVector3.
getVector3(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getVector3(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as SFSVector3.
getVector3(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getVector3Array(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Get the element at the specified index as Collection of SFSVector3.
getVector3Array(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
getVector3Array(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the element for the specified key as a Collection of SFSVector3.
getVector3Array(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
getVector3Value() - Method in interface com.smartfoxserver.entities.variables.Variable
Get the value of the variable as Vector3
getVersion() - Method in class com.smartfoxserver.SmartFoxServer
Obtain the server version number
getWarningMessage() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getWarningsBeforeKick() - Method in class com.smartfoxserver.util.SFSWordFilter
 
getWordFilter() - Method in class com.smartfoxserver.entities.SFSZone
getWordFilter() - Method in interface com.smartfoxserver.entities.Zone
 
getWordsFile() - Method in class com.smartfoxserver.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.buddylist.BuddyListManager
Get the parent Zone
getZone() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Get the parent Zone
getZone() - Method in interface com.smartfoxserver.entities.Room
Get the Zone managing this Room.
getZone() - Method in class com.smartfoxserver.entities.SFSRoom
Get the Zone managing this Room.
getZone() - Method in class com.smartfoxserver.entities.SFSUser
 
getZone() - Method in interface com.smartfoxserver.entities.User
Get the Zone where the User is currently logged in
getZoneManager() - Method in class com.smartfoxserver.entities.SFSZone
 
getZoneManager() - Method in interface com.smartfoxserver.entities.Zone
 
getZoneManager() - Method in class com.smartfoxserver.SmartFoxServer
 
getZoneName() - Method in interface com.smartfoxserver.entities.BannedUser
 
getZoneName() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
globalPrintStackTrace - Static variable in class com.smartfoxserver.exceptions.ExceptionMessageComposer
 
globalUserManager - Variable in class com.smartfoxserver.api.SFSApi
 
goOnline(User, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSBuddyApi
Toggles the Buddy ONLINE state of the User.
goOnline(User, boolean, boolean) - Method in class com.smartfoxserver.api.SFSBuddyApi
Toggles the Buddy ONLINE state of the User.
GoOnline - Class in com.smartfoxserver.controllers.system.buddylist
 
GoOnline - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
GoOnline() - Constructor for class com.smartfoxserver.controllers.system.buddylist.GoOnline
 
GREATER_THAN - Enum constant in enum class com.smartfoxserver.entities.match.NumberMatch
Checks that Num1 > Num2
GREATER_THAN_OR_EQUAL_TO - Enum constant in enum class com.smartfoxserver.entities.match.NumberMatch
Checks that Num1 >= Num2
GROUP_ID - Static variable in class com.smartfoxserver.entities.match.RoomProperties
The Room group id
GUEST - Enum constant in enum class com.smartfoxserver.security.DefaultPermissionProfile
 

H

halt() - Method in class com.smartfoxserver.SmartFoxServer
 
HALT - Enum constant in enum class com.smartfoxserver.extensions.filter.FilterAction
Halt the Filter Chain execution.
handleAcceptedInvitation(Invitation, ISFSObject) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
handleClientRequest(User, ISFSObject) - Method in interface com.smartfoxserver.controllers.filter.ISystemFilter
Handles a client request
handleClientRequest(User, ISFSObject) - Method in class com.smartfoxserver.controllers.filter.ReadOnlyUserVariablesFilter
 
handleClientRequest(User, ISFSObject, TransportType) - Method in class com.smartfoxserver.components.signup.SignUpAssistantComponent
 
handleClientRequest(User, ISFSObject, TransportType) - Method in interface com.smartfoxserver.extensions.IClientRequestHandler
Handle a client request
handleClientRequest(String, User, ISFSObject) - Method in interface com.smartfoxserver.extensions.filter.IFilter
Handles a client request
handleClientRequest(String, User, ISFSObject, TransportType) - Method in interface com.smartfoxserver.extensions.ISFSExtension
This method is called whenever a client sends a request to this Extension
handleClientRequest(String, User, ISFSObject, TransportType) - Method in class com.smartfoxserver.extensions.SFSExtension
This method is called whenever a client sends a request to this Extension
handleInternalMessage(String, Object) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
This method can be invoked across different Extensions.
handleInternalMessage(String, Object) - Method in interface com.smartfoxserver.extensions.ISFSExtension
This method can be invoked across different Extensions.
handleMessage(Object) - Method in class com.smartfoxserver.api.APIManager
 
handleMessage(Object) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
handleMessage(Object) - Method in class com.smartfoxserver.db.SFSDBManager
 
handleMessage(Object) - Method in class com.smartfoxserver.db.EmbeddedDBService
 
handleMessage(Object) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
handleMessage(Object) - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
 
handleMessage(Object) - Method in class com.smartfoxserver.util.TaskScheduler
 
handleRDPDisconnection() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
handleRDPDisconnection() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
handleRefusedInvitation(Invitation, ISFSObject) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
handleServerEvent(ISFSEvent) - Method in interface com.smartfoxserver.core.ISFSEventListener
Handle server event
handleServerEvent(ISFSEvent) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Handle server event
handleServerEvent(ISFSEvent) - Method in interface com.smartfoxserver.extensions.filter.IFilter
Handles a server side event
handleServerEvent(ISFSEvent) - Method in interface com.smartfoxserver.extensions.IServerEventHandler
Handle a server side event
handleServerEvent(ISFSEvent) - Method in class com.smartfoxserver.extensions.SFSExtension
Handle server event
Handshake - Class in com.smartfoxserver.controllers.system
 
Handshake - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
Handshake() - Constructor for class com.smartfoxserver.controllers.system.Handshake
 
HANDSHAKE_API_OBSOLETE - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
handshakeComplete() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
handshakeComplete() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
handshakeComplete(boolean) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
handshakeComplete(boolean) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
HAS_FREE_PLAYER_SLOTS - Static variable in class com.smartfoxserver.entities.match.RoomProperties
Check if the Room has at least 1 free player slot
hashCode() - Method in class com.smartfoxserver.entities.data.SFSVector2
 
hasNext() - Method in class com.smartfoxserver.entities.match.MatchExpression
 
hasVariables() - Method in interface com.smartfoxserver.buddylist.Buddy
Checks if the Buddy has at least one variable set
hasVariables() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
hidden - Variable in class com.smartfoxserver.entities.variables.SFSUserVariable
 
HIGH - Enum constant in enum class com.smartfoxserver.bitswarm.data.MessagePriority
 

I

IBuddySerializer - Interface in com.smartfoxserver.buddylist
 
IClientRequestHandler - Interface in com.smartfoxserver.extensions
 
IDBManager - Interface in com.smartfoxserver.db
 
idField - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
The name of the field used as the main table Id.
idGen - Variable in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
IDGenerator - Interface in com.smartfoxserver.entities
 
IDisconnectionReason - Interface in com.smartfoxserver.util
 
IDLE - Enum constant in enum class com.smartfoxserver.util.ClientDisconnectionReason
The connection was closed after the Client has been idle for too long.
IErrorCode - Interface in com.smartfoxserver.exceptions
 
IFilter - Interface in com.smartfoxserver.extensions.filter
Overview
IFilterChain - Interface in com.smartfoxserver.extensions.filter
 
IFloodFilter<T> - Interface in com.smartfoxserver.util
Configuration should be done via AdminTool > ZoneConfigurator > Flood Filter /** @internal
ILoginAssistantPlugin - Interface in com.smartfoxserver.components.login
ADVANCED USERS ONLY
ILoginFinalizer - Interface in com.smartfoxserver.entities
 
IMailerCallbackHandler - Interface in com.smartfoxserver.entities.managers
Callback handler invoked after sending an email.
IMailerService - Interface in com.smartfoxserver.entities.managers
 
IMMOItem - Interface in com.smartfoxserver.mmo
MMOItems are generic objects that can be placed in an MMORoom to represent interactive or non-interactive items as part of the virtual world, such as obstacles, doors, collectibles, etc...
IMMOItemVariable - Interface in com.smartfoxserver.mmo
Base interface for MMOItemVariable implementation
IMPORTANT: - Search tag in class com.smartfoxserver.components.signup.SignUpConfiguration.EmailConfig
Section
In a nutshell - Search tag in class com.smartfoxserver.components.signup.SignUpAssistantComponent
Section
INFO - Enum constant in enum class com.smartfoxserver.extensions.ExtensionLogLevel
 
init() - Static method in class com.smartfoxserver.buddylist.BuddySerializerFactory
 
init() - Method in interface com.smartfoxserver.buddylist.storage.BuddyStorage
Initialize the Storage class
init() - Method in class com.smartfoxserver.buddylist.storage.FSBuddyStorage
 
init() - Method in interface com.smartfoxserver.extensions.ISFSExtension
This method is called once by the Server after the Extension is instantiated.
init() - Method in class com.smartfoxserver.util.DefaultPlayerIdGenerator
 
init() - Method in interface com.smartfoxserver.util.IPlayerIdGenerator
The init() method is invoked immediately after the successful creation of the Game Room.
init(Zone, BaseStorageConfig) - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Invoked once, after the class is instantiated: it provides the reference to the current Zone and the custom configurator
init(SFSExtension) - Method in interface com.smartfoxserver.extensions.filter.IFilter
Initialize the Filter
init(SFSExtension) - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilter
Initialize the Filter
init(Object) - Method in class com.smartfoxserver.api.APIManager
 
init(Object) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
init(Object) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
init(Object) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
init(Object) - Method in class com.smartfoxserver.db.EmbeddedDBService
 
init(Object) - Method in class com.smartfoxserver.db.SFSDBManager
 
init(Object) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
init(Object) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
init(Object) - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
 
init(Object) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
init(Object) - Method in class com.smartfoxserver.util.SFSWordFilter
 
init(Object) - Method in class com.smartfoxserver.util.TaskScheduler
 
initBuddyList(User, boolean) - Method in interface com.smartfoxserver.api.ISFSBuddyApi
Initializes the buddy list for the requested User.
initBuddyList(User, boolean) - Method in class com.smartfoxserver.api.SFSBuddyApi
Initializes the buddy list for the requested User.
InitBuddyList - Class in com.smartfoxserver.controllers.system.buddylist
 
InitBuddyList - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
InitBuddyList() - Constructor for class com.smartfoxserver.controllers.system.buddylist.InitBuddyList
 
initCleanUpTask() - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
inited - Variable in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
initFloodFilter(ExtensionFloodFilterConfig) - Method in class com.smartfoxserver.extensions.SFSExtension
Initializes the Extension anti-flood filter, which allows to configure a maximum request rate (req/s) for every custom Extension call.
initializeBuddyState(User) - Method in class com.smartfoxserver.api.SFSBuddyApi
 
initRoomPersistence(RoomStorageMode, BaseStorageConfig) - Method in class com.smartfoxserver.entities.SFSZone
Initializes the Room Persistence functionality.
initRoomPersistence(RoomStorageMode, BaseStorageConfig) - Method in interface com.smartfoxserver.entities.Zone
Initializes the Room Persistence functionality.
Instantiation - Annotation Interface in com.smartfoxserver.annotations
Indicates how a dynamic class should be managed by the class that instantiate it The mode parameter by default is set to NEW_INSTANCE.
Instantiation.InstantiationMode - Enum Class in com.smartfoxserver.annotations
 
INT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
INT - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
INT_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
Intended use - Search tag in class com.smartfoxserver.mmo.MMORoom
Section
InterruptedEventException - Exception Class in com.smartfoxserver.exceptions
 
InterruptedEventException() - Constructor for exception class com.smartfoxserver.exceptions.InterruptedEventException
 
Introduction - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
Introduction - Search tag in class com.smartfoxserver.game.SFSGame
Section
intX() - Method in class com.smartfoxserver.mmo.Vec3D
Get the X coordinate as integer
intY() - Method in class com.smartfoxserver.mmo.Vec3D
Get the Y coordinate as integer
intZ() - Method in class com.smartfoxserver.mmo.Vec3D
Get the Z coordinate as integer
INVALID_EMAIL - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
Invitation - Interface in com.smartfoxserver.entities.invitation
Represents an Invitation object
INVITATION_NOT_VALID - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
InvitationCallback - Interface in com.smartfoxserver.entities.invitation
The InvitationCallback is used to handle the client response to an invitation.
InvitationManager - Interface in com.smartfoxserver.entities.invitation
 
InvitationReply - Class in com.smartfoxserver.controllers.system.game
 
InvitationReply - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
InvitationReply() - Constructor for class com.smartfoxserver.controllers.system.game.InvitationReply
 
InvitationResponse - Enum Class in com.smartfoxserver.entities.invitation
 
invitationsById - Variable in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
invitationsByOwner - Variable in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
InviteUser - Class in com.smartfoxserver.controllers.system.game
 
InviteUser - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
InviteUser() - Constructor for class com.smartfoxserver.controllers.system.game.InviteUser
 
ipAddress - Variable in class com.smartfoxserver.entities.SFSBannedUser
 
IPasswordManager - Interface in com.smartfoxserver.components.signup
 
IPasswordRecovery - Interface in com.smartfoxserver.components.signup
 
IPermissionProfile - Interface in com.smartfoxserver.security
 
IPlayerIdGenerator - Interface in com.smartfoxserver.util
Overview
IRoomFactory - Interface in com.smartfoxserver.entities
 
IRoomStorage - Interface in com.smartfoxserver.persistence.room
Basic interface for Room Storage implementations.
IS_GAME - Static variable in class com.smartfoxserver.entities.match.RoomProperties
The Room isGame flag
IS_IN_ANY_ROOM - Static variable in class com.smartfoxserver.entities.match.UserProperties
Equivalent to User.lastJoinedRoom == null
IS_NPC - Static variable in class com.smartfoxserver.entities.match.UserProperties
The isNpc flag
IS_PLAYER - Static variable in class com.smartfoxserver.entities.match.UserProperties
The isPlayer flag
IS_PRIVATE - Static variable in class com.smartfoxserver.entities.match.RoomProperties
The Room isPrivate flag
IS_SPECTATOR - Static variable in class com.smartfoxserver.entities.match.UserProperties
The isSpectator flag
IS_TYPE_DEFAULT - Static variable in class com.smartfoxserver.entities.match.RoomProperties
Check if the Room is of type Default
IS_TYPE_MMO - Static variable in class com.smartfoxserver.entities.match.RoomProperties
Check if the Room if of type MMORoom
IS_TYPE_SFSGAME - Static variable in class com.smartfoxserver.entities.match.RoomProperties
Check if the Room is of type SFSGame
isActive - Variable in class com.smartfoxserver.components.login.LoginData
Optional field that checks if the account has been activated
isActive - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.EmailConfig
Turns on/off the automated email
isActive - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.PasswordRecovery
Turns on/off the Password Recovery
isActive() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Check if the BuddyList management is active in the Zone
isActive() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Check if the BuddyList management is active in the Zone
isActive() - Method in class com.smartfoxserver.db.SFSDBManager
 
isActive() - Method in interface com.smartfoxserver.db.IDBManager
True if the Service is active
isActive() - Method in interface com.smartfoxserver.entities.Room
Return true if the Room is active in the Zone.
isActive() - Method in class com.smartfoxserver.entities.SFSRoom
Return true if the Room is active in the Zone.
isActive() - Method in class com.smartfoxserver.entities.SFSZone
Checks if the Zone is currently enabled in the system or not.
isActive() - Method in interface com.smartfoxserver.entities.Zone
Checks if the Zone is currently enabled in the system or not.
isActive() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Checks if the Extension is active.
isActive() - Method in interface com.smartfoxserver.extensions.ISFSExtension
Checks if the Extension is active.
isActive() - Method in interface com.smartfoxserver.security.PrivilegeManager
 
isActive() - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
isAdmin() - Method in class com.smartfoxserver.entities.SFSUser
 
isAdmin() - Method in interface com.smartfoxserver.entities.User
 
isAllowedToPerformNewSearch(User) - Static method in class com.smartfoxserver.util.UsersUtil
 
isAllowInvitationsOnlyForBuddies() - Method in class com.smartfoxserver.entities.SFSZone
True if only buddies can be invited by a client side JoinRoomInvitationRequest, false otherwise.
isAllowInvitationsOnlyForBuddies() - Method in interface com.smartfoxserver.entities.Zone
True if only buddies can be invited by a client side JoinRoomInvitationRequest, false otherwise.
isAllowOwnerInvitations() - Method in interface com.smartfoxserver.entities.Room
True if the Room allows only its creator to send JoinRoomInvitations.
isAllowOwnerInvitations() - Method in class com.smartfoxserver.entities.SFSRoom
True if the Room allows only its creator to send JoinRoomInvitations.
isAudioStreamingAllowed() - Method in interface com.smartfoxserver.entities.Room
Returns true if audio streaming is allowed in the current Room.
isAudioStreamingAllowed() - Method in class com.smartfoxserver.entities.SFSRoom
Returns true if audio streaming is allowed in the current Room.
isAutoRemoveBan() - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
isBanned(String) - Method in class com.smartfoxserver.entities.RoomBanLedger
 
isBeingKicked() - Method in class com.smartfoxserver.entities.SFSUser
 
isBeingKicked() - Method in interface com.smartfoxserver.entities.User
 
isBlocked() - Method in interface com.smartfoxserver.buddylist.Buddy
When a Buddy is blocked he won't be able to see the User status and send him messages
isBlocked() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
isBuddyBlocked(String) - Method in interface com.smartfoxserver.buddylist.BuddyList
Checks whether the specified Buddy is blocked in this BuddyList
isBuddyBlocked(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
isChangedSinceLastSave() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
isChangedSinceLastSave() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
isClientAllowedToOverridRoomEvents() - Method in class com.smartfoxserver.entities.SFSZone
Deprecated. 
isClientAllowedToOverridRoomEvents() - Method in interface com.smartfoxserver.entities.Zone
 
isConnected() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Check if the session is connected.
isConnected() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
isConnected() - Method in class com.smartfoxserver.entities.SFSUser
 
isConnected() - Method in interface com.smartfoxserver.entities.User
Check if the User is connected
isCustomLogin() - Method in class com.smartfoxserver.entities.SFSZone
Check if the Zone fires LOGIN events to the Zone extension at login time.
isCustomLogin() - Method in interface com.smartfoxserver.entities.Zone
Check if the Zone fires LOGIN events to the Zone extension at login time.
isDynamic() - Method in class com.smartfoxserver.api.CreateRoomSettings
A dynamic Room is created at runtime by either a client request or a server side "CreateRoom" command.
isDynamic() - Method in interface com.smartfoxserver.entities.Room
Checks if the Room was created dynamically (at runtime)
isDynamic() - Method in class com.smartfoxserver.entities.SFSRoom
Checks if the Room was created dynamically (at runtime)
isEmailRequired - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Determines whether or not an email address is mandatory for signing up.
isEmpty() - Method in interface com.smartfoxserver.buddylist.BuddyList
Checks if the BuddyList is empty
isEmpty() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
isEmpty() - Method in interface com.smartfoxserver.entities.Room
Checks whether the Room is empty
isEmpty() - Method in class com.smartfoxserver.entities.SFSRoom
Checks whether the Room is empty
isEncrypted() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
isEncrypted() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
isEncrypted() - Method in class com.smartfoxserver.entities.SFSZone
True if protocol cryptography is turned on in this Zone.
isEncrypted() - Method in interface com.smartfoxserver.entities.Zone
True if protocol cryptography is turned on in this Zone.
IServerEventHandler - Interface in com.smartfoxserver.extensions
 
ISession - Interface in com.smartfoxserver.bitswarm.sessions
A Session object is created every time a TCP/Websocket or HTTP connection to the server is made.
isExpired() - Method in interface com.smartfoxserver.entities.BannedUser
 
isExpired() - Method in interface com.smartfoxserver.entities.invitation.Invitation
Checks if the invitation is expired.
isExpired() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
isExpired() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
isFilterBuddyMessages() - Method in class com.smartfoxserver.entities.SFSZone
Toggle the filtering of Buddy messages via the Words Filter.
isFilterBuddyMessages() - Method in interface com.smartfoxserver.entities.Zone
Toggle the filtering of Buddy messages via the Words Filter.
isFilterChainInited() - Method in class com.smartfoxserver.entities.SFSZone
Returns true if the FilterChain was initialized
isFilterChainInited() - Method in interface com.smartfoxserver.entities.Zone
Returns true if the FilterChain was initialized
isFilterPrivateMessages() - Method in class com.smartfoxserver.entities.SFSZone
If turned on the Zone will apply the Words Filter to private messages
isFilterPrivateMessages() - Method in interface com.smartfoxserver.entities.Zone
If turned on the Zone will apply the Words Filter to private messages
isFilterRoomNames() - Method in class com.smartfoxserver.entities.SFSZone
If turned on the Zone will apply the Words Filter to Room names
isFilterRoomNames() - Method in interface com.smartfoxserver.entities.Zone
If turned on the Zone will apply the Words Filter to Room names
isFilterUserNames() - Method in class com.smartfoxserver.entities.SFSZone
If turned on the Zone will apply the Words Filter to User names provided at login time
isFilterUserNames() - Method in interface com.smartfoxserver.entities.Zone
If turned on the Zone will apply the Words Filter to User names provided at login time
isFlagSet(SFSRoomSettings) - Method in interface com.smartfoxserver.entities.Room
Checks whether a certain Room Setting is set
isFlagSet(SFSRoomSettings) - Method in class com.smartfoxserver.entities.SFSRoom
Checks whether a certain Room Setting is set
isFlagSet(User, SystemPermission) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
isFlagSet(User, SystemPermission) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
isFlagSet(SystemPermission) - Method in class com.smartfoxserver.security.SFSPermissionProfile
 
isFloat() - Method in class com.smartfoxserver.mmo.Vec3D
Detect whether this object uses floating point numbers or integers
isForceLogout() - Method in class com.smartfoxserver.entities.SFSZone
If turned on it allows a User to connect from another location while another connection is already active.
isForceLogout() - Method in interface com.smartfoxserver.entities.Zone
If turned on it allows a User to connect from another location while another connection is already active.
isFrozen() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
isFrozen() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
ISFSApi - Interface in com.smartfoxserver.api
 
ISFSArray - Interface in com.smartfoxserver.entities.data
 
ISFSBuddyApi - Interface in com.smartfoxserver.api
 
ISFSEvent - Interface in com.smartfoxserver.core
 
ISFSEventListener - Interface in com.smartfoxserver.core
 
ISFSEventParam - Interface in com.smartfoxserver.core
 
ISFSExtension - Interface in com.smartfoxserver.extensions
 
ISFSGameApi - Interface in com.smartfoxserver.api
 
ISFSMMOApi - Interface in com.smartfoxserver.api
 
ISFSObject - Interface in com.smartfoxserver.entities.data
SFSObject and SFSArray represent a platform-neutral, high level object used to exchange data between client and server.
isFull() - Method in interface com.smartfoxserver.buddylist.BuddyList
Checks if the BuddyList is full
isFull() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
isFull() - Method in interface com.smartfoxserver.entities.Room
Checks whether the Room is full.
isFull() - Method in class com.smartfoxserver.entities.SFSRoom
Checks whether the Room is full.
isGame() - Method in class com.smartfoxserver.api.CreateRoomSettings
Check if the Room is a game.
isGame() - Method in interface com.smartfoxserver.entities.Room
Checks if this is a Game Room
isGame() - Method in class com.smartfoxserver.entities.SFSRoom
Checks if this is a Game Room
isGame() - Method in class com.smartfoxserver.mmo.MMORoom
 
isGamePublic() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
Check if the Game is public.
isGameStarted() - Method in class com.smartfoxserver.game.SFSGame
Checks if the minimum amount of players to start the game was reached.
isGameStateChanged() - Method in class com.smartfoxserver.game.SFSGame
 
isGeoLocationEnabled() - Method in class com.smartfoxserver.entities.SFSZone
 
isGeoLocationEnabled() - Method in interface com.smartfoxserver.entities.Zone
Toggles geolocation for clients.
isGlobal() - Method in interface com.smartfoxserver.entities.variables.RoomVariable
Checks if a RoomVariable is global.
isGlobal() - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
Checks if a RoomVariable is global.
isGroupEventSet(String, SFSRoomEvents) - Method in class com.smartfoxserver.entities.SFSZone
Checks whether a specific Room Event for the specified Group is active
isGroupEventSet(String, SFSRoomEvents) - Method in interface com.smartfoxserver.entities.Zone
Checks whether a specific Room Event for the specified Group is active
isGuestUserAllowed() - Method in class com.smartfoxserver.entities.SFSZone
Check if the Zone allows guest users (those sending no name and no password).
isGuestUserAllowed() - Method in interface com.smartfoxserver.entities.Zone
Check if the Zone allows guest users (those sending no name and no password).
isHidden() - Method in class com.smartfoxserver.api.CreateRoomSettings
The hidden flag allows to conceal one or more Rooms from the Room List.
isHidden() - Method in interface com.smartfoxserver.entities.Room
Checks if the Game is hidden.
isHidden() - Method in class com.smartfoxserver.entities.SFSRoom
Checks if the Game is hidden.
isHidden() - Method in class com.smartfoxserver.entities.SFSZone
 
isHidden() - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
Checks if the variable is hidden
isHidden() - Method in interface com.smartfoxserver.entities.variables.UserVariable
Checks if the variable is hidden
isHidden() - Method in interface com.smartfoxserver.entities.Zone
 
isIdle() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
isIdle() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
ISignUpAssistantPlugin - Interface in com.smartfoxserver.components.signup
ADVANCED USERS ONLY
ISignUpValidator - Interface in com.smartfoxserver.components.signup
 
isInited() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
isInited() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
isIpBanned(String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
isJoinAllowed(User) - Method in interface com.smartfoxserver.entities.Room
Returns false if the provided User is not allowed to join this Room.
isJoinAllowed(User) - Method in class com.smartfoxserver.entities.SFSRoom
 
isJoinedInRoom(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
isJoinedInRoom(Room) - Method in interface com.smartfoxserver.entities.User
Check if a User is joined in a Room
isJoining() - Method in class com.smartfoxserver.entities.SFSUser
 
isJoining() - Method in interface com.smartfoxserver.entities.User
 
isLagMonitorKeepAlive() - Method in class com.smartfoxserver.entities.SFSZone
 
isLagMonitorKeepAlive() - Method in interface com.smartfoxserver.entities.Zone
Returns true if the LagMonitor requests are also actively resetting the User's idle timer
isLeaveLastJoindRoom() - Method in class com.smartfoxserver.game.BaseGameInvitationCallback
Check if the join operation should include leaving the last joined Room
isLeaveLastJoinedRoom() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
Check if the Player should be removed from its previous Room after he joins the Game
isLeaveLastRoomOnJoin() - Method in class com.smartfoxserver.game.SFSGame
 
isLogFloodingAttempts() - Method in interface com.smartfoxserver.util.IFloodFilter
 
isLogFloodingAttempts() - Method in class com.smartfoxserver.util.SFSFloodFilter
 
isLoggedIn() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Check if the the Session is logged in.
isLoggedIn() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
isMarkedForEviction() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
isMarkedForEviction() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
isNameBanned(String, String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
isNormalized() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns true if the vector is normalized, i.e., its length is approximately equal to 1.
isNormalized() - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns true if the vector is normalized, i.e., its length is approximately equal to 1.
isNotifyGameStarted() - Method in class com.smartfoxserver.game.SFSGame
 
isNotifyGameStartedViaRoomVariable() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
Turn on the notification of the Game state (started, not-started) by the way of a reserved global Room Variable.
isNpc() - Method in class com.smartfoxserver.entities.SFSUser
 
isNpc() - Method in interface com.smartfoxserver.entities.User
Returns the NPC flag
isNull() - Method in interface com.smartfoxserver.entities.variables.Variable
Test if a variable is null
isNull(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Checks if a specific element is null.
isNull(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
isNull(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Checks if a specific element is of SFSDataType.NULL.
isNull(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
isOffline() - Method in interface com.smartfoxserver.buddylist.BuddyVariable
Checks if this is a "offline" variable (persistent), which is available to other Users even when the client is not online.
isOffline() - Method in class com.smartfoxserver.buddylist.SFSBuddyVariable
 
isOnline() - Method in interface com.smartfoxserver.buddylist.Buddy
Checks if the Buddy is active in the system
isOnline() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
isOnline() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
isOnline() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
isOwnedBy(User) - Method in interface com.smartfoxserver.entities.Room
Return true if the Room is owned by the provided User object.
isOwnedBy(User) - Method in class com.smartfoxserver.entities.SFSRoom
 
isPasswordProtected() - Method in interface com.smartfoxserver.entities.Room
Checks if the Room requires a password for joining it
isPasswordProtected() - Method in class com.smartfoxserver.entities.SFSRoom
Checks if the Room requires a password for joining it
isPersistent() - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
isPersistent() - Method in interface com.smartfoxserver.entities.variables.RoomVariable
Checks if a RoomVariable is persistent
isPersistent() - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
Checks if a RoomVariable is persistent
isPlayer() - Method in class com.smartfoxserver.entities.SFSUser
 
isPlayer() - Method in interface com.smartfoxserver.entities.User
Check if the User is a Player in the current Room (only for Game Rooms)
isPlayer(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
isPlayer(Room) - Method in interface com.smartfoxserver.entities.User
Check if the User is Player in a specific Room
isPrivate() - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
Checks if a RoomVariable is private.
isPrivate() - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
Checks whether a UserVariable is private.
isPrivate() - Method in interface com.smartfoxserver.entities.variables.UserVariable
A private UserVariable is only known and updated for the owner, not other clients
isProcessControlAllowed() - Method in class com.smartfoxserver.SmartFoxServer
 
isPublic() - Method in interface com.smartfoxserver.entities.Room
Returns true if the Room has public access, in other words it doesn't require a password.
isPublic() - Method in class com.smartfoxserver.entities.SFSRoom
Returns true if the Room has public access, in other words it doesn't require a password.
isReconnectionTimeExpired() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
isReconnectionTimeExpired() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
isRequestAllowed(SystemRequest) - Method in class com.smartfoxserver.security.SFSPermissionProfile
 
isRequestAllowed(User, SystemRequest) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
isRequestAllowed(User, SystemRequest) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
isRequestFiltered(SystemRequest) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
isRequestFiltered(T) - Method in interface com.smartfoxserver.util.IFloodFilter
 
isSendAOIEntryPoint() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
 
isSendAOIEntryPoint() - Method in class com.smartfoxserver.mmo.MMORoom
 
isSpectator() - Method in class com.smartfoxserver.entities.SFSUser
 
isSpectator() - Method in interface com.smartfoxserver.entities.User
Check if the User is a Spectator in the current Room (only for Game Rooms)
isSpectator(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
isSpectator(Room) - Method in interface com.smartfoxserver.entities.User
Check if the User is Spectator in a specific Room
isStarted() - Method in class com.smartfoxserver.SmartFoxServer
 
isStop() - Method in exception class com.smartfoxserver.exceptions.SFSLoginInterruptedException
 
isStorable() - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
Storable variables can be saved by the Room Persistence API
isStorable() - Method in interface com.smartfoxserver.entities.variables.UserVariable
Storable variables can be saved by the Room Persistence API
isSubscribedToGroup(String) - Method in class com.smartfoxserver.entities.SFSUser
 
isSubscribedToGroup(String) - Method in interface com.smartfoxserver.entities.User
Check if the User is subscribed to a certain Room Group
isSuperUser() - Method in class com.smartfoxserver.entities.SFSUser
 
isSuperUser() - Method in interface com.smartfoxserver.entities.User
Check if the User has SuperUser privileges (allows to send mod/admin messages and kick/ban Users)
isSuppressUserList() - Method in class com.smartfoxserver.api.CreateRoomSettings
Check whether or not the client side User list is suppressed for this Room
isSuppressUserList() - Method in interface com.smartfoxserver.entities.Room
 
isSuppressUserList() - Method in class com.smartfoxserver.entities.SFSRoom
 
isSuppressUserList() - Method in class com.smartfoxserver.mmo.MMORoom
 
isTemp() - Method in interface com.smartfoxserver.buddylist.Buddy
A temporary Buddy will only exist at runtime but will be lost as soon as he goes away or the user is disconnected.
isTemp() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
isUdpConnected() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
isUdpConnected() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
isUdpKeepAlive() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
isUdpKeepAlive() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
isUdpKeepAlive() - Method in class com.smartfoxserver.entities.SFSZone
 
isUdpKeepAlive() - Method in interface com.smartfoxserver.entities.Zone
 
isUploadEnabled() - Method in class com.smartfoxserver.entities.SFSZone
True if the Zone supports HTTP uploads.
isUploadEnabled() - Method in interface com.smartfoxserver.entities.Zone
True if the Zone supports HTTP uploads.
isUseWarnings() - Method in class com.smartfoxserver.util.SFSWordFilter
 
isUseWordsFilter() - Method in class com.smartfoxserver.api.CreateRoomSettings
Check if the word filter is used in this Room (applied to Public Messages)
isUseWordsFilter() - Method in interface com.smartfoxserver.entities.Room
Check if the word filter is used in this Room (applied to Public Messages)
isUseWordsFilter() - Method in class com.smartfoxserver.entities.SFSRoom
Check if the word filter is used in this Room (applied to Public Messages)
ISystemFilter - Interface in com.smartfoxserver.controllers.filter
 
ISystemFilterChain - Interface in com.smartfoxserver.controllers.filter
 
iterator() - Method in interface com.smartfoxserver.entities.data.ISFSArray
 
iterator() - Method in interface com.smartfoxserver.entities.data.ISFSObject
Return an Iterator to loop through the collection of values
iterator() - Method in class com.smartfoxserver.entities.data.SFSArray
 
iterator() - Method in class com.smartfoxserver.entities.data.SFSObject
 
IVersion - Interface in com.smartfoxserver.entities
 

J

JOIN_ALREADY_JOINED - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
JOIN_BAD_PASSWORD - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
JOIN_BAD_ROOM - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
JOIN_GAME_ACCESS_DENIED - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
JOIN_GAME_NOT_FOUND - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
JOIN_ROOM_FULL - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
JOIN_ROOM_LOCKED - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
JOINED_ROOMS - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The list of joined Rooms of a User that was disconnected ( List of Room )
Joining and Setting a User position - Search tag in class com.smartfoxserver.mmo.MMORoom
Section
joinRoom(User, Room) - Method in interface com.smartfoxserver.api.ISFSApi
Join the user in a room.
joinRoom(User, Room) - Method in class com.smartfoxserver.api.SFSApi
Join the user in a room.
joinRoom(User, Room, String, boolean, Room) - Method in interface com.smartfoxserver.api.ISFSApi
Join the user in a room.
A client update and server side event will be also fired
joinRoom(User, Room, String, boolean, Room) - Method in class com.smartfoxserver.api.SFSApi
Join the user in a room.
A client update and server side event will be also fired
joinRoom(User, Room, String, boolean, Room, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Join the user in a Room.
joinRoom(User, Room, String, boolean, Room, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
Join the user in a Room.
JoinRoom - Class in com.smartfoxserver.controllers.system
 
JoinRoom - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
JoinRoom() - Constructor for class com.smartfoxserver.controllers.system.JoinRoom
 
JoinRoomInvitationCallback - Class in com.smartfoxserver.game
 
JoinRoomInvitationCallback(Room) - Constructor for class com.smartfoxserver.game.JoinRoomInvitationCallback
 
JoinRoomInvite - Class in com.smartfoxserver.controllers.system.game
 
JoinRoomInvite - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
JoinRoomInvite() - Constructor for class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 

K

KeepAlive - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
keepAliveMinutes - Variable in class com.smartfoxserver.db.DBConfig
Leave this disabled (set to zero) unless you really know what you're doing.
KEY_ADMIN_PWD_HASHED - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_ALLOW_AUDIO_STREAMING - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_ALLOW_JOIN_INVITATION_BY_OWNER - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_AOI - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_API - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_AS_SPECT - Static variable in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
KEY_AS_SPECTATOR - Static variable in class com.smartfoxserver.controllers.system.JoinRoom
 
KEY_AUDIO_STREAMING_ENABLED - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_AUTO_JOIN - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_BAN_DURATION_HOURS - Static variable in class com.smartfoxserver.controllers.system.BanUser
 
KEY_BAN_MODE - Static variable in class com.smartfoxserver.controllers.system.BanUser
 
KEY_BIN_FLAG - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_BUDDY - Static variable in class com.smartfoxserver.controllers.system.buddylist.BlockBuddy
 
KEY_BUDDY_BLOCK_STATE - Static variable in class com.smartfoxserver.controllers.system.buddylist.BlockBuddy
 
KEY_BUDDY_ID - Static variable in class com.smartfoxserver.controllers.system.buddylist.GoOnline
 
KEY_BUDDY_LIST - Static variable in class com.smartfoxserver.controllers.system.buddylist.InitBuddyList
 
KEY_BUDDY_NAME - Static variable in class com.smartfoxserver.controllers.system.buddylist.AddBuddy
 
KEY_BUDDY_NAME - Static variable in class com.smartfoxserver.controllers.system.buddylist.BlockBuddy
 
KEY_BUDDY_NAME - Static variable in class com.smartfoxserver.controllers.system.buddylist.GoOnline
 
KEY_BUDDY_NAME - Static variable in class com.smartfoxserver.controllers.system.buddylist.RemoveBuddy
 
KEY_BUDDY_NAME - Static variable in class com.smartfoxserver.controllers.system.buddylist.SetBuddyVariables
 
KEY_BUDDY_STATES - Static variable in class com.smartfoxserver.controllers.system.buddylist.InitBuddyList
 
KEY_BUDDY_VARS - Static variable in class com.smartfoxserver.controllers.system.buddylist.SetBuddyVariables
 
KEY_CLIENT_TYPE - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_COMPRESSION_THRESHOLD - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_DELAY - Static variable in class com.smartfoxserver.controllers.system.BanUser
 
KEY_DELAY - Static variable in class com.smartfoxserver.controllers.system.KickUser
 
KEY_EVENTS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_EXPIRY_SECONDS - Static variable in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
KEY_EXPRESSION - Static variable in class com.smartfoxserver.controllers.system.FindRooms
 
KEY_EXPRESSION - Static variable in class com.smartfoxserver.controllers.system.FindUsers
 
KEY_EXTCLASS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_EXTID - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_EXTPROP - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_FILTERED_ROOMS - Static variable in class com.smartfoxserver.controllers.system.FindRooms
 
KEY_FILTERED_USERS - Static variable in class com.smartfoxserver.controllers.system.FindUsers
 
KEY_GROUP - Static variable in class com.smartfoxserver.controllers.system.FindRooms
 
KEY_GROUP - Static variable in class com.smartfoxserver.controllers.system.FindUsers
 
KEY_GROUP_ID - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_GROUP_ID - Static variable in class com.smartfoxserver.controllers.system.SubscribeRoomGroup
 
KEY_GROUP_ID - Static variable in class com.smartfoxserver.controllers.system.UnsubscribeRoomGroup
 
KEY_GROUP_LIST - Static variable in class com.smartfoxserver.controllers.system.game.QuickJoinGame
 
KEY_GROUP_LIST - Static variable in class com.smartfoxserver.controllers.system.QuickJoinOrCreateRoom
 
KEY_ID - Static variable in class com.smartfoxserver.controllers.system.Login
 
KEY_INTERVAL - Static variable in class com.smartfoxserver.controllers.system.BanUsersFromRoom
 
KEY_INVITATION_EXPIRY - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_INVITATION_ID - Static variable in class com.smartfoxserver.controllers.system.game.InvitationReply
 
KEY_INVITATION_ID - Static variable in class com.smartfoxserver.controllers.system.game.InviteUser
 
KEY_INVITATION_PARAMS - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_INVITATION_PARAMS - Static variable in class com.smartfoxserver.controllers.system.game.InvitationReply
 
KEY_INVITATION_REPLY - Static variable in class com.smartfoxserver.controllers.system.game.InvitationReply
 
KEY_INVITED_NAMES - Static variable in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
KEY_INVITED_PLAYERS - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_INVITED_USERS - Static variable in class com.smartfoxserver.controllers.system.game.InviteUser
 
KEY_IS_PUBLIC - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_ISGAME - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_ITEM_ID - Static variable in class com.smartfoxserver.controllers.system.SetMMOItemVariables
 
KEY_LEAVE_ROOM - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_LIMIT - Static variable in class com.smartfoxserver.controllers.system.FindRooms
 
KEY_LIMIT - Static variable in class com.smartfoxserver.controllers.system.FindUsers
 
KEY_MATCH_EXPRESSION - Static variable in class com.smartfoxserver.controllers.system.game.QuickJoinGame
 
KEY_MATCH_EXPRESSION - Static variable in class com.smartfoxserver.controllers.system.QuickJoinOrCreateRoom
 
KEY_MAX_MESSAGE_SIZE - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_MAX_SPECT - Static variable in class com.smartfoxserver.controllers.system.ChangeRoomCapacity
 
KEY_MAX_USERS - Static variable in class com.smartfoxserver.controllers.system.ChangeRoomCapacity
 
KEY_MAXSPECTATORS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MAXUSERS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MAXVARS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MESSAGE - Static variable in class com.smartfoxserver.controllers.system.BanUser
 
KEY_MESSAGE - Static variable in class com.smartfoxserver.controllers.system.BanUsersFromRoom
 
KEY_MESSAGE - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_MESSAGE - Static variable in class com.smartfoxserver.controllers.system.KickUser
 
KEY_MESSAGE_TYPE - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_MIN_PLAYERS - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_MINUS_ITEM_LIST - Static variable in class com.smartfoxserver.controllers.system.SetUserPosition
 
KEY_MINUS_USER_LIST - Static variable in class com.smartfoxserver.controllers.system.SetUserPosition
 
KEY_MMO_DEFAULT_AOI - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MMO_MAP_HIGH_LIMIT - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MMO_MAP_LOW_LIMIT - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MMO_PROXIMITY_UPDATE_MILLIS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MMO_SEND_ENTRY_POINT - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MMO_USER_MAX_LIMBO_SECONDS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_MY_VARS - Static variable in class com.smartfoxserver.controllers.system.buddylist.InitBuddyList
 
KEY_NAME - Static variable in class com.smartfoxserver.controllers.system.ChangeRoomName
 
KEY_NAME - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_NOTIFY_GAME_STARTED - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_ONLINE - Static variable in class com.smartfoxserver.controllers.system.buddylist.GoOnline
 
KEY_OPTIONAL_PARAMS - Static variable in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
KEY_PARAMS - Static variable in class com.smartfoxserver.controllers.system.game.InviteUser
 
KEY_PARAMS - Static variable in class com.smartfoxserver.controllers.system.Login
 
KEY_PASS - Static variable in class com.smartfoxserver.controllers.system.ChangeRoomPassword
 
KEY_PASS - Static variable in class com.smartfoxserver.controllers.system.JoinRoom
 
KEY_PASSWORD - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_PASSWORD - Static variable in class com.smartfoxserver.controllers.system.Login
 
KEY_PERMISSIONS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_PLAYER_ID - Static variable in class com.smartfoxserver.controllers.system.SpectatorToPlayer
 
KEY_PLAYER_MATCH_EXP - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_PLUS_ITEM_LIST - Static variable in class com.smartfoxserver.controllers.system.SetUserPosition
 
KEY_PLUS_USER_LIST - Static variable in class com.smartfoxserver.controllers.system.SetUserPosition
 
KEY_PRIVILEGE_ID - Static variable in class com.smartfoxserver.controllers.system.Login
 
KEY_RECIPIENT - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_RECIPIENT_MODE - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_RECONNECTION_SECONDS - Static variable in class com.smartfoxserver.controllers.system.Login
 
KEY_RECONNECTION_TOKEN - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_REPLY_ID - Static variable in class com.smartfoxserver.controllers.system.game.InviteUser
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.BanUsersFromRoom
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.ChangeRoomCapacity
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.ChangeRoomName
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.ChangeRoomPassword
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.FindUsers
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.JoinRoom
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.PlayerToSpectator
 
KEY_ROOM - Static variable in class com.smartfoxserver.controllers.system.SpectatorToPlayer
 
KEY_ROOM_ID - Static variable in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
KEY_ROOM_ID - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_ROOM_ID - Static variable in class com.smartfoxserver.controllers.system.JoinRoom
 
KEY_ROOM_ID - Static variable in class com.smartfoxserver.controllers.system.LeaveRoom
 
KEY_ROOM_ID - Static variable in class com.smartfoxserver.controllers.system.SetMMOItemVariables
 
KEY_ROOM_ID - Static variable in class com.smartfoxserver.controllers.system.SetUserPosition
 
KEY_ROOM_LIST - Static variable in class com.smartfoxserver.controllers.system.game.QuickJoinGame
 
KEY_ROOM_LIST - Static variable in class com.smartfoxserver.controllers.system.SubscribeRoomGroup
 
KEY_ROOM_NAME - Static variable in class com.smartfoxserver.controllers.system.JoinRoom
 
KEY_ROOM_SETTINGS - Static variable in class com.smartfoxserver.controllers.system.QuickJoinOrCreateRoom
 
KEY_ROOM_TO_LEAVE - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_ROOM_TO_LEAVE - Static variable in class com.smartfoxserver.controllers.system.game.QuickJoinGame
 
KEY_ROOM_TO_LEAVE - Static variable in class com.smartfoxserver.controllers.system.JoinRoom
 
KEY_ROOM_TO_LEAVE - Static variable in class com.smartfoxserver.controllers.system.QuickJoinOrCreateRoom
 
KEY_ROOMLIST - Static variable in class com.smartfoxserver.controllers.system.Login
 
KEY_ROOMVARS - Static variable in class com.smartfoxserver.controllers.system.CreateRoom
 
KEY_SEARCHABLE_ROOMS - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_SENDER_DATA - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_SPECTATOR_MATCH_EXP - Static variable in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
KEY_TIME - Static variable in class com.smartfoxserver.controllers.system.game.InviteUser
 
KEY_TIME_UNIT - Static variable in class com.smartfoxserver.controllers.system.BanUsersFromRoom
 
KEY_TOKEN - Static variable in class com.smartfoxserver.controllers.system.Handshake
 
KEY_USER - Static variable in class com.smartfoxserver.controllers.system.game.InviteUser
 
KEY_USER - Static variable in class com.smartfoxserver.controllers.system.SetUserVariables
 
KEY_USER_ID - Static variable in class com.smartfoxserver.controllers.system.BanUser
 
KEY_USER_ID - Static variable in class com.smartfoxserver.controllers.system.game.InviteUser
 
KEY_USER_ID - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_USER_ID - Static variable in class com.smartfoxserver.controllers.system.KickUser
 
KEY_USER_ID - Static variable in class com.smartfoxserver.controllers.system.PlayerToSpectator
 
KEY_USER_ID - Static variable in class com.smartfoxserver.controllers.system.SpectatorToPlayer
 
KEY_USER_LIST - Static variable in class com.smartfoxserver.controllers.system.JoinRoom
 
KEY_USERNAME - Static variable in class com.smartfoxserver.controllers.system.Login
 
KEY_USERS - Static variable in class com.smartfoxserver.controllers.system.BanUsersFromRoom
 
KEY_VAR_LIST - Static variable in class com.smartfoxserver.controllers.system.SetMMOItemVariables
 
KEY_VAR_LIST - Static variable in class com.smartfoxserver.controllers.system.SetRoomVariables
 
KEY_VAR_LIST - Static variable in class com.smartfoxserver.controllers.system.SetUserVariables
 
KEY_VAR_ROOM - Static variable in class com.smartfoxserver.controllers.system.SetRoomVariables
 
KEY_VEC3D - Static variable in class com.smartfoxserver.controllers.system.SetUserPosition
 
KEY_XTRA_PARAMS - Static variable in class com.smartfoxserver.controllers.system.GenericMessage
 
KEY_ZONE_NAME - Static variable in class com.smartfoxserver.controllers.system.Logout
 
KEY_ZONENAME - Static variable in class com.smartfoxserver.controllers.system.Login
 
KICK - Enum constant in enum class com.smartfoxserver.util.ClientDisconnectionReason
The client was kicked (by a mod or admin User)
kickUser(User, User, String, int) - Method in interface com.smartfoxserver.api.ISFSApi
Kicks the User out.
kickUser(User, User, String, int) - Method in class com.smartfoxserver.api.SFSApi
Kicks the User out.
kickUser(User, User, String, int) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
kickUser(User, User, String, int, boolean) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
KickUser - Class in com.smartfoxserver.controllers.system
 
KickUser - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
KickUser() - Constructor for class com.smartfoxserver.controllers.system.KickUser
 
killConnection(User) - Method in interface com.smartfoxserver.api.ISFSApi
Simulates a sudden connection drop to test the reconnection system (HRC)
killConnection(User) - Method in class com.smartfoxserver.api.SFSApi
Simulates a sudden connection drop to test the reconnection system (HRC)

L

lagMonitorKeepAlive - Variable in class com.smartfoxserver.entities.SFSZone
 
leaveRoom(User, Room) - Method in interface com.smartfoxserver.api.ISFSApi
Removes a User from a previously joined Room
leaveRoom(User, Room) - Method in class com.smartfoxserver.api.SFSApi
Removes a User from a previously joined Room
leaveRoom(User, Room, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Removes a User from a previously joined Room
leaveRoom(User, Room, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
Removes a User from a previously joined Room
LeaveRoom - Class in com.smartfoxserver.controllers.system
 
LeaveRoom - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
LeaveRoom() - Constructor for class com.smartfoxserver.controllers.system.LeaveRoom
 
LEFT_THE_SERVER - Enum constant in enum class com.smartfoxserver.buddylist.BuddyOnlineState
The Buddy left the server
LegacyPasswordRecovery - Class in com.smartfoxserver.components.signup
 
LegacyPasswordRecovery() - Constructor for class com.smartfoxserver.components.signup.LegacyPasswordRecovery
 
length() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns the length (magnitude) of this vector.
length() - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns the length (magnitude) of this vector.
lerp(SFSVector2, float) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns the result of the linear interpolation between this vector and the specified vector by the specified weight.
lerp(SFSVector3, float) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns the result of the linear interpolation between this vector and the specified vector by the specified weight.
LESS_THAN - Enum constant in enum class com.smartfoxserver.entities.match.NumberMatch
Checks that Num1 < Num2
LESS_THAN_OR_EQUAL_TO - Enum constant in enum class com.smartfoxserver.entities.match.NumberMatch
Checks that Num1 <= Num2
loadAllRooms() - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Load all stored Rooms for this Zone
loadAllRooms(String) - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Load all Rooms belonging to a specific Room Group
loadBuddyList(String) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Use the SFSBuddyAPI
loadBuddyList(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Use the SFSBuddyAPI
loadExpressionList() - Method in class com.smartfoxserver.util.SFSWordFilter
 
loadList(String) - Method in interface com.smartfoxserver.buddylist.storage.BuddyStorage
Load a Buddy List from your data source.
loadList(String) - Method in class com.smartfoxserver.buddylist.storage.FSBuddyStorage
 
loadRoom(String) - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Loads the setting of a previously saved Room
log - Variable in class com.smartfoxserver.api.SFSApi
 
log - Variable in class com.smartfoxserver.api.SFSBuddyApi
 
log - Variable in class com.smartfoxserver.api.SFSGameApi
 
log - Variable in class com.smartfoxserver.api.SFSMMOApi
 
log - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
log - Variable in class com.smartfoxserver.db.SFSDBManager
 
log - Variable in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
log - Variable in class com.smartfoxserver.extensions.BaseSFSExtension
 
log - Variable in class com.smartfoxserver.game.BaseGameInvitationCallback
A reference to the logger
Loggable - Interface in com.smartfoxserver.entities
 
logger - Variable in class com.smartfoxserver.controllers.filter.SysControllerFilter
 
logger - Variable in class com.smartfoxserver.entities.SFSRoom
 
login(ISession, String, String, String, ISFSObject) - Method in interface com.smartfoxserver.api.ISFSApi
 
login(ISession, String, String, String, ISFSObject) - Method in class com.smartfoxserver.api.SFSApi
login(ISession, String, String, String, ISFSObject, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
 
login(ISession, String, String, String, ISFSObject, boolean) - Method in class com.smartfoxserver.api.SFSApi
login(LoginData) - Method in class com.smartfoxserver.entities.SFSZone
login(LoginData) - Method in interface com.smartfoxserver.entities.Zone
 
Login - Class in com.smartfoxserver.controllers.system
 
Login - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
Login() - Constructor for class com.smartfoxserver.controllers.system.Login
 
LOGIN_ALREADY_LOGGED - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_BAD_PASSWORD - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_BAD_USERNAME - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_BAD_ZONENAME - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_BANNED_IP - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_BANNED_USER - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_GUEST_NOT_ALLOWED - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_IN_DATA - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The custom data sent at login time ( SFSObject )
LOGIN_INACTIVE_ZONE - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_NAME - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The user name sent at login time ( String )
LOGIN_NAME_CONTAINS_BAD_WORDS - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_OUT_DATA - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The custom data to return to the user after a successful login ( SFSObject )
LOGIN_PASSWORD - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The user password sent at login time ( String )
LOGIN_SERVER_FULL - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LOGIN_ZONE_FULL - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
LoginAssistantComponent - Class in com.smartfoxserver.components.login
Overview
LoginAssistantComponent(ISFSExtension) - Constructor for class com.smartfoxserver.components.login.LoginAssistantComponent
 
LoginConfiguration - Class in com.smartfoxserver.components.login
This is the main configuration object used by the Login Assistant to load data from the user's database.
LoginConfiguration() - Constructor for class com.smartfoxserver.components.login.LoginConfiguration
 
LoginData - Class in com.smartfoxserver.components.login
This object is passed to an ILoginAssistantPlugin at runtime, during the login process.
LoginData - Class in com.smartfoxserver.entities
 
LoginData() - Constructor for class com.smartfoxserver.components.login.LoginData
 
LoginData() - Constructor for class com.smartfoxserver.entities.LoginData
 
LoginData(ISession, String) - Constructor for class com.smartfoxserver.entities.LoginData
 
LoginData(ISession, String, String) - Constructor for class com.smartfoxserver.entities.LoginData
 
LoginData(ISession, String, String, ISFSObject, boolean) - Constructor for class com.smartfoxserver.entities.LoginData
 
LoginFinalizer - Class in com.smartfoxserver.entities
 
LoginFinalizer(Zone) - Constructor for class com.smartfoxserver.entities.LoginFinalizer
 
loginTable - Variable in class com.smartfoxserver.components.login.LoginConfiguration
The name of the Database table where user profiles are stored, default is 'users'
logout(User) - Method in interface com.smartfoxserver.api.ISFSApi
Log a User out of the current Zone
logout(User) - Method in class com.smartfoxserver.api.SFSApi
Log a User out of the current Zone
Logout - Class in com.smartfoxserver.controllers.system
 
Logout - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
Logout() - Constructor for class com.smartfoxserver.controllers.system.Logout
 
logSQL - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
(Debug Only) logs every SQL query for testing / debugging purposes.
LONG - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
LONG - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
LONG_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
LOW - Enum constant in enum class com.smartfoxserver.bitswarm.data.MessagePriority
 

M

major() - Method in class com.smartfoxserver.entities.SFSVersion
 
MANUAL - Enum constant in enum class com.smartfoxserver.extensions.ExtensionReloadMode
Extension is reloaded manually via the Admin Tool
ManualDisconnection - Class in com.smartfoxserver.controllers.system
 
ManualDisconnection - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
ManualDisconnection() - Constructor for class com.smartfoxserver.controllers.system.ManualDisconnection
 
MapLimits(Vec3D, Vec3D) - Constructor for class com.smartfoxserver.mmo.CreateMMORoomSettings.MapLimits
 
Map limits - Search tag in class com.smartfoxserver.mmo.MMORoom
Section
MatchExpression - Class in com.smartfoxserver.entities.match
Overview
MatchExpression(String, IMatcher, Object) - Constructor for class com.smartfoxserver.entities.match.MatchExpression
Example of matching a User to its variables:
max(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector with the component-wise maximum of this vector and the specified vector.
max(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector with the component-wise maximum of this vector and the specified vector.
MAX_ARRAY_SIZE - Static variable in class com.smartfoxserver.entities.data.SFSDataSize
 
MAX_SHORT_STRING_SIZE - Static variable in class com.smartfoxserver.entities.data.SFSDataSize
 
MAX_SPECTATORS - Static variable in class com.smartfoxserver.entities.match.RoomProperties
The Room max spectators
MAX_STRING_SIZE - Static variable in class com.smartfoxserver.entities.data.SFSDataSize
 
MAX_TEXT_SIZE - Static variable in class com.smartfoxserver.entities.data.SFSDataSize
 
MAX_USERS - Static variable in class com.smartfoxserver.entities.match.RoomProperties
The Room max users
maxActiveConnections - Variable in class com.smartfoxserver.db.DBConfig
The maximum number of active connections in the connection pool A default value of 10 should be enough for most high traffic scenarios.
maxEmailLength - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Maximum length of the email field.
maxInvitationsPerUser - Variable in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
maxListSize - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
maxPasswordLength - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Maximum length of the user password.
maxResendTimes - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.EmailConfig
Determines how many times a user can request the Activation email to be re-sent in case the previous one wasn't received.
maxUserNameLength - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Maximum length of the user name.
maxVariables - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
MESSAGE - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The chat message ( String )
MessagePriority - Enum Class in com.smartfoxserver.bitswarm.data
 
micro() - Method in class com.smartfoxserver.entities.SFSVersion
 
min(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector with the component-wise minimum of this vector and the specified vector.
min(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector with the component-wise minimum of this vector and the specified vector.
minor() - Method in class com.smartfoxserver.entities.SFSVersion
 
minPasswordLength - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Minimum length of the user password.
minUserNameLength - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Minimum length of the user name.
MISSING_EMAIL - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
MISSING_PASSWORD - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
MISSING_USERNAME - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
MMOItem - Class in com.smartfoxserver.mmo
An MMOItem represents a non-player entity inside an MMORoom.
MMOItem() - Constructor for class com.smartfoxserver.mmo.MMOItem
Creates a new MMOItem
MMOItem(List<IMMOItemVariable>) - Constructor for class com.smartfoxserver.mmo.MMOItem
Creates an MMOItem populated with custom variables
MMOItems - Search tag in class com.smartfoxserver.mmo.MMORoom
Section
MMOItemVariable - Class in com.smartfoxserver.mmo
MMOItem Variables allow to attach custom properties to MMOItems inside an MMORoom.
MMOItemVariable(String) - Constructor for class com.smartfoxserver.mmo.MMOItemVariable
 
MMOItemVariable(String, VariableType, String) - Constructor for class com.smartfoxserver.mmo.MMOItemVariable
 
MMOItemVariable(String, Object) - Constructor for class com.smartfoxserver.mmo.MMOItemVariable
Construct an MMOVariable with it's name and value.
MMOItemVariable(String, Object, boolean) - Constructor for class com.smartfoxserver.mmo.MMOItemVariable
Construct an MMOVariable with it's name and value.
MMOItemVariable(String, String, String) - Constructor for class com.smartfoxserver.mmo.MMOItemVariable
 
mmoResponseApi - Variable in class com.smartfoxserver.api.SFSMMOApi
 
MMORoom - Class in com.smartfoxserver.mmo
Overview
MMORoom(String, Vec3D, int) - Constructor for class com.smartfoxserver.mmo.MMORoom
 
MMORoom.PreviousMMORoomState - Class in com.smartfoxserver.mmo
 
MMORoom Settings: - Search tag in class com.smartfoxserver.mmo.CreateMMORoomSettings
Section
MOD_USER - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
Moderator/Admin User that triggered a certain operation (for example a Kick or Ban) ( User )
mode - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.PasswordRecovery
Specify the mode in which the Password Recovery service works GENERATE_NEW: generates a new password
mode - Variable in class com.smartfoxserver.entities.SFSBannedUser
 
MODERATOR - Enum constant in enum class com.smartfoxserver.security.DefaultPermissionProfile
 
ModeratorMessage - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
More Settings - Search tag in class com.smartfoxserver.api.CreateRoomSettings
Section
mult(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector that is the component-wise multiplication of this vector and the specified vector.
mult(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector that is the component-wise multiplication of this vector and the specified vector.
MultiHandler - Annotation Interface in com.smartfoxserver.annotations
Indicates if an handler class (e.g. for extension request/event) handling is a multi-handler.
MULTIHANDLER_REQUEST_ID - Static variable in class com.smartfoxserver.extensions.SFSExtension
 

N

name - Variable in class com.smartfoxserver.db.SFSDBManager
 
name - Variable in class com.smartfoxserver.entities.SFSBannedUser
 
NAME - Static variable in class com.smartfoxserver.entities.match.RoomProperties
The Room name
NAME - Static variable in class com.smartfoxserver.entities.match.UserProperties
The user name
NEVER_REMOVE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomRemoveMode
The Room is never removed (use with caution)
NEW_INSTANCE - Enum constant in enum class com.smartfoxserver.annotations.Instantiation.InstantiationMode
 
newFromBinaryData(byte[]) - Static method in class com.smartfoxserver.entities.data.SFSArray
Rebuild an SFSArray form its binary form
newFromBinaryData(byte[]) - Static method in class com.smartfoxserver.entities.data.SFSObject
Rebuild an SFSObject form its binary form
newFromBinaryData(ByteBuffer) - Static method in class com.smartfoxserver.entities.data.SFSObject
 
newFromJsonData(String) - Static method in class com.smartfoxserver.entities.data.SFSArray
 
newFromJsonData(String) - Static method in class com.smartfoxserver.entities.data.SFSObject
 
newFromResultSet(ResultSet) - Static method in class com.smartfoxserver.entities.data.SFSArray
 
newFromResultSet(ResultSet) - Static method in class com.smartfoxserver.entities.data.SFSObject
 
newFromRoomSettings(CreateRoomSettings) - Static method in class com.smartfoxserver.game.CreateSFSGameSettings
 
newFromSFSArray(ISFSArray) - Static method in class com.smartfoxserver.buddylist.SFSBuddyVariable
SFSArray is expected to be formatted as follows 0: (str) - name 1: (byte) - type id 2: (*) - value
newFromSFSArray(ISFSArray) - Static method in class com.smartfoxserver.entities.variables.SFSRoomVariable
 
newFromSFSArray(ISFSArray) - Static method in class com.smartfoxserver.entities.variables.SFSUserVariable
 
newFromSFSArray(ISFSArray) - Static method in class com.smartfoxserver.mmo.MMOItemVariable
 
newFromStringLiteral(String, String, String) - Static method in class com.smartfoxserver.entities.variables.SFSRoomVariable
 
newFromStringLiteral(String, String, String) - Static method in class com.smartfoxserver.entities.variables.SFSUserVariable
 
newFromStringLiteral(String, String, String) - Static method in class com.smartfoxserver.mmo.MMOItemVariable
 
newInstance() - Static method in class com.smartfoxserver.entities.data.SFSArray
Static constructor, similar to new SFSArray();
newInstance() - Static method in class com.smartfoxserver.entities.data.SFSArrayLite
 
newInstance() - Static method in class com.smartfoxserver.entities.data.SFSObject
Static constructor, similar to new SFSObject();
newInstance() - Static method in class com.smartfoxserver.entities.data.SFSObjectLite
 
newInstance() - Static method in class com.smartfoxserver.util.SHA256
 
newInstance(String, Object) - Static method in class com.smartfoxserver.mmo.MMOItemVariable
 
newPrivateVariable(String, Object) - Static method in class com.smartfoxserver.entities.variables.SFSUserVariable
Creates a private variable
next() - Method in class com.smartfoxserver.entities.match.MatchExpression
 
nickName - Variable in class com.smartfoxserver.components.login.LoginData
The optional nickname extracted from the database (might be null)
nickNameField - Variable in class com.smartfoxserver.components.login.LoginConfiguration
If the user name used for login is not to be used as the nickname of the user in the system, you can specify which other field in the database contains the nickname.
NO_IP - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 
NONE - Enum constant in enum class com.smartfoxserver.extensions.ExtensionReloadMode
Extension cannot be reloaded at runtime
NORMAL - Enum constant in enum class com.smartfoxserver.bitswarm.data.MessagePriority
 
normalize() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector that is the normalized (unit length) version of this vector.
normalize() - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector that is the normalized (unit length) version of this vector.
NOT_EQUALS - Enum constant in enum class com.smartfoxserver.entities.match.BoolMatch
Checks that Bool1 !
NOT_EQUALS - Enum constant in enum class com.smartfoxserver.entities.match.NumberMatch
Checks that Num1 !
NOT_EQUALS - Enum constant in enum class com.smartfoxserver.entities.match.StringMatch
Check that !
NULL - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
NULL - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
NumberMatch - Enum Class in com.smartfoxserver.entities.match
This matcher is used in MatchExpressions to check Numeric conditions

O

OBJECT - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
An object with extra data ( ISFSObject )
OBJECT - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
ObjectMessage - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
Obtain the entry point of other Users - Search tag in class com.smartfoxserver.mmo.MMORoom
Section
OFFLINE - Enum constant in enum class com.smartfoxserver.buddylist.BuddyOnlineState
The Buddy is off-line in the system
OFFLINE_PREFIX - Static variable in class com.smartfoxserver.buddylist.SFSBuddyVariable
 
offlineBuddyVariables - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
offlineVarsCache - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
onAccepted(Invitation, ISFSObject) - Method in interface com.smartfoxserver.entities.invitation.InvitationCallback
Fired when the invited User has accepted the invitation
onAccepted(Invitation, ISFSObject) - Method in class com.smartfoxserver.game.GenericInvitationCallback
 
onAccepted(Invitation, ISFSObject) - Method in class com.smartfoxserver.game.JoinRoomInvitationCallback
 
onAccepted(Invitation, ISFSObject) - Method in class com.smartfoxserver.game.SFSGameInvitationCallback
 
OnClientDisconnection - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
OnEnterRoom - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
onError(Email, Throwable) - Method in interface com.smartfoxserver.entities.managers.IMailerCallbackHandler
Called when the SMTP incurred in an error sending the email
onExpired(Invitation) - Method in interface com.smartfoxserver.entities.invitation.InvitationCallback
The event is fired when the invitation has expired or if the invitee gets disconnected before he sends a response.
onExpired(Invitation) - Method in class com.smartfoxserver.game.GenericInvitationCallback
 
onExpired(Invitation) - Method in class com.smartfoxserver.game.JoinRoomInvitationCallback
 
onExpired(Invitation) - Method in class com.smartfoxserver.game.SFSGameInvitationCallback
 
OnGameServerConnectionRequired - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
onInvitationResult(int, InvitationResponse, ISFSObject) - Method in interface com.smartfoxserver.entities.invitation.InvitationManager
Handle the response to an invitation
onInvitationResult(int, InvitationResponse, ISFSObject) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
onInvitationResult(Invitation, InvitationResponse, ISFSObject) - Method in interface com.smartfoxserver.entities.invitation.InvitationManager
Handle the response to an invitation
onInvitationResult(Invitation, InvitationResponse, ISFSObject) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
ONLINE - Enum constant in enum class com.smartfoxserver.buddylist.BuddyOnlineState
The Buddy is online in the system
Online State - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
OnLoadBalanceError - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
OnMMOItemVariablesUpdate - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
onRefused(Invitation, ISFSObject) - Method in interface com.smartfoxserver.entities.invitation.InvitationCallback
Fired when the invited User has refused the invitation
onRefused(Invitation, ISFSObject) - Method in class com.smartfoxserver.game.GenericInvitationCallback
 
onRefused(Invitation, ISFSObject) - Method in class com.smartfoxserver.game.JoinRoomInvitationCallback
 
onRefused(Invitation, ISFSObject) - Method in class com.smartfoxserver.game.SFSGameInvitationCallback
 
OnRoomCountChange - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
OnRoomLost - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
onRoomResize() - Method in class com.smartfoxserver.util.DefaultPlayerIdGenerator
 
onRoomResize() - Method in interface com.smartfoxserver.util.IPlayerIdGenerator
This method is invoked upon a Room size change.
onSuccess(Email) - Method in interface com.smartfoxserver.entities.managers.IMailerCallbackHandler
Called when an email was successfully delivered to the SMTP server
OnUserExitRoom - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
OnUserLost - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
or(String, IMatcher, Object) - Method in class com.smartfoxserver.entities.match.MatchExpression
Concatenates two expressions with the logical OR operator.
Overview - Search tag in class com.smartfoxserver.api.SFSApi
Section
Overview - Search tag in class com.smartfoxserver.bitswarm.sessions.Session
Section
Overview - Search tag in class com.smartfoxserver.components.login.LoginAssistantComponent
Section
Overview - Search tag in class com.smartfoxserver.components.signup.SignUpAssistantComponent
Section
Overview - Search tag in class com.smartfoxserver.entities.SFSRoom
Section
Overview - Search tag in class com.smartfoxserver.entities.SFSUser
Section
Overview - Search tag in class com.smartfoxserver.entities.SFSZone
Section
Overview - Search tag in class com.smartfoxserver.entities.invitation.SFSInvitation
Section
Overview - Search tag in class com.smartfoxserver.entities.match.MatchExpression
Section
Overview - Search tag in class com.smartfoxserver.game.CreateSFSGameSettings
Section
Overview - Search tag in class com.smartfoxserver.mmo.MMORoom
Section
Overview - Search tag in class com.smartfoxserver.util.TaskScheduler
Section
Overview - Search tag in interface com.smartfoxserver.extensions.filter.IFilter
Section
Overview - Search tag in interface com.smartfoxserver.util.IPlayerIdGenerator
Section

P

PACKET_READ_STATE - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 
paramsOut - Variable in class com.smartfoxserver.entities.LoginData
 
parentExtension - Variable in class com.smartfoxserver.extensions.filter.SFSExtensionFilter
 
parentZone - Variable in class com.smartfoxserver.db.SFSDBManager
 
password - Variable in class com.smartfoxserver.components.login.LoginData
The password extracted from the database
password - Variable in class com.smartfoxserver.db.DBConfig
The password for accessing the database
password - Variable in class com.smartfoxserver.entities.LoginData
 
PASSWORD_STATE_CHANGE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomEvents
This event is notified every time a Room password is changed
PASSWORD_STATE_CHANGE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomSettings
Toggles the ability to change the password of a Room at runtime
PASSWORD_TOO_LONG - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
PASSWORD_TOO_SHORT - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
PasswordCheckException - Exception Class in com.smartfoxserver.components.login
 
PasswordCheckException() - Constructor for exception class com.smartfoxserver.components.login.PasswordCheckException
 
passwordField - Variable in class com.smartfoxserver.components.login.LoginConfiguration
The name of the field in the Database containing the user password, default is 'password'
passwordField - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
The name of the field used to store the user password.
passwordMode - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Indicates how the password should be stored in the database
PasswordMode - Enum Class in com.smartfoxserver.components.signup
Indicates how the password should be stored in the database
passwordRecovery - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
Configures the Password Recovery service
PasswordRecovery() - Constructor for class com.smartfoxserver.components.signup.SignUpConfiguration.PasswordRecovery
 
Persistence - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
PingPong - Class in com.smartfoxserver.controllers.system
 
PingPong - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
PingPong() - Constructor for class com.smartfoxserver.controllers.system.PingPong
 
PLAIN_TEXT - Enum constant in enum class com.smartfoxserver.components.signup.PasswordMode
The password will be stored as plain text in the assigned database field.
PLAYER_ID - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The PlayerId ( Integer )
PLAYER_IDS_BY_ROOM - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
A map of PlayerId by Room ( Map ) of Room, Integer
PLAYER_TO_SPECTATOR - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a User joined in a Game Room as player changes turns into a Spectator.
playerToSpectator(User, Room, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Turns a player in a Game Room to a spectator.
playerToSpectator(User, Room, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
 
PlayerToSpectator - Class in com.smartfoxserver.controllers.system
 
PlayerToSpectator - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
PlayerToSpectator() - Constructor for class com.smartfoxserver.controllers.system.PlayerToSpectator
 
postProcessPlugin - Variable in class com.smartfoxserver.components.login.LoginConfiguration
ADVANCED
postProcessPlugin - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
ADVANCED
prepareStartInvitation(Invitation, InvitationCallback) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
preProcessPlugin - Variable in class com.smartfoxserver.components.login.LoginConfiguration
ADVANCED
preProcessPlugin - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
ADVANCED
PreviousMMORoomState(int, List<User>) - Constructor for class com.smartfoxserver.mmo.MMORoom.PreviousMMORoomState
 
priv - Variable in class com.smartfoxserver.entities.variables.SFSUserVariable
 
PRIVATE_MESSAGE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a private message is received in the current Zone.
PrivateMessage - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
Private SFSGame - Search tag in class com.smartfoxserver.game.SFSGame
Section
PRIVILEGE_ID - Static variable in class com.smartfoxserver.entities.match.UserProperties
The privilege Id
PrivilegeManager - Interface in com.smartfoxserver.security
 
PROTOCOL - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 
PUBLIC_MESSAGE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a public message is received in the current Zone.
PUBLIC_MESSAGES - Enum constant in enum class com.smartfoxserver.entities.SFSRoomSettings
Toggles the ability to send public messages in a Room at runtime
PublicMessage - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
Public SFSGame - Search tag in class com.smartfoxserver.game.SFSGame
Section
put(String, SFSDataWrapper) - Method in interface com.smartfoxserver.entities.data.ISFSObject
 
put(String, SFSDataWrapper) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putBool(String, boolean) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a boolean
putBool(String, boolean) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putBoolArray(String, Collection<Boolean>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a Collection of boolean
putBoolArray(String, Collection<Boolean>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putByte(String, byte) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a byte (signed 8-bit)
putByte(String, byte) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putByteArray(String, byte[]) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add an array of bytes
putByteArray(String, byte[]) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putDouble(String, double) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a double value (signed 64-bit)
putDouble(String, double) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putDoubleArray(String, Collection<Double>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a Collection of double
putDoubleArray(String, Collection<Double>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putFloat(String, float) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a float value (signed 32-bit)
putFloat(String, float) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putFloatArray(String, Collection<Float>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a Collection of float
putFloatArray(String, Collection<Float>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putInt(String, int) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a short value (signed 32-bit)
putInt(String, int) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putIntArray(String, Collection<Integer>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a Collection of int
putIntArray(String, Collection<Integer>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putLong(String, long) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a long value (signed 64-bit)
putLong(String, long) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putLongArray(String, Collection<Long>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a Collection of long
putLongArray(String, Collection<Long>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putNull(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a null field to the Object.
putNull(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putSFSArray(String, ISFSArray) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a nested ISFSArray
putSFSArray(String, ISFSArray) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putSFSObject(String, ISFSObject) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a nested SFSObject
putSFSObject(String, ISFSObject) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putShort(String, short) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a short value (signed 16-bit)
putShort(String, short) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putShortArray(String, Collection<Short>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a Collection of short
putShortArray(String, Collection<Short>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putShortString(String, String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a short string value (UTF encoded), with a limit of 255 bytes
putShortString(String, String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putShortStringArray(String, Collection<String>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a collection of short strings (each string limited to 255 bytes) The collection is also limited to a max of 32768 short strings
putShortStringArray(String, Collection<String>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putString(String, String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a string value (encoded in UTF-8), with a limit of 32768 bytes.
putString(String, String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putStringArray(String, Collection<String>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a collection of strings (each string limited to 32768 bytes) The collection is also limited to a max of 32768 strings
putStringArray(String, Collection<String>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putText(String, String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a string value (UTF encoded), with a limit of 2 GBytes
putText(String, String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putVector2(String, SFSVector2) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a SFSVector2
putVector2(String, SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putVector2Array(String, Collection<SFSVector2>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a collection of SFSVector2
putVector2Array(String, Collection<SFSVector2>) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putVector3(String, SFSVector3) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a SFSVector3
putVector3(String, SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSObject
 
putVector3Array(String, Collection<SFSVector3>) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Add a collection of SFSVector3
putVector3Array(String, Collection<SFSVector3>) - Method in class com.smartfoxserver.entities.data.SFSObject
 

Q

QuickJoin - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
quickJoinGame(User, MatchExpression, Zone, String) - Method in interface com.smartfoxserver.api.ISFSGameApi
Quick join a User in an SFSGame.
quickJoinGame(User, MatchExpression, Zone, String) - Method in class com.smartfoxserver.api.SFSGameApi
Quick join a User in an SFSGame.
quickJoinGame(User, MatchExpression, Zone, String, Room) - Method in interface com.smartfoxserver.api.ISFSGameApi
Quick join a User in an SFSGame.
quickJoinGame(User, MatchExpression, Zone, String, Room) - Method in class com.smartfoxserver.api.SFSGameApi
Quick join a User in an SFSGame.
quickJoinGame(User, MatchExpression, Collection<Room>, Room) - Method in interface com.smartfoxserver.api.ISFSGameApi
Quick join a User in an SFSGame.
quickJoinGame(User, MatchExpression, Collection<Room>, Room) - Method in class com.smartfoxserver.api.SFSGameApi
Quick join a User in an SFSGame.
QuickJoinGame - Class in com.smartfoxserver.controllers.system.game
 
QuickJoinGame - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
QuickJoinGame() - Constructor for class com.smartfoxserver.controllers.system.game.QuickJoinGame
 
quickJoinOrCreateRoom(User, MatchExpression, Collection<String>, CreateRoomSettings) - Method in interface com.smartfoxserver.api.ISFSApi
Searches for a Room that matches the provided MatchExpression and joins the User in the first occurrence found.
quickJoinOrCreateRoom(User, MatchExpression, Collection<String>, CreateRoomSettings) - Method in class com.smartfoxserver.api.SFSApi
Searches for a Room that matches the provided MatchExpression and joins the User in the first occurrence found.
quickJoinOrCreateRoom(User, MatchExpression, Collection<String>, CreateRoomSettings, Room) - Method in interface com.smartfoxserver.api.ISFSApi
Searches for a Room that matches the provided MatchExpression and joins the User in the first Room found.
quickJoinOrCreateRoom(User, MatchExpression, Collection<String>, CreateRoomSettings, Room) - Method in class com.smartfoxserver.api.SFSApi
Searches for a Room that matches the provided MatchExpression and joins the User in the first Room found.
QuickJoinOrCreateRoom - Class in com.smartfoxserver.controllers.system
 
QuickJoinOrCreateRoom - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
QuickJoinOrCreateRoom() - Constructor for class com.smartfoxserver.controllers.system.QuickJoinOrCreateRoom
 

R

rdpTxConfig - Variable in class com.smartfoxserver.entities.SFSZone
 
ReadOnlyUserVariablesFilter - Class in com.smartfoxserver.controllers.filter
This filter can be added to any existing application to provide read-only User Variables.
ReadOnlyUserVariablesFilter(Zone) - Constructor for class com.smartfoxserver.controllers.filter.ReadOnlyUserVariablesFilter
Builds an empty filter.
ReadOnlyUserVariablesFilter(Zone, List<String>) - Constructor for class com.smartfoxserver.controllers.filter.ReadOnlyUserVariablesFilter
Builds a new filter with a list of read-only User Variables names.
reason - Variable in class com.smartfoxserver.entities.SFSBannedUser
 
RECIPIENT - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The recipient of a message ( User )
recover(SignUpAssistantComponent, User, ISFSObject) - Method in class com.smartfoxserver.components.signup.CustomFieldPasswordRecovery
 
recover(SignUpAssistantComponent, User, ISFSObject) - Method in interface com.smartfoxserver.components.signup.IPasswordRecovery
 
recover(SignUpAssistantComponent, User, ISFSObject) - Method in class com.smartfoxserver.components.signup.LegacyPasswordRecovery
 
RECOVER_NO_USER - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
RecoveryMode - Enum Class in com.smartfoxserver.components.signup
Determines the mode of the Password Recovery service
REFUSE - Enum constant in enum class com.smartfoxserver.entities.invitation.InvitationResponse
Refuse the invitation
registerEventsForRoomGroup(String, Set<SFSRoomEvents>) - Method in class com.smartfoxserver.entities.SFSZone
registerEventsForRoomGroup(String, Set<SFSRoomEvents>) - Method in interface com.smartfoxserver.entities.Zone
 
remove(String) - Method in interface com.smartfoxserver.controllers.filter.ISystemFilterChain
Remove a Filter from the Filter Chain.
remove(String) - Method in class com.smartfoxserver.controllers.filter.SysControllerFilterChain
 
remove(String) - Method in interface com.smartfoxserver.extensions.filter.IFilterChain
Remove a Filter from the Filter Chain.
remove(String) - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilterChain
Remove a Filter from the Filter Chain.
removeAllRooms() - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Remove all stored Rooms for this Zone from the storage system (Use wisely!)
removeAllRooms(String) - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Remove all stored Rooms belonging to a specific Room Group
removeAllUsers() - Method in class com.smartfoxserver.entities.SFSZone
removeAllUsers() - Method in interface com.smartfoxserver.entities.Zone
 
removeBannedUser(String, String, BanMode) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
removeBuddy(User, String, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSBuddyApi
Remove a Buddy from the owner's BuddyList
removeBuddy(User, String, boolean, boolean) - Method in class com.smartfoxserver.api.SFSBuddyApi
Remove a Buddy from the owner's BuddyList
removeBuddy(String) - Method in interface com.smartfoxserver.buddylist.BuddyList
Used by the BuddyManager only.
removeBuddy(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
removeBuddy(String, String) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
Use the SFSBuddyAPI
removeBuddy(String, String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
Use the SFSBuddyAPI
RemoveBuddy - Class in com.smartfoxserver.controllers.system.buddylist
 
RemoveBuddy - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
RemoveBuddy() - Constructor for class com.smartfoxserver.controllers.system.buddylist.RemoveBuddy
 
removeBuddyList(String) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
removeBuddyList(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
removeCreatedRoom(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
removeCreatedRoom(Room) - Method in interface com.smartfoxserver.entities.User
 
removeElement(String) - Method in interface com.smartfoxserver.entities.data.ISFSObject
Remove an element in the object
removeElement(String) - Method in class com.smartfoxserver.entities.data.SFSObject
 
removeElementAt(int) - Method in interface com.smartfoxserver.entities.data.ISFSArray
Remove an element at a specific index
removeElementAt(int) - Method in class com.smartfoxserver.entities.data.SFSArray
 
removeEventHandler(SFSEventType) - Method in class com.smartfoxserver.extensions.SFSExtension
Remove an event handler
removeEventListener(SFSEventType, ISFSEventListener) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Remove an event listener
removeEventListener(SFSEventType, ISFSEventListener) - Method in interface com.smartfoxserver.extensions.ISFSExtension
Remove an event listener
removeEventsForListener(ISFSEventListener) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
 
removeExpression(String) - Method in class com.smartfoxserver.util.SFSWordFilter
 
removeFilter(String) - Method in class com.smartfoxserver.extensions.SFSExtension
Removes a filter from the Extension
removeInvitation(Invitation) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
removeJoinedRoom(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
removeJoinedRoom(Room) - Method in interface com.smartfoxserver.entities.User
 
removeMMOItem(BaseMMOItem) - Method in interface com.smartfoxserver.api.ISFSMMOApi
Remove an MMOItem from an MMORoom.
removeMMOItem(BaseMMOItem) - Method in class com.smartfoxserver.api.SFSMMOApi
Remove an MMOItem from an MMORoom.
removeMMOItem(BaseMMOItem) - Method in class com.smartfoxserver.mmo.MMORoom
 
removePermissionProfile(short) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
removePermissionProfile(short) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
removePermissionProfile(String) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
removePermissionProfile(String) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
removeProperty(Object) - Method in interface com.smartfoxserver.entities.Room
Removes a custom property
removeProperty(Object) - Method in class com.smartfoxserver.entities.SFSRoom
Removes a custom property
removeProperty(Object) - Method in class com.smartfoxserver.entities.SFSUser
 
removeProperty(Object) - Method in class com.smartfoxserver.entities.SFSZone
Removes a property.
removeProperty(Object) - Method in interface com.smartfoxserver.entities.User
Removes a custom property
removeProperty(Object) - Method in interface com.smartfoxserver.entities.Zone
Removes a property.
removeProperty(String) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Remove an asoociated property
removeProperty(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
removeRequestHandler(String) - Method in class com.smartfoxserver.extensions.SFSExtension
Remove a request handler
removeRoom(int) - Method in class com.smartfoxserver.entities.SFSZone
removeRoom(int) - Method in interface com.smartfoxserver.entities.Zone
 
removeRoom(Room) - Method in interface com.smartfoxserver.api.ISFSApi
Removes a Room from its Zone, provided the Room is empty.
removeRoom(Room) - Method in class com.smartfoxserver.api.SFSApi
Removes a Room from its Zone, provided the Room is empty.
removeRoom(Room) - Method in class com.smartfoxserver.entities.SFSZone
removeRoom(Room) - Method in interface com.smartfoxserver.entities.Zone
 
removeRoom(Room, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Removes a Room from its Zone
removeRoom(Room, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
Removes a Room from its Zone
removeRoom(String) - Method in class com.smartfoxserver.entities.SFSZone
removeRoom(String) - Method in interface com.smartfoxserver.entities.Zone
 
removeRoom(String) - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Remove a saved Room from the storage system
removeSystemProperty(String) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
removeSystemProperty(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
removeUser(int) - Method in class com.smartfoxserver.entities.SFSZone
removeUser(int) - Method in interface com.smartfoxserver.entities.Zone
 
removeUser(ISession) - Method in class com.smartfoxserver.entities.SFSZone
removeUser(ISession) - Method in interface com.smartfoxserver.entities.Zone
 
removeUser(User) - Method in interface com.smartfoxserver.entities.Room
 
removeUser(User) - Method in class com.smartfoxserver.entities.SFSRoom
removeUser(User) - Method in class com.smartfoxserver.entities.SFSZone
removeUser(User) - Method in interface com.smartfoxserver.entities.Zone
 
removeUser(User) - Method in class com.smartfoxserver.game.SFSGame
 
removeUser(User) - Method in class com.smartfoxserver.mmo.MMORoom
 
removeUser(String) - Method in class com.smartfoxserver.entities.RoomBanLedger
 
removeUser(String) - Method in class com.smartfoxserver.entities.SFSZone
removeUser(String) - Method in interface com.smartfoxserver.entities.Zone
 
removeUserFromRoom(User, Room) - Method in class com.smartfoxserver.entities.SFSZone
removeUserFromRoom(User, Room) - Method in interface com.smartfoxserver.entities.Zone
 
removeVariable(String) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
removeVariable(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
removeVariable(String) - Method in class com.smartfoxserver.controllers.filter.ReadOnlyUserVariablesFilter
Removes a variable name, rendering the related User Variable readable and writable
removeVariable(String) - Method in interface com.smartfoxserver.entities.Room
 
removeVariable(String) - Method in class com.smartfoxserver.entities.SFSRoom
removeVariable(String) - Method in class com.smartfoxserver.entities.SFSUser
 
removeVariable(String) - Method in interface com.smartfoxserver.entities.User
 
removeVariable(String) - Method in interface com.smartfoxserver.mmo.IMMOItem
 
removeVariable(String) - Method in class com.smartfoxserver.mmo.MMOItem
 
removeVariablesCreatedByUser(User) - Method in interface com.smartfoxserver.entities.Room
 
removeVariablesCreatedByUser(User) - Method in class com.smartfoxserver.entities.SFSRoom
removeVariablesCreatedByUser(User, boolean) - Method in interface com.smartfoxserver.entities.Room
 
removeVariablesCreatedByUser(User, boolean) - Method in class com.smartfoxserver.entities.SFSRoom
replyToInvitation(User, int, InvitationResponse, ISFSObject, boolean) - Method in interface com.smartfoxserver.api.ISFSGameApi
Handle the Invitation reply of a User
replyToInvitation(User, int, InvitationResponse, ISFSObject, boolean) - Method in class com.smartfoxserver.api.SFSGameApi
Handle the Invitation reply of a User
ReservedBuddyVariables - Class in com.smartfoxserver.buddylist
Contains a series of Reserved BuddyVariables with a special meaning for the BuddyList system: BV_ONLINE: the Buddy Online status BV_STATE: the Buddy State message BV_NICKNAME: the Buddy nickname
ReservedBuddyVariables() - Constructor for class com.smartfoxserver.buddylist.ReservedBuddyVariables
 
ReservedRoomVariables - Class in com.smartfoxserver.entities.variables
The class contains static fields that represent names of "reserved" Room Variables.
ReservedRoomVariables() - Constructor for class com.smartfoxserver.entities.variables.ReservedRoomVariables
 
resetSystemFilterChain() - Method in class com.smartfoxserver.entities.SFSZone
Resets the whole SystemController Filter chain.
resetSystemFilterChain() - Method in interface com.smartfoxserver.entities.Zone
Resets the whole SystemController Filter chain.
resolveIpAddress(ISession) - Method in class com.smartfoxserver.controllers.system.Login
 
responseApi - Variable in class com.smartfoxserver.api.SFSGameApi
 
responseApi - Variable in class com.smartfoxserver.game.GenericInvitationCallback
 
responseAPI - Variable in class com.smartfoxserver.api.SFSApi
 
responseAPI - Variable in class com.smartfoxserver.api.SFSBuddyApi
 
restart() - Method in class com.smartfoxserver.SmartFoxServer
 
rewind() - Method in class com.smartfoxserver.entities.match.MatchExpression
 
Room - Interface in com.smartfoxserver.entities
 
ROOM - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The Room in which the event was fired, where applicable ( Room )
ROOM_ADDED - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a new Room is created in the current Zone
ROOM_CAPACITY_CHANGE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomEvents
This event is notified every time the capacity of Room is changed
ROOM_CAPACITY_CHANGE_PERMISSION_ERR - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
ROOM_DUPLICATE_NAME - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
ROOM_NAME_BAD_SIZE - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
ROOM_NAME_CHANGE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomEvents
This event is notified every time a Room name is changed
ROOM_NAME_CHANGE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomSettings
Toggles the ability to change the name of a Room at runtime
ROOM_NAME_CHANGE_PERMISSION_ERR - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
ROOM_NAME_CONTAINS_BADWORDS - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
ROOM_PASS_CHANGE_PERMISSION_ERR - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
ROOM_REMOVED - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a Room is removed from the current Zone
ROOM_VARIABLES_UPDATE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a one or more Room Variables are set.
ROOM_VARIABLES_UPDATE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomEvents
This event is notified every time one or more Variables are modified in the Room
RoomBanLedger - Class in com.smartfoxserver.entities
 
RoomBanLedger() - Constructor for class com.smartfoxserver.entities.RoomBanLedger
 
RoomExtensionSettings(String, String) - Constructor for class com.smartfoxserver.api.CreateRoomSettings.RoomExtensionSettings
The Extension id is the name of the folder that contains it.
RoomProperties - Class in com.smartfoxserver.entities.match
A list of properties that can be used in MatchExpressions for Room objects
RoomProperties() - Constructor for class com.smartfoxserver.entities.match.RoomProperties
 
RoomSize - Class in com.smartfoxserver.entities
Represent the size of a Room.
RoomSize(int, int) - Constructor for class com.smartfoxserver.entities.RoomSize
 
RoomStorageMode - Enum Class in com.smartfoxserver.persistence.room
Provides several modes for the Room Storage API
RoomVariable - Interface in com.smartfoxserver.entities.variables
 
rotate(float) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector that is the result of rotating this vector by the specified angle.
rotate(SFSVector3, float) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector that is the result of rotating this vector around the specified axis by the specified angle.
round() - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
round() - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
runEventInChain(ISFSEvent) - Method in interface com.smartfoxserver.extensions.filter.IFilterChain
 
runEventInChain(ISFSEvent) - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilterChain
 
runInSeparateThread(Runnable) - Method in interface com.smartfoxserver.api.ISFSApi
Runs a task in a separate (virtual) thread.
runInSeparateThread(Runnable) - Method in class com.smartfoxserver.api.SFSApi
 
runInSeparateThread(Callable<T>) - Method in interface com.smartfoxserver.api.ISFSApi
Similar to the above but uses a Callable which in turn can be used to return a result from the concurrent Task
runInSeparateThread(Callable<T>) - Method in class com.smartfoxserver.api.SFSApi
 
runRequest(User, ISFSObject) - Method in interface com.smartfoxserver.controllers.filter.ISystemFilterChain
 
runRequest(User, ISFSObject) - Method in class com.smartfoxserver.controllers.filter.SysControllerFilterChain
 
runRequestInChain(String, User, ISFSObject) - Method in interface com.smartfoxserver.extensions.filter.IFilterChain
 
runRequestInChain(String, User, ISFSObject) - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilterChain
 
RV_GAME_STARTED - Static variable in class com.smartfoxserver.entities.variables.ReservedRoomVariables
Used by the SFSGame Rooms to notify the change in the started/stopped game status

S

saveAll() - Method in interface com.smartfoxserver.buddylist.BuddyListManager
This is called automatically by the system
saveAll() - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
This is called automatically by the system
saveAllRooms() - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Saves all Rooms in the Zone
saveAllRooms(String) - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Saves all Rooms belonging to the provided group name
saveBuddyList(String) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
This is called automatically by the system
saveBuddyList(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
This is called automatically by the system
saveList(BuddyList) - Method in interface com.smartfoxserver.buddylist.storage.BuddyStorage
This method is invoked by the Buddy System when a BuddyList needs to be saved.
saveList(BuddyList) - Method in class com.smartfoxserver.buddylist.storage.FSBuddyStorage
 
saveRoom(Room) - Method in interface com.smartfoxserver.persistence.room.IRoomStorage
Save a Room and its state
schedule(Runnable, int, TimeUnit) - Method in class com.smartfoxserver.util.TaskScheduler
Schedule a Task to be executed in the future, once.
scheduleAtFixedRate(Runnable, int, int, TimeUnit) - Method in class com.smartfoxserver.util.TaskScheduler
Schedule Task to be executed periodically.
send(String, ISFSObject, User) - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Send a response back to a User
send(String, ISFSObject, User) - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Send a response back to a User
send(String, ISFSObject, User) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
send(String, ISFSObject, User) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
send(String, ISFSObject, User, TransportType) - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Send a response back to a User
send(String, ISFSObject, User, TransportType) - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Send a response back to a User
send(String, ISFSObject, User, TransportType) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
 
send(String, ISFSObject, User, TransportType) - Method in interface com.smartfoxserver.extensions.ISFSExtension
Send an extension message/response to a single User
send(String, ISFSObject, List<User>) - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Broadcast a response back to multiple Users
send(String, ISFSObject, List<User>) - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Broadcast a response back to multiple Users
send(String, ISFSObject, List<User>) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
send(String, ISFSObject, List<User>) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
send(String, ISFSObject, List<User>, TransportType) - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Broadcast a response back to multiple Users
send(String, ISFSObject, List<User>, TransportType) - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Broadcast a response back to multiple Users
send(String, ISFSObject, List<User>, TransportType) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Send an extension message/response to a list of recipients
send(String, ISFSObject, List<User>, TransportType) - Method in interface com.smartfoxserver.extensions.ISFSExtension
Send an extension message/response to a list of recipients
sendAdminMessage(User, String, ISFSObject, Collection<ISession>) - Method in interface com.smartfoxserver.api.ISFSApi
Sends a admin message to a number of Users.
sendAdminMessage(User, String, ISFSObject, Collection<ISession>) - Method in class com.smartfoxserver.api.SFSApi
Sends a admin message to a number of Users.
sendBuddyMessage(User, User, String, ISFSObject) - Method in interface com.smartfoxserver.api.ISFSApi
Sends a Buddy message to a specific user.
sendBuddyMessage(User, User, String, ISFSObject) - Method in interface com.smartfoxserver.api.ISFSBuddyApi
Send a Buddy Message to any Buddy in your list.
sendBuddyMessage(User, User, String, ISFSObject) - Method in class com.smartfoxserver.api.SFSApi
Sends a Buddy message to a specific user.
sendBuddyMessage(User, User, String, ISFSObject) - Method in class com.smartfoxserver.api.SFSBuddyApi
Send a Buddy Message to any Buddy in your list.
sendExtensionResponse(String, ISFSObject, User, Room, TransportType) - Method in interface com.smartfoxserver.api.ISFSApi
 
sendExtensionResponse(String, ISFSObject, User, Room, TransportType) - Method in class com.smartfoxserver.api.SFSApi
 
sendExtensionResponse(String, ISFSObject, List<User>, Room, TransportType) - Method in interface com.smartfoxserver.api.ISFSApi
 
sendExtensionResponse(String, ISFSObject, List<User>, Room, TransportType) - Method in class com.smartfoxserver.api.SFSApi
 
sendGenericMessage(GenericMessageType, User, int, String, ISFSObject, Collection<ISession>) - Method in interface com.smartfoxserver.api.ISFSApi
 
sendGenericMessage(GenericMessageType, User, int, String, ISFSObject, Collection<ISession>) - Method in class com.smartfoxserver.api.SFSApi
 
sendInvitation(Invitation, InvitationCallback) - Method in interface com.smartfoxserver.api.ISFSGameApi
Send an Invitation to a User.
An Invitation can be sent for various purposes such as for joining a room/game, adding a friend to the Buddy List etc...
sendInvitation(Invitation, InvitationCallback) - Method in class com.smartfoxserver.api.SFSGameApi
Send an Invitation to a User.
An Invitation can be sent for various purposes such as for joining a room/game, adding a friend to the Buddy List etc...
sendInvitation(User, List<User>, int, InvitationCallback, ISFSObject) - Method in interface com.smartfoxserver.api.ISFSGameApi
Send an Invitation to a User.
An Invitation can be sent for various purposes such as for joining a room/game, adding a friend to the Buddy List etc...
sendInvitation(User, List<User>, int, InvitationCallback, ISFSObject) - Method in class com.smartfoxserver.api.SFSGameApi
Send an Invitation to a User.
An Invitation can be sent for various purposes such as for joining a room/game, adding a friend to the Buddy List etc...
sendJoinRoomInvitation(Room, User, List<User>, int) - Method in interface com.smartfoxserver.api.ISFSGameApi
Invites Users / Players in an existing Room.
sendJoinRoomInvitation(Room, User, List<User>, int) - Method in class com.smartfoxserver.api.SFSGameApi
Invites Users / Players in an existing Room.
sendJoinRoomInvitation(Room, User, List<User>, int, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSGameApi
Invites Users / Players in an existing Room.
sendJoinRoomInvitation(Room, User, List<User>, int, boolean, boolean) - Method in class com.smartfoxserver.api.SFSGameApi
Invites Users / Players in an existing Room.
sendJoinRoomInvitation(Room, User, List<User>, int, boolean, boolean, ISFSObject) - Method in interface com.smartfoxserver.api.ISFSGameApi
Invites Users / Players in an existing Room.
sendJoinRoomInvitation(Room, User, List<User>, int, boolean, boolean, ISFSObject) - Method in class com.smartfoxserver.api.SFSGameApi
Invites Users / Players in an existing Room.
sendMail(Email) - Method in interface com.smartfoxserver.entities.managers.IMailerService
Sends the email to the recipient, or list of recipients, specified in the Email argument.
sendMail(Email) - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
Sends the email to the recipient, or list of recipients, specified in the Email argument.
sendMail(Email, IMailerCallbackHandler) - Method in interface com.smartfoxserver.entities.managers.IMailerService
Sends the email to the recipient, or list of recipients, specified in the Email argument and get an asynchronous event when the email is delivered.
sendMail(Email, IMailerCallbackHandler) - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
Sends the email to the recipient, or list of recipients, specified in the Email argument and get an asynchronous event when the email is delivered.
sendMail(Email, IMailerCallbackHandler, int) - Method in interface com.smartfoxserver.entities.managers.IMailerService
Sends an email in the future.
sendMail(Email, IMailerCallbackHandler, int) - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
Sends an email in the future.
sendModeratorMessage(User, String, ISFSObject, Collection<ISession>) - Method in interface com.smartfoxserver.api.ISFSApi
Sends a moderator message to a number of Users.
sendModeratorMessage(User, String, ISFSObject, Collection<ISession>) - Method in class com.smartfoxserver.api.SFSApi
Sends a moderator message to a number of Users.
sendObjectMessage(Room, User, ISFSObject, Vec3D) - Method in interface com.smartfoxserver.api.ISFSMMOApi
Send an Object message based on a custom SFSObject that can contain any data.
sendObjectMessage(Room, User, ISFSObject, Vec3D) - Method in class com.smartfoxserver.api.SFSMMOApi
Send an Object message based on a custom SFSObject that can contain any data.
sendObjectMessage(Room, User, ISFSObject, Collection<User>) - Method in interface com.smartfoxserver.api.ISFSApi
Send an Object message.
sendObjectMessage(Room, User, ISFSObject, Collection<User>) - Method in class com.smartfoxserver.api.SFSApi
Send an Object message.
sendPrivateMessage(User, User, String, ISFSObject) - Method in interface com.smartfoxserver.api.ISFSApi
Sends a private chat message.
sendPrivateMessage(User, User, String, ISFSObject) - Method in class com.smartfoxserver.api.SFSApi
Sends a private chat message.
sendPublicMessage(Room, User, String, ISFSObject) - Method in interface com.smartfoxserver.api.ISFSApi
Sends a public chat message.
sendPublicMessage(Room, User, String, ISFSObject) - Method in class com.smartfoxserver.api.SFSApi
Sends a public chat message.
sendPublicMessage(Room, User, String, ISFSObject, Vec3D) - Method in interface com.smartfoxserver.api.ISFSMMOApi
Sends a public chat message.
sendPublicMessage(Room, User, String, ISFSObject, Vec3D) - Method in class com.smartfoxserver.api.SFSMMOApi
Sends a public chat message.
sendWarningMessage(User, User, String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
serialize(Buddy) - Method in class com.smartfoxserver.buddylist.DefaultBuddySerializer
 
serialize(Buddy) - Method in interface com.smartfoxserver.buddylist.IBuddySerializer
 
SERVER_READY - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered by SmartFoxServer when the server engine has completed the boot phase.
Server Side Events - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
serviceName - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
serviceName - Variable in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
Services - Search tag in class com.smartfoxserver.entities.SFSRoom
Section
session - Variable in class com.smartfoxserver.components.login.LoginData
The client's session
session - Variable in class com.smartfoxserver.entities.LoginData
 
Session - Class in com.smartfoxserver.bitswarm.sessions
Overview
Session() - Constructor for class com.smartfoxserver.bitswarm.sessions.Session
 
Session(SocketAddress) - Constructor for class com.smartfoxserver.bitswarm.sessions.Session
 
SESSION - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The User Session ( Session )
SessionType - Enum Class in com.smartfoxserver.bitswarm.sessions
 
setActive(boolean) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setActive(boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setActive(boolean) - Method in interface com.smartfoxserver.entities.Room
 
setActive(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
setActive(boolean) - Method in class com.smartfoxserver.entities.SFSZone
Changes the state of the Zone.
setActive(boolean) - Method in interface com.smartfoxserver.entities.Zone
Changes the state of the Zone.
setActive(boolean) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setActive(boolean) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setActive(boolean) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
setActive(boolean) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
setActive(boolean) - Method in interface com.smartfoxserver.util.IFloodFilter
 
setActive(boolean) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
setActive(boolean) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setAdminHelper(IAdminHelper) - Method in class com.smartfoxserver.entities.SFSRoom
 
setAdminHelper(IAdminHelper) - Method in class com.smartfoxserver.entities.SFSUser
 
setAdminHelper(IAdminHelper) - Method in class com.smartfoxserver.entities.SFSZone
 
setAllowAudioStreaming(boolean) - Method in class com.smartfoxserver.api.CreateRoomSettings
Allow/disallow audio streaming in the Room.
setAllowInvitationsOnlyForBuddies(boolean) - Method in class com.smartfoxserver.entities.SFSZone
setAllowInvitationsOnlyForBuddies(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setAllowOfflineBuddyVariables(boolean) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setAllowOfflineBuddyVariables(boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setAllowOwnerInvitations(boolean) - Method in interface com.smartfoxserver.entities.Room
Set to true if the Room allows only its creator to send JoinRoomInvitations.
setAllowOwnerInvitations(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
Set to true if the Room allows only its creator to send JoinRoomInvitations.
setAllowOwnerOnlyInvitation(boolean) - Method in class com.smartfoxserver.api.CreateRoomSettings
If false, any User joined in the Room will be able to invite players in the Room.
setApplyBadWordsFilter(boolean) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setApplyBadWordsFilter(boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setAudioStreamInfo(AudioStreamInfo) - Method in class com.smartfoxserver.entities.SFSUser
 
setAudioStreamInfo(AudioStreamInfo) - Method in interface com.smartfoxserver.entities.User
 
setAutoRemoveBan(boolean) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
setAutoRemoveMode(SFSRoomRemoveMode) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the Auto-Remove mode of the Room for a dynamic Room.
setAutoRemoveMode(SFSRoomRemoveMode) - Method in interface com.smartfoxserver.entities.Room
 
setAutoRemoveMode(SFSRoomRemoveMode) - Method in class com.smartfoxserver.entities.SFSRoom
setBadWordsWarnings(int) - Method in class com.smartfoxserver.entities.SFSUser
 
setBadWordsWarnings(int) - Method in interface com.smartfoxserver.entities.User
 
setBanDurationMinutes(int) - Method in interface com.smartfoxserver.util.IFloodFilter
 
setBanDurationMinutes(int) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
setBanDurationMinutes(int) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setBanMessage(String) - Method in interface com.smartfoxserver.util.IFloodFilter
 
setBanMessage(String) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
setBanMessage(String) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setBanMode(BanMode) - Method in interface com.smartfoxserver.util.IFloodFilter
 
setBanMode(BanMode) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
setBanMode(BanMode) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setBannedUserManager(IBannedUserManager) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setBannedUserManger(IBannedUserManager) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setBeingKicked(boolean) - Method in class com.smartfoxserver.entities.SFSUser
 
setBeingKicked(boolean) - Method in interface com.smartfoxserver.entities.User
 
setBlocked(boolean) - Method in interface com.smartfoxserver.buddylist.Buddy
Block the Buddy
setBlocked(boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
setBuddyListManager(BuddyListManager) - Method in interface com.smartfoxserver.buddylist.BuddyList
 
setBuddyListManager(BuddyListManager) - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
setBuddyListManager(BuddyListManager) - Method in interface com.smartfoxserver.buddylist.storage.BuddyStorage
 
setBuddyListManager(BuddyListManager) - Method in class com.smartfoxserver.buddylist.storage.FSBuddyStorage
 
setBuddyListManager(BuddyListManager) - Method in class com.smartfoxserver.entities.SFSZone
setBuddyListManager(BuddyListManager) - Method in interface com.smartfoxserver.entities.Zone
 
setBuddyListMaxSize(int) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setBuddyListMaxSize(int) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setBuddyStates(List<String>) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setBuddyStates(List<String>) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setBuddyVariables(User, List<BuddyVariable>, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSBuddyApi
Set any number of BuddyVariables for the specified owner
setBuddyVariables(User, List<BuddyVariable>, boolean, boolean) - Method in class com.smartfoxserver.api.SFSBuddyApi
Set any number of BuddyVariables for the specified owner
SetBuddyVariables - Class in com.smartfoxserver.controllers.system.buddylist
 
SetBuddyVariables - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
SetBuddyVariables() - Constructor for class com.smartfoxserver.controllers.system.buddylist.SetBuddyVariables
 
setCallback(InvitationCallback) - Method in interface com.smartfoxserver.entities.invitation.Invitation
Set the CallBack handler for the invitation.
setCallback(InvitationCallback) - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
setCapacity(int, int) - Method in interface com.smartfoxserver.entities.Room
 
setCapacity(int, int) - Method in class com.smartfoxserver.entities.SFSRoom
setChangedSinceLastSave(boolean) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
setChangedSinceLastSave(boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
setClientAllowedToOverridRoomEvents(boolean) - Method in class com.smartfoxserver.entities.SFSZone
Deprecated. 
setClientAllowedToOverridRoomEvents(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setCode(IErrorCode) - Method in class com.smartfoxserver.exceptions.SFSErrorData
 
setConnected(boolean) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setConnected(boolean) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setConnected(boolean) - Method in class com.smartfoxserver.entities.SFSUser
 
setConnected(boolean) - Method in interface com.smartfoxserver.entities.User
 
setConnection(SocketChannel) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setConnection(SocketChannel) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setCreationTime(long) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setCreationTime(long) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setCryptoKey(Object) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setCryptoKey(Object) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setCustomLogin(boolean) - Method in class com.smartfoxserver.entities.SFSZone
 
setCustomLogin(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setCustomPlayerIdGeneratorClass(Class<? extends IPlayerIdGenerator>) - Method in class com.smartfoxserver.api.CreateRoomSettings
All Game Rooms by default use the SFS default PlayerId Generator class.
setDatagramOutQueue(IPacketQueue) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setDatagramOutQueue(IPacketQueue) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setDBManager(IDBManager) - Method in class com.smartfoxserver.entities.SFSZone
 
setDBManager(IDBManager) - Method in interface com.smartfoxserver.entities.Zone
 
setDefaultAOI(Vec3D) - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
The Area Of Interest (AOI) represents the area within which Users will affect each other, for example when sending public messages, updating User Variables etc...
setDefaultGroups(List<String>) - Method in class com.smartfoxserver.entities.SFSZone
setDefaultGroups(List<String>) - Method in interface com.smartfoxserver.entities.Zone
 
setDefaultPlayerIdGeneratorClassName(String) - Method in class com.smartfoxserver.entities.SFSZone
 
setDefaultPlayerIdGeneratorClassName(String) - Method in interface com.smartfoxserver.entities.Zone
 
setDescription(String) - Method in class com.smartfoxserver.exceptions.ExceptionMessageComposer
 
setDynamic(boolean) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the Room as dynamic.
setDynamic(boolean) - Method in interface com.smartfoxserver.entities.Room
 
setDynamic(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
setEncrypted(boolean) - Method in class com.smartfoxserver.entities.SFSZone
setEncrypted(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setExtension(CreateRoomSettings.RoomExtensionSettings) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the Extension for the Room
setExtension(ISFSExtension) - Method in interface com.smartfoxserver.entities.Room
 
setExtension(ISFSExtension) - Method in class com.smartfoxserver.entities.SFSRoom
 
setExtension(ISFSExtension) - Method in class com.smartfoxserver.entities.SFSZone
 
setExtension(ISFSExtension) - Method in interface com.smartfoxserver.entities.Zone
 
setExtensionFileName(String) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setExtensionFileName(String) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setExtFloodWarnings(int) - Method in class com.smartfoxserver.entities.SFSUser
 
setExtFloodWarnings(int) - Method in interface com.smartfoxserver.entities.User
 
setFilterBuddyMessages(boolean) - Method in class com.smartfoxserver.entities.SFSZone
setFilterBuddyMessages(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setFilterChain(SystemRequest, ISystemFilterChain) - Method in class com.smartfoxserver.entities.SFSZone
Set a SystemFilterChain for a specific SystemController's Request.
setFilterChain(SystemRequest, ISystemFilterChain) - Method in interface com.smartfoxserver.entities.Zone
Set a SystemFilterChain for a specific SystemController's Request.
setFilterMode(WordsFilterMode) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setFilterPrivateMessages(boolean) - Method in class com.smartfoxserver.entities.SFSZone
setFilterPrivateMessages(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setFilterRoomNames(boolean) - Method in class com.smartfoxserver.entities.SFSZone
setFilterRoomNames(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setFilterUserNames(boolean) - Method in class com.smartfoxserver.entities.SFSZone
setFilterUserNames(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setFlag(SFSRoomSettings, boolean) - Method in interface com.smartfoxserver.entities.Room
 
setFlag(SFSRoomSettings, boolean) - Method in class com.smartfoxserver.entities.SFSRoom
setFlags(Set<SFSRoomSettings>) - Method in interface com.smartfoxserver.entities.Room
 
setFlags(Set<SFSRoomSettings>) - Method in class com.smartfoxserver.entities.SFSRoom
setFloodWarnings(int) - Method in class com.smartfoxserver.entities.SFSUser
 
setFloodWarnings(int) - Method in interface com.smartfoxserver.entities.User
 
setForceLogout(boolean) - Method in class com.smartfoxserver.entities.SFSZone
 
setForceLogout(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setGame(boolean) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the Room as a Game Room.
setGame(boolean) - Method in interface com.smartfoxserver.entities.Room
 
setGame(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
setGame(boolean) - Method in class com.smartfoxserver.mmo.MMORoom
 
setGame(boolean, Class<? extends IPlayerIdGenerator>) - Method in interface com.smartfoxserver.entities.Room
 
setGame(boolean, Class<? extends IPlayerIdGenerator>) - Method in class com.smartfoxserver.entities.SFSRoom
setGame(boolean, Class<? extends IPlayerIdGenerator>) - Method in class com.smartfoxserver.mmo.MMORoom
 
setGamePublic(boolean) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
 
setGeoLocationEnabled(boolean) - Method in class com.smartfoxserver.entities.SFSZone
 
setGeoLocationEnabled(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setGlobal(boolean) - Method in interface com.smartfoxserver.entities.variables.RoomVariable
When a RoomVariable is set to global all changes will be broadcast not only to the Users in the Room but also to all other Users in the same Room Group
setGlobal(boolean) - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
When a RoomVariable is set to global all changes will be broadcast not only to the Users in the Room but also to all other Users in the same Room Group
setGroupId(String) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the name of the Room Group that the new Room will be assigned to.
setGroupId(String) - Method in interface com.smartfoxserver.entities.Room
 
setGroupId(String) - Method in class com.smartfoxserver.entities.SFSRoom
setGuestUserAllowed(boolean) - Method in class com.smartfoxserver.entities.SFSZone
setGuestUserAllowed(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setGuestUserNamePrefix(String) - Method in class com.smartfoxserver.entities.SFSZone
setGuestUserNamePrefix(String) - Method in interface com.smartfoxserver.entities.Zone
 
setHashId(String) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setHashId(String) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setHidden(boolean) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the Room as hidden.
setHidden(boolean) - Method in interface com.smartfoxserver.entities.Room
 
setHidden(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
setHidden(boolean) - Method in class com.smartfoxserver.entities.SFSZone
 
setHidden(boolean) - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
 
setHidden(boolean) - Method in interface com.smartfoxserver.entities.variables.UserVariable
Set the variable as hidden.
setHidden(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setId(int) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setId(int) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setId(int) - Method in class com.smartfoxserver.entities.SFSZone
 
setId(int) - Method in interface com.smartfoxserver.entities.Zone
 
setInited() - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
setInited() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
setInSeqProcessor(ISeqProcessor) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setInSeqProcessor(ISeqProcessor) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setInvitationExpiryTime(int) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
The maximum amount of time for an invited Player to accept/refuse an invitation.
setInvitationParams(ISFSObject) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
Set the custom invitation parameters.
setInvitedPlayers(List<User>) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
Set a list of people invited to play a private Game
setIsTemp(boolean) - Method in interface com.smartfoxserver.buddylist.Buddy
 
setIsTemp(boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
setJoining(boolean) - Method in class com.smartfoxserver.entities.SFSUser
 
setJoining(boolean) - Method in interface com.smartfoxserver.entities.User
 
setKickMessage(String) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setKicksBeforeBan(int) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setKicksBeforeBanMinutes(int) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setLagMonitorKeepAlive(boolean) - Method in class com.smartfoxserver.entities.SFSZone
 
setLagMonitorKeepAlive(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setLastActivityTime(long) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setLastActivityTime(long) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setLastLoggedInActivityTime(long) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setLastLoggedInActivityTime(long) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setLastLoginTime(long) - Method in class com.smartfoxserver.entities.SFSUser
 
setLastLoginTime(long) - Method in interface com.smartfoxserver.entities.User
 
setLastMMOItemsList(List<BaseMMOItem>) - Method in class com.smartfoxserver.entities.SFSUser
 
setLastMMOItemsList(List<BaseMMOItem>) - Method in interface com.smartfoxserver.entities.User
 
setLastProxyList(List<User>) - Method in class com.smartfoxserver.entities.SFSUser
 
setLastProxyList(List<User>) - Method in interface com.smartfoxserver.entities.User
 
setLastReadTime(long) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setLastReadTime(long) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setLastRequestTime(long) - Method in class com.smartfoxserver.entities.SFSUser
 
setLastRequestTime(long) - Method in interface com.smartfoxserver.entities.User
 
setLastWriteTime(long) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setLastWriteTime(long) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setLeaveLastJoinedRoom(boolean) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
 
setLeaveLastRoomOnJoin(boolean) - Method in class com.smartfoxserver.game.SFSGame
 
setLevel(ExtensionLevel) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setLevel(ExtensionLevel) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setLogFloodingAttempts(boolean) - Method in interface com.smartfoxserver.util.IFloodFilter
 
setLogFloodingAttempts(boolean) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
setLoggedIn(boolean) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setLoggedIn(boolean) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setMapLimits(CreateMMORoomSettings.MapLimits) - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
Map limits are optional.
setMapLimits(Vec3D, Vec3D) - Method in class com.smartfoxserver.mmo.MMORoom
 
setMarkedForEviction() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setMarkedForEviction() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setMaskCharacter(String) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setMaxAllowedRooms(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxAllowedRooms(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxAllowedUsers(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxAllowedUsers(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxAllowedVariables(int) - Method in class com.smartfoxserver.entities.SFSUser
 
setMaxAllowedVariables(int) - Method in interface com.smartfoxserver.entities.User
 
setMaxBadWordsPerMessage(int) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setMaxBuddyVariables(int) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setMaxBuddyVariables(int) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setMaxFailedLogins(int) - Method in class com.smartfoxserver.entities.SFSZone
 
setMaxFailedLogins(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxFindRoomResults(int) - Method in class com.smartfoxserver.entities.SFSZone
 
setMaxFindRoomResults(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxFindUserResults(int) - Method in class com.smartfoxserver.entities.SFSZone
 
setMaxFindUserResults(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxFloodingAttempts(int) - Method in interface com.smartfoxserver.util.IFloodFilter
 
setMaxFloodingAttempts(int) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
setMaxIdleTime(int) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setMaxIdleTime(int) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setMaxInvitationsPerRequest(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxInvitationsPerRequest(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxInvitationsPerUser(int) - Method in interface com.smartfoxserver.entities.invitation.InvitationManager
 
setMaxInvitationsPerUser(int) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
setMaxLoggedInIdleTime(int) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setMaxLoggedInIdleTime(int) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setMaxRoomNameChars(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxRoomNameChars(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxRoomsCreatedPerUserLimit(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxRoomsCreatedPerUserLimit(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxRoomVariablesAllowed(int) - Method in interface com.smartfoxserver.entities.Room
 
setMaxRoomVariablesAllowed(int) - Method in class com.smartfoxserver.entities.SFSRoom
setMaxRoomVariablesAllowed(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxRoomVariablesAllowed(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxSpectators(int) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the maximum number of spectators allowed in the Room (game only)
setMaxSpectators(int) - Method in interface com.smartfoxserver.entities.Room
 
setMaxSpectators(int) - Method in class com.smartfoxserver.entities.SFSRoom
setMaxUdpIdleSeconds(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxUdpIdleSeconds(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxUdpIdleTime(int) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setMaxUdpIdleTime(int) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setMaxUserIdleTime(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxUserIdleTime(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxUserNameChars(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxUserNameChars(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxUsers(int) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the maximum number of users allowed in the Room
setMaxUsers(int) - Method in interface com.smartfoxserver.entities.Room
 
setMaxUsers(int) - Method in class com.smartfoxserver.entities.SFSRoom
setMaxUserVariablesAllowed(int) - Method in class com.smartfoxserver.entities.SFSZone
setMaxUserVariablesAllowed(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMaxVariablesAllowed(int) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the maximum number of Room Variables allowed
setMinPlayersToStartGame(int) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
 
setMinPlayersToStartGame(int) - Method in class com.smartfoxserver.game.SFSGame
 
setMinRoomNameChars(int) - Method in class com.smartfoxserver.entities.SFSZone
setMinRoomNameChars(int) - Method in interface com.smartfoxserver.entities.Zone
 
setMMOItemPosition(BaseMMOItem, Vec3D, Room) - Method in interface com.smartfoxserver.api.ISFSMMOApi
Set or update an MMOItem inside an MMORoom
setMMOItemPosition(BaseMMOItem, Vec3D, Room) - Method in class com.smartfoxserver.api.SFSMMOApi
Set or update an MMOItem inside an MMORoom
setMMOItemVariables(BaseMMOItem, List<IMMOItemVariable>) - Method in interface com.smartfoxserver.api.ISFSMMOApi
Set MMOItemVariables.
setMMOItemVariables(BaseMMOItem, List<IMMOItemVariable>) - Method in class com.smartfoxserver.api.SFSMMOApi
Set MMOItemVariables.
setMMOItemVariables(BaseMMOItem, List<IMMOItemVariable>, boolean) - Method in interface com.smartfoxserver.api.ISFSMMOApi
Set MMOItemVariables.
setMMOItemVariables(BaseMMOItem, List<IMMOItemVariable>, boolean) - Method in class com.smartfoxserver.api.SFSMMOApi
Set MMOItemVariables.
SetMMOItemVariables - Class in com.smartfoxserver.controllers.system
 
SetMMOItemVariables() - Constructor for class com.smartfoxserver.controllers.system.SetMMOItemVariables
 
setName(String) - Method in class com.smartfoxserver.api.APIManager
 
setName(String) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the name of the Room.
setName(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setName(String) - Method in class com.smartfoxserver.controllers.filter.SysControllerFilter
 
setName(String) - Method in class com.smartfoxserver.db.SFSDBManager
 
setName(String) - Method in class com.smartfoxserver.db.EmbeddedDBService
 
setName(String) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
setName(String) - Method in class com.smartfoxserver.entities.managers.SFSPostOffice
 
setName(String) - Method in interface com.smartfoxserver.entities.Room
 
setName(String) - Method in class com.smartfoxserver.entities.SFSRoom
setName(String) - Method in class com.smartfoxserver.entities.SFSUser
 
setName(String) - Method in interface com.smartfoxserver.entities.User
 
setName(String) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setName(String) - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilter
Set the name of the filter
setName(String) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setName(String) - Method in class com.smartfoxserver.util.TaskScheduler
 
setNickName(String) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
setNickName(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
setNotifyGameStarted(boolean) - Method in class com.smartfoxserver.game.SFSGame
 
setNotifyGameStartedViaRoomVariable(boolean) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
 
setNull() - Method in interface com.smartfoxserver.entities.variables.UserVariable
 
setOfflineBuddyVariablesCacheSize(int) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setOfflineBuddyVariablesCacheSize(int) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setOnline(boolean) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
setOnline(boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
setOwner(User) - Method in interface com.smartfoxserver.entities.Room
 
setOwner(User) - Method in class com.smartfoxserver.entities.SFSRoom
setOwner(User) - Method in interface com.smartfoxserver.entities.variables.RoomVariable
Sets the creator of a variable.
setOwner(User) - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
Sets the creator of a variable.
setPacketOutQueue(IPacketQueue) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setPacketOutQueue(IPacketQueue) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setParams(ISFSObject) - Method in interface com.smartfoxserver.entities.invitation.Invitation
An SFSObject of custom parameters can be attached to the invitation.
setParams(ISFSObject) - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
setParams(List<String>) - Method in class com.smartfoxserver.exceptions.SFSErrorData
 
setParentBuddyList(BuddyList) - Method in interface com.smartfoxserver.buddylist.Buddy
Set the parent BuddyList
setParentBuddyList(BuddyList) - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
setParentExtension(SFSExtension) - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
setParentExtension(SFSExtension) - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
setParentExtension(SFSExtension) - Method in interface com.smartfoxserver.extensions.IClientRequestHandler
 
setParentExtension(SFSExtension) - Method in interface com.smartfoxserver.extensions.IServerEventHandler
 
setParentRoom(Room) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setParentRoom(Room) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setParentRoom(Room) - Method in class com.smartfoxserver.util.DefaultPlayerIdGenerator
 
setParentRoom(Room) - Method in interface com.smartfoxserver.util.IPlayerIdGenerator
 
setParentZone(Zone) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setParentZone(Zone) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setPassword(String) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the Room password
setPassword(String) - Method in interface com.smartfoxserver.entities.Room
 
setPassword(String) - Method in class com.smartfoxserver.entities.SFSRoom
setPermissionProfile(SFSPermissionProfile) - Method in interface com.smartfoxserver.security.PrivilegeManager
 
setPermissionProfile(SFSPermissionProfile) - Method in class com.smartfoxserver.security.SFSPrivilegeManager
 
setPersistenceClass(String) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
setPersistent(boolean) - Method in class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
setPersistent(boolean) - Method in interface com.smartfoxserver.entities.variables.RoomVariable
When a RoomVariable is set to persistent the variable will not be removed from a Room when the user leaves it.
setPersistent(boolean) - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
When a RoomVariable is set to persistent the variable will not be removed from a Room when the user leaves it.
setPlayerId(int, Room) - Method in class com.smartfoxserver.entities.SFSUser
 
setPlayerId(int, Room) - Method in interface com.smartfoxserver.entities.User
 
setPlayerMatchExpression(MatchExpression) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
A match expression to filter Players willing to join the Game.
setPlayerMatchExpression(MatchExpression) - Method in class com.smartfoxserver.game.SFSGame
 
setPossibleCauses(String) - Method in class com.smartfoxserver.exceptions.ExceptionMessageComposer
 
setPrivate(boolean) - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
When a RoomVariable is set to private only its owner can modify or delete it.
setPrivate(boolean) - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
Setting a UserVariable as private restricts its visibility to the owner only.
setPrivate(boolean) - Method in interface com.smartfoxserver.entities.variables.UserVariable
A private UserVariable is only known and updated for the owner, not other clients
setPrivilegeId(short) - Method in class com.smartfoxserver.entities.SFSUser
 
setPrivilegeId(short) - Method in interface com.smartfoxserver.entities.User
 
setPrivilegeManager(PrivilegeManager) - Method in class com.smartfoxserver.entities.SFSZone
setPrivilegeManager(PrivilegeManager) - Method in interface com.smartfoxserver.entities.Zone
 
setProperties(Map<Object, Object>) - Method in class com.smartfoxserver.entities.SFSRoom
 
setPropertiesFile(String) - Method in class com.smartfoxserver.api.CreateRoomSettings.RoomExtensionSettings
Set an optional properties file that will be loaded when the Extension is initialized.
setPropertiesFileName(String) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setPropertiesFileName(String) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setProperty(Object, Object) - Method in interface com.smartfoxserver.entities.Room
Attach a custom (server-side only) property to the Room object
setProperty(Object, Object) - Method in class com.smartfoxserver.entities.SFSRoom
Attach a custom (server-side only) property to the Room object
setProperty(Object, Object) - Method in class com.smartfoxserver.entities.SFSUser
 
setProperty(Object, Object) - Method in class com.smartfoxserver.entities.SFSZone
Properties are custom values that can be added or removed from the Zone at run-time.
setProperty(Object, Object) - Method in interface com.smartfoxserver.entities.User
Attach a custom (server-side only) property to the User object
setProperty(Object, Object) - Method in interface com.smartfoxserver.entities.Zone
Properties are custom values that can be added or removed from the Zone at run-time.
setProperty(String, Object) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
Can be used to attach custom properties to a Session at runtime.
setProperty(String, Object) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setProximityListUpdateMillis(int) - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
In MMORoom(s) there are no USER_ENTER/EXIT events.
setPublicGroups(List<String>) - Method in class com.smartfoxserver.entities.SFSZone
setPublicGroups(List<String>) - Method in interface com.smartfoxserver.entities.Zone
 
setRdpTxConfig(TransportConfig) - Method in class com.smartfoxserver.entities.SFSZone
 
setRdpTxConfig(TransportConfig) - Method in interface com.smartfoxserver.entities.Zone
 
setReconnectionSeconds(int) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setReconnectionSeconds(int) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setReconnectionSeconds(int) - Method in class com.smartfoxserver.entities.SFSUser
 
setReconnectionSeconds(int) - Method in interface com.smartfoxserver.entities.User
 
setReloadMode(ExtensionReloadMode) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setReloadMode(ExtensionReloadMode) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setRoomProperties(Map<Object, Object>) - Method in class com.smartfoxserver.api.CreateRoomSettings
Allows to set a number of custom properties that will be available in the Room Extension
setRoomSettings(Set<SFSRoomSettings>) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set the advanced settings of the Room.
setRoomVariables(User, Room, List<RoomVariable>) - Method in interface com.smartfoxserver.api.ISFSApi
Set Room Variables and update all clients.
setRoomVariables(User, Room, List<RoomVariable>) - Method in class com.smartfoxserver.api.SFSApi
Set Room Variables and update all clients.
setRoomVariables(User, Room, List<RoomVariable>, boolean, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Set Room Variables and update all clients.
setRoomVariables(User, Room, List<RoomVariable>, boolean, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
Set Room Variables and update all clients.
setRoomVariables(List<RoomVariable>) - Method in class com.smartfoxserver.api.CreateRoomSettings
Set one or more Room Variables in the new Room
SetRoomVariables - Class in com.smartfoxserver.controllers.system
 
SetRoomVariables - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
SetRoomVariables() - Constructor for class com.smartfoxserver.controllers.system.SetRoomVariables
 
setSearchableRooms(List<Room>) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
Provide a list of Rooms (e.g. all the Rooms from a specific Group in the Zone) that the system will use to search more players to join in a private Game.
setSecondsBeforeBan(int) - Method in interface com.smartfoxserver.util.IFloodFilter
 
setSecondsBeforeBan(int) - Method in class com.smartfoxserver.util.SFSFloodFilter
 
setSecondsBeforeBanOrKick(int) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setSendAOIEntryPoint(boolean) - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
When a User enters the proximity list of another Player by default we also send their coordinates.
setSendAOIEntryPoint(boolean) - Method in class com.smartfoxserver.mmo.MMORoom
 
setSessionManager(ISessionManager) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setSessionManager(ISessionManager) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setSFS(SmartFoxServer) - Method in interface com.smartfoxserver.api.ISFSGameApi
Private
setSFS(SmartFoxServer) - Method in class com.smartfoxserver.api.SFSGameApi
 
setSpectatorMatchExpression(MatchExpression) - Method in class com.smartfoxserver.game.CreateSFSGameSettings
A match expression to filter Spectators willing to join the Game.
setSpectatorMatchExpression(MatchExpression) - Method in class com.smartfoxserver.game.SFSGame
 
setState(String) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
setState(String) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
setStorable(boolean) - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
Flags this variable as storable (default = true).
setStorable(boolean) - Method in interface com.smartfoxserver.entities.variables.UserVariable
Flags this variable as storable (default = true).
setStorageHandler(BuddyStorage) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setStorageHandler(BuddyStorage) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setSuppressUserList(boolean) - Method in class com.smartfoxserver.api.CreateRoomSettings
Used to suppress the User list on the client side, for special use cases when Rooms are not used for User interaction.
setSuppressUserList(boolean) - Method in interface com.smartfoxserver.entities.Room
 
setSuppressUserList(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
 
setSuppressUserList(boolean) - Method in class com.smartfoxserver.mmo.MMORoom
 
setSystemProperty(String, Object) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setSystemProperty(String, Object) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setType(SessionType) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setType(SessionType) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setType(ExtensionType) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
setType(ExtensionType) - Method in interface com.smartfoxserver.extensions.ISFSExtension
 
setUdpConnection(UDPConnection) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setUdpConnection(UDPConnection) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setUdpKeepAlive(boolean) - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
setUdpKeepAlive(boolean) - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
setUdpKeepAlive(boolean) - Method in class com.smartfoxserver.entities.SFSZone
 
setUdpKeepAlive(boolean) - Method in interface com.smartfoxserver.entities.Zone
When true, sends a ping every few seconds to every UDP connection to keep it alive.
setUploadEnabled(boolean) - Method in class com.smartfoxserver.entities.SFSZone
setUploadEnabled(boolean) - Method in interface com.smartfoxserver.entities.Zone
 
setUserCountChangeUpdateInterval(int) - Method in class com.smartfoxserver.entities.SFSZone
setUserCountChangeUpdateInterval(int) - Method in interface com.smartfoxserver.entities.Zone
 
setUserLimboMaxSeconds(int) - Method in class com.smartfoxserver.mmo.MMORoom
 
setUserManager(IUserManager) - Method in interface com.smartfoxserver.entities.Room
 
setUserManager(IUserManager) - Method in class com.smartfoxserver.entities.SFSRoom
 
setUserMaxLimboSeconds(int) - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
When a User joins an MMORoom his position in the Room is undefined and therefore he will be in a state of limbo until the first SetUserPosition request will be received.
setUserPosition(User, Vec3D, Room) - Method in interface com.smartfoxserver.api.ISFSMMOApi
Set the new User position inside an MMORoom
setUserPosition(User, Vec3D, Room) - Method in class com.smartfoxserver.api.SFSMMOApi
Set the new User position inside an MMORoom
SetUserPosition - Class in com.smartfoxserver.controllers.system
 
SetUserPosition - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
SetUserPosition() - Constructor for class com.smartfoxserver.controllers.system.SetUserPosition
 
setUserReconnectionSeconds(int) - Method in class com.smartfoxserver.entities.SFSZone
setUserReconnectionSeconds(int) - Method in interface com.smartfoxserver.entities.Zone
 
setUserVariables(User, List<UserVariable>) - Method in interface com.smartfoxserver.api.ISFSApi
Set User Variables.
setUserVariables(User, List<UserVariable>) - Method in class com.smartfoxserver.api.SFSApi
Set User Variables.
setUserVariables(User, List<UserVariable>, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Set User Variables.
setUserVariables(User, List<UserVariable>, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
Set User Variables.
SetUserVariables - Class in com.smartfoxserver.controllers.system
 
SetUserVariables - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
SetUserVariables() - Constructor for class com.smartfoxserver.controllers.system.SetUserVariables
 
setUseTempBuddies(boolean) - Method in interface com.smartfoxserver.buddylist.BuddyListManager
 
setUseTempBuddies(boolean) - Method in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
setUseWarnings(boolean) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setUseWordsFilter(boolean) - Method in class com.smartfoxserver.api.CreateRoomSettings
Toggle the word filter in this Room (applied to Public Messages)
setUseWordsFilter(boolean) - Method in interface com.smartfoxserver.entities.Room
Toggle the word filter in this Room (applied to Public Messages)
setUseWordsFilter(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
Toggle the word filter in this Room (applied to Public Messages)
setVariable(BuddyVariable) - Method in interface com.smartfoxserver.buddylist.Buddy
Set / modify a BuddyVariable.
setVariable(BuddyVariable) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
setVariable(BuddyVariable) - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
setVariable(BuddyVariable) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
setVariable(RoomVariable) - Method in interface com.smartfoxserver.entities.Room
 
setVariable(RoomVariable) - Method in class com.smartfoxserver.entities.SFSRoom
setVariable(RoomVariable, boolean) - Method in interface com.smartfoxserver.entities.Room
 
setVariable(RoomVariable, boolean) - Method in class com.smartfoxserver.entities.SFSRoom
 
setVariable(UserVariable) - Method in class com.smartfoxserver.entities.SFSUser
 
setVariable(UserVariable) - Method in interface com.smartfoxserver.entities.User
 
setVariable(IMMOItemVariable) - Method in interface com.smartfoxserver.mmo.IMMOItem
 
setVariable(IMMOItemVariable) - Method in class com.smartfoxserver.mmo.MMOItem
 
setVariables(List<BuddyVariable>) - Method in interface com.smartfoxserver.buddylist.Buddy
Sets a number of variables at once.
setVariables(List<BuddyVariable>) - Method in interface com.smartfoxserver.buddylist.BuddyProperties
 
setVariables(List<BuddyVariable>) - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
setVariables(List<BuddyVariable>) - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
setVariables(List<RoomVariable>) - Method in interface com.smartfoxserver.entities.Room
 
setVariables(List<RoomVariable>) - Method in class com.smartfoxserver.entities.SFSRoom
setVariables(List<RoomVariable>, boolean) - Method in interface com.smartfoxserver.entities.Room
 
setVariables(List<RoomVariable>, boolean) - Method in class com.smartfoxserver.entities.SFSRoom
setVariables(List<UserVariable>) - Method in class com.smartfoxserver.entities.SFSUser
 
setVariables(List<UserVariable>) - Method in interface com.smartfoxserver.entities.User
 
setVariables(List<IMMOItemVariable>) - Method in interface com.smartfoxserver.mmo.IMMOItem
 
setVariables(List<IMMOItemVariable>) - Method in class com.smartfoxserver.mmo.MMOItem
 
setWarningMessage(String) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setWarningsBeforeKick(int) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setWordsFile(String) - Method in class com.smartfoxserver.util.SFSWordFilter
 
setZone(Zone) - Method in interface com.smartfoxserver.entities.Room
 
setZone(Zone) - Method in class com.smartfoxserver.entities.SFSRoom
setZone(Zone) - Method in class com.smartfoxserver.entities.SFSUser
 
setZone(Zone) - Method in interface com.smartfoxserver.entities.User
 
setZoneManager(IZoneManager) - Method in class com.smartfoxserver.entities.SFSZone
setZoneManager(IZoneManager) - Method in interface com.smartfoxserver.entities.Zone
 
sfs - Variable in class com.smartfoxserver.api.SFSApi
 
sfs - Variable in class com.smartfoxserver.api.SFSBuddyApi
 
sfs - Variable in class com.smartfoxserver.api.SFSGameApi
 
sfs - Variable in class com.smartfoxserver.api.SFSMMOApi
 
sfs - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
sfs - Variable in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
SFS_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
SFS_OBJECT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
SFS3_DB_ALIAS - Static variable in class com.smartfoxserver.db.EmbeddedDBService
 
SFS3_DB_PASS - Static variable in class com.smartfoxserver.db.EmbeddedDBService
 
SFS3_DB_PATH - Static variable in class com.smartfoxserver.db.EmbeddedDBService
 
SFS3_DB_SCHEMA - Static variable in class com.smartfoxserver.db.EmbeddedDBService
 
SFS3_DB_TAB_PERFDATA - Static variable in class com.smartfoxserver.db.EmbeddedDBService
 
SFS3_DB_USER - Static variable in class com.smartfoxserver.db.EmbeddedDBService
 
SFS3_SCHEMA - Static variable in class com.smartfoxserver.db.EmbeddedDBService
 
SFSAdminException - Exception Class in com.smartfoxserver.exceptions
 
SFSAdminException() - Constructor for exception class com.smartfoxserver.exceptions.SFSAdminException
 
SFSAdminException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSAdminException
 
SFSAdminException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSAdminException
 
sfsApi - Variable in class com.smartfoxserver.api.SFSBuddyApi
 
sfsApi - Variable in class com.smartfoxserver.api.SFSGameApi
 
sfsApi - Variable in class com.smartfoxserver.extensions.BaseSFSExtension
A reference to the SmartFoxServer API main object
sfsAPI - Variable in class com.smartfoxserver.api.SFSMMOApi
 
sfsAPI - Variable in class com.smartfoxserver.game.BaseGameInvitationCallback
A reference to the SFS API
SFSApi - Class in com.smartfoxserver.api
Overview
SFSApi(SmartFoxServer) - Constructor for class com.smartfoxserver.api.SFSApi
 
SFSArray - Class in com.smartfoxserver.entities.data
SFSArray and SFSObject represent a platform-neutral, high-level objects that abstract the data transport between client and server.
SFSArray() - Constructor for class com.smartfoxserver.entities.data.SFSArray
 
SFSArrayLite - Class in com.smartfoxserver.entities.data
 
SFSArrayLite() - Constructor for class com.smartfoxserver.entities.data.SFSArrayLite
 
SFSAudioException - Exception Class in com.smartfoxserver.exceptions
 
SFSAudioException() - Constructor for exception class com.smartfoxserver.exceptions.SFSAudioException
 
SFSAudioException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSAudioException
 
SFSAudioException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSAudioException
 
SFSBannedUser - Class in com.smartfoxserver.entities
 
SFSBannedUser() - Constructor for class com.smartfoxserver.entities.SFSBannedUser
 
SFSBannedUser(User, int, BanMode) - Constructor for class com.smartfoxserver.entities.SFSBannedUser
 
SFSBannedUser(User, int, BanMode, String, String) - Constructor for class com.smartfoxserver.entities.SFSBannedUser
 
SFSBannedUser(String, String, int, BanMode) - Constructor for class com.smartfoxserver.entities.SFSBannedUser
 
SFSBannedUser(String, String, int, BanMode, String, String) - Constructor for class com.smartfoxserver.entities.SFSBannedUser
 
SFSBannedUserManager - Class in com.smartfoxserver.entities.managers
 
SFSBannedUserManager() - Constructor for class com.smartfoxserver.entities.managers.SFSBannedUserManager
 
SFSBootException - Exception Class in com.smartfoxserver.exceptions
 
SFSBootException() - Constructor for exception class com.smartfoxserver.exceptions.SFSBootException
 
SFSBootException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSBootException
 
SFSBuddy - Class in com.smartfoxserver.buddylist
Introduction
SFSBuddy(String) - Constructor for class com.smartfoxserver.buddylist.SFSBuddy
 
SFSBuddy(String, boolean) - Constructor for class com.smartfoxserver.buddylist.SFSBuddy
 
SFSBuddyApi - Class in com.smartfoxserver.api
Provides access to the API for managing Buddies and Buddy lists.
SFSBuddyApi(SmartFoxServer) - Constructor for class com.smartfoxserver.api.SFSBuddyApi
 
SFSBuddyEventParam - Enum Class in com.smartfoxserver.buddylist
 
SFSBuddyList - Class in com.smartfoxserver.buddylist
An SFSBuddyList represents one BuddyList in the Buddy System.
SFSBuddyList(String) - Constructor for class com.smartfoxserver.buddylist.SFSBuddyList
 
SFSBuddyList(String, BuddyListManager) - Constructor for class com.smartfoxserver.buddylist.SFSBuddyList
 
SFSBuddyListException - Exception Class in com.smartfoxserver.exceptions
 
SFSBuddyListException() - Constructor for exception class com.smartfoxserver.exceptions.SFSBuddyListException
 
SFSBuddyListException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSBuddyListException
 
SFSBuddyListException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSBuddyListException
 
SFSBuddyListManager - Class in com.smartfoxserver.buddylist
 
SFSBuddyListManager(Zone, boolean) - Constructor for class com.smartfoxserver.buddylist.SFSBuddyListManager
 
SFSBuddyListNotFoundException - Exception Class in com.smartfoxserver.exceptions
 
SFSBuddyListNotFoundException() - Constructor for exception class com.smartfoxserver.exceptions.SFSBuddyListNotFoundException
 
SFSBuddyListNotFoundException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSBuddyListNotFoundException
 
SFSBuddyListNotFoundException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSBuddyListNotFoundException
 
SFSBuddyProperties - Class in com.smartfoxserver.buddylist
 
SFSBuddyProperties() - Constructor for class com.smartfoxserver.buddylist.SFSBuddyProperties
 
SFSBuddyVariable - Class in com.smartfoxserver.buddylist
BuddyVariables are custom values attached to any Buddy in a BuddyList.
SFSBuddyVariable() - Constructor for class com.smartfoxserver.buddylist.SFSBuddyVariable
 
SFSBuddyVariable(String, Object) - Constructor for class com.smartfoxserver.buddylist.SFSBuddyVariable
 
SFSBuddyVariable(String, Object, VariableType) - Constructor for class com.smartfoxserver.buddylist.SFSBuddyVariable
 
SFSCodecException - Exception Class in com.smartfoxserver.exceptions
 
SFSCodecException() - Constructor for exception class com.smartfoxserver.exceptions.SFSCodecException
 
SFSCodecException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSCodecException
 
SFSCodecException(Throwable) - Constructor for exception class com.smartfoxserver.exceptions.SFSCodecException
 
SFSCreateGameException - Exception Class in com.smartfoxserver.exceptions
 
SFSCreateGameException() - Constructor for exception class com.smartfoxserver.exceptions.SFSCreateGameException
 
SFSCreateGameException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSCreateGameException
 
SFSCreateGameException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSCreateGameException
 
SFSCreateRoomException - Exception Class in com.smartfoxserver.exceptions
 
SFSCreateRoomException() - Constructor for exception class com.smartfoxserver.exceptions.SFSCreateRoomException
 
SFSCreateRoomException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSCreateRoomException
 
SFSCreateRoomException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSCreateRoomException
 
SFSDataSize - Class in com.smartfoxserver.entities.data
 
SFSDataSize() - Constructor for class com.smartfoxserver.entities.data.SFSDataSize
 
SFSDataType - Enum Class in com.smartfoxserver.entities.data
 
SFSDataWrapper - Class in com.smartfoxserver.entities.data
 
SFSDataWrapper(SFSDataType, Object) - Constructor for class com.smartfoxserver.entities.data.SFSDataWrapper
 
SFSDBManager - Class in com.smartfoxserver.db
SFSDBManager is the default implementation of the IDBManager interface provided by the SmartFoxServer platform.
SFSDBManager(DBConfig) - Constructor for class com.smartfoxserver.db.SFSDBManager
 
SFSEmail - Class in com.smartfoxserver.entities
The class represent an email message in either plain text or valid HTML format that can be sent via the mail service provided by the SmartFoxServer class.
SFSEmail(String, String, String, String) - Constructor for class com.smartfoxserver.entities.SFSEmail
 
SFSEmail(String, String, String, String, int) - Constructor for class com.smartfoxserver.entities.SFSEmail
 
SFSErrorCode - Enum Class in com.smartfoxserver.exceptions
 
SFSErrorData - Class in com.smartfoxserver.exceptions
 
SFSErrorData(IErrorCode) - Constructor for class com.smartfoxserver.exceptions.SFSErrorData
 
SFSEvent - Class in com.smartfoxserver.core
Events are notified to Server Extensions via listeners.
SFSEvent(EventType) - Constructor for class com.smartfoxserver.core.SFSEvent
 
SFSEvent(EventType, Map<ISFSEventParam, Object>) - Constructor for class com.smartfoxserver.core.SFSEvent
 
SFSEventParam - Enum Class in com.smartfoxserver.core
 
SFSEventType - Enum Class in com.smartfoxserver.core
 
SFSException - Exception Class in com.smartfoxserver.exceptions
 
SFSException() - Constructor for exception class com.smartfoxserver.exceptions.SFSException
 
SFSException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSException
 
SFSException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSException
 
SFSException(Throwable) - Constructor for exception class com.smartfoxserver.exceptions.SFSException
 
SFSExtension - Class in com.smartfoxserver.extensions
The SFSExtension class provides an invocation mechanism that promotes clear separation between the main extension class and each request and event handlers.
SFSExtension() - Constructor for class com.smartfoxserver.extensions.SFSExtension
 
SFSExtensionException - Exception Class in com.smartfoxserver.exceptions
 
SFSExtensionException() - Constructor for exception class com.smartfoxserver.exceptions.SFSExtensionException
 
SFSExtensionException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSExtensionException
 
SFSExtensionException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSExtensionException
 
SFSExtensionFilter - Class in com.smartfoxserver.extensions.filter
For a quick introduction see:
SFSExtensionFilter() - Constructor for class com.smartfoxserver.extensions.filter.SFSExtensionFilter
 
SFSExtensionFilterChain - Class in com.smartfoxserver.extensions.filter
The Filter Chain allows the developer to configure a number of Filters that will run prior to executing a Client request or dispatching a Server side event.
SFSExtensionFilterChain(SFSExtension) - Constructor for class com.smartfoxserver.extensions.filter.SFSExtensionFilterChain
 
SFSFilterInterruptedException - Exception Class in com.smartfoxserver.exceptions
 
SFSFilterInterruptedException() - Constructor for exception class com.smartfoxserver.exceptions.SFSFilterInterruptedException
 
SFSFilterInterruptedException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSFilterInterruptedException
 
SFSFloodFilter - Class in com.smartfoxserver.util
 
SFSFloodFilter(IBannedUserManager) - Constructor for class com.smartfoxserver.util.SFSFloodFilter
 
SFSFloodingException - Exception Class in com.smartfoxserver.exceptions
 
SFSFloodingException() - Constructor for exception class com.smartfoxserver.exceptions.SFSFloodingException
 
SFSFloodingException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSFloodingException
 
SFSFloodingException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSFloodingException
 
SFSGame - Class in com.smartfoxserver.game
Introduction
SFSGame(String) - Constructor for class com.smartfoxserver.game.SFSGame
 
SFSGameApi - Class in com.smartfoxserver.api
Provides specialized methods for advanced game functionalities such as: Match making Creation of private/invitation-only games Invitations Quick joining games matching specific parameters Etc...
SFSGameApi() - Constructor for class com.smartfoxserver.api.SFSGameApi
 
SFSGameApi(SmartFoxServer) - Constructor for class com.smartfoxserver.api.SFSGameApi
 
SFSGameInvitationCallback - Class in com.smartfoxserver.game
 
SFSGameInvitationCallback(Room, int, boolean) - Constructor for class com.smartfoxserver.game.SFSGameInvitationCallback
 
SFSIDGenerator - Class in com.smartfoxserver.entities
 
SFSIDGenerator() - Constructor for class com.smartfoxserver.entities.SFSIDGenerator
 
SFSInvitation - Class in com.smartfoxserver.entities.invitation
Overview
SFSInvitation(User, User, int) - Constructor for class com.smartfoxserver.entities.invitation.SFSInvitation
 
SFSInvitation(User, User, int, ISFSObject) - Constructor for class com.smartfoxserver.entities.invitation.SFSInvitation
 
SFSInvitationException - Exception Class in com.smartfoxserver.exceptions
 
SFSInvitationException() - Constructor for exception class com.smartfoxserver.exceptions.SFSInvitationException
 
SFSInvitationException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSInvitationException
 
SFSInvitationException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSInvitationException
 
SFSInvitationManager - Class in com.smartfoxserver.entities.invitation
 
SFSInvitationManager() - Constructor for class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
SFSJoinRoomException - Exception Class in com.smartfoxserver.exceptions
 
SFSJoinRoomException() - Constructor for exception class com.smartfoxserver.exceptions.SFSJoinRoomException
 
SFSJoinRoomException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSJoinRoomException
 
SFSJoinRoomException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSJoinRoomException
 
SFSLoginException - Exception Class in com.smartfoxserver.exceptions
 
SFSLoginException() - Constructor for exception class com.smartfoxserver.exceptions.SFSLoginException
 
SFSLoginException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSLoginException
 
SFSLoginException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSLoginException
 
SFSLoginFilterException - Exception Class in com.smartfoxserver.exceptions
 
SFSLoginFilterException() - Constructor for exception class com.smartfoxserver.exceptions.SFSLoginFilterException
 
SFSLoginFilterException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSLoginFilterException
 
SFSLoginInterruptedException - Exception Class in com.smartfoxserver.exceptions
 
SFSLoginInterruptedException() - Constructor for exception class com.smartfoxserver.exceptions.SFSLoginInterruptedException
 
SFSLoginInterruptedException(boolean) - Constructor for exception class com.smartfoxserver.exceptions.SFSLoginInterruptedException
 
SFSMMOApi - Class in com.smartfoxserver.api
Provides access to the API for managing MMORooms.
SFSMMOApi(SmartFoxServer) - Constructor for class com.smartfoxserver.api.SFSMMOApi
 
SFSObject - Class in com.smartfoxserver.entities.data
 
SFSObject() - Constructor for class com.smartfoxserver.entities.data.SFSObject
 
SFSObjectLite - Class in com.smartfoxserver.entities.data
 
SFSObjectLite() - Constructor for class com.smartfoxserver.entities.data.SFSObjectLite
 
SFSPermissionProfile - Class in com.smartfoxserver.security
 
SFSPermissionProfile(short, String, List<SystemRequest>) - Constructor for class com.smartfoxserver.security.SFSPermissionProfile
 
SFSPermissionProfile(short, String, List<SystemRequest>, List<SystemPermission>) - Constructor for class com.smartfoxserver.security.SFSPermissionProfile
 
SFSPostOffice - Class in com.smartfoxserver.entities.managers
SFSPostOffice provides a simple mailing service for sending text/html emails via a configured SMTP service.
SFSPostOffice() - Constructor for class com.smartfoxserver.entities.managers.SFSPostOffice
 
SFSPrivilegeManager - Class in com.smartfoxserver.security
 
SFSPrivilegeManager() - Constructor for class com.smartfoxserver.security.SFSPrivilegeManager
 
SFSQuickJoinGameException - Exception Class in com.smartfoxserver.exceptions
 
SFSQuickJoinGameException() - Constructor for exception class com.smartfoxserver.exceptions.SFSQuickJoinGameException
 
SFSQuickJoinGameException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSQuickJoinGameException
 
SFSQuickJoinGameException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSQuickJoinGameException
 
SFSRequestValidationException - Exception Class in com.smartfoxserver.exceptions
 
SFSRequestValidationException() - Constructor for exception class com.smartfoxserver.exceptions.SFSRequestValidationException
 
SFSRequestValidationException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSRequestValidationException
 
SFSRequestValidationException(Throwable) - Constructor for exception class com.smartfoxserver.exceptions.SFSRequestValidationException
 
SFSRoom - Class in com.smartfoxserver.entities
Overview
SFSRoom(String) - Constructor for class com.smartfoxserver.entities.SFSRoom
 
SFSRoom(String, Class<?>) - Constructor for class com.smartfoxserver.entities.SFSRoom
 
SFSRoomEvents - Enum Class in com.smartfoxserver.entities
 
SFSRoomException - Exception Class in com.smartfoxserver.exceptions
 
SFSRoomException() - Constructor for exception class com.smartfoxserver.exceptions.SFSRoomException
 
SFSRoomException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSRoomException
 
SFSRoomException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSRoomException
 
SFSRoomRemoveMode - Enum Class in com.smartfoxserver.entities
The Remove Mode tells the RoomManager how to auto-remove dynamically created Rooms.
SFSRoomSettings - Enum Class in com.smartfoxserver.entities
These flags are used to configure the Room behavior
SFSRoomVariable - Class in com.smartfoxserver.entities.variables
RoomVariables are custom values assigned to Room objects that get automatically synchronized between client and server on every change.
SFSRoomVariable(String) - Constructor for class com.smartfoxserver.entities.variables.SFSRoomVariable
 
SFSRoomVariable(String, Object) - Constructor for class com.smartfoxserver.entities.variables.SFSRoomVariable
Create a new Room Variable
SFSRoomVariable(String, Object, boolean, boolean, boolean) - Constructor for class com.smartfoxserver.entities.variables.SFSRoomVariable
Create a new Room Variable
SFSRoomVariable(String, String, String) - Constructor for class com.smartfoxserver.entities.variables.SFSRoomVariable
 
SFSRuntimeException - Exception Class in com.smartfoxserver.exceptions
 
SFSRuntimeException() - Constructor for exception class com.smartfoxserver.exceptions.SFSRuntimeException
 
SFSRuntimeException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSRuntimeException
 
SFSRuntimeException(Throwable) - Constructor for exception class com.smartfoxserver.exceptions.SFSRuntimeException
 
SFSStorageException - Exception Class in com.smartfoxserver.persistence.room
 
SFSStorageException() - Constructor for exception class com.smartfoxserver.persistence.room.SFSStorageException
 
SFSStorageException(Exception) - Constructor for exception class com.smartfoxserver.persistence.room.SFSStorageException
 
SFSStorageException(String) - Constructor for exception class com.smartfoxserver.persistence.room.SFSStorageException
 
SFSTooManyRoomsException - Exception Class in com.smartfoxserver.exceptions
 
SFSTooManyRoomsException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSTooManyRoomsException
 
SFSTooManyRoomsException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSTooManyRoomsException
 
SFSUser - Class in com.smartfoxserver.entities
Overview
SFSUser(ISession) - Constructor for class com.smartfoxserver.entities.SFSUser
 
SFSUser(String, ISession) - Constructor for class com.smartfoxserver.entities.SFSUser
 
SFSUserException - Exception Class in com.smartfoxserver.exceptions
 
SFSUserException() - Constructor for exception class com.smartfoxserver.exceptions.SFSUserException
 
SFSUserException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSUserException
 
SFSUserException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSUserException
 
SFSUserVariable - Class in com.smartfoxserver.entities.variables
UserVariables are custom values assigned to User objects that are automatically synchronized between client and server on every change.
SFSUserVariable(String) - Constructor for class com.smartfoxserver.entities.variables.SFSUserVariable
 
SFSUserVariable(String, VariableType, String) - Constructor for class com.smartfoxserver.entities.variables.SFSUserVariable
 
SFSUserVariable(String, Object) - Constructor for class com.smartfoxserver.entities.variables.SFSUserVariable
Create a new UserVariable
SFSUserVariable(String, Object, boolean) - Constructor for class com.smartfoxserver.entities.variables.SFSUserVariable
Create a new UserVariable
SFSUserVariable(String, Object, boolean, boolean) - Constructor for class com.smartfoxserver.entities.variables.SFSUserVariable
Create a new UserVariable
SFSUserVariable(String, String, String) - Constructor for class com.smartfoxserver.entities.variables.SFSUserVariable
 
SFSVariableException - Exception Class in com.smartfoxserver.exceptions
 
SFSVariableException() - Constructor for exception class com.smartfoxserver.exceptions.SFSVariableException
 
SFSVariableException(String) - Constructor for exception class com.smartfoxserver.exceptions.SFSVariableException
 
SFSVariableException(String, SFSErrorData) - Constructor for exception class com.smartfoxserver.exceptions.SFSVariableException
 
SFSVector2 - Class in com.smartfoxserver.entities.data
A class representing a Vector in 2D space
SFSVector2(float, float) - Constructor for class com.smartfoxserver.entities.data.SFSVector2
 
SFSVector2(SFSVector2) - Constructor for class com.smartfoxserver.entities.data.SFSVector2
 
SFSVector3 - Class in com.smartfoxserver.entities.data
A class representing a Vector in 23 space
SFSVector3(float, float, float) - Constructor for class com.smartfoxserver.entities.data.SFSVector3
 
SFSVector3(SFSVector3) - Constructor for class com.smartfoxserver.entities.data.SFSVector3
 
SFSVersion - Class in com.smartfoxserver.entities
 
SFSVersion() - Constructor for class com.smartfoxserver.entities.SFSVersion
 
SFSWordFilter - Class in com.smartfoxserver.util
 
SFSWordFilter(IBannedUserManager) - Constructor for class com.smartfoxserver.util.SFSWordFilter
 
SFSWordFilter(IBannedUserManager, String) - Constructor for class com.smartfoxserver.util.SFSWordFilter
 
SFSZone - Class in com.smartfoxserver.entities
Overview
SFSZone(String) - Constructor for class com.smartfoxserver.entities.SFSZone
 
SHA256 - Class in com.smartfoxserver.util
 
SHA256 - Enum constant in enum class com.smartfoxserver.components.signup.PasswordMode
The password will be stored as MD5 hash in the database.
SHORT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
SHORT - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
SHORT_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
SHORT_STRING - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
SHORT_STRING_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
SignUpAssistantComponent - Class in com.smartfoxserver.components.signup
Overview
SignUpAssistantComponent() - Constructor for class com.smartfoxserver.components.signup.SignUpAssistantComponent
 
SignUpConfiguration - Class in com.smartfoxserver.components.signup
Provides all the necessary settings for the SignUpAssistant Component
SignUpConfiguration() - Constructor for class com.smartfoxserver.components.signup.SignUpConfiguration
 
SignUpConfiguration.EmailConfig - Class in com.smartfoxserver.components.signup
Configures the options related to sending an email response, after a successful user registration.
SignUpConfiguration.PasswordRecovery - Class in com.smartfoxserver.components.signup
Configures the Password Recovery feature of the SignUp Assistant.
SignUpErrorCodes - Enum Class in com.smartfoxserver.components.signup
Provides several error codes that are associated with customizable error messages.
signUpTable - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
The name of the Database table used for storing the user registrations.
SignUpValidationException - Exception Class in com.smartfoxserver.components.signup
Signal a validation error during the SignUp process
SignUpValidationException(SignUpErrorCodes, Object...) - Constructor for exception class com.smartfoxserver.components.signup.SignUpValidationException
Provide a description of the error.
Simple example of usage - Search tag in class com.smartfoxserver.components.login.LoginAssistantComponent
Section
SINGLE_INSTANCE - Enum constant in enum class com.smartfoxserver.annotations.Instantiation.InstantiationMode
 
size() - Method in interface com.smartfoxserver.controllers.filter.ISystemFilterChain
Get the size of the Filter Chain.
size() - Method in class com.smartfoxserver.controllers.filter.SysControllerFilterChain
 
size() - Method in interface com.smartfoxserver.entities.data.ISFSArray
Return the number of elements contained in the array
size() - Method in interface com.smartfoxserver.entities.data.ISFSObject
Get the size of the SFSObject
size() - Method in class com.smartfoxserver.entities.data.SFSArray
 
size() - Method in class com.smartfoxserver.entities.data.SFSObject
 
size() - Method in interface com.smartfoxserver.extensions.filter.IFilterChain
Get the size of the Filter Chain.
size() - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilterChain
Get the size of the Filter Chain.
skipStaticRooms - Variable in class com.smartfoxserver.persistence.room.BaseStorageConfig
When saving Rooms in batches by calling IRoomStorage.saveAllRooms() or IRoomStorage.saveAllRooms(String) the default assumption is to skip all static Rooms.
SmartFoxServer - Class in com.smartfoxserver
Main Server class, provides access to a series of services that can be sometimes useful for more advanced operations.
Specialized API - Search tag in class com.smartfoxserver.api.SFSApi
Section
SPECTATOR_COUNT - Static variable in class com.smartfoxserver.entities.match.RoomProperties
The Room spectator count
SPECTATOR_TO_PLAYER - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a User joined in a Game Room as spectator turns into a Player.
spectatorToPlayer(User, Room, boolean, boolean) - Method in interface com.smartfoxserver.api.ISFSApi
Turns a spectator in a Game Room to a Player.
spectatorToPlayer(User, Room, boolean, boolean) - Method in class com.smartfoxserver.api.SFSApi
 
SpectatorToPlayer - Class in com.smartfoxserver.controllers.system
 
SpectatorToPlayer - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
SpectatorToPlayer() - Constructor for class com.smartfoxserver.controllers.system.SpectatorToPlayer
 
STANDARD - Enum constant in enum class com.smartfoxserver.security.DefaultPermissionProfile
 
start() - Method in class com.smartfoxserver.SmartFoxServer
 
startInvitation(Invitation, InvitationCallback) - Method in interface com.smartfoxserver.entities.invitation.InvitationManager
Start a new invitation
startInvitation(Invitation, InvitationCallback) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
STARTS_WITH - Enum constant in enum class com.smartfoxserver.entities.match.StringMatch
Check that Str1.startsWith(Str2)
storable - Variable in class com.smartfoxserver.entities.variables.SFSUserVariable
 
storeInactiveRooms - Variable in class com.smartfoxserver.persistence.room.BaseStorageConfig
When set to true it will also save Rooms that are marked as inactive.
storeRoomVariables - Variable in class com.smartfoxserver.persistence.room.BaseStorageConfig
When set to true it will also save the Room Variables (owned by the server).
STRING - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
STRING - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
STRING_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
StringMatch - Enum Class in com.smartfoxserver.entities.match
This matcher is used in MatchExpressions to check String conditions
sub(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector that is the result of subtracting the specified vector from this vector.
sub(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector that is the result of subtracting the specified vector from this vector.
subject - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.EmailConfig
The email's subject
SUBSCRIBE_GROUP_ALREADY_SUBSCRIBED - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
SUBSCRIBE_GROUP_NOT_FOUND - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
subscribeGroup(String) - Method in class com.smartfoxserver.entities.SFSUser
 
subscribeGroup(String) - Method in interface com.smartfoxserver.entities.User
 
subscribeRoomGroup(User, String) - Method in interface com.smartfoxserver.api.ISFSApi
Subscribe User to a Room Group.
subscribeRoomGroup(User, String) - Method in class com.smartfoxserver.api.SFSApi
Subscribe User to a Room Group.
SubscribeRoomGroup - Class in com.smartfoxserver.controllers.system
 
SubscribeRoomGroup - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
SubscribeRoomGroup() - Constructor for class com.smartfoxserver.controllers.system.SubscribeRoomGroup
 
sum(SFSVector2) - Method in class com.smartfoxserver.entities.data.SFSVector2
Returns a new vector that is the sum of this vector and the specified vector.
sum(SFSVector3) - Method in class com.smartfoxserver.entities.data.SFSVector3
Returns a new vector that is the sum of this vector and the specified vector.
SuperUser - Enum constant in enum class com.smartfoxserver.security.SystemPermission
 
suppressInvitation(Invitation) - Method in interface com.smartfoxserver.entities.invitation.InvitationManager
Stop an invitation that is running
suppressInvitation(Invitation) - Method in class com.smartfoxserver.entities.invitation.SFSInvitationManager
 
SWITCH_NO_PLAYER_SLOTS_AVAILABLE - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
SWITCH_NO_SPECTATOR_SLOTS_AVAILABLE - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
SWITCH_NOT_A_GAME_ROOM - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
SWITCH_NOT_JOINED_IN_ROOM - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
switchPlayerToSpectator(User) - Method in interface com.smartfoxserver.entities.Room
 
switchPlayerToSpectator(User) - Method in class com.smartfoxserver.entities.SFSRoom
switchPlayerToSpectator(User) - Method in class com.smartfoxserver.game.SFSGame
 
switchSpectatorToPlayer(User) - Method in interface com.smartfoxserver.entities.Room
 
switchSpectatorToPlayer(User) - Method in class com.smartfoxserver.entities.SFSRoom
switchSpectatorToPlayer(User) - Method in class com.smartfoxserver.game.SFSGame
 
SysControllerFilter - Class in com.smartfoxserver.controllers.filter
A filter can be used to intercept any API client request (not Extension requests) and interact with the parameter, adding extra validation, custom logic etc...
SysControllerFilter() - Constructor for class com.smartfoxserver.controllers.filter.SysControllerFilter
 
SysControllerFilterChain - Class in com.smartfoxserver.controllers.filter
The SystemFilterChain can contain one or several SystemController Filter instances that can be applied before a client request is executed by the SystemController.
SysControllerFilterChain() - Constructor for class com.smartfoxserver.controllers.filter.SysControllerFilterChain
 
SystemPermission - Enum Class in com.smartfoxserver.security
 
SystemRequest - Enum Class in com.smartfoxserver.controllers
 

T

tableName - Variable in class com.smartfoxserver.persistence.room.DBRoomStorageConfig
Name of the table to use for Room storage
TaskScheduler - Class in com.smartfoxserver.util
Overview
TaskScheduler(int) - Constructor for class com.smartfoxserver.util.TaskScheduler
Instead of creating a new instance use the API's scheduler
TCP - Enum constant in enum class com.smartfoxserver.bitswarm.data.TransportType
Standard TCP transport
TCP - Enum constant in enum class com.smartfoxserver.bitswarm.sessions.SessionType
A default, persistent socket connection, using TCP and UDP protocols
Temp Buddy - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
template - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.EmailConfig
The path to the email HTML template relative to the Extension's folder.
testSql - Variable in class com.smartfoxserver.db.DBConfig
A test SQL expression that will be executed at startup to verify the integrity of the setup and connection
testTableExistenceSQL - Variable in class com.smartfoxserver.persistence.room.DBRoomStorageConfig
This SQL is used to test the existence of the table.
TEXT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
toBinary() - Method in interface com.smartfoxserver.entities.data.ISFSArray
Return the binary representation of the SFSArray
toBinary() - Method in interface com.smartfoxserver.entities.data.ISFSObject
Serialize the SFSObject to a byte[]
toBinary() - Method in class com.smartfoxserver.entities.data.SFSArray
 
toBinary() - Method in class com.smartfoxserver.entities.data.SFSObject
 
toFloatArray() - Method in class com.smartfoxserver.mmo.Vec3D
 
toIntArray() - Method in class com.smartfoxserver.mmo.Vec3D
 
toJson() - Method in interface com.smartfoxserver.entities.data.ISFSArray
Return the JSON representation of the SFSArray
toJson() - Method in interface com.smartfoxserver.entities.data.ISFSObject
 
toJson() - Method in class com.smartfoxserver.entities.data.SFSArray
 
toJson() - Method in class com.smartfoxserver.entities.data.SFSObject
 
toSFSArray() - Method in interface com.smartfoxserver.buddylist.Buddy
 
toSFSArray() - Method in interface com.smartfoxserver.buddylist.BuddyList
 
toSFSArray() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
toSFSArray() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
toSFSArray() - Method in class com.smartfoxserver.buddylist.SFSBuddyVariable
 
toSFSArray() - Method in interface com.smartfoxserver.entities.BannedUser
 
toSFSArray() - Method in class com.smartfoxserver.entities.match.MatchExpression
 
toSFSArray() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
toSFSArray() - Method in class com.smartfoxserver.entities.SFSUser
 
toSFSArray() - Method in interface com.smartfoxserver.entities.User
 
toSFSArray() - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
 
toSFSArray() - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
 
toSFSArray() - Method in interface com.smartfoxserver.entities.variables.Variable
 
toSFSArray() - Method in interface com.smartfoxserver.mmo.IMMOItem
 
toSFSArray() - Method in class com.smartfoxserver.mmo.MMOItem
 
toSFSArray(boolean) - Method in interface com.smartfoxserver.entities.Room
 
toSFSArray(boolean) - Method in class com.smartfoxserver.entities.SFSRoom
 
toSFSArray(boolean) - Method in class com.smartfoxserver.mmo.MMORoom
 
toSFSArray(Room) - Method in class com.smartfoxserver.entities.SFSUser
 
toSFSArray(Room) - Method in interface com.smartfoxserver.entities.User
 
toSFSObject(BuddyList, boolean) - Static method in class com.smartfoxserver.buddylist.BuddyUtils
 
toString() - Method in class com.smartfoxserver.api.CreateRoomSettings.RoomExtensionSettings
 
toString() - Method in class com.smartfoxserver.api.CreateRoomSettings
 
toString() - Method in enum class com.smartfoxserver.bitswarm.data.MessagePriority
 
toString() - Method in enum class com.smartfoxserver.bitswarm.data.TransportType
 
toString() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
toString() - Method in class com.smartfoxserver.buddylist.SFSBuddy
 
toString() - Method in class com.smartfoxserver.buddylist.SFSBuddyList
 
toString() - Method in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
toString() - Method in class com.smartfoxserver.buddylist.SFSBuddyVariable
 
toString() - Method in class com.smartfoxserver.core.SFSEvent
 
toString() - Method in class com.smartfoxserver.entities.data.SFSArray
 
toString() - Method in class com.smartfoxserver.entities.data.SFSObject
 
toString() - Method in class com.smartfoxserver.entities.data.SFSVector2
 
toString() - Method in class com.smartfoxserver.entities.data.SFSVector3
 
toString() - Method in class com.smartfoxserver.entities.invitation.SFSInvitation
 
toString() - Method in class com.smartfoxserver.entities.match.MatchExpression
 
toString() - Method in class com.smartfoxserver.entities.RoomSize
 
toString() - Method in class com.smartfoxserver.entities.SFSBannedUser
 
toString() - Method in class com.smartfoxserver.entities.SFSEmail
 
toString() - Method in class com.smartfoxserver.entities.SFSRoom
 
toString() - Method in class com.smartfoxserver.entities.SFSUser
 
toString() - Method in class com.smartfoxserver.entities.SFSZone
 
toString() - Method in class com.smartfoxserver.entities.variables.SFSRoomVariable
 
toString() - Method in class com.smartfoxserver.entities.variables.SFSUserVariable
 
toString() - Method in class com.smartfoxserver.exceptions.ExceptionMessageComposer
 
toString() - Method in class com.smartfoxserver.extensions.BaseSFSExtension
toString() - Method in class com.smartfoxserver.game.CreateSFSGameSettings
 
toString() - Method in class com.smartfoxserver.game.SFSGame
 
toString() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings.MapLimits
 
toString() - Method in class com.smartfoxserver.mmo.CreateMMORoomSettings
 
toString() - Method in class com.smartfoxserver.mmo.MMOItem
 
toString() - Method in class com.smartfoxserver.mmo.MMORoom
 
toString() - Method in class com.smartfoxserver.mmo.Vec3D
 
trace(ExtensionLogLevel, Object...) - Method in class com.smartfoxserver.controllers.filter.SysControllerFilter
Trace a message to the console and log files using the specified logging level
trace(ExtensionLogLevel, Object...) - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Trace a message to the console and log files using the specified logging level
trace(ExtensionLogLevel, Object...) - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Trace a message to the console and log files using the specified logging level
trace(ExtensionLogLevel, Object...) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Trace a message to the console and log files using the specified logging level
trace(ExtensionLogLevel, Object...) - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilter
Trace a message to the console and log files using the specified logging level
trace(Object...) - Method in class com.smartfoxserver.controllers.filter.SysControllerFilter
Traces a message to the console and log files using the Logger INFO level
trace(Object...) - Method in class com.smartfoxserver.extensions.BaseClientRequestHandler
Traces a message to the console and log files using the Logger INFO level
trace(Object...) - Method in class com.smartfoxserver.extensions.BaseServerEventHandler
Traces a message to the console and log files using the Logger INFO level
trace(Object...) - Method in class com.smartfoxserver.extensions.BaseSFSExtension
Traces a message to the console and log files using the Logger INFO level
trace(Object...) - Method in class com.smartfoxserver.extensions.filter.SFSExtensionFilter
Allows to trace messages to the console and log files using the Logger INFO level
TransportType - Enum Class in com.smartfoxserver.bitswarm.data
 
Tutorial - Search tag in class com.smartfoxserver.api.SFSMMOApi
Section
Tutorial - Search tag in class com.smartfoxserver.mmo.MMOItem
Section
Tutorial - Search tag in class com.smartfoxserver.mmo.MMORoom
Section

U

UDP - Enum constant in enum class com.smartfoxserver.bitswarm.data.TransportType
 
UDP_RAW - Enum constant in enum class com.smartfoxserver.bitswarm.data.TransportType
Standard UDP transport
UDP_RELIABLE - Enum constant in enum class com.smartfoxserver.bitswarm.data.TransportType
Reliable UDP (ordered packets with retransmissions)
UDP_UNRELIABLE - Enum constant in enum class com.smartfoxserver.bitswarm.data.TransportType
Unreliable UDP (ordered packets, no retransmissions)
UdpInit - Class in com.smartfoxserver.controllers.system
 
UdpInit - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
UdpInit() - Constructor for class com.smartfoxserver.controllers.system.UdpInit
 
unbanUser(User) - Method in interface com.smartfoxserver.entities.Room
 
unbanUser(User) - Method in class com.smartfoxserver.entities.SFSRoom
unfreeze() - Method in interface com.smartfoxserver.bitswarm.sessions.ISession
 
unfreeze() - Method in class com.smartfoxserver.bitswarm.sessions.Session
 
UNKNOWN - Enum constant in enum class com.smartfoxserver.util.ClientDisconnectionReason
It wasn't possible to detect the cause of disconnection.
UNSUBSCRIBE_GROUP_NOT_FOUND - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
UNSUBSCRIBE_GROUP_NOT_SUBSCRIBED - Enum constant in enum class com.smartfoxserver.exceptions.SFSErrorCode
 
unsubscribeGroup(String) - Method in class com.smartfoxserver.entities.SFSUser
 
unsubscribeGroup(String) - Method in interface com.smartfoxserver.entities.User
 
unsubscribeRoomGroup(User, String) - Method in interface com.smartfoxserver.api.ISFSApi
Unsubscribe User to a Room Group.
unsubscribeRoomGroup(User, String) - Method in class com.smartfoxserver.api.SFSApi
Unsubscribe User to a Room Group.
UnsubscribeRoomGroup - Class in com.smartfoxserver.controllers.system
 
UnsubscribeRoomGroup - Enum constant in enum class com.smartfoxserver.controllers.SystemRequest
 
UnsubscribeRoomGroup() - Constructor for class com.smartfoxserver.controllers.system.UnsubscribeRoomGroup
 
updated - Variable in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
updateItem(BaseMMOItem, Vec3D) - Method in class com.smartfoxserver.mmo.MMORoom
 
updateLastRequestTime() - Method in class com.smartfoxserver.entities.SFSUser
 
updateLastRequestTime() - Method in interface com.smartfoxserver.entities.User
 
updateUser(User) - Method in class com.smartfoxserver.mmo.MMORoom
 
UPLOAD_FILE_LIST - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
List of uploaded files as List<UploadedFile> ( List )
UPLOAD_HTTP_PARAMS - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
Custom HTTP parameters passed in the upload HTTP POST call.
useBadWordsFilter - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
useCaseSensitiveNameCheck - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration.PasswordRecovery
Validates the user name using a case-sensitive string comparison
useCaseSensitiveNameChecks - Variable in class com.smartfoxserver.components.login.LoginConfiguration
By default user name checks are not case-sensitive.
useExtendedMessages - Static variable in class com.smartfoxserver.exceptions.ExceptionMessageComposer
 
User - Interface in com.smartfoxserver.entities
 
USER - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The User that generated the event ( User )
USER_BANNED - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a User has been banned in the current Zone
USER_COUNT - Static variable in class com.smartfoxserver.entities.match.RoomProperties
The Room user count
USER_COUNT_CHANGE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomEvents
This event is notified every time when the Room user/spectator count changes
USER_COUNT_CHANGE_EVENT - Enum constant in enum class com.smartfoxserver.entities.SFSRoomSettings
Toggles the notifications changes in the count of Users and Spectators in a Room
USER_DISCONNECT - Enum constant in enum class com.smartfoxserver.core.SFSEventType
The event is triggered after a User disconnects or is disconnected.
USER_ENTER_EVENT - Enum constant in enum class com.smartfoxserver.entities.SFSRoomSettings
Toggles the notifications for Users entering the Room
USER_EXIT_EVENT - Enum constant in enum class com.smartfoxserver.entities.SFSRoomSettings
Toggles the notifications for Users leaving the Room
USER_JOIN_ROOM - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a User has joined a Room.
USER_JOIN_ZONE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a successful User login, as soon as the User is added to the requested Zone.
USER_KICKED - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a User has been kicked in the current Zone
USER_LEAVE_ROOM - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a User has left a Room.
USER_LOGIN - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a User sends a login request.
USER_LOGOUT - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered after a User logout.
USER_RECONNECTION_SUCCESS - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when the HRC (Highly Resilient Connection) system is turned on and a User has successfully reconnected.
USER_RECONNECTION_TRY - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered by HRC (Highly Resilient Connection) system, if active, when a User is trying to reconnect.
USER_VARIABLES_UPDATE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
Triggered when a one or more User Variables are set.
USER_VARIABLES_UPDATE_EVENT - Enum constant in enum class com.smartfoxserver.entities.SFSRoomSettings
Toggles the notifications for UserVariables changes the Room
userExitEventHandler - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
userIsActiveField - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
(Optional) If the activationCodeField is used this property will indicate which field to use to keep track of the User's account activation.
userName - Variable in class com.smartfoxserver.components.login.LoginData
The user name extracted from the database
userName - Variable in class com.smartfoxserver.db.DBConfig
The user name for accessing the database
userName - Variable in class com.smartfoxserver.entities.LoginData
 
USERNAME_ALREADY_IN_USE - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
USERNAME_TOO_LONG - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
USERNAME_TOO_SHORT - Enum constant in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
 
usernameField - Variable in class com.smartfoxserver.components.signup.SignUpConfiguration
The name of the field used to store the user name.
userNameField - Variable in class com.smartfoxserver.components.login.LoginConfiguration
The name of the field in the Database containing the user name, default is 'username'
UserProperties - Class in com.smartfoxserver.entities.match
A list of properties that can be used in MatchExpressions for User objects
UserProperties() - Constructor for class com.smartfoxserver.entities.match.UserProperties
 
usersSeeEachOthers(User, User) - Static method in class com.smartfoxserver.util.UsersUtil
 
UsersUtil - Class in com.smartfoxserver.util
 
UsersUtil() - Constructor for class com.smartfoxserver.util.UsersUtil
 
UserVariable - Interface in com.smartfoxserver.entities.variables
 
User Variables and Room Variables - Search tag in class com.smartfoxserver.mmo.MMORoom
Section
useTempBuddies - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
useTextSerialization - Variable in class com.smartfoxserver.persistence.room.DBRoomStorageConfig
Instead of using a binary serialization the Room data will be converted to JSON and stored as TEXT in the database.

V

validate(IRequest) - Method in class com.smartfoxserver.controllers.system.BanUser
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.BanUsersFromRoom
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.AddBuddy
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.BlockBuddy
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.GoOnline
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.InitBuddyList
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.RemoveBuddy
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.buddylist.SetBuddyVariables
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.ChangeRoomCapacity
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.ChangeRoomName
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.ChangeRoomPassword
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.CreateRoom
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.FindRooms
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.FindUsers
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.game.CreateSFSGame
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.game.InvitationReply
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.game.InviteUser
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.game.JoinRoomInvite
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.game.QuickJoinGame
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.GenericMessage
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.Handshake
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.JoinRoom
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.KickUser
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.LeaveRoom
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.Login
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.Logout
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.ManualDisconnection
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.PingPong
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.PlayerToSpectator
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.QuickJoinOrCreateRoom
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.SetRoomVariables
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.SetUserPosition
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.SetUserVariables
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.SpectatorToPlayer
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.SubscribeRoomGroup
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.UdpInit
 
validate(IRequest) - Method in class com.smartfoxserver.controllers.system.UnsubscribeRoomGroup
 
validate(IDBManager, ISFSObject) - Method in interface com.smartfoxserver.components.signup.ISignUpValidator
 
validateEncryptionStatus(ISession, IRequest, Zone) - Method in class com.smartfoxserver.controllers.system.Login
 
validateLoginErrors(ISession, Zone) - Method in class com.smartfoxserver.controllers.system.Login
 
validateUserName(String) - Method in class com.smartfoxserver.entities.SFSZone
validateUserName(String) - Method in interface com.smartfoxserver.entities.Zone
 
value() - Element in annotation interface com.smartfoxserver.annotations.Instantiation
 
valueOf(String) - Static method in enum class com.smartfoxserver.annotations.Instantiation.InstantiationMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.bitswarm.data.MessagePriority
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.bitswarm.data.TransportType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.bitswarm.sessions.SessionType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.buddylist.BuddyOnlineState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.buddylist.SFSBuddyEventParam
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.components.signup.PasswordMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.components.signup.RecoveryMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.controllers.SystemRequest
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.core.SFSEventParam
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.core.SFSEventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.data.SFSDataType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.invitation.InvitationResponse
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.managers.BanMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.match.BoolMatch
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.match.NumberMatch
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.match.StringMatch
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.SFSRoomEvents
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.SFSRoomRemoveMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.SFSRoomSettings
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.entities.variables.VariableType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.exceptions.SFSErrorCode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.extensions.ExtensionLogLevel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.extensions.ExtensionReloadMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.extensions.filter.FilterAction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.persistence.room.RoomStorageMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.security.DefaultPermissionProfile
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.security.SystemPermission
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.smartfoxserver.util.ClientDisconnectionReason
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.smartfoxserver.annotations.Instantiation.InstantiationMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.bitswarm.data.MessagePriority
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.bitswarm.data.TransportType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.bitswarm.sessions.SessionType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.buddylist.BuddyOnlineState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.buddylist.SFSBuddyEventParam
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.components.signup.PasswordMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.components.signup.RecoveryMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.components.signup.SignUpErrorCodes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.controllers.SystemRequest
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.core.SFSEventParam
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.core.SFSEventType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.data.SFSDataType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.invitation.InvitationResponse
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.managers.BanMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.match.BoolMatch
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.match.NumberMatch
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.match.StringMatch
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.SFSRoomEvents
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.SFSRoomRemoveMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.SFSRoomSettings
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.entities.variables.VariableType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.exceptions.SFSErrorCode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.extensions.ExtensionLogLevel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.extensions.ExtensionReloadMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.extensions.filter.FilterAction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.persistence.room.RoomStorageMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.security.DefaultPermissionProfile
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.security.SystemPermission
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.smartfoxserver.util.ClientDisconnectionReason
Returns an array containing the constants of this enum class, in the order they are declared.
Variable - Interface in com.smartfoxserver.entities.variables
Top level interface common to all 'variable' types in SmartfoxServer, such as RoomVariable, UserVariable, BuddyVariable, MMOItemVariable
variables - Variable in class com.smartfoxserver.buddylist.SFSBuddyProperties
 
Variables - Search tag in class com.smartfoxserver.buddylist.SFSBuddy
Section
VARIABLES - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
A list of server variables ( List )
VARIABLES_MAP - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
A list of server variables in map ( key/value ) form ( Map )
VariableType - Enum Class in com.smartfoxserver.entities.variables
 
Vec3D - Class in com.smartfoxserver.mmo
A vector 3D class used for defining coordinates in the MMORoom virtual world.
Vec3D(float, float) - Constructor for class com.smartfoxserver.mmo.Vec3D
Constructor for float-based 2D coordinates
Vec3D(float, float, float) - Constructor for class com.smartfoxserver.mmo.Vec3D
Constructor for float-based 3D coordinates
Vec3D(int, int) - Constructor for class com.smartfoxserver.mmo.Vec3D
Constructor for integer-based 2D coordinates
Vec3D(int, int, int) - Constructor for class com.smartfoxserver.mmo.Vec3D
Constructor for integer-based 3D coordinates
VECTOR2 - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
VECTOR2 - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
VECTOR2_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
VECTOR3 - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
VECTOR3 - Enum constant in enum class com.smartfoxserver.entities.variables.VariableType
 
VECTOR3_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
 
VERY_HIGH - Enum constant in enum class com.smartfoxserver.bitswarm.data.MessagePriority
 
VERY_LOW - Enum constant in enum class com.smartfoxserver.bitswarm.data.MessagePriority
 
VOID - Enum constant in enum class com.smartfoxserver.bitswarm.sessions.SessionType
A virtual/no-network session.

W

WARN - Enum constant in enum class com.smartfoxserver.extensions.ExtensionLogLevel
 
WEBSOCKET - Enum constant in enum class com.smartfoxserver.bitswarm.sessions.SessionType
Websocket session
WebSocketHandshakeException - Exception Class in com.smartfoxserver.exceptions
 
WebSocketHandshakeException() - Constructor for exception class com.smartfoxserver.exceptions.WebSocketHandshakeException
 
WebSocketHandshakeException(String) - Constructor for exception class com.smartfoxserver.exceptions.WebSocketHandshakeException
 
WHEN_EMPTY - Enum constant in enum class com.smartfoxserver.entities.SFSRoomRemoveMode
The Room is auto-removed when the last user leaves it
WHEN_EMPTY_AND_CREATOR_IS_GONE - Enum constant in enum class com.smartfoxserver.entities.SFSRoomRemoveMode
The Room is auto-removed when the Room is empty and its creator is not connected anymore
WS_CHANNEL - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 
WS_REMOTE_IP - Static variable in class com.smartfoxserver.bitswarm.sessions.Session
 

X

x - Variable in class com.smartfoxserver.entities.data.SFSVector2
 
x - Variable in class com.smartfoxserver.entities.data.SFSVector3
 

Y

y - Variable in class com.smartfoxserver.entities.data.SFSVector2
 
y - Variable in class com.smartfoxserver.entities.data.SFSVector3
 

Z

z - Variable in class com.smartfoxserver.entities.data.SFSVector3
 
zone - Variable in class com.smartfoxserver.buddylist.SFSBuddyListManager
 
Zone - Interface in com.smartfoxserver.entities
 
ZONE - Enum constant in enum class com.smartfoxserver.core.SFSEventParam
The Zone in which the event was fired ( Zone )
zoneName - Variable in class com.smartfoxserver.entities.SFSBannedUser
 

_

__CLUSTER_READY - Enum constant in enum class com.smartfoxserver.core.SFSEventType
 
__TRACE_MESSAGE - Enum constant in enum class com.smartfoxserver.core.SFSEventType
 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _ 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form