Index
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 sfs3.client.entities.invitation.InvitationReply
- 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 sfs3.client.entities.managers.IBuddyManager
- addBuddy(Buddy) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- AddBuddy - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- AddBuddyRequest - Class in sfs3.client.requests.buddylist
-
Adds a new buddy to the current user's buddies list.
- AddBuddyRequest(String) - Constructor for class sfs3.client.requests.buddylist.AddBuddyRequest
-
Creates a new AddBuddyRequest instance.
- 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
- 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
- AddedItems - Static variable in class sfs3.client.core.EventParam
- AddedUsers - Static variable in class sfs3.client.core.EventParam
- addEventListener(String, IEventListener) - Method in interface sfs3.client.ISmartFox
- addEventListener(String, IEventListener) - Method in class sfs3.client.SmartFox
-
Adds an event listener to handle a specific event
- 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
- addGroup(String) - Method in interface sfs3.client.entities.managers.IRoomManager
- addGroup(String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- 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
- 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
- addMMOItem(IMMOItem) - Method in class sfs3.client.entities.MMORoom
-
API internal usage only
- 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
- addRoom(Room) - Method in interface sfs3.client.entities.managers.IRoomManager
- addRoom(Room) - Method in class sfs3.client.entities.managers.SFSRoomManager
- addRoom(Room, boolean) - Method in interface sfs3.client.entities.managers.IRoomManager
- addRoom(Room, boolean) - Method in class sfs3.client.entities.managers.SFSRoomManager
- 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
- 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
- addUser(User) - Method in interface sfs3.client.entities.managers.IUserManager
- addUser(User) - Method in class sfs3.client.entities.managers.SFSUserManager
- addUser(User) - Method in interface sfs3.client.entities.Room
- addUser(User) - Method in class sfs3.client.entities.SFSRoom
- addUserInternal(User) - Method in class sfs3.client.entities.managers.SFSUserManager
- 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
- ADMIN_MESSAGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the current user receives a message from an administrator user.
- ADMINISTRATOR - Static variable in class sfs3.client.entities.UserPrivileges
-
The administrator user can send dedicated "administrator messages", kick and ban users.
- AdminMessage - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- AdminMessageRequest - Class in sfs3.client.requests
-
Sends an administrator message to a specific user or a group of users.
- AdminMessageRequest(String, MessageRecipientMode) - Constructor for class sfs3.client.requests.AdminMessageRequest
- AdminMessageRequest(String, MessageRecipientMode, ISFSObject) - Constructor for class sfs3.client.requests.AdminMessageRequest
-
Creates a new AdminMessageRequest instance.
- allowOwnerOnlyInvitation() - Method in class sfs3.client.requests.RoomSettings
-
Specifies if the Room allows "Join Room" Invitations sent by any User or just by its owner
- allowUnsafeSSL - Variable in class sfs3.client.ConfigData
-
Allows to test locally with the default, self-signed SSL/TLS certificate, skipping the validation of the certificate.
- and(String, IMatcher, Object) - Method in class sfs3.client.entities.match.MatchExpression
-
Concatenates the current expression with a new one using the logical AND operator.
- AND - Enum constant in enum class sfs3.client.entities.match.LogicOperator
-
An instance of LogicOperator representing the AND logical operator.
- angle() - Method in class com.smartfoxserver.entities.data.SFSVector2
-
Returns the angle of this vector in radians, measured from the positive x-axis.
- aoiEntryPoint - Variable in class sfs3.client.entities.SFSUser
- ApiEvent - Class in sfs3.client.core
-
This is the base class of all the events dispatched by the SmartFoxServer 3 Java Client API.
- ApiEvent(String) - Constructor for class sfs3.client.core.ApiEvent
- ApiEvent(String, Map<String, Object>) - Constructor for class sfs3.client.core.ApiEvent
- ARRAY - Enum constant in enum class sfs3.client.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.
- asString() - Method in class sfs3.client.entities.match.MatchExpression
- AutoJoin - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
B
- BanMode - Class in sfs3.client.requests
-
The BanMode class contains the constants describing the possible banning modalities for a BanUserRequest.
- BanMode() - Constructor for class sfs3.client.requests.BanMode
- BANNED - Static variable in class sfs3.client.util.ClientDisconnectionReason
-
Client was banned from the server.
- BanUser - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- BanUserRequest - Class in sfs3.client.requests
-
Banishes a user from the server.
- BanUserRequest(int) - Constructor for class sfs3.client.requests.BanUserRequest
- BanUserRequest(int, String) - Constructor for class sfs3.client.requests.BanUserRequest
- BanUserRequest(int, String, int) - Constructor for class sfs3.client.requests.BanUserRequest
- BanUserRequest(int, String, int, int) - Constructor for class sfs3.client.requests.BanUserRequest
- BanUserRequest(int, String, int, int, int) - Constructor for class sfs3.client.requests.BanUserRequest
-
Creates a new BanUserRequest instance.
- BanUsersFromRoom - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- BaseRequest - Class in sfs3.client.requests
- BaseRequest(int) - Constructor for class sfs3.client.requests.BaseRequest
- BaseVariable - Class in sfs3.client.entities.variables
- BaseVariable(String, Object) - Constructor for class sfs3.client.entities.variables.BaseVariable
- BaseVariable(String, Object, VariableType) - Constructor for class sfs3.client.entities.variables.BaseVariable
- bitSwarm - Variable in class sfs3.client.SmartFox
- BlockBuddy - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- BlockBuddyRequest - Class in sfs3.client.requests.buddylist
-
Blocks or unblocks a buddy in the current user's buddies list.
- BlockBuddyRequest(String, boolean) - Constructor for class sfs3.client.requests.buddylist.BlockBuddyRequest
-
Creates a new BlockBuddyRequest instance.
- blueBox - Variable in class sfs3.client.ConfigData
-
Settings to configure the HTTP tunnel, used when a TCP connection cannot be established
- BlueBoxCfg() - Constructor for class sfs3.client.ConfigData.BlueBoxCfg
- BOOL - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- BOOL - Enum constant in enum class sfs3.client.entities.variables.VariableType
- BOOL_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- BoolMatch - Enum Class in sfs3.client.entities.match
-
The BoolMatch class is used in matching expressions to check boolean conditions.
- buddiesByName - Variable in class sfs3.client.entities.managers.SFSBuddyManager
- Buddy - Interface in sfs3.client.entities
-
In the SmartFoxServer 3 client API this interface is implemented by the SFSBuddy class.
- Buddy - Static variable in class sfs3.client.core.EventParam
- BUDDY_ADD - Static variable in class sfs3.client.core.SFSBuddyEvent
-
Dispatched when a buddy is added successfully to the user's buddies list.
- BUDDY_BLOCK - Static variable in class sfs3.client.core.SFSBuddyEvent
-
Dispatched when a buddy is blocked or unblocked by the current user.
- BUDDY_ERROR - Static variable in class sfs3.client.core.SFSBuddyEvent
-
Dispatched if an error occurs while executing a request related to the Buddy List system.
- BUDDY_LIST_INIT - Static variable in class sfs3.client.core.SFSBuddyEvent
-
Dispatched if the Buddy List system is successfully initialized.
- BUDDY_MESSAGE - Static variable in class sfs3.client.core.SFSBuddyEvent
-
Dispatched when a message from a buddy is received by the current user.
- BUDDY_ONLINE_STATE_CHANGE - Static variable in class sfs3.client.core.SFSBuddyEvent
-
Dispatched when a buddy in the current user's buddy list changes its online state.
- BUDDY_REMOVE - Static variable in class sfs3.client.core.SFSBuddyEvent
-
Dispatched when a buddy is removed successfully from theuser's buddies list.
- BUDDY_VARIABLES_UPDATE - Static variable in class sfs3.client.core.SFSBuddyEvent
-
Dispatched when a buddy (in the current buddy list) updates one or more Buddy Variables.
- BuddyList - Static variable in class sfs3.client.core.EventParam
- BuddyMessageRequest - Class in sfs3.client.requests.buddylist
-
Sends a message to a buddy in the current user's buddies list.
- BuddyMessageRequest(String, Buddy) - Constructor for class sfs3.client.requests.buddylist.BuddyMessageRequest
- BuddyMessageRequest(String, Buddy, ISFSObject) - Constructor for class sfs3.client.requests.buddylist.BuddyMessageRequest
-
Creates a new BuddyMessageRequest instance.
- BuddyVariable - Interface in sfs3.client.entities.variables
-
The BuddyVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Buddy Variable exposes.
- BV_NICKNAME - Static variable in class sfs3.client.entities.variables.ReservedBuddyVariables
-
The Buddy Variable with this name stores the optional nickname of the user in a buddy list.
- BV_ONLINE - Static variable in class sfs3.client.entities.variables.ReservedBuddyVariables
-
The Buddy Variable with this name keeps track of the online/offline state of the user in a buddy list.
- BV_STATE - Static variable in class sfs3.client.entities.variables.ReservedBuddyVariables
-
The Buddy Variable with this name stores the custom state of the user in a buddy list.
- BY_ADDRESS - Static variable in class sfs3.client.requests.BanMode
-
User is banned by IP address.
- BY_NAME - Static variable in class sfs3.client.requests.BanMode
-
User is banned by name.
- BYTE - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- BYTE - Enum constant in enum class sfs3.client.entities.variables.VariableType
- BYTE_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
C
- CallExtension - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- 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.
- ChangedVars - Static variable in class sfs3.client.core.EventParam
- changeRoomCapacity(Room, int, int) - Method in interface sfs3.client.entities.managers.IRoomManager
- changeRoomCapacity(Room, int, int) - Method in class sfs3.client.entities.managers.SFSRoomManager
- ChangeRoomCapacity - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- ChangeRoomCapacityRequest - Class in sfs3.client.requests
-
Changes the maximum number of users and/or spectators who can join a Room.
- ChangeRoomCapacityRequest(Room, int, int) - Constructor for class sfs3.client.requests.ChangeRoomCapacityRequest
-
Creates a new ChangeRoomCapacityRequest instance.
- changeRoomName(Room, String) - Method in interface sfs3.client.entities.managers.IRoomManager
- changeRoomName(Room, String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- ChangeRoomName - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- ChangeRoomNameRequest - Class in sfs3.client.requests
-
Changes the name of a Room.
- ChangeRoomNameRequest(Room, String) - Constructor for class sfs3.client.requests.ChangeRoomNameRequest
-
Creates a new ChangeRoomNameRequest instance.
- ChangeRoomPassword - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- changeRoomPasswordState(Room, boolean) - Method in interface sfs3.client.entities.managers.IRoomManager
- changeRoomPasswordState(Room, boolean) - Method in class sfs3.client.entities.managers.SFSRoomManager
- ChangeRoomPasswordStateRequest - Class in sfs3.client.requests
-
Changes the password of a Room.
- ChangeRoomPasswordStateRequest(Room, String) - Constructor for class sfs3.client.requests.ChangeRoomPasswordStateRequest
-
Creates a new ChangeRoomPasswordStateRequest instance.
- clearAll() - Method in interface sfs3.client.entities.managers.IBuddyManager
- clearAll() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- clearVolatileVariables() - Method in interface sfs3.client.entities.Buddy
- clearVolatileVariables() - Method in class sfs3.client.entities.SFSBuddy
- ClientDisconnectionReason - Class in sfs3.client.util
-
The ClientDisconnectionReason class contains the constants describing the possible reasons why a disconnection from the server occurred.
- ClientDisconnectionReason() - Constructor for class sfs3.client.util.ClientDisconnectionReason
- clone() - Method in class sfs3.client.core.ApiEvent
- ClusterConfigData - Static variable in class sfs3.client.core.EventParam
- ClusterInviteUsers - Static variable in class sfs3.client.requests.BaseRequest
- ClusterJoinOrCreate - Static variable in class sfs3.client.requests.BaseRequest
- ClusterPassword - Static variable in class sfs3.client.core.EventParam
- ClusterUserName - Static variable in class sfs3.client.core.EventParam
- Cmd - Static variable in class sfs3.client.core.EventParam
- ConfigData - Class in sfs3.client
-
ConfigData contains all the settings for the connection.
- ConfigData() - Constructor for class sfs3.client.ConfigData
- ConfigData.BlueBoxCfg - Class in sfs3.client
- connect(ConfigData) - Method in interface sfs3.client.ISmartFox
- connect(ConfigData) - Method in class sfs3.client.SmartFox
-
Attempts to connect to the server.
- CONNECTION - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a connection between the client and a SmartFoxServer 3 instance is attempted.
- CONNECTION_LOST - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the connection between the client and the SmartFoxServer 3 instance is interrupted.
- CONNECTION_RESUME - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the connection between the client and the SmartFoxServer 3 instance is re-established after a temporary disconnection, while the SmartFoxServer 3 HRC system is available in the Zone.
- CONNECTION_RETRY - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the connection between the client and the SmartFoxServer 3 instance is interrupted abruptly while the SmartFoxServer 3 HRC system is available in the Zone.
- connectUdp() - Method in interface sfs3.client.ISmartFox
- connectUdp() - Method in class sfs3.client.SmartFox
-
Initializes the UDP protocol by performing an handshake with the server.
- 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 sfs3.client.entities.match.StringMatch
-
An instance of StringMatch representing the following condition: string1.indexOf(string2) !
- containsBuddy(String) - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Indicates whether a buddy exists in user's buddies list or not.
- containsBuddy(String) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- containsGroup(String) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Indicates whether the specified Group has been subscribed by the client or not.
- containsGroup(String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- 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
- containsRoom(int) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Indicates whether a Room exists in the Rooms list or not.
- containsRoom(int) - Method in class sfs3.client.entities.managers.SFSRoomManager
- containsRoom(String) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Indicates whether a Room exists in the Rooms list or not.
- containsRoom(String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- containsRoomInGroup(int, String) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Indicates whether the Rooms list contains a Room belonging to the specified Group or not.
- containsRoomInGroup(int, String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- containsRoomInGroup(String, String) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Indicates whether the Rooms list contains a Room belonging to the specified Group or not.
- containsRoomInGroup(String, String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- containsUser(User) - Method in interface sfs3.client.entities.managers.IUserManager
-
Indicates whether a user exists in the local users list or not.
- containsUser(User) - Method in class sfs3.client.entities.managers.SFSUserManager
- containsUser(User) - Method in interface sfs3.client.entities.Room
-
Indicates whether the specified user is currently inside this Room or not.
- containsUser(User) - Method in class sfs3.client.entities.SFSRoom
- containsUserId(int) - Method in interface sfs3.client.entities.managers.IUserManager
-
Indicates whether a user exists in the local users list or not from the id.
- containsUserId(int) - Method in class sfs3.client.entities.managers.SFSUserManager
- containsUserName(String) - Method in interface sfs3.client.entities.managers.IUserManager
-
Indicates whether a user exists in the local users list or not from the name.
- containsUserName(String) - Method in class sfs3.client.entities.managers.SFSUserManager
- containsVariable(String) - Method in interface sfs3.client.entities.Buddy
-
Indicates whether this buddy has the specified Buddy Variable set or not.
- containsVariable(String) - Method in interface sfs3.client.entities.IMMOItem
-
Indicates whether this MMOItem has the specified Item Variable set or not.
- containsVariable(String) - Method in class sfs3.client.entities.MMOItem
-
Indicates whether this MMOItem has the specified Item Variable set or not.
- containsVariable(String) - Method in interface sfs3.client.entities.Room
-
Indicates whether this Room has the specified Room Variable set or not.
- containsVariable(String) - Method in class sfs3.client.entities.SFSBuddy
- containsVariable(String) - Method in class sfs3.client.entities.SFSRoom
- containsVariable(String) - Method in class sfs3.client.entities.SFSUser
- containsVariable(String) - Method in interface sfs3.client.entities.User
-
Indicates whether this user has the specified User Variable set or not.
- CreateRoom - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- CreateRoomRequest - Class in sfs3.client.requests
-
Creates a new Room in the current Zone.
- CreateRoomRequest(RoomSettings) - Constructor for class sfs3.client.requests.CreateRoomRequest
- CreateRoomRequest(RoomSettings, boolean) - Constructor for class sfs3.client.requests.CreateRoomRequest
- CreateRoomRequest(RoomSettings, boolean, Room) - Constructor for class sfs3.client.requests.CreateRoomRequest
-
Creates a new CreateRoomRequest instance.
- CreateSFSGame - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- CreateSFSGameRequest - Class in sfs3.client.requests.game
-
Creates a new public or private game, including player matching criteria, invitations settings and more.
- CreateSFSGameRequest(SFSGameSettings) - Constructor for class sfs3.client.requests.game.CreateSFSGameRequest
-
Creates a new CreateSFSGameRequest instance.
- 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.
D
- Data - Static variable in class sfs3.client.core.EventParam
- debug - Variable in class sfs3.client.ConfigData.BlueBoxCfg
-
Logs debug information in the logs
- DEFAULT_GROUP_ID - Static variable in class sfs3.client.entities.SFSRoom
- disconnect() - Method in interface sfs3.client.ISmartFox
- disconnect() - Method in class sfs3.client.SmartFox
-
Manually disconnect from the server.
- DisconnectionReason - Static variable in class sfs3.client.core.EventParam
- disconnectUdp() - Method in interface sfs3.client.ISmartFox
- disconnectUdp() - Method in class sfs3.client.SmartFox
-
Closes the current UDP Connection.
- dispatch(ApiEvent) - Method in interface sfs3.client.core.IEventListener
-
The method is invoked when the Event is dispatched.
- dispatcher - Variable in class sfs3.client.SmartFox
- dispatchEvent(ApiEvent) - Method in interface sfs3.client.ISmartFox
- dispatchEvent(ApiEvent) - Method in class sfs3.client.SmartFox
- 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.
- 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.
- DOUBLE - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- DOUBLE - Enum constant in enum class sfs3.client.entities.variables.VariableType
- DOUBLE_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
E
- empty() - Static method in class com.smartfoxserver.entities.data.SFSVector2
- empty() - Static method in class com.smartfoxserver.entities.data.SFSVector3
- enableLagMonitor(boolean) - Method in class sfs3.client.SmartFox
- enableLagMonitor(boolean, int) - Method in class sfs3.client.SmartFox
- enableLagMonitor(boolean, int, int) - Method in class sfs3.client.SmartFox
-
Enables the automatic monitoring of latency between client and the server in a round-robin fashion.
- ENDS_WITH - Enum constant in enum class sfs3.client.entities.match.StringMatch
-
An instance of StringMatch representing the following condition: string1 ends with characters contained in string2.
- 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 sfs3.client.entities.MMOItem
- equals(Object) - Method in class sfs3.client.entities.SFSBuddy
- equals(Object) - Method in class sfs3.client.entities.SFSRoom
- equals(Object) - Method in class sfs3.client.entities.SFSUser
- EQUALS - Enum constant in enum class sfs3.client.entities.match.BoolMatch
-
An instance of BoolMatch representing the following condition: bool1 == bool2.
- EQUALS - Enum constant in enum class sfs3.client.entities.match.NumberMatch
-
An instance of NumberMatch representing the following condition: number1 == number2.
- EQUALS - Enum constant in enum class sfs3.client.entities.match.StringMatch
-
An instance of StringMatch representing the following condition: string1 == string2.
- ErrorCode - Static variable in class sfs3.client.core.EventParam
- ErrorMessage - Static variable in class sfs3.client.core.EventParam
- EventParam - Class in sfs3.client.core
-
Contains the list of public parameters passed in events by the API.
- EventParam() - Constructor for class sfs3.client.core.EventParam
- eventThreadPool - Variable in class sfs3.client.SmartFox
- execute(ISmartFox) - Method in class sfs3.client.requests.BanUserRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.buddylist.AddBuddyRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.buddylist.BlockBuddyRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.buddylist.GoOnlineRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.buddylist.InitBuddyListRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.buddylist.RemoveBuddyRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.buddylist.SetBuddyVariablesRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.ChangeRoomCapacityRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.ChangeRoomNameRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.ChangeRoomPasswordStateRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.CreateRoomRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.ExtensionRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.FindRoomsRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.FindUsersRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.game.CreateSFSGameRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.game.QuickJoinGameRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.invitation.InvitationReplyRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.invitation.InviteUsersRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.invitation.JoinRoomInvitationRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.JoinRoomRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.KickUserRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.LeaveRoomRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.LoginRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.LogoutRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.mmo.SetUserPositionRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.PlayerToSpectatorRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.SetRoomVariablesRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.SetUserVariablesRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.SpectatorToPlayerRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.SubscribeRoomGroupRequest
- execute(ISmartFox) - Method in class sfs3.client.requests.UnsubscribeRoomGroupRequest
- EXPIRED - Enum constant in enum class sfs3.client.entities.invitation.InvitationReply
- EXTENSION_RESPONSE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when data coming from a server-side Extension is received by the current user.
- ExtensionRequest - Class in sfs3.client.requests
-
Sends a command to the server-side Extension attached to the Zone or to a Room.
- ExtensionRequest(String) - Constructor for class sfs3.client.requests.ExtensionRequest
- ExtensionRequest(String, ISFSObject) - Constructor for class sfs3.client.requests.ExtensionRequest
- ExtensionRequest(String, ISFSObject, Room) - Constructor for class sfs3.client.requests.ExtensionRequest
- ExtensionRequest(String, ISFSObject, Room, TransportType) - Constructor for class sfs3.client.requests.ExtensionRequest
-
Creates a new ExtensionRequest instance.
- ExtParams - Static variable in class sfs3.client.core.EventParam
F
- FindRooms - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- FindRoomsRequest - Class in sfs3.client.requests
-
Retrieves a list of Rooms from the server which match the specified criteria.
- FindRoomsRequest(MatchExpression) - Constructor for class sfs3.client.requests.FindRoomsRequest
- FindRoomsRequest(MatchExpression, String) - Constructor for class sfs3.client.requests.FindRoomsRequest
- FindRoomsRequest(MatchExpression, String, short) - Constructor for class sfs3.client.requests.FindRoomsRequest
-
Creates a new FindRoomsRequest instance.
- FindUsers - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- FindUsersRequest - Class in sfs3.client.requests
-
Retrieves a list of users from the server which match the specified criteria.
- FindUsersRequest(MatchExpression) - Constructor for class sfs3.client.requests.FindUsersRequest
- FindUsersRequest(MatchExpression, Object) - Constructor for class sfs3.client.requests.FindUsersRequest
- FindUsersRequest(MatchExpression, Object, short) - Constructor for class sfs3.client.requests.FindUsersRequest
-
Creates a new FindUsersRequest instance.
- FLOAT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- FLOAT - Enum constant in enum class sfs3.client.entities.variables.VariableType
- FLOAT_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- floatX() - Method in class sfs3.client.entities.data.Vec3D
-
Get the X coordinate as float
- floatY() - Method in class sfs3.client.entities.data.Vec3D
-
Get the Y coordinate as float
- floatZ() - Method in class sfs3.client.entities.data.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.
- fromArray(SFSDataWrapper) - Static method in class sfs3.client.entities.data.Vec3D
- fromFloatArray(List<Float>) - Static method in class sfs3.client.entities.data.Vec3D
-
private
- fromId(int) - Static method in enum class sfs3.client.entities.invitation.InvitationReply
- fromId(int) - Static method in enum class sfs3.client.entities.variables.VariableType
- fromIntArray(List<Integer>) - Static method in class sfs3.client.entities.data.Vec3D
-
private
- fromRdpMode(TxpMode) - Static method in enum class sfs3.client.bitswarm.TransportType
- fromSFSArray(ISFSArray) - Static method in class sfs3.client.entities.MMOItem
- fromSFSArray(ISFSArray) - Static method in class sfs3.client.entities.SFSBuddy
- fromSFSArray(ISFSArray) - Static method in class sfs3.client.entities.SFSRoom
- fromSFSArray(ISFSArray) - Static method in class sfs3.client.entities.SFSUser
- fromSFSArray(ISFSArray) - Static method in class sfs3.client.entities.variables.MMOItemVariable
- fromSFSArray(ISFSArray) - Static method in class sfs3.client.entities.variables.SFSBuddyVariable
- fromSFSArray(ISFSArray) - Static method in class sfs3.client.entities.variables.SFSRoomVariable
- fromSFSArray(ISFSArray) - Static method in class sfs3.client.entities.variables.SFSUserVariable
- fromSFSArray(ISFSArray, Room) - Static method in class sfs3.client.entities.SFSUser
- fromString(String) - Static method in enum class sfs3.client.entities.variables.VariableType
- fromTypeId(int) - Static method in enum class com.smartfoxserver.entities.data.SFSDataType
-
Get the SFSDataType enum from its type id
G
- GameServerConnectionRequired - Static variable in class sfs3.client.requests.BaseRequest
- GenericMessage - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- 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
- getAllowNameChange() - Method in class sfs3.client.requests.RoomPermissions
-
Indicates whether changing the Room name after its creation is allowed or not.
- getAllowPasswordStateChange() - Method in class sfs3.client.requests.RoomPermissions
-
Indicates whether changing (or removing) the Room password after its creation is allowed or not.
- getAllowPublicMessages() - Method in class sfs3.client.requests.RoomPermissions
-
Indicates whether users inside the Room are allowed to send public messages or not.
- getAllowResizing() - Method in class sfs3.client.requests.RoomPermissions
-
Indicates whether the Room capacity can be changed after its creation or not.
- getAllowUserCountChange() - Method in class sfs3.client.requests.RoomEvents
-
Indicates whether or not the userCountChange event should be dispatched whenever the users (or players+spectators) count changes in the Room.
- getAllowUserEnter() - Method in class sfs3.client.requests.RoomEvents
-
Indicates whether the userEnterRoom event should be dispatched whenever a user joins the Room or not.
- getAllowUserExit() - Method in class sfs3.client.requests.RoomEvents
-
Indicates whether the userExitRoom event should be dispatched whenever a user leaves the Room or not.
- getAllowUserVariablesUpdate() - Method in class sfs3.client.requests.RoomEvents
-
Indicates whether or not the userVariablesUpdate event should be dispatched whenever a user in the Room updates his User Variables.
- getAOIEntryPoint() - Method in interface sfs3.client.entities.IMMOItem
-
Returns the entry point within the User's AOI where this object "appeared" with the last PROXIMITY_LIST_UPDATE event.
- getAOIEntryPoint() - Method in class sfs3.client.entities.MMOItem
-
Returns the entry point within the User's AOI where this object "appeared" with the last PROXIMITY_LIST_UPDATE event.
- getAOIEntryPoint() - Method in class sfs3.client.entities.SFSUser
- getAOIEntryPoint() - Method in interface sfs3.client.entities.User
-
Returns the entry point within the User's AOI where this client "appeared" with the last PROXIMITY_LIST_UPDATE event.
- getBitSwarm() - Method in interface sfs3.client.ISmartFox
- getBitSwarm() - Method in class sfs3.client.SmartFox
- 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(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
- getBoolValue() - Method in class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as Boolean
- getBoolValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as Boolean
- getBuddyById(int) - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Retrieves a Buddy object from its id property.
- getBuddyById(int) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getBuddyByName(String) - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Retrieves a Buddy object from its name property.
- getBuddyByName(String) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getBuddyByNickName(String) - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Retrieves a Buddy object from its nickName property (if set).
- getBuddyByNickName(String) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getBuddyList() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Returns a list of Buddy objects representing all the buddies in the user's buddies list.
- getBuddyList() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getBuddyManager() - Method in interface sfs3.client.ISmartFox
- getBuddyManager() - Method in class sfs3.client.SmartFox
-
Returns a reference to the Buddy Manager.
- getBuddyStates() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Returns a list of strings representing the available custom buddy states.
- getBuddyStates() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- 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(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
- 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 class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as Byte
- getByteValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as Byte
- getCapacity() - Method in interface sfs3.client.entities.Room
-
Returns the maximum amount of users, including spectators, that can be contained in this Room.
- getCapacity() - Method in class sfs3.client.entities.SFSRoom
- getClassName() - Method in class sfs3.client.requests.RoomExtension
-
Returns the fully qualified name of the main class of the Extension.
- getCondition() - Method in class sfs3.client.entities.match.MatchExpression
-
Returns the matching criteria used during values comparison.
- getConfig() - Method in interface sfs3.client.ISmartFox
- getConfig() - Method in class sfs3.client.SmartFox
-
Get the client configuration details.
- getConnectionMode() - Method in interface sfs3.client.ISmartFox
- getConnectionMode() - Method in class sfs3.client.SmartFox
-
Returns the current connection mode after a connection has been successfully established.
- getDefaultAOI() - Method in class sfs3.client.entities.MMORoom
-
Returns the default Area of Interest (AoI) of this MMORoom.
- getDefaultAOI() - Method in class sfs3.client.requests.mmo.MMORoomSettings
-
Defines the Area of Interest (AoI) for the MMORoom.
- getDispatcher() - Method in class sfs3.client.SmartFox
- getDisplayName() - Method in interface sfs3.client.entities.Buddy
-
If a Buddy nickname exists returns that nickname, otherwise returns the User's login name.
- getDisplayName() - Method in class sfs3.client.entities.SFSBuddy
- 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(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
- getDoubleValue() - Method in class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as Double
- getDoubleValue() - Method in interface sfs3.client.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(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
- getErrorData() - Method in exception class com.smartfoxserver.exceptions.SFSException
- getErrorMessage(short, Object[]) - Static method in class sfs3.client.util.SFSErrorCodes
- getErrors() - Method in exception class sfs3.client.SFSValidationException
- getEvents() - Method in class sfs3.client.requests.RoomSettings
-
Defines the flags indicating which events related to the Room are dispatched by the SmartFox client.
- getExecutor() - Method in interface sfs3.client.ISmartFox
- getExecutor() - Method in class sfs3.client.SmartFox
- getExtension() - Method in class sfs3.client.requests.RoomSettings
-
Defines the Extension that must be attached to the Room on the server-side, and its settings.
- 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(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
- 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(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
- getFloatValue() - Method in class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as Float
- getFloatValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as Float
- getGroupId() - Method in interface sfs3.client.entities.Room
-
Returns the Room Group name.
- getGroupId() - Method in class sfs3.client.entities.SFSRoom
- getGroupId() - Method in class sfs3.client.requests.RoomSettings
-
Defines the id of the Group to which the Room should belong.
- 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 sfs3.client.requests.mmo.MapLimits
-
Obtain the higher coordinate limit
- getHigherMapLimit() - Method in class sfs3.client.entities.MMORoom
-
Returns the higher coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
- getHttpUploadURI() - Method in class sfs3.client.SmartFox
-
Returns the HTTP/HTTPS URI that can be used to upload files to SmartFoxServer, using an HTTP POST request.
- getId() - Method in interface sfs3.client.entities.Buddy
-
The buddy id.
- getId() - Method in interface sfs3.client.entities.IMMOItem
-
The unique ID of this item
- getId() - Method in interface sfs3.client.entities.invitation.Invitation
-
Indicates the id of this invitation.
- getId() - Method in enum class sfs3.client.entities.invitation.InvitationReply
- getId() - Method in class sfs3.client.entities.invitation.SFSInvitation
- getId() - Method in enum class sfs3.client.entities.match.LogicOperator
-
Returns the id of the current LogicOperator instance.
- getId() - Method in class sfs3.client.entities.MMOItem
-
The unique ID of this item
- getId() - Method in interface sfs3.client.entities.Room
-
The id of this Room.
- getId() - Method in class sfs3.client.entities.SFSBuddy
- getId() - Method in class sfs3.client.entities.SFSRoom
- getId() - Method in class sfs3.client.entities.SFSUser
- getId() - Method in interface sfs3.client.entities.User
-
The id of this user.
- getId() - Method in enum class sfs3.client.entities.variables.VariableType
- getId() - Method in class sfs3.client.requests.BaseRequest
- getId() - Method in class sfs3.client.requests.RoomExtension
-
Returns the name of the Extension to be attached to the Room.
- 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(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
- getIntValue() - Method in class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as Integer
- getIntValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as Integer
- getInvitationExpiryTime() - Method in class sfs3.client.requests.game.SFSGameSettings
-
In private games, defines the number of seconds that the users invited to join the game have to reply to the invitation.
- getInvitationParams() - Method in class sfs3.client.requests.game.SFSGameSettings
-
In private games, defines an optional object containing additional custom parameters to be sent together with the invitation.
- getInvitedPlayers() - Method in class sfs3.client.requests.game.SFSGameSettings
-
In private games, defines a list of User objects representing players to be invited to join the game.
- getInvitee() - Method in interface sfs3.client.entities.invitation.Invitation
-
Returns the User object corresponding to the user who received the invitation.
- getInvitee() - Method in class sfs3.client.entities.invitation.SFSInvitation
- getInviter() - Method in interface sfs3.client.entities.invitation.Invitation
-
Returns the User object corresponding to the user who sent the invitation.
- getInviter() - Method in class sfs3.client.entities.invitation.SFSInvitation
- getJoinedRooms() - Method in interface sfs3.client.entities.managers.IRoomManager
-
Returns a list of Rooms currently joined by the client.
- getJoinedRooms() - Method in class sfs3.client.entities.managers.SFSRoomManager
- getJoinedRooms() - Method in interface sfs3.client.ISmartFox
- getJoinedRooms() - Method in class sfs3.client.SmartFox
-
Returns a list of Room objects representing the Rooms currently joined by the client.
- getKeys() - Method in interface com.smartfoxserver.entities.data.ISFSObject
-
Get a set of all keys
- getKeys() - Method in class com.smartfoxserver.entities.data.SFSObject
- getLagMonitor() - Method in interface sfs3.client.ISmartFox
- getLagMonitor() - Method in class sfs3.client.SmartFox
- getLastJoinedRoom() - Method in interface sfs3.client.ISmartFox
- getLastJoinedRoom() - Method in class sfs3.client.SmartFox
-
Returns the object representing the last Room joined by the client, if any.
- getLeaveLastJoinedRoom() - Method in class sfs3.client.requests.game.SFSGameSettings
-
In private games, indicates whether the players must leave the previous Room when joining the game or not.
- getLogicOp() - Method in class sfs3.client.entities.match.MatchExpression
-
In case of concatenated expressions, returns the current logical operator.
- 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(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
- 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 class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as Long
- getLongValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as Long
- getLowerLimit() - Method in class sfs3.client.requests.mmo.MapLimits
-
Obtain the lower coordinate limit
- getLowerMapLimit() - Method in class sfs3.client.entities.MMORoom
-
Returns the lower coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
- getMapLimits() - Method in class sfs3.client.requests.mmo.MMORoomSettings
-
Defines the limits of the virtual environment represented by the MMORoom.
- getMaxSpectators() - Method in interface sfs3.client.entities.Room
-
Returns the maximum number of spectators allowed in this Room (Game Rooms only).
- getMaxSpectators() - Method in class sfs3.client.entities.SFSRoom
- getMaxSpectators() - Method in class sfs3.client.requests.RoomSettings
-
Defines the maximum number of spectators allowed in the Room (only for Game Rooms).
- getMaxUsers() - Method in interface sfs3.client.entities.Room
-
Returns the maximum number of users allowed in this Room.
- getMaxUsers() - Method in class sfs3.client.entities.SFSRoom
- getMaxUsers() - Method in class sfs3.client.requests.RoomSettings
-
Defines the maximum number of users allowed in the Room.
- getMaxVariables() - Method in class sfs3.client.requests.RoomSettings
-
Defines the maximum number of Room Variables allowed for the Room.
- getMinPlayersToStartGame() - Method in class sfs3.client.requests.game.SFSGameSettings
-
Defines the minimum number of players required to start the game.
- getMMOItem(int) - Method in class sfs3.client.entities.MMORoom
-
Retrieves an MMOItem object from its id property.
- getMMOItems() - Method in class sfs3.client.entities.MMORoom
-
Retrieves all MMOItem object in the MMORoom that fall within the current user's Area of Interest.
- getMode() - Method in class sfs3.client.requests.MessageRecipientMode
-
Returns the selected recipient mode.
- getMyDisplayName() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Gets the nickname of the current User or the User's name, if nickname is not set
- getMyDisplayName() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getMyNickName() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Returns the current user's nickname (if set).
- getMyNickName() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getMyOnlineState() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Returns the current user's online/offline state.
- getMyOnlineState() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getMySelf() - Method in interface sfs3.client.ISmartFox
- getMySelf() - Method in class sfs3.client.SmartFox
-
Returns the User object representing the client when connected to a SmartFoxServer instance.
- getMyState() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Returns the current user's custom state (if set).
- getMyState() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getMyVariable(String) - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Retrieves a Buddy Variable from its name.
- getMyVariable(String) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getMyVariables() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Returns all the Buddy Variables associated with the current user.
- getMyVariables() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getName() - Method in interface sfs3.client.entities.Buddy
-
The name of this buddy.
- getName() - Method in interface sfs3.client.entities.Room
-
The unique name of this Room.
- getName() - Method in class sfs3.client.entities.SFSBuddy
- getName() - Method in class sfs3.client.entities.SFSRoom
- getName() - Method in class sfs3.client.entities.SFSUser
- getName() - Method in interface sfs3.client.entities.User
-
The name of this user.
- getName() - Method in class sfs3.client.entities.variables.BaseVariable
-
Return the name of the variable
- getName() - Method in interface sfs3.client.entities.variables.Variable
-
Return the name of the variable
- getName() - Method in class sfs3.client.requests.RoomSettings
-
Defines the name of the Room.
- getNetDebugLevel() - Method in interface sfs3.client.ISmartFox
- getNetDebugLevel() - Method in class sfs3.client.SmartFox
- getNext() - Method in class sfs3.client.entities.match.MatchExpression
-
Returns the next matching expression concatenated to the current one.
- getNickName() - Method in interface sfs3.client.entities.Buddy
-
Returns the nickname of this buddy.
- getNickName() - Method in class sfs3.client.entities.SFSBuddy
- getNodeId() - Method in interface sfs3.client.ISmartFox
- getNodeId() - Method in class sfs3.client.SmartFox
- getNotifyGameStarted() - Method in class sfs3.client.requests.game.SFSGameSettings
-
Indicates if a game state change must be notified when the minimum number of players is reached.
- getObject() - Method in class com.smartfoxserver.entities.data.SFSDataWrapper
- getOfflineBuddies() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Returns a list of Buddy objects representing all the offline buddies in the user's buddies list.
- getOfflineBuddies() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getOfflineVariables() - Method in interface sfs3.client.entities.Buddy
-
Retrieves the list of persistent Buddy Variables of this buddy.
- getOfflineVariables() - Method in class sfs3.client.entities.SFSBuddy
- getOnlineBuddies() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Returns a list of Buddy objects representing all the online buddies in the user's buddies list.
- getOnlineBuddies() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- getOnlineVariables() - Method in interface sfs3.client.entities.Buddy
-
Retrieves the list of non-persistent Buddy Variables of this buddy.
- getOnlineVariables() - Method in class sfs3.client.entities.SFSBuddy
- getParam(String) - Method in class sfs3.client.core.ApiEvent
- getParams() - Method in class sfs3.client.core.ApiEvent
-
Returns a Map<String, Object> containing the parameters of the event.
- getParams() - Method in interface sfs3.client.entities.invitation.Invitation
-
Returns an instance of SFSObject containing a custom set of parameters.
- getParams() - Method in class sfs3.client.entities.invitation.SFSInvitation
- getPassword() - Method in class sfs3.client.requests.RoomSettings
-
Defines the password of the Room.
- getPermissions() - Method in class sfs3.client.requests.RoomSettings
-
Defines the flags indicating which operations are permitted on the Room.
- getPlayerId() - Method in class sfs3.client.entities.SFSUser
- getPlayerId() - Method in interface sfs3.client.entities.User
-
Returns the id of this user as a player in a Game Room.
- getPlayerId(Room) - Method in class sfs3.client.entities.SFSUser
- getPlayerId(Room) - Method in interface sfs3.client.entities.User
-
Returns the playerId value of this user in the passed Room.
- getPlayerList() - Method in interface sfs3.client.entities.Room
-
Returns a list of User objects representing the players currently inside this Room (Game Rooms only).
- getPlayerList() - Method in class sfs3.client.entities.SFSRoom
- getPlayerMatchExpression() - Method in class sfs3.client.requests.game.SFSGameSettings
-
Defines the game matching expression to be used to filters players.
- getPrivilegeId() - Method in class sfs3.client.entities.SFSUser
- getPrivilegeId() - Method in interface sfs3.client.entities.User
-
Returns the id which identifies the privilege level of this user.
- getPropertiesFile() - Method in class sfs3.client.requests.RoomExtension
-
Defines the name of an optional properties file that should be loaded on the server-side during the Extension initialization.
- getProximityListUpdateMillis() - Method in class sfs3.client.requests.mmo.MMORoomSettings
-
Configures the speed at which the SFSEvent.PROXIMITY_LIST_UPDATE event is sent by the server.
- getReason(int) - Static method in class sfs3.client.util.ClientDisconnectionReason
- getRequest() - Method in class sfs3.client.requests.BaseRequest
- getRoomById(int) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Retrieves a Room object from its id.
- getRoomById(int) - Method in class sfs3.client.entities.managers.SFSRoomManager
- getRoomByName(String) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Retrieves a Room object from its name.
- getRoomByName(String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- getRoomCount() - Method in interface sfs3.client.entities.managers.IRoomManager
-
Returns the current number of Rooms in the Rooms list.
- getRoomCount() - Method in class sfs3.client.entities.managers.SFSRoomManager
- getRoomGroups() - Method in interface sfs3.client.entities.managers.IRoomManager
-
Returns the names of Room Groups currently subscribed by the client.
- getRoomGroups() - Method in class sfs3.client.entities.managers.SFSRoomManager
- getRoomList() - Method in interface sfs3.client.entities.managers.IRoomManager
-
Returns a list of Rooms currently "known" by the client.
- getRoomList() - Method in class sfs3.client.entities.managers.SFSRoomManager
- GetRoomList - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- getRoomListFromGroup(String) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Retrieves the list of Rooms which are part of the specified Room Group.
- getRoomListFromGroup(String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- getRoomManager() - Method in interface sfs3.client.entities.Room
-
Returns a reference to the Room Manager which manages this Room.
- getRoomManager() - Method in class sfs3.client.entities.SFSRoom
- getRoomManager() - Method in interface sfs3.client.ISmartFox
- getRoomManager() - Method in class sfs3.client.SmartFox
-
Returns a reference to the Room Manager.
- getScheduler() - Method in interface sfs3.client.ISmartFox
- getScheduler() - Method in class sfs3.client.SmartFox
-
This can be used to schedule simple delayed Tasks.
- getSearchableRooms() - Method in class sfs3.client.requests.game.SFSGameSettings
-
In private games, defines a list of Groups names where to search players to invite.
- getSecondsForAnswer() - Method in interface sfs3.client.entities.invitation.Invitation
-
Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires.
- getSecondsForAnswer() - Method in class sfs3.client.entities.invitation.SFSInvitation
- getSessionToken() - Method in interface sfs3.client.ISmartFox
- getSessionToken() - Method in class sfs3.client.SmartFox
-
Returns the current session token.
- 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 class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as SFSArray
- getSFSArrayValue() - Method in interface sfs3.client.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 class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as SFSObject
- getSFSObjectValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as SFSObject
- getSFSVector2Value() - Method in class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as SFSVector2
- getSFSVector2Value() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as SFSVector2
- getSFSVector3Value() - Method in class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as SFSVector3
- getSFSVector3Value() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as SFSVector3
- 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(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
- 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(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
- 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 class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as Short
- getShortValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as Short
- getSmartFox() - Method in interface sfs3.client.entities.managers.IRoomManager
- getSmartFox() - Method in interface sfs3.client.entities.managers.IUserManager
- getSmartFox() - Method in class sfs3.client.entities.managers.SFSRoomManager
- getSmartFox() - Method in class sfs3.client.entities.managers.SFSUserManager
- getSpectatorCount() - Method in interface sfs3.client.entities.Room
-
Returns the current number of spectators in this Room (Game Rooms only).
- getSpectatorCount() - Method in class sfs3.client.entities.SFSRoom
- getSpectatorList() - Method in interface sfs3.client.entities.Room
-
Returns a list of User objects representing the spectators currently inside this Room (Game Rooms only).
- getSpectatorList() - Method in class sfs3.client.entities.SFSRoom
- getSpectatorMatchExpression() - Method in class sfs3.client.requests.game.SFSGameSettings
-
Defines the game matching expression to be used to filters spectators.
- getState() - Method in interface sfs3.client.entities.Buddy
-
Returns the custom state of this buddy.
- getState() - Method in class sfs3.client.entities.SFSBuddy
- 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(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
- getStringValue() - Method in class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as String
- getStringValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as String
- getSymbol() - Method in enum class sfs3.client.entities.match.BoolMatch
- getSymbol() - Method in interface sfs3.client.entities.match.IMatcher
-
Returns the condition symbol of this matcher.
- getSymbol() - Method in enum class sfs3.client.entities.match.NumberMatch
- getSymbol() - Method in enum class sfs3.client.entities.match.StringMatch
- getTarget() - Method in class sfs3.client.core.ApiEvent
- getTarget() - Method in class sfs3.client.requests.MessageRecipientMode
-
Returns the moderator/administrator message target, according to the selected recipient mode.
- getTargetController() - Method in class sfs3.client.requests.BaseRequest
- 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
- getTransportType() - Method in class sfs3.client.requests.BaseRequest
- getType() - Method in class sfs3.client.core.ApiEvent
-
Returns the type of the event.
- getType() - Method in enum class sfs3.client.entities.match.BoolMatch
- getType() - Method in interface sfs3.client.entities.match.IMatcher
-
Returns the type id of this matcher.
- getType() - Method in enum class sfs3.client.entities.match.NumberMatch
- getType() - Method in enum class sfs3.client.entities.match.StringMatch
- getType() - Method in class sfs3.client.entities.variables.BaseVariable
-
Return the data type of the variable
- getType() - Method in interface sfs3.client.entities.variables.Variable
-
Return the data type of the variable
- getTypeId() - Method in class com.smartfoxserver.entities.data.SFSDataWrapper
- getTypeID() - Method in enum class com.smartfoxserver.entities.data.SFSDataType
- 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
- getUserById(int) - Method in interface sfs3.client.entities.managers.IUserManager
-
Retrieves a User object from its id property.
- getUserById(int) - Method in class sfs3.client.entities.managers.SFSUserManager
- getUserById(int) - Method in interface sfs3.client.entities.Room
-
Retrieves a User object from its id property.
- getUserById(int) - Method in class sfs3.client.entities.SFSRoom
- getUserByName(String) - Method in interface sfs3.client.entities.managers.IUserManager
-
Retrieves a User object from its name property.
- getUserByName(String) - Method in class sfs3.client.entities.managers.SFSUserManager
- getUserByName(String) - Method in interface sfs3.client.entities.Room
-
Retrieves a User object from its name property.
- getUserByName(String) - Method in class sfs3.client.entities.SFSRoom
- getUserCount() - Method in interface sfs3.client.entities.managers.IUserManager
-
Returns the total number of users in the local users list.
- getUserCount() - Method in class sfs3.client.entities.managers.SFSUserManager
- getUserCount() - Method in interface sfs3.client.entities.Room
-
Returns the current number of users in this Room.
- getUserCount() - Method in class sfs3.client.entities.SFSRoom
- getUserList() - Method in interface sfs3.client.entities.managers.IUserManager
-
Get the whole list of users inside the Rooms joined by the client.
- getUserList() - Method in class sfs3.client.entities.managers.SFSUserManager
- getUserList() - Method in interface sfs3.client.entities.Room
-
Returns a list of User objects representing all the users currently inside this Room.
- getUserList() - Method in class sfs3.client.entities.SFSRoom
- getUserManager() - Method in class sfs3.client.entities.SFSUser
- getUserManager() - Method in interface sfs3.client.entities.User
-
Returns a reference to the User Manager which manages this user.
- getUserManager() - Method in interface sfs3.client.ISmartFox
- getUserManager() - Method in class sfs3.client.SmartFox
-
Returns a reference to the User Manager.
- getUserMaxLimboSeconds() - Method in class sfs3.client.requests.mmo.MMORoomSettings
-
Defines the time limit before a user without a physical position set inside the MMORoom is kicked from the Room.
- getUserRooms(User) - Method in interface sfs3.client.entities.managers.IRoomManager
-
Retrieves a list of Rooms joined by the specified user.
- getUserRooms(User) - Method in class sfs3.client.entities.managers.SFSRoomManager
- getValue() - Method in class sfs3.client.entities.match.MatchExpression
-
Returns the value against which the variable or property corresponding to varName is compared.
- getValue() - Method in class sfs3.client.entities.variables.BaseVariable
-
Get the value of the variable as Object
- getValue() - Method in interface sfs3.client.entities.variables.Variable
-
Get the value of the variable as Object
- getVariable(String) - Method in interface sfs3.client.entities.Buddy
-
Retrieves a Buddy Variable from its name.
- getVariable(String) - Method in interface sfs3.client.entities.IMMOItem
-
Retrieves a User Variable from its name.
- getVariable(String) - Method in class sfs3.client.entities.MMOItem
-
Retrieves a User Variable from its name.
- getVariable(String) - Method in interface sfs3.client.entities.Room
-
Retrieves a Room Variable from its name.
- getVariable(String) - Method in class sfs3.client.entities.SFSBuddy
- getVariable(String) - Method in class sfs3.client.entities.SFSRoom
- getVariable(String) - Method in class sfs3.client.entities.SFSUser
- getVariable(String) - Method in interface sfs3.client.entities.User
-
Retrieves a User Variable from its name.
- getVariables() - Method in interface sfs3.client.entities.Buddy
-
Returns a list of BuddyVariable objects associated with the buddy.
- getVariables() - Method in interface sfs3.client.entities.IMMOItem
-
Retrieves all the Variables of this Item
- getVariables() - Method in class sfs3.client.entities.MMOItem
-
Retrieves all the Variables of this Item
- getVariables() - Method in interface sfs3.client.entities.Room
-
Retrieves all the Room Variables of this Room.
- getVariables() - Method in class sfs3.client.entities.SFSBuddy
- getVariables() - Method in class sfs3.client.entities.SFSRoom
- getVariables() - Method in class sfs3.client.entities.SFSUser
- getVariables() - Method in interface sfs3.client.entities.User
-
Retrieves all the User Variables of this user.
- getVariables() - Method in class sfs3.client.requests.RoomSettings
-
Defines a list of RooomVariable objects to be attached to the Room.
- getVarName() - Method in class sfs3.client.entities.match.MatchExpression
-
Returns the name of the variable or property against which the comparison is made.
- 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
- 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
- getVersion() - Method in interface sfs3.client.ISmartFox
- getVersion() - Method in class sfs3.client.SmartFox
-
Returns the current version of the SmartFoxServer 3 Client API.
- GoOnline - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- GoOnlineRequest - Class in sfs3.client.requests.buddylist
-
Toggles the current user's online/offline state as buddy in other users' buddies lists.
- GoOnlineRequest(boolean) - Constructor for class sfs3.client.requests.buddylist.GoOnlineRequest
-
Creates a new GoOnlineRequest instance.
- GREATER_THAN - Enum constant in enum class sfs3.client.entities.match.NumberMatch
-
An instance of NumberMatch representing the following condition: number1 > number2.
- GREATER_THAN_OR_EQUAL_TO - Enum constant in enum class sfs3.client.entities.match.NumberMatch
-
An instance of NumberMatch representing the following condition: number1 >= number2.
- GROUP_ID - Static variable in class sfs3.client.entities.match.RoomProperties
-
The name of the Group to which the Room belongs.
- groupId - Variable in class sfs3.client.entities.SFSRoom
- GroupId - Static variable in class sfs3.client.core.EventParam
- GUEST - Static variable in class sfs3.client.entities.UserPrivileges
-
The Guest user is usually the lowest level in the privilege profiles scale.
H
- handleHandShake(ISFSObject) - Method in interface sfs3.client.ISmartFox
- handleHandShake(ISFSObject) - Method in class sfs3.client.SmartFox
- handleLogout() - Method in interface sfs3.client.ISmartFox
- handleLogout() - Method in class sfs3.client.SmartFox
- Handshake - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- HANDSHAKE - Static variable in class sfs3.client.core.SFSEvent
- HAS_FREE_PLAYER_SLOTS - Static variable in class sfs3.client.entities.match.RoomProperties
-
The Room has at least one free player slot.
- hashCode() - Method in class com.smartfoxserver.entities.data.SFSVector2
- hashCode() - Method in class sfs3.client.entities.MMOItem
- hashCode() - Method in class sfs3.client.entities.SFSBuddy
- hashCode() - Method in class sfs3.client.entities.SFSRoom
- hashCode() - Method in class sfs3.client.entities.SFSUser
- hasNext() - Method in class sfs3.client.entities.match.MatchExpression
-
Checks if the current matching expression is concatenated to another one through a logical operator.
- host - Variable in class sfs3.client.ConfigData
-
The host to connect to
- httpPort - Variable in class sfs3.client.ConfigData
-
The HTTP port to be used for HTTP calls
- httpsPort - Variable in class sfs3.client.ConfigData
-
The HTTPS port to be used for HTTP calls
I
- IBuddyManager - Interface in sfs3.client.entities.managers
-
The IBuddyManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Buddy List system.
- id - Variable in class sfs3.client.entities.invitation.SFSInvitation
- id - Variable in class sfs3.client.entities.SFSBuddy
- id - Variable in class sfs3.client.entities.SFSRoom
- id - Variable in class sfs3.client.entities.SFSUser
- IDLE - Static variable in class sfs3.client.util.ClientDisconnectionReason
-
Client was disconnected because it was idle for too long.
- IEventListener - Interface in sfs3.client.core
-
The interface can be implemented to handle a single event type or it can be used to capture multiple events.
- IMatcher - Interface in sfs3.client.entities.match
-
The IMatcher interface defines the properties of an object representing a condition to be used in a matching expression exposes.
- IMMOItem - Interface in sfs3.client.entities
- IMMOItemVariable - Interface in sfs3.client.entities.variables
-
In the SmartFoxServer 3 client API this interface is implemented by the MMOItemVariable class.
- init() - Method in class sfs3.client.SmartFox
- InitBuddyList - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- InitBuddyListRequest - Class in sfs3.client.requests.buddylist
-
Initializes the Buddy List system on the current client.
- InitBuddyListRequest() - Constructor for class sfs3.client.requests.buddylist.InitBuddyListRequest
-
Creates a new InitBuddyListRequest instance.
- inited - Variable in class sfs3.client.entities.managers.SFSBuddyManager
- INT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- INT - Enum constant in enum class sfs3.client.entities.variables.VariableType
- INT_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- intX() - Method in class sfs3.client.entities.data.Vec3D
-
Get the X coordinate as integer
- intY() - Method in class sfs3.client.entities.data.Vec3D
-
Get the Y coordinate as integer
- intZ() - Method in class sfs3.client.entities.data.Vec3D
-
Get the Z coordinate as integer
- Invitation - Interface in sfs3.client.entities.invitation
-
The Invitation interface defines all the methods and properties that an object representing an invitation entity exposes.
- Invitation - Static variable in class sfs3.client.core.EventParam
- INVITATION - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the current user receives an invitation from another user.
- INVITATION_REPLY - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the current user receives a reply to an invitation sent previously.
- INVITATION_REPLY_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an error occurs while the current user is sending a reply to an invitation.
- InvitationReply - Enum Class in sfs3.client.entities.invitation
-
The InvitationReply class contains the constants describing the possible replies to an invitation.
- InvitationReply - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- InvitationReplyRequest - Class in sfs3.client.requests.invitation
-
Replies to an invitation received by the current user.
- InvitationReplyRequest(Invitation, InvitationReply) - Constructor for class sfs3.client.requests.invitation.InvitationReplyRequest
- InvitationReplyRequest(Invitation, InvitationReply, ISFSObject) - Constructor for class sfs3.client.requests.invitation.InvitationReplyRequest
-
Creates a new InvitationReplyRequest instance.
- invitee - Variable in class sfs3.client.entities.invitation.SFSInvitation
- Invitee - Static variable in class sfs3.client.core.EventParam
- inviter - Variable in class sfs3.client.entities.invitation.SFSInvitation
- InviteUser - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- InviteUsersRequest - Class in sfs3.client.requests.invitation
-
Sends a generic invitation to a list of users.
- InviteUsersRequest(List<Object>, int, ISFSObject) - Constructor for class sfs3.client.requests.invitation.InviteUsersRequest
-
Creates a new InviteUsersRequest instance.
- IRoomManager - Interface in sfs3.client.entities.managers
-
The IRoomManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Room entities.
- IS_GAME - Static variable in class sfs3.client.entities.match.RoomProperties
-
The Room is a Game Room.
- IS_IN_ANY_ROOM - Static variable in class sfs3.client.entities.match.UserProperties
-
The user joined at least one room.
- IS_NPC - Static variable in class sfs3.client.entities.match.UserProperties
-
The user is a Non-Player Character (NPC).
- IS_PLAYER - Static variable in class sfs3.client.entities.match.UserProperties
-
The user is a player in a Game Room.
- IS_PRIVATE - Static variable in class sfs3.client.entities.match.RoomProperties
-
The Room is private.
- IS_SPECTATOR - Static variable in class sfs3.client.entities.match.UserProperties
-
The user is a spectator in a Game Room.
- IS_TYPE_SFSGAME - Static variable in class sfs3.client.entities.match.RoomProperties
-
The Room is an SFSGame on the server-side.
- isActive - Variable in class sfs3.client.ConfigData.BlueBoxCfg
-
When active if the TCP connection fails an attempt to use an HTTP tunnel will be made
- isAdmin() - Method in class sfs3.client.entities.SFSUser
- isAdmin() - Method in interface sfs3.client.entities.User
-
Indicates whether this user logged in as an administrator or not.
- isAudioStreamingAllowed - Variable in class sfs3.client.entities.SFSRoom
- isAudioStreamingAllowed() - Method in interface sfs3.client.entities.Room
-
Indicates whether audio streaming is allowed in the Room.
- isAudioStreamingAllowed() - Method in class sfs3.client.entities.SFSRoom
- isBlocked - Variable in class sfs3.client.entities.SFSBuddy
- isBlocked() - Method in interface sfs3.client.entities.Buddy
-
Indicates whether this buddy is blocked in the current user's buddies list or not.
- isBlocked() - Method in class sfs3.client.entities.SFSBuddy
- isConnected() - Method in interface sfs3.client.ISmartFox
- isConnected() - Method in class sfs3.client.SmartFox
- isFloat() - Method in class sfs3.client.entities.data.Vec3D
-
Detect whether this object uses floating point numbers or integers
- ISFSArray - Interface in com.smartfoxserver.entities.data
- 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.
- isGame - Variable in class sfs3.client.entities.SFSRoom
- isGame() - Method in interface sfs3.client.entities.Room
-
Indicates whether this is a Game Room or not.
- isGame() - Method in class sfs3.client.entities.SFSRoom
- isGame() - Method in class sfs3.client.requests.RoomSettings
-
Indicates whether the Room is a Game Room or not.
- isGuest() - Method in class sfs3.client.entities.SFSUser
- isGuest() - Method in interface sfs3.client.entities.User
-
Indicates whether this user logged in as a guest or not.
- isHidden - Variable in class sfs3.client.entities.SFSRoom
- isHidden() - Method in interface sfs3.client.entities.Room
-
Indicates whether this Room is hidden or not.
- isHidden() - Method in class sfs3.client.entities.SFSRoom
- isInited() - Method in interface sfs3.client.entities.managers.IBuddyManager
-
Indicates whether the client's Buddy List system is initialized or not.
- isInited() - Method in class sfs3.client.entities.managers.SFSBuddyManager
- isItMe - Variable in class sfs3.client.entities.SFSUser
- isItMe() - Method in class sfs3.client.entities.SFSUser
- isItMe() - Method in interface sfs3.client.entities.User
-
Indicates if this User object represents the current client.
- IsItMe - Static variable in class sfs3.client.core.EventParam
- isJoined - Variable in class sfs3.client.entities.SFSRoom
- isJoined() - Method in interface sfs3.client.entities.Room
-
Indicates whether the client joined this Room or not.
- isJoined() - Method in class sfs3.client.entities.SFSRoom
- isJoinedInRoom(Room) - Method in class sfs3.client.entities.SFSUser
- isJoinedInRoom(Room) - Method in interface sfs3.client.entities.User
-
Indicates whether this user joined the passed Room or not.
- isJoining() - Method in class sfs3.client.SmartFox
- isManaged - Variable in class sfs3.client.entities.SFSRoom
- isManaged() - Method in interface sfs3.client.entities.Room
- isManaged() - Method in class sfs3.client.entities.SFSRoom
- ISmartFox - Interface in sfs3.client
- isModerator() - Method in class sfs3.client.entities.SFSUser
- isModerator() - Method in interface sfs3.client.entities.User
-
Indicates whether this user logged in as a moderator or not.
- 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.
- isNull() - Method in class sfs3.client.entities.variables.BaseVariable
-
Test if a variable is null
- isNull() - Method in interface sfs3.client.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 sfs3.client.entities.variables.BuddyVariable
-
Indicates whether the Buddy Variable is persistent or not.
- isOffline() - Method in class sfs3.client.entities.variables.SFSBuddyVariable
- isOnline() - Method in interface sfs3.client.entities.Buddy
-
Indicates whether this buddy is online in the Buddy List system or not.
- isOnline() - Method in class sfs3.client.entities.SFSBuddy
- isPasswordProtected - Variable in class sfs3.client.entities.SFSRoom
- isPasswordProtected() - Method in interface sfs3.client.entities.Room
-
Indicates whether this Room requires a password to be joined or not.
- isPasswordProtected() - Method in class sfs3.client.entities.SFSRoom
- isPersistent() - Method in interface sfs3.client.entities.variables.RoomVariable
-
Indicates whether this Room Variable is persistent or not.
- isPersistent() - Method in class sfs3.client.entities.variables.SFSRoomVariable
- isPlayer() - Method in class sfs3.client.entities.SFSUser
- isPlayer() - Method in interface sfs3.client.entities.User
-
Indicates whether this user is a player (playerId greater than
0) in the last joined Room or not. - isPlayerInRoom(Room) - Method in class sfs3.client.entities.SFSUser
- isPlayerInRoom(Room) - Method in interface sfs3.client.entities.User
-
Indicates whether this user is a player (playerId greater than
0) in the passed Room or not. - isPrivate() - Method in interface sfs3.client.entities.variables.RoomVariable
-
Indicates whether this Room Variable is private or not.
- isPrivate() - Method in class sfs3.client.entities.variables.SFSRoomVariable
- isPrivate() - Method in class sfs3.client.entities.variables.SFSUserVariable
-
Indicates whether this User Variable is private or not.
- isPrivate() - Method in interface sfs3.client.entities.variables.UserVariable
-
Indicates whether this User Variable is private or not.
- isPublic() - Method in class sfs3.client.requests.game.SFSGameSettings
-
Indicates whether the game is public or private.
- isSendAOIEntryPoint() - Method in class sfs3.client.requests.mmo.MMORoomSettings
-
Sets if the users entry points in the current user's Area of Interest should be transmitted in the SFSEvent.PROXIMITY_LIST_UPDATE event.
- isSpectator() - Method in class sfs3.client.entities.SFSUser
- isSpectator() - Method in interface sfs3.client.entities.User
-
Indicates whether this user is a spectator (playerId lower than
0) in the last joined Room or not. - isSpectatorInRoom(Room) - Method in class sfs3.client.entities.SFSUser
- isSpectatorInRoom(Room) - Method in interface sfs3.client.entities.User
-
Indicates whether this user is a spectator (playerId lower than
0) in the passed Room or not. - isStandardUser() - Method in class sfs3.client.entities.SFSUser
- isStandardUser() - Method in interface sfs3.client.entities.User
-
Indicates whether this user logged in as a standard user or not.
- isTemp - Variable in class sfs3.client.entities.SFSBuddy
- isTemp() - Method in interface sfs3.client.entities.Buddy
-
Indicates whether this buddy is temporary (non-persistent) in the current user's buddies list or not.
- isTemp() - Method in class sfs3.client.entities.SFSBuddy
- isUDP() - Method in enum class sfs3.client.bitswarm.TransportType
- isUdpConnected() - Method in interface sfs3.client.ISmartFox
- isUdpConnected() - Method in class sfs3.client.SmartFox
- 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
- IUserManager - Interface in sfs3.client.entities.managers
-
The IUserManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer User entities.
J
- JoinRoom - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- JoinRoomInvitationRequest - Class in sfs3.client.requests.invitation
- JoinRoomInvitationRequest(Room, List<String>) - Constructor for class sfs3.client.requests.invitation.JoinRoomInvitationRequest
-
Sends an invitation to other users/players to join a specific Room.
- JoinRoomInvitationRequest(Room, List<String>, ISFSObject, int) - Constructor for class sfs3.client.requests.invitation.JoinRoomInvitationRequest
- JoinRoomInvitationRequest(Room, List<String>, ISFSObject, int, boolean) - Constructor for class sfs3.client.requests.invitation.JoinRoomInvitationRequest
- JoinRoomInvite - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- JoinRoomRequest - Class in sfs3.client.requests
-
Joins the current user in a Room.
- JoinRoomRequest(Object) - Constructor for class sfs3.client.requests.JoinRoomRequest
- JoinRoomRequest(Object, String) - Constructor for class sfs3.client.requests.JoinRoomRequest
- JoinRoomRequest(Object, String, Integer) - Constructor for class sfs3.client.requests.JoinRoomRequest
- JoinRoomRequest(Object, String, Integer, boolean) - Constructor for class sfs3.client.requests.JoinRoomRequest
-
Creates a new JoinRoomRequest instance.
K
- KEY_ALLOW_JOIN_INVITATION_BY_OWNER - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_AS_SPECTATOR - Static variable in class sfs3.client.requests.JoinRoomRequest
- KEY_AUTOJOIN - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_BAN_DURATION_HOURS - Static variable in class sfs3.client.requests.BanUserRequest
- KEY_BAN_MODE - Static variable in class sfs3.client.requests.BanUserRequest
- KEY_BLIST - Static variable in class sfs3.client.requests.buddylist.InitBuddyListRequest
- KEY_BUDDY - Static variable in class sfs3.client.requests.buddylist.BlockBuddyRequest
- KEY_BUDDY_BLOCK_STATE - Static variable in class sfs3.client.requests.buddylist.BlockBuddyRequest
- KEY_BUDDY_ID - Static variable in class sfs3.client.requests.buddylist.GoOnlineRequest
- KEY_BUDDY_NAME - Static variable in class sfs3.client.requests.buddylist.AddBuddyRequest
- KEY_BUDDY_NAME - Static variable in class sfs3.client.requests.buddylist.BlockBuddyRequest
- KEY_BUDDY_NAME - Static variable in class sfs3.client.requests.buddylist.GoOnlineRequest
- KEY_BUDDY_NAME - Static variable in class sfs3.client.requests.buddylist.RemoveBuddyRequest
- KEY_BUDDY_NAME - Static variable in class sfs3.client.requests.buddylist.SetBuddyVariablesRequest
- KEY_BUDDY_STATES - Static variable in class sfs3.client.requests.buddylist.InitBuddyListRequest
- KEY_BUDDY_VARS - Static variable in class sfs3.client.requests.buddylist.SetBuddyVariablesRequest
- KEY_CLUSTER_SID - Static variable in class sfs3.client.requests.LoginRequest
- KEY_CMD - Static variable in class sfs3.client.requests.ExtensionRequest
- KEY_DELAY - Static variable in class sfs3.client.requests.BanUserRequest
- KEY_DELAY - Static variable in class sfs3.client.requests.KickUserRequest
- KEY_ERROR_CODE - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- KEY_ERROR_PARAMS - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- KEY_EVENTS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_EXPRESSION - Static variable in class sfs3.client.requests.FindRoomsRequest
- KEY_EXPRESSION - Static variable in class sfs3.client.requests.FindUsersRequest
- KEY_EXTCLASS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_EXTID - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_EXTPROP - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_FILTERED_ROOMS - Static variable in class sfs3.client.requests.FindRoomsRequest
- KEY_FILTERED_USERS - Static variable in class sfs3.client.requests.FindUsersRequest
- KEY_GROUP - Static variable in class sfs3.client.requests.FindRoomsRequest
- KEY_GROUP - Static variable in class sfs3.client.requests.FindUsersRequest
- KEY_GROUP_ID - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_GROUP_ID - Static variable in class sfs3.client.requests.SubscribeRoomGroupRequest
- KEY_GROUP_ID - Static variable in class sfs3.client.requests.UnsubscribeRoomGroupRequest
- KEY_GROUP_LIST - Static variable in class sfs3.client.requests.game.QuickJoinGameRequest
- KEY_ID - Static variable in class sfs3.client.requests.LoginRequest
- KEY_INVITATION_EXPIRY - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_INVITATION_ID - Static variable in class sfs3.client.requests.invitation.InvitationReplyRequest
- KEY_INVITATION_ID - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- KEY_INVITATION_PARAMS - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_INVITATION_PARAMS - Static variable in class sfs3.client.requests.invitation.InvitationReplyRequest
- KEY_INVITATION_REPLY - Static variable in class sfs3.client.requests.invitation.InvitationReplyRequest
- KEY_INVITED_PLAYERS - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_INVITED_USERS - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- KEY_INVITEE_ID - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- KEY_IS_PUBLIC - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_ISGAME - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_ITEM_ID - Static variable in class sfs3.client.requests.mmo.SetMMOItemVariables
- KEY_LEAVE_ROOM - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_LIMIT - Static variable in class sfs3.client.requests.FindRoomsRequest
- KEY_LIMIT - Static variable in class sfs3.client.requests.FindUsersRequest
- KEY_MATCH_EXPRESSION - Static variable in class sfs3.client.requests.game.QuickJoinGameRequest
- KEY_MAXSPECTATORS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MAXUSERS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MAXVARS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MESSAGE - Static variable in class sfs3.client.requests.BanUserRequest
- KEY_MESSAGE - Static variable in class sfs3.client.requests.KickUserRequest
- KEY_MIN_PLAYERS - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_MINUS_ITEM_LIST - Static variable in class sfs3.client.requests.mmo.SetUserPositionRequest
-
API internal usage only
- KEY_MINUS_USER_LIST - Static variable in class sfs3.client.requests.mmo.SetUserPositionRequest
-
API internal usage only
- KEY_MMO_DEFAULT_AOI - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MMO_MAP_HIGH_LIMIT - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MMO_MAP_LOW_LIMIT - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MMO_PROXIMITY_UPDATE_MILLIS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MMO_SEND_ENTRY_POINT - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MMO_USER_MAX_LIMBO_SECONDS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_MY_VARS - Static variable in class sfs3.client.requests.buddylist.InitBuddyListRequest
- KEY_NAME - Static variable in class sfs3.client.requests.ChangeRoomNameRequest
- KEY_NAME - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_NOTIFY_GAME_STARTED - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_ONLINE - Static variable in class sfs3.client.requests.buddylist.GoOnlineRequest
- KEY_PARAMS - Static variable in class sfs3.client.requests.ExtensionRequest
- KEY_PARAMS - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- KEY_PARAMS - Static variable in class sfs3.client.requests.LoginRequest
- KEY_PASS - Static variable in class sfs3.client.requests.ChangeRoomPasswordStateRequest
- KEY_PASS - Static variable in class sfs3.client.requests.JoinRoomRequest
- KEY_PASSWORD - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_PASSWORD - Static variable in class sfs3.client.requests.LoginRequest
- KEY_PERMISSIONS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_PLAYER_ID - Static variable in class sfs3.client.requests.SpectatorToPlayerRequest
- KEY_PLAYER_MATCH_EXP - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_PLUS_ITEM_LIST - Static variable in class sfs3.client.requests.mmo.SetUserPositionRequest
-
API internal usage only
- KEY_PLUS_USER_LIST - Static variable in class sfs3.client.requests.mmo.SetUserPositionRequest
-
API internal usage only
- KEY_PRIVILEGE_ID - Static variable in class sfs3.client.requests.LoginRequest
- KEY_RECONNECTION_SECONDS - Static variable in class sfs3.client.requests.LoginRequest
- KEY_REPLY_ID - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- KEY_ROOM - Static variable in class sfs3.client.requests.ChangeRoomCapacityRequest
- KEY_ROOM - Static variable in class sfs3.client.requests.ChangeRoomNameRequest
- KEY_ROOM - Static variable in class sfs3.client.requests.ChangeRoomPasswordStateRequest
- KEY_ROOM - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_ROOM - Static variable in class sfs3.client.requests.ExtensionRequest
- KEY_ROOM - Static variable in class sfs3.client.requests.FindUsersRequest
- KEY_ROOM - Static variable in class sfs3.client.requests.JoinRoomRequest
- KEY_ROOM - Static variable in class sfs3.client.requests.mmo.SetUserPositionRequest
-
API internal usage only
- KEY_ROOM_ID - Static variable in class sfs3.client.requests.JoinRoomRequest
- KEY_ROOM_ID - Static variable in class sfs3.client.requests.LeaveRoomRequest
- KEY_ROOM_ID - Static variable in class sfs3.client.requests.mmo.SetMMOItemVariables
- KEY_ROOM_ID - Static variable in class sfs3.client.requests.PlayerToSpectatorRequest
- KEY_ROOM_ID - Static variable in class sfs3.client.requests.SpectatorToPlayerRequest
- KEY_ROOM_LIST - Static variable in class sfs3.client.requests.game.QuickJoinGameRequest
- KEY_ROOM_LIST - Static variable in class sfs3.client.requests.SubscribeRoomGroupRequest
- KEY_ROOM_NAME - Static variable in class sfs3.client.requests.JoinRoomRequest
- KEY_ROOM_TO_LEAVE - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_ROOM_TO_LEAVE - Static variable in class sfs3.client.requests.game.QuickJoinGameRequest
- KEY_ROOM_TO_LEAVE - Static variable in class sfs3.client.requests.JoinRoomRequest
- KEY_ROOMLIST - Static variable in class sfs3.client.requests.LoginRequest
- KEY_ROOMVARS - Static variable in class sfs3.client.requests.CreateRoomRequest
- KEY_SEARCHABLE_ROOMS - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_SPEC_SIZE - Static variable in class sfs3.client.requests.ChangeRoomCapacityRequest
- KEY_SPECTATOR_MATCH_EXP - Static variable in class sfs3.client.requests.game.CreateSFSGameRequest
- KEY_TIME - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- KEY_USER - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- KEY_USER - Static variable in class sfs3.client.requests.SetUserVariablesRequest
- KEY_USER_ID - Static variable in class sfs3.client.requests.BanUserRequest
- KEY_USER_ID - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- KEY_USER_ID - Static variable in class sfs3.client.requests.KickUserRequest
- KEY_USER_ID - Static variable in class sfs3.client.requests.PlayerToSpectatorRequest
- KEY_USER_ID - Static variable in class sfs3.client.requests.SpectatorToPlayerRequest
- KEY_USER_LIST - Static variable in class sfs3.client.requests.JoinRoomRequest
- KEY_USER_NAME - Static variable in class sfs3.client.requests.LoginRequest
- KEY_USER_SIZE - Static variable in class sfs3.client.requests.ChangeRoomCapacityRequest
- KEY_VAR_LIST - Static variable in class sfs3.client.requests.mmo.SetMMOItemVariables
- KEY_VAR_LIST - Static variable in class sfs3.client.requests.SetRoomVariablesRequest
- KEY_VAR_LIST - Static variable in class sfs3.client.requests.SetUserVariablesRequest
- KEY_VAR_ROOM - Static variable in class sfs3.client.requests.SetRoomVariablesRequest
- KEY_VEC3D - Static variable in class sfs3.client.requests.mmo.SetUserPositionRequest
-
API internal usage only
- KEY_ZONE_NAME - Static variable in class sfs3.client.requests.LoginRequest
- KEY_ZONE_NAME - Static variable in class sfs3.client.requests.LogoutRequest
- KICKED - Static variable in class sfs3.client.util.ClientDisconnectionReason
-
Client was kicked out of the server.
- KickUser - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- KickUserRequest - Class in sfs3.client.requests
-
Kicks a user out of the server.
- KickUserRequest(int) - Constructor for class sfs3.client.requests.KickUserRequest
- KickUserRequest(int, String) - Constructor for class sfs3.client.requests.KickUserRequest
- KickUserRequest(int, String, int) - Constructor for class sfs3.client.requests.KickUserRequest
-
Creates a new KickUserRequest instance.
- killConnection() - Method in interface sfs3.client.ISmartFox
- killConnection() - Method in class sfs3.client.SmartFox
-
Used to simulate an unexpected connection, to test the reconnection system.
L
- LagValue - Static variable in class sfs3.client.core.EventParam
- LeaveRoom - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- LeaveRoomRequest - Class in sfs3.client.requests
-
Leaves one of the Rooms joined by the current user.
- LeaveRoomRequest() - Constructor for class sfs3.client.requests.LeaveRoomRequest
- LeaveRoomRequest(Room) - Constructor for class sfs3.client.requests.LeaveRoomRequest
-
Creates a new LeaveRoomRequest instance.
- 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 sfs3.client.entities.match.NumberMatch
-
An instance of NumberMatch representing the following condition: number1 < number2.
- LESS_THAN_OR_EQUAL_TO - Enum constant in enum class sfs3.client.entities.match.NumberMatch
-
An instance of NumberMatch representing the following condition: number1 <= number2.
- log - Variable in class sfs3.client.entities.managers.SFSUserManager
- log - Variable in class sfs3.client.SmartFox
- LogicOperator - Enum Class in sfs3.client.entities.match
-
The LogicOperator class is used to concatenate two matching expressions using the AND or OR logical operator.
- Login - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- LOGIN - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched in response to a LoginRequest and signaling a successful login in the selected Zone.
- LOGIN_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched if an error occurs while the user login is being performed.
- LoginRequest - Class in sfs3.client.requests
-
Logs the current user in one of the server Zones.
- LoginRequest(String) - Constructor for class sfs3.client.requests.LoginRequest
- LoginRequest(String, String) - Constructor for class sfs3.client.requests.LoginRequest
- LoginRequest(String, String, String) - Constructor for class sfs3.client.requests.LoginRequest
- LoginRequest(String, String, String, ISFSObject) - Constructor for class sfs3.client.requests.LoginRequest
-
Creates a new LoginRequest instance.
- Logout - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- LOGOUT - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the current user logs out of the server Zone.
- LogoutRequest - Class in sfs3.client.requests
-
Logs the user out of the current server Zone.
- LogoutRequest() - Constructor for class sfs3.client.requests.LogoutRequest
-
Creates a new LogoutRequest instance.
- LONG - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- LONG - Enum constant in enum class sfs3.client.entities.variables.VariableType
- LONG_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
M
- MANUAL - Static variable in class sfs3.client.util.ClientDisconnectionReason
-
The client manually disconnected from the server.
- ManualDisconnection - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- MapLimits - Class in sfs3.client.requests.mmo
-
The class describes the lowest and highest 2D/3D coordinates available inside an MMORoom
- MapLimits(Vec3D, Vec3D) - Constructor for class sfs3.client.requests.mmo.MapLimits
-
Default constructor
- MatchExpression - Class in sfs3.client.entities.match
-
The MatchExpression class represents a matching expression used to compare custom variables or predefined properties when searching for users or Rooms.
- MatchExpression(String, IMatcher, Object) - Constructor for class sfs3.client.entities.match.MatchExpression
-
Creates a new MatchExpression instance.
- MatchExpression(String, IMatcher, Object, LogicOperator, MatchExpression) - Constructor for class sfs3.client.entities.match.MatchExpression
- 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_EXPIRY_TIME - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- MAX_INVITATIONS_FROM_CLIENT_SIDE - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- MAX_SPECTATORS - Static variable in class sfs3.client.entities.match.RoomProperties
-
The maximum number of spectators allowed in the Room (Game Rooms only).
- MAX_USERS - Static variable in class sfs3.client.entities.match.RoomProperties
-
The maximum number of users allowed in the Room (players in Game Rooms).
- maxSpectators - Variable in class sfs3.client.entities.SFSRoom
- maxUsers - Variable in class sfs3.client.entities.SFSRoom
- Message - Static variable in class sfs3.client.core.EventParam
- MessageRecipientMode - Class in sfs3.client.requests
-
The MessageRecipientMode class is used to specify the recipient/s of moderator and administrator messages.
- MessageRecipientMode(int, Object) - Constructor for class sfs3.client.requests.MessageRecipientMode
-
Creates a new MessageRecipientMode instance.
- 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.
- MIN_EXPIRY_TIME - Static variable in class sfs3.client.requests.invitation.InviteUsersRequest
- MMOItem - Class in sfs3.client.entities
-
An MMOItem represents an active non-player entity inside an MMORoom.
- MMOItem - Static variable in class sfs3.client.core.EventParam
- MMOItem(int) - Constructor for class sfs3.client.entities.MMOItem
- MMOITEM_VARIABLES_UPDATE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched to notify about MMOItemVariables updates in the current MMORoom.
- MMOItemVariable - Class in sfs3.client.entities.variables
-
The MMOItemVariabke is a custom value attached to an MMOItem object that gets automatically synchronized between client and server on every change, provided that the MMOItem is inside the Area of Interest of the current User in a MMORoom.
- MMOItemVariable(String, Object) - Constructor for class sfs3.client.entities.variables.MMOItemVariable
-
Creates a new variable
- MMOItemVariable(String, Object, VariableType) - Constructor for class sfs3.client.entities.variables.MMOItemVariable
-
Types are usually auto-detected.
- MMORoom - Class in sfs3.client.entities
-
The MMORoom object represents a specialized type of Room entity on the client.
- MMORoom(int, String) - Constructor for class sfs3.client.entities.MMORoom
-
Creates a new MMORoom instance.
- MMORoom(int, String, String) - Constructor for class sfs3.client.entities.MMORoom
-
Creates a new MMORoom instance.
- MMORoomSettings - Class in sfs3.client.requests.mmo
-
The MMORoomSettings class is a container for the settings required to create an MMORoom using the CreateRoomRequest request.
- MMORoomSettings(String, Vec3D) - Constructor for class sfs3.client.requests.mmo.MMORoomSettings
-
Creates a new MMORoomSettings instance.
- MODERATOR - Static variable in class sfs3.client.entities.UserPrivileges
-
The moderator user can send dedicated "moderator messages", kick and ban users.
- MODERATOR_MESSAGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the current user receives a message from a moderator user.
- ModeratorMessage - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- ModeratorMessageRequest - Class in sfs3.client.requests
-
Sends a moderator message to a specific user or a group of users.
- ModeratorMessageRequest(String, MessageRecipientMode) - Constructor for class sfs3.client.requests.ModeratorMessageRequest
- ModeratorMessageRequest(String, MessageRecipientMode, ISFSObject) - Constructor for class sfs3.client.requests.ModeratorMessageRequest
-
Creates a new ModeratorMessageRequest instance.
- 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.
- MyBuddyVars - Static variable in class sfs3.client.core.EventParam
- myVariables - Variable in class sfs3.client.entities.managers.SFSBuddyManager
N
- name - Variable in class sfs3.client.entities.SFSBuddy
- name - Variable in class sfs3.client.entities.SFSRoom
- name - Variable in class sfs3.client.entities.SFSUser
- name - Variable in class sfs3.client.entities.variables.BaseVariable
- NAME - Static variable in class sfs3.client.entities.match.RoomProperties
-
The Room name.
- NAME - Static variable in class sfs3.client.entities.match.UserProperties
-
The user name.
- netDebugLevel - Variable in class sfs3.client.ConfigData
-
Debug settings to show more information about the data exchange between client and server OFF: no extra info logged PACKET: additional packet hex dump is logged PROTOCOL: as above, plus each request/response structure is also dumped
- 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
- 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.SFSObject
-
Static constructor, similar to new SFSObject();
- NewRooms - Static variable in class sfs3.client.core.EventParam
- 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 sfs3.client.entities.match.BoolMatch
-
An instance of BoolMatch representing the following condition: bool1 !
- NOT_EQUALS - Enum constant in enum class sfs3.client.entities.match.NumberMatch
-
An instance of NumberMatch representing the following condition: number1 !
- NOT_EQUALS - Enum constant in enum class sfs3.client.entities.match.StringMatch
-
An instance of StringMatch representing the following condition: string1 !
- NULL - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- NULL - Enum constant in enum class sfs3.client.entities.variables.VariableType
- NumberMatch - Enum Class in sfs3.client.entities.match
-
The NumberMatch class is used in matching expressions to check numeric conditions.
O
- OBJECT - Enum constant in enum class sfs3.client.entities.variables.VariableType
- OBJECT_MESSAGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an object containing custom data is received by the current user.
- ObjectMessage - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- ObjectMessageRequest - Class in sfs3.client.requests
-
Sends an object containing custom data to all users in a Room, or a subset of them.
- ObjectMessageRequest(ISFSObject) - Constructor for class sfs3.client.requests.ObjectMessageRequest
- ObjectMessageRequest(ISFSObject, Room) - Constructor for class sfs3.client.requests.ObjectMessageRequest
- ObjectMessageRequest(ISFSObject, Room, List<User>) - Constructor for class sfs3.client.requests.ObjectMessageRequest
-
Creates a new ObjectMessageRequest instance.
- OFFLINE_PREFIX - Static variable in class sfs3.client.entities.variables.SFSBuddyVariable
-
The prefix to be added to a Buddy Variable name to make it persistent.
- OldName - Static variable in class sfs3.client.core.EventParam
- or(String, IMatcher, Object) - Method in class sfs3.client.entities.match.MatchExpression
-
Concatenates the current expression with a new one using the logical OR operator.
- OR - Enum constant in enum class sfs3.client.entities.match.LogicOperator
-
An instance of LogicOperator representing the OR logical operator.
P
- parameters - Variable in class sfs3.client.entities.invitation.SFSInvitation
- PING_PONG - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a new lag value measurement is available.
- PingPong - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- PLAYER_TO_SPECTATOR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a player is turned to a spectator inside a Game Room.
- PLAYER_TO_SPECTATOR_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an error occurs while the current user is being turned from player to spectator in a Game Room.
- PlayerId - Static variable in class sfs3.client.core.EventParam
- playerIdByRoomId - Variable in class sfs3.client.entities.SFSUser
- PlayerToSpectator - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- PlayerToSpectatorRequest - Class in sfs3.client.requests
-
Turns the current user from player to spectator in a Game Room.
- PlayerToSpectatorRequest() - Constructor for class sfs3.client.requests.PlayerToSpectatorRequest
- PlayerToSpectatorRequest(Room) - Constructor for class sfs3.client.requests.PlayerToSpectatorRequest
-
Creates a new PlayerToSpectatorRequest instance.
- pollingRateMs - Variable in class sfs3.client.ConfigData.BlueBoxCfg
-
Adjusts the polling rate between "long polls".
- populateArrayWithValue(ISFSArray) - Method in class sfs3.client.entities.variables.BaseVariable
- port - Variable in class sfs3.client.ConfigData
-
The TCP port used for the connection
- PRIVATE_MESSAGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a private message is received by the current user.
- PrivateMessage - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- PrivateMessageRequest - Class in sfs3.client.requests
-
Sends a private chat message.
- PrivateMessageRequest(String, int) - Constructor for class sfs3.client.requests.PrivateMessageRequest
- PrivateMessageRequest(String, int, ISFSObject) - Constructor for class sfs3.client.requests.PrivateMessageRequest
-
Creates a new PrivateMessageRequest instance.
- PRIVILEGE_ID - Static variable in class sfs3.client.entities.match.UserProperties
-
The user privilege id.
- privilegeId - Variable in class sfs3.client.entities.SFSUser
- PROXIMITY_LIST_UPDATE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched to notify about Users and MMOItem changes in the players' AoI of a joined MMORoom, typically in response to a SetUserPositionRequest request.
- PUBLIC_MESSAGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a public message is received by the current user.
- PublicMessage - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- PublicMessageRequest - Class in sfs3.client.requests
-
Sends a public chat message.
- PublicMessageRequest(String) - Constructor for class sfs3.client.requests.PublicMessageRequest
- PublicMessageRequest(String, ISFSObject) - Constructor for class sfs3.client.requests.PublicMessageRequest
- PublicMessageRequest(String, ISFSObject, Room) - Constructor for class sfs3.client.requests.PublicMessageRequest
-
Creates a new PublicMessageRequest instance.
- 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
- QuickJoinGame - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- QuickJoinGameRequest - Class in sfs3.client.requests.game
-
Quickly joins the current user in a public game.
- QuickJoinGameRequest(MatchExpression, List<?>) - Constructor for class sfs3.client.requests.game.QuickJoinGameRequest
- QuickJoinGameRequest(MatchExpression, List<?>, Room) - Constructor for class sfs3.client.requests.game.QuickJoinGameRequest
-
Creates a new QuickJoinGameRequest instance.
- QuickJoinOrCreateRoom - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
R
- RECONNECTION_FAILURE - Static variable in class sfs3.client.util.ClientDisconnectionReason
-
The client reconnection system was not able to re-establish a connection to the server successfully.
- REFUSE - Enum constant in enum class sfs3.client.entities.invitation.InvitationReply
- removeAllEventListeners() - Method in interface sfs3.client.ISmartFox
- removeAllEventListeners() - Method in class sfs3.client.SmartFox
-
Used to clear all listeners previously added.
- RemoveBuddy - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- removeBuddyById(int) - Method in interface sfs3.client.entities.managers.IBuddyManager
- removeBuddyById(int) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- removeBuddyByName(String) - Method in interface sfs3.client.entities.managers.IBuddyManager
- removeBuddyByName(String) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- RemoveBuddyRequest - Class in sfs3.client.requests.buddylist
-
Removes a buddy from the current user's buddies list.
- RemoveBuddyRequest(String) - Constructor for class sfs3.client.requests.buddylist.RemoveBuddyRequest
-
Creates a new RemoveBuddyRequest instance.
- RemovedItems - Static variable in class sfs3.client.core.EventParam
- RemovedUsers - Static variable in class sfs3.client.core.EventParam
- 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
- removeEventListener(String, IEventListener) - Method in interface sfs3.client.ISmartFox
- removeEventListener(String, IEventListener) - Method in class sfs3.client.SmartFox
-
Used to remove a single event listeners that was previously added
- removeGroup(String) - Method in interface sfs3.client.entities.managers.IRoomManager
- removeGroup(String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- removeItem(int) - Method in class sfs3.client.entities.MMORoom
-
API internal usage only
- removePlayerId(Room) - Method in class sfs3.client.entities.SFSUser
- removePlayerId(Room) - Method in interface sfs3.client.entities.User
- removeRoom(Room) - Method in interface sfs3.client.entities.managers.IRoomManager
- removeRoom(Room) - Method in class sfs3.client.entities.managers.SFSRoomManager
- removeRoomById(int) - Method in interface sfs3.client.entities.managers.IRoomManager
- removeRoomById(int) - Method in class sfs3.client.entities.managers.SFSRoomManager
- removeRoomByName(String) - Method in interface sfs3.client.entities.managers.IRoomManager
- removeRoomByName(String) - Method in class sfs3.client.entities.managers.SFSRoomManager
- removeUser(User) - Method in interface sfs3.client.entities.managers.IRoomManager
- removeUser(User) - Method in interface sfs3.client.entities.managers.IUserManager
- removeUser(User) - Method in class sfs3.client.entities.managers.SFSRoomManager
- removeUser(User) - Method in class sfs3.client.entities.managers.SFSUserManager
- removeUser(User) - Method in interface sfs3.client.entities.Room
- removeUser(User) - Method in class sfs3.client.entities.SFSRoom
- removeUserById(int) - Method in interface sfs3.client.entities.managers.IUserManager
- removeUserById(int) - Method in class sfs3.client.entities.managers.SFSUserManager
- removeVariable(String) - Method in interface sfs3.client.entities.Buddy
- removeVariable(String) - Method in class sfs3.client.entities.SFSBuddy
- replaceVariables(List<UserVariable>) - Method in class sfs3.client.entities.SFSUser
- Reply - Static variable in class sfs3.client.core.EventParam
- ReservedBuddyVariables - Class in sfs3.client.entities.variables
-
The ReservedBuddyVariables class contains the constants describing the SmartFoxServer API reserved Buddy Variable names.
- ReservedBuddyVariables() - Constructor for class sfs3.client.entities.variables.ReservedBuddyVariables
- ReservedRoomVariables - Class in sfs3.client.entities.variables
-
The ReservedRoomVariables class contains the constants describing the SmartFoxServer API reserved Room Variable names.
- ReservedRoomVariables() - Constructor for class sfs3.client.entities.variables.ReservedRoomVariables
- rewind() - Method in class sfs3.client.entities.match.MatchExpression
-
Moves the iterator cursor to the first matching expression in the chain.
- Room - Interface in sfs3.client.entities
-
In the SmartFoxServer 3 client API this interface is implemented by the SFSRoom class.
- Room - Static variable in class sfs3.client.core.EventParam
- ROOM_ADD - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a new Room is created inside the Zone under any of the Room Groups that the client is subscribed to.
- ROOM_CAPACITY_CHANGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the capacity of a Room is changed.
- ROOM_CAPACITY_CHANGE_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an error occurs while attempting to change the capacity of a Room.
- ROOM_CREATION_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched if an error occurs while creating a new Room.
- ROOM_FIND_RESULT - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a Rooms search is completed.
- ROOM_GROUP_SUBSCRIBE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a Room Group is subscribed by the current user.
- ROOM_GROUP_SUBSCRIBE_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
This event is fired in response to the SubscribeRoomGroupRequest request in case the operation failed.
- ROOM_GROUP_UNSUBSCRIBE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a Group is unsubscribed by the current user.
- ROOM_GROUP_UNSUBSCRIBE_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
This event is fired in response to the UnsubscribeRoomGroupRequest request in case the operation failed.
- ROOM_JOIN - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a Room is joined by the current user.
- ROOM_JOIN_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an error occurs while the current user is trying to join a Room.
- ROOM_NAME_CHANGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the name of a Room is changed.
- ROOM_NAME_CHANGE_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an error occurs while attempting to change the name of a Room.
- ROOM_PASSWORD_STATE_CHANGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the password of a Room is set, changed or removed.
- ROOM_PASSWORD_STATE_CHANGE_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an error occurs while attempting to set, change or remove the password of a Room.
- ROOM_REMOVE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a Room belonging to one of the Groups subscribed by the client is removed from the Zone.
- ROOM_VARIABLES_UPDATE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a Room Variable is updated.
- RoomEvents - Class in sfs3.client.requests
-
The RoomEvents class contains a specific subset of the RoomSettings required to create a Room.
- RoomEvents() - Constructor for class sfs3.client.requests.RoomEvents
-
Creates a new RoomEvents instance.
- RoomExtension - Class in sfs3.client.requests
-
The RoomExtension class contains a specific subset of the RoomSettings required to create a Room.
- RoomExtension(String, String) - Constructor for class sfs3.client.requests.RoomExtension
-
Creates a new RoomExtension instance.
- RoomId - Static variable in class sfs3.client.core.EventParam
- RoomList - Static variable in class sfs3.client.core.EventParam
- roomManager - Variable in class sfs3.client.entities.SFSRoom
- RoomPermissions - Class in sfs3.client.requests
-
The RoomPermissions class contains a specific subset of the RoomSettings required to create a Room.
- RoomPermissions() - Constructor for class sfs3.client.requests.RoomPermissions
-
Creates a new RoomPermissions instance.
- RoomProperties - Class in sfs3.client.entities.match
-
The RoomProperties class contains the names of predefined properties that can be used in matching expressions to search/filter Rooms.
- RoomSettings - Class in sfs3.client.requests
-
The RoomSettings class is a container for the settings required to create a Room using the CreateRoomRequest request.
- RoomSettings(String) - Constructor for class sfs3.client.requests.RoomSettings
-
Creates a new RoomSettings instance.
- RoomVariable - Interface in sfs3.client.entities.variables
-
The RoomVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Room Variable exposes.
- 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.
- RV_GAME_STARTED - Static variable in class sfs3.client.entities.variables.ReservedRoomVariables
-
The Room Variable with this name keeps track of the state (started or stopped) of a game created with the CreateSFSGameRequest request.
S
- scheduler - Variable in class sfs3.client.SmartFox
- secondsForAnswer - Variable in class sfs3.client.entities.invitation.SFSInvitation
- send(IClientRequest) - Method in interface sfs3.client.ISmartFox
- send(IClientRequest) - Method in class sfs3.client.SmartFox
-
Sends a request to the server.
- Sender - Static variable in class sfs3.client.core.EventParam
- setAllowNameChange(boolean) - Method in class sfs3.client.requests.RoomPermissions
- setAllowOwnerOnlyInvitation(boolean) - Method in class sfs3.client.requests.RoomSettings
-
Specifies if the Room allows "Join Room" Invitations sent by any User or just by its owner
- setAllowPasswordStateChange(boolean) - Method in class sfs3.client.requests.RoomPermissions
- setAllowPublicMessages(boolean) - Method in class sfs3.client.requests.RoomPermissions
- setAllowResizing(boolean) - Method in class sfs3.client.requests.RoomPermissions
- setAllowUserCountChange(boolean) - Method in class sfs3.client.requests.RoomEvents
- setAllowUserEnter(boolean) - Method in class sfs3.client.requests.RoomEvents
- setAllowUserExit(boolean) - Method in class sfs3.client.requests.RoomEvents
- setAllowUserVariablesUpdate(boolean) - Method in class sfs3.client.requests.RoomEvents
- setAOIEntryPoint(Vec3D) - Method in class sfs3.client.entities.MMOItem
- setAOIEntryPoint(Vec3D) - Method in class sfs3.client.entities.SFSUser
- setAOIEntryPoint(Vec3D) - Method in interface sfs3.client.entities.User
- setAudioStreamingAllowed(boolean) - Method in interface sfs3.client.entities.Room
- setAudioStreamingAllowed(boolean) - Method in class sfs3.client.entities.SFSRoom
- setBlocked(boolean) - Method in interface sfs3.client.entities.Buddy
- setBlocked(boolean) - Method in class sfs3.client.entities.SFSBuddy
- setBuddyStates(List<String>) - Method in interface sfs3.client.entities.managers.IBuddyManager
- setBuddyStates(List<String>) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- SetBuddyVariables - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- SetBuddyVariablesRequest - Class in sfs3.client.requests.buddylist
-
Sets one or more Buddy Variables for the current user.
- SetBuddyVariablesRequest(List<BuddyVariable>) - Constructor for class sfs3.client.requests.buddylist.SetBuddyVariablesRequest
-
Creates a new SetBuddyVariablesRequest instance.
- setClientDetails(String, String) - Method in interface sfs3.client.ISmartFox
- setClientDetails(String, String) - Method in class sfs3.client.SmartFox
-
Allows to specify custom client details that will be used to gather statistics about the client platform via the SmartFox Analytics Module.
- setDefaultAOI(Vec3D) - Method in class sfs3.client.entities.MMORoom
-
API internal usage only
- setDefaultAOI(Vec3D) - Method in class sfs3.client.requests.mmo.MMORoomSettings
- setErrorMessage(short, String) - Static method in class sfs3.client.util.SFSErrorCodes
-
Sets the text of the error message corresponding to the passed error code.
- setEvents(RoomEvents) - Method in class sfs3.client.requests.RoomSettings
- setExecutor(ExecutorService) - Method in interface sfs3.client.ISmartFox
- setExecutor(ExecutorService) - Method in class sfs3.client.SmartFox
- setExtension(RoomExtension) - Method in class sfs3.client.requests.RoomSettings
- setGame(boolean) - Method in interface sfs3.client.entities.Room
- setGame(boolean) - Method in class sfs3.client.entities.SFSRoom
- setGame(boolean) - Method in class sfs3.client.requests.RoomSettings
- setGroupId(String) - Method in class sfs3.client.requests.RoomSettings
- setHidden(boolean) - Method in interface sfs3.client.entities.Room
- setHidden(boolean) - Method in class sfs3.client.entities.SFSRoom
- setHigherMapLimit(Vec3D) - Method in class sfs3.client.entities.MMORoom
-
API internal usage only
- setId(int) - Method in interface sfs3.client.entities.Buddy
- setId(int) - Method in interface sfs3.client.entities.invitation.Invitation
- setId(int) - Method in class sfs3.client.entities.invitation.SFSInvitation
- setId(int) - Method in class sfs3.client.entities.SFSBuddy
- setId(int) - Method in class sfs3.client.requests.BaseRequest
- setInited(boolean) - Method in interface sfs3.client.entities.managers.IBuddyManager
- setInited(boolean) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- setInvitationExpiryTime(int) - Method in class sfs3.client.requests.game.SFSGameSettings
- setInvitationParams(ISFSObject) - Method in class sfs3.client.requests.game.SFSGameSettings
- setInvitedPlayers(List<?>) - Method in class sfs3.client.requests.game.SFSGameSettings
- setJoined(boolean) - Method in interface sfs3.client.entities.Room
- setJoined(boolean) - Method in class sfs3.client.entities.SFSRoom
- setJoining(boolean) - Method in interface sfs3.client.ISmartFox
- setJoining(boolean) - Method in class sfs3.client.SmartFox
- setLastJoinedRoom(Room) - Method in interface sfs3.client.ISmartFox
- setLastJoinedRoom(Room) - Method in class sfs3.client.SmartFox
- setLeaveLastJoinedRoom(boolean) - Method in class sfs3.client.requests.game.SFSGameSettings
- setLowerMapLimit(Vec3D) - Method in class sfs3.client.entities.MMORoom
-
API internal usage only
- setManaged(boolean) - Method in interface sfs3.client.entities.Room
- setManaged(boolean) - Method in class sfs3.client.entities.SFSRoom
- setMapLimits(MapLimits) - Method in class sfs3.client.requests.mmo.MMORoomSettings
- setMaxSpectators(int) - Method in interface sfs3.client.entities.Room
- setMaxSpectators(int) - Method in class sfs3.client.entities.SFSRoom
- setMaxSpectators(int) - Method in class sfs3.client.requests.RoomSettings
- setMaxUsers(int) - Method in interface sfs3.client.entities.Room
- setMaxUsers(int) - Method in class sfs3.client.entities.SFSRoom
- setMaxUsers(int) - Method in class sfs3.client.requests.RoomSettings
- setMaxVariables(int) - Method in class sfs3.client.requests.RoomSettings
- setMinPlayersToStartGame(int) - Method in class sfs3.client.requests.game.SFSGameSettings
- SetMMOItemVariables - Class in sfs3.client.requests.mmo
-
USED FOR CONSTANTS ONLY
- SetMMOItemVariables() - Constructor for class sfs3.client.requests.mmo.SetMMOItemVariables
- setMyNickName(String) - Method in interface sfs3.client.entities.managers.IBuddyManager
- setMyNickName(String) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- setMyOnlineState(boolean) - Method in interface sfs3.client.entities.managers.IBuddyManager
- setMyOnlineState(boolean) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- setMySelf(User) - Method in interface sfs3.client.ISmartFox
- setMySelf(User) - Method in class sfs3.client.SmartFox
- setMyState(String) - Method in interface sfs3.client.entities.managers.IBuddyManager
- setMyState(String) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- setMyVariable(BuddyVariable) - Method in interface sfs3.client.entities.managers.IBuddyManager
- setMyVariable(BuddyVariable) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- setMyVariables(List<BuddyVariable>) - Method in interface sfs3.client.entities.managers.IBuddyManager
- setMyVariables(List<BuddyVariable>) - Method in class sfs3.client.entities.managers.SFSBuddyManager
- setName(String) - Method in interface sfs3.client.entities.Room
- setName(String) - Method in class sfs3.client.entities.SFSRoom
- setName(String) - Method in class sfs3.client.requests.RoomSettings
- setNodeId(String) - Method in interface sfs3.client.ISmartFox
- setNodeId(String) - Method in class sfs3.client.SmartFox
- setNotifyGameStarted(boolean) - Method in class sfs3.client.requests.game.SFSGameSettings
- setParams(Map<String, Object>) - Method in class sfs3.client.core.ApiEvent
- setPassword(String) - Method in class sfs3.client.requests.RoomSettings
- setPasswordProtected(boolean) - Method in interface sfs3.client.entities.Room
- setPasswordProtected(boolean) - Method in class sfs3.client.entities.SFSRoom
- setPermissions(RoomPermissions) - Method in class sfs3.client.requests.RoomSettings
- setPersistent(boolean) - Method in interface sfs3.client.entities.variables.RoomVariable
- setPersistent(boolean) - Method in class sfs3.client.entities.variables.SFSRoomVariable
- setPlayerId(int, Room) - Method in class sfs3.client.entities.SFSUser
- setPlayerId(int, Room) - Method in interface sfs3.client.entities.User
- setPlayerMatchExpression(MatchExpression) - Method in class sfs3.client.requests.game.SFSGameSettings
- setPrivate(boolean) - Method in interface sfs3.client.entities.variables.RoomVariable
- setPrivate(boolean) - Method in class sfs3.client.entities.variables.SFSRoomVariable
- setPrivate(boolean) - Method in class sfs3.client.entities.variables.SFSUserVariable
- setPrivate(boolean) - Method in interface sfs3.client.entities.variables.UserVariable
- setPrivilegeId(int) - Method in class sfs3.client.entities.SFSUser
- setPrivilegeId(int) - Method in interface sfs3.client.entities.User
- setPropertiesFile(String) - Method in class sfs3.client.requests.RoomExtension
- setProximityListUpdateMillis(int) - Method in class sfs3.client.requests.mmo.MMORoomSettings
- setPublic(boolean) - Method in class sfs3.client.requests.game.SFSGameSettings
- setReconnectionSeconds(int) - Method in interface sfs3.client.ISmartFox
- setReconnectionSeconds(int) - Method in class sfs3.client.SmartFox
- setRoomManager(IRoomManager) - Method in interface sfs3.client.entities.Room
- setRoomManager(IRoomManager) - Method in class sfs3.client.entities.SFSRoom
- SetRoomVariables - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- SetRoomVariablesRequest - Class in sfs3.client.requests
-
Sets one or more custom Room Variables in a Room.
- SetRoomVariablesRequest(List<RoomVariable>) - Constructor for class sfs3.client.requests.SetRoomVariablesRequest
- SetRoomVariablesRequest(List<RoomVariable>, Room) - Constructor for class sfs3.client.requests.SetRoomVariablesRequest
-
Creates a new SetRoomVariablesRequest instance.
- setSearchableRooms(List<String>) - Method in class sfs3.client.requests.game.SFSGameSettings
- setSendAOIEntryPoint(boolean) - Method in class sfs3.client.requests.mmo.MMORoomSettings
- setSpectatorCount(int) - Method in interface sfs3.client.entities.Room
- setSpectatorCount(int) - Method in class sfs3.client.entities.SFSRoom
- setSpectatorMatchExpression(MatchExpression) - Method in class sfs3.client.requests.game.SFSGameSettings
- setTarget(Object) - Method in class sfs3.client.core.ApiEvent
- setTargetController(int) - Method in class sfs3.client.requests.BaseRequest
- setTransportType(TransportType) - Method in class sfs3.client.requests.BaseRequest
- setUserCount(int) - Method in interface sfs3.client.entities.Room
- setUserCount(int) - Method in class sfs3.client.entities.SFSRoom
- setUserManager(IUserManager) - Method in class sfs3.client.entities.SFSUser
- setUserManager(IUserManager) - Method in interface sfs3.client.entities.User
- setUserMaxLimboSeconds(int) - Method in class sfs3.client.requests.mmo.MMORoomSettings
- SetUserPosition - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- SetUserPositionRequest - Class in sfs3.client.requests.mmo
-
Updates the User position inside an MMORoom.
- SetUserPositionRequest(Vec3D, Room) - Constructor for class sfs3.client.requests.mmo.SetUserPositionRequest
-
Creates a new SetUserPositionRequest instance.
- SetUserVariables - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- SetUserVariablesRequest - Class in sfs3.client.requests
-
Sets one or more custom User Variables for the current user.
- SetUserVariablesRequest(List<UserVariable>) - Constructor for class sfs3.client.requests.SetUserVariablesRequest
-
Creates a new SetUserVariablesRequest instance.
- setValue(Object) - Method in class sfs3.client.entities.variables.BaseVariable
- setVariable(BuddyVariable) - Method in interface sfs3.client.entities.Buddy
- setVariable(BuddyVariable) - Method in class sfs3.client.entities.SFSBuddy
- setVariable(IMMOItemVariable) - Method in interface sfs3.client.entities.IMMOItem
-
private
- setVariable(IMMOItemVariable) - Method in class sfs3.client.entities.MMOItem
-
private
- setVariable(RoomVariable) - Method in interface sfs3.client.entities.Room
- setVariable(RoomVariable) - Method in class sfs3.client.entities.SFSRoom
- setVariable(UserVariable) - Method in class sfs3.client.entities.SFSUser
- setVariable(UserVariable) - Method in interface sfs3.client.entities.User
- setVariables(List<? extends RoomVariable>) - Method in interface sfs3.client.entities.Room
- setVariables(List<? extends RoomVariable>) - Method in class sfs3.client.entities.SFSRoom
- setVariables(List<? extends UserVariable>) - Method in class sfs3.client.entities.SFSUser
- setVariables(List<? extends UserVariable>) - Method in interface sfs3.client.entities.User
- setVariables(List<BuddyVariable>) - Method in interface sfs3.client.entities.Buddy
- setVariables(List<BuddyVariable>) - Method in class sfs3.client.entities.SFSBuddy
- setVariables(List<IMMOItemVariable>) - Method in interface sfs3.client.entities.IMMOItem
-
private
- setVariables(List<IMMOItemVariable>) - Method in class sfs3.client.entities.MMOItem
-
private
- setVariables(List<RoomVariable>) - Method in class sfs3.client.requests.RoomSettings
- 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.client - package sfs3.client
- 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
- SFSBuddy - Class in sfs3.client.entities
-
The SFSBuddy object represents a buddy in the current user's buddy list.
- SFSBuddy(int, String) - Constructor for class sfs3.client.entities.SFSBuddy
- SFSBuddy(int, String, boolean) - Constructor for class sfs3.client.entities.SFSBuddy
- SFSBuddy(int, String, boolean, boolean) - Constructor for class sfs3.client.entities.SFSBuddy
-
Creates a new SFSBuddy instance.
- SFSBuddyEvent - Class in sfs3.client.core
-
SFSBuddyEvent is the class representing all the events related to the Buddy List system dispatched by the SmartFoxServer 3 Java client API.
- SFSBuddyEvent(String) - Constructor for class sfs3.client.core.SFSBuddyEvent
- SFSBuddyEvent(String, Map<String, Object>) - Constructor for class sfs3.client.core.SFSBuddyEvent
-
Creates a new SFSBuddyEvent instance.
- SFSBuddyManager - Class in sfs3.client.entities.managers
-
The SFSBuddyManager class is the entity in charge of managing the current user's Buddy List system.
- SFSBuddyManager(ISmartFox) - Constructor for class sfs3.client.entities.managers.SFSBuddyManager
-
Creates a new SFSBuddyManager instance.
- SFSBuddyVariable - Class in sfs3.client.entities.variables
-
The SFSBuddyVariable is a custom value attached to a Buddy object in a Buddy List which is automatically synchronized between client and server on every change.
- SFSBuddyVariable(String, Object) - Constructor for class sfs3.client.entities.variables.SFSBuddyVariable
-
Creates a new Buddy Variable
- SFSBuddyVariable(String, Object, VariableType) - Constructor for class sfs3.client.entities.variables.SFSBuddyVariable
-
Types are normally auto-detected.
- 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
- 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
- SFSErrorCodes - Class in sfs3.client.util
-
The SFSErrorCodes class provides a mean of translation between server error codes and their relative error messages.
- SFSErrorCodes() - Constructor for class sfs3.client.util.SFSErrorCodes
- SFSEvent - Class in sfs3.client.core
-
SFSEvent is the class representing most of the events dispatched by the SmartFoxServer 3 Java client API.
- SFSEvent(String) - Constructor for class sfs3.client.core.SFSEvent
- SFSEvent(String, Map<String, Object>) - Constructor for class sfs3.client.core.SFSEvent
-
Creates a new SFSEvent instance.
- 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
- SFSGameSettings - Class in sfs3.client.requests.game
-
The SFSGameSettings class is a container for the settings required to create a Game Room using the CreateSFSGameRequest request.
- SFSGameSettings(String) - Constructor for class sfs3.client.requests.game.SFSGameSettings
-
Creates a new SFSGameSettings instance.
- SFSInvitation - Class in sfs3.client.entities.invitation
-
The SFSInvitation object contains all the informations about an invitation received by the current user.
- SFSInvitation(User, User) - Constructor for class sfs3.client.entities.invitation.SFSInvitation
- SFSInvitation(User, User, int) - Constructor for class sfs3.client.entities.invitation.SFSInvitation
- SFSInvitation(User, User, int, ISFSObject) - Constructor for class sfs3.client.entities.invitation.SFSInvitation
-
Creates a new SFSInvitation instance.
- sfso - Variable in class sfs3.client.requests.BaseRequest
-
*Private*
- SFSObject - Class in com.smartfoxserver.entities.data
- SFSObject() - Constructor for class com.smartfoxserver.entities.data.SFSObject
- SFSRoom - Class in sfs3.client.entities
-
The SFSRoom object represents a SmartFoxServer Room on the client.
- SFSRoom(int, String) - Constructor for class sfs3.client.entities.SFSRoom
- SFSRoom(int, String, String) - Constructor for class sfs3.client.entities.SFSRoom
-
NOTE: never instantiate a SFSRoom manually: this is done by the SmartFoxServer 3 API internally.
- SFSRoomManager - Class in sfs3.client.entities.managers
-
The SFSRoomManager class is the entity in charge of managing the client-side Rooms list.
- SFSRoomManager(ISmartFox) - Constructor for class sfs3.client.entities.managers.SFSRoomManager
-
Creates a new SFSRoomManager instance.
- SFSRoomVariable - Class in sfs3.client.entities.variables
-
The SFSRoomVariable is a custom value attached to a Room object that is automatically synchronized between client and server on every change.
- SFSRoomVariable(String, Object) - Constructor for class sfs3.client.entities.variables.SFSRoomVariable
-
Creates a new Room Variable
- SFSRoomVariable(String, Object, VariableType) - Constructor for class sfs3.client.entities.variables.SFSRoomVariable
-
Types are normally auto-detected.
- 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
- SFSUser - Class in sfs3.client.entities
-
The SFSUser object represents a client logged in SmartFoxServer.
- SFSUser(int, String) - Constructor for class sfs3.client.entities.SFSUser
- SFSUser(int, String, boolean) - Constructor for class sfs3.client.entities.SFSUser
-
Creates a new SFSUser instance.
- SFSUserManager - Class in sfs3.client.entities.managers
-
The SFSUserManager class is the entity in charge of managing the local (client-side) users list.
- SFSUserManager(ISmartFox) - Constructor for class sfs3.client.entities.managers.SFSUserManager
-
Creates a new SFSUserManager instance.
- SFSUserVariable - Class in sfs3.client.entities.variables
-
The SFSUserVariable is a custom value attached to a User object that gets automatically synchronized between clients and the server on every change.
- SFSUserVariable(String, Object) - Constructor for class sfs3.client.entities.variables.SFSUserVariable
-
Creates a new SFSUserVariable instance.
- SFSUserVariable(String, Object, VariableType) - Constructor for class sfs3.client.entities.variables.SFSUserVariable
-
Typically types are auto detected: see
SFSUserVariable(String, Object) - SFSValidationException - Exception Class in sfs3.client
- SFSValidationException(String, List<String>) - Constructor for exception class sfs3.client.SFSValidationException
- 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
- SHORT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- SHORT - Enum constant in enum class sfs3.client.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
- 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
- smartFox - Variable in class sfs3.client.entities.managers.SFSRoomManager
- smartFox - Variable in class sfs3.client.entities.managers.SFSUserManager
- SmartFox - Class in sfs3.client
-
The main class of the SmartFoxServer 3 API: it is responsible for connecting the client to a SmartFoxServer instance and dispatching all asynchronous events.
- SmartFox() - Constructor for class sfs3.client.SmartFox
- specCount - Variable in class sfs3.client.entities.SFSRoom
- SpecCount - Static variable in class sfs3.client.core.EventParam
- SPECTATOR_COUNT - Static variable in class sfs3.client.entities.match.RoomProperties
-
The Room spectators count (Game Rooms only).
- SPECTATOR_TO_PLAYER - Static variable in class sfs3.client.core.SFSEvent
-
This event is fired in response to the SpectatorToPlayerRequest request if the operation is executed successfully.
- SPECTATOR_TO_PLAYER_ERROR - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an error occurs while the current user is being turned from spectator to player in a Game Room.
- SpectatorToPlayer - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- SpectatorToPlayerRequest - Class in sfs3.client.requests
-
Turns the current user from spectator to player in a Game Room.
- SpectatorToPlayerRequest() - Constructor for class sfs3.client.requests.SpectatorToPlayerRequest
- SpectatorToPlayerRequest(Room) - Constructor for class sfs3.client.requests.SpectatorToPlayerRequest
-
Creates a new SpectatorToPlayerRequest instance.
- STANDARD - Static variable in class sfs3.client.entities.UserPrivileges
-
The standard user is usually registered in the application custom login system; uses a unique name and password to login.
- STARTS_WITH - Enum constant in enum class sfs3.client.entities.match.StringMatch
-
An instance of StringMatch representing the following condition: string1 starts with characters contained in string2.
- stopExecutors() - Method in class sfs3.client.SmartFox
- STRING - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- STRING - Enum constant in enum class sfs3.client.entities.variables.VariableType
- STRING_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- StringMatch - Enum Class in sfs3.client.entities.match
-
The StringMatch class is used in matching expressions 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.
- SubscribeRoomGroup - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- SubscribeRoomGroupRequest - Class in sfs3.client.requests
-
Subscribes the current user to Room-related events occurring in the specified Group.
- SubscribeRoomGroupRequest(String) - Constructor for class sfs3.client.requests.SubscribeRoomGroupRequest
-
Creates a new SubscribeRoomGroupRequest instance.
- Success - Static variable in class sfs3.client.core.EventParam
- 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.
T
- target - Variable in class sfs3.client.core.ApiEvent
- targetController - Variable in class sfs3.client.requests.BaseRequest
-
*Private*
- TCP - Enum constant in enum class sfs3.client.bitswarm.TransportType
-
Standard TCP transport
- tcpConnectionTimeout - Variable in class sfs3.client.ConfigData
-
The amount of time (in milliseconds) after which the client should give up if there's no response from the server side
- TEXT - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- TO_GROUP - Static variable in class sfs3.client.requests.MessageRecipientMode
-
The moderator/administrator message will be sent to all the clients who subscribed a specific Room Group.
- TO_ROOM - Static variable in class sfs3.client.requests.MessageRecipientMode
-
The moderator/administrator message will be sent to all the users in a specific Room.
- TO_USER - Static variable in class sfs3.client.requests.MessageRecipientMode
-
The moderator/administrator message will be sent to a specific user.
- TO_ZONE - Static variable in class sfs3.client.requests.MessageRecipientMode
-
The moderator/administrator message will be sent to all the users in the Zone.
- 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 sfs3.client.entities.data.Vec3D
-
private
- toIntArray() - Method in class sfs3.client.entities.data.Vec3D
-
private
- 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
- toRdpMode(TransportType) - Static method in enum class sfs3.client.bitswarm.TransportType
- toSFSArray() - Method in class sfs3.client.entities.match.MatchExpression
- toSFSArray() - Method in class sfs3.client.entities.variables.BaseVariable
- toSFSArray() - Method in class sfs3.client.entities.variables.SFSRoomVariable
- toSFSArray() - Method in class sfs3.client.entities.variables.SFSUserVariable
-
Private
- toSFSArray() - Method in interface sfs3.client.entities.variables.Variable
-
Private
- 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 sfs3.client.core.ApiEvent
-
Generates a string containing all the properties of the BaseEvent object.
- toString() - Method in class sfs3.client.entities.data.Vec3D
- toString() - Method in class sfs3.client.entities.invitation.SFSInvitation
- toString() - Method in class sfs3.client.entities.match.MatchExpression
-
Returns a string representation of the matching expression.
- toString() - Method in class sfs3.client.entities.MMOItem
- toString() - Method in class sfs3.client.entities.SFSBuddy
-
Returns a string that contains the buddy name and id.
- toString() - Method in class sfs3.client.entities.SFSRoom
-
Returns a string that contains the Room id, name and id of the Group to which it belongs.
- toString() - Method in class sfs3.client.entities.SFSUser
-
Returns a string that contains the user id, name and a boolean indicating if the SFSUser object represents the current client.
- toString() - Method in class sfs3.client.entities.variables.BaseVariable
- toString() - Method in class sfs3.client.entities.variables.SFSBuddyVariable
-
Returns a string that contains the Buddy Variable name, type and value.
- toString() - Method in class sfs3.client.entities.variables.SFSRoomVariable
-
Returns a string that contains the Room Variable name, type, value and isPrivate flag.
- toString() - Method in class sfs3.client.entities.variables.SFSUserVariable
- TransportType - Enum Class in sfs3.client.bitswarm
- TxType - Static variable in class sfs3.client.core.EventParam
- type - Variable in class sfs3.client.core.ApiEvent
- type - Variable in class sfs3.client.entities.variables.BaseVariable
U
- UDP - Enum constant in enum class sfs3.client.bitswarm.TransportType
-
Standard unreliable/unordered UDP transport
- UDP_CONNECTION - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the result of the UDP handshake is notified.
- UDP_CONNECTION_LOST - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when an active UDP connection is lost.
- UDP_RELIABLE - Enum constant in enum class sfs3.client.bitswarm.TransportType
-
Ordered + reliable UDP transport
- UDP_TIMEOUT - Static variable in class sfs3.client.util.ClientDisconnectionReason
-
The client did not send data for a while and got disconnected.
- UDP_UNRELIABLE - Enum constant in enum class sfs3.client.bitswarm.TransportType
-
Ordered + unreliable UDP transport
- UdpInit - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- udpPort - Variable in class sfs3.client.ConfigData
-
The UDP port used for a UDP connection
- UNKNOWN - Static variable in class sfs3.client.util.ClientDisconnectionReason
-
A generic network error occurred, and the client is unable to determine the cause of the disconnection.
- UNSTABLE_UDP_CONNECTION - Static variable in class sfs3.client.util.ClientDisconnectionReason
-
The client is loosing too many packets and the RDP config does not handle packet loss.
- UnsubscribeRoomGroup - Static variable in class sfs3.client.requests.BaseRequest
-
*Private*
- UnsubscribeRoomGroupRequest - Class in sfs3.client.requests
-
Unsubscribes the current user to Room-related events occurring in the specified Group.
- UnsubscribeRoomGroupRequest(String) - Constructor for class sfs3.client.requests.UnsubscribeRoomGroupRequest
-
Creates a new UnsubscribeRoomGroupRequest instance.
- updateRoomList(ISFSArray) - Method in interface sfs3.client.entities.managers.IRoomManager
- updateRoomList(ISFSArray) - Method in class sfs3.client.entities.managers.SFSRoomManager
- User - Interface in sfs3.client.entities
-
In the SmartFoxServer 3 API this interface is implemented by the SFSUser class.
- User - Static variable in class sfs3.client.core.EventParam
- USER_COUNT - Static variable in class sfs3.client.entities.match.RoomProperties
-
The Room users count (players in Game Rooms).
- USER_COUNT_CHANGE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when the number of users/players or spectators inside a Room changes.
- USER_ENTER_ROOM - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when one of the Rooms joined by the current user is entered by another user.
- USER_EXIT_ROOM - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when one of the Rooms joined by the current user is left by another user, or by the current user himself.
- USER_FIND_RESULT - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a Users search is completed.
- USER_VARIABLES_UPDATE - Static variable in class sfs3.client.core.SFSEvent
-
Dispatched when a User Variable is updated.
- userCount - Variable in class sfs3.client.entities.SFSRoom
- UserCount - Static variable in class sfs3.client.core.EventParam
- UserList - Static variable in class sfs3.client.core.EventParam
- userManager - Variable in class sfs3.client.entities.SFSRoom
- userManager - Variable in class sfs3.client.entities.SFSUser
- UserPrivileges - Class in sfs3.client.entities
-
The UserPrivileges class contains the constants describing the default user types known by SmartFoxServer.
- UserPrivileges() - Constructor for class sfs3.client.entities.UserPrivileges
- UserProperties - Class in sfs3.client.entities.match
-
The UserProperties class contains the names of predefined properties that can be used in matching expressions to search/filter users.
- UserVariable - Interface in sfs3.client.entities.variables
-
The UserVariable interface defines all the public methods and properties that an object representing a SmartFoxServer User Variable exposes.
- useSSL - Variable in class sfs3.client.ConfigData
-
Enables protocol encryption.
- useTcpFallback - Variable in class sfs3.client.ConfigData
-
When sending data via UDP, if the UDP connection failed, it will use TCP instead
- useTcpNoDelay - Variable in class sfs3.client.ConfigData
-
Toggles the Nagle algorithm for the TCP connection More on this here: https://en.wikipedia.org/wiki/Nagle's_algorithm
V
- val - Variable in class sfs3.client.entities.variables.BaseVariable
- validate(ISmartFox) - Method in class sfs3.client.requests.BanUserRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.buddylist.AddBuddyRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.buddylist.BlockBuddyRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.buddylist.GoOnlineRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.buddylist.InitBuddyListRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.buddylist.RemoveBuddyRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.buddylist.SetBuddyVariablesRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.ChangeRoomCapacityRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.ChangeRoomNameRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.ChangeRoomPasswordStateRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.CreateRoomRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.ExtensionRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.FindRoomsRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.FindUsersRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.game.CreateSFSGameRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.game.QuickJoinGameRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.invitation.InvitationReplyRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.invitation.InviteUsersRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.invitation.JoinRoomInvitationRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.JoinRoomRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.KickUserRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.LeaveRoomRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.LoginRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.LogoutRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.mmo.SetUserPositionRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.PlayerToSpectatorRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.SetRoomVariablesRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.SetUserVariablesRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.SpectatorToPlayerRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.SubscribeRoomGroupRequest
- validate(ISmartFox) - Method in class sfs3.client.requests.UnsubscribeRoomGroupRequest
- 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 sfs3.client.bitswarm.TransportType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class sfs3.client.entities.invitation.InvitationReply
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class sfs3.client.entities.match.BoolMatch
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class sfs3.client.entities.match.LogicOperator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class sfs3.client.entities.match.NumberMatch
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class sfs3.client.entities.match.StringMatch
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class sfs3.client.entities.variables.VariableType
-
Returns the enum constant of this class with the specified name.
- 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 sfs3.client.bitswarm.TransportType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class sfs3.client.entities.invitation.InvitationReply
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class sfs3.client.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 sfs3.client.entities.match.LogicOperator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class sfs3.client.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 sfs3.client.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 sfs3.client.entities.variables.VariableType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- Variable - Interface in sfs3.client.entities.variables
-
Interface for all variable types in the API.
- variables - Variable in class sfs3.client.entities.SFSBuddy
- variables - Variable in class sfs3.client.entities.SFSRoom
- variables - Variable in class sfs3.client.entities.SFSUser
- VariableType - Enum Class in sfs3.client.entities.variables
-
The VariableType class contains the constants defining the valid types of User, Buddy and Room Variables to be passed to their constructors.
- Vec3D - Class in sfs3.client.entities.data
-
A vector 3D class used for defining coordinates in the MMORoom virtual world.
- Vec3D(float, float) - Constructor for class sfs3.client.entities.data.Vec3D
-
Constructor for float-based 2D coordinates
- Vec3D(float, float, float) - Constructor for class sfs3.client.entities.data.Vec3D
-
Constructor for float-based 3D coordinates
- Vec3D(int, int) - Constructor for class sfs3.client.entities.data.Vec3D
-
Constructor for integer-based 2D coordinates
- Vec3D(int, int, int) - Constructor for class sfs3.client.entities.data.Vec3D
-
Constructor for integer-based 3D coordinates
- VECTOR2 - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
- VECTOR2 - Enum constant in enum class sfs3.client.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 sfs3.client.entities.variables.VariableType
- VECTOR3_ARRAY - Enum constant in enum class com.smartfoxserver.entities.data.SFSDataType
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 sfs3.client.ConfigData
-
The name of the Zone to connect to
- ZoneName - Static variable in class sfs3.client.core.EventParam
_
- _isPrivate - Variable in class sfs3.client.entities.variables.SFSUserVariable
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form