All Classes Interface Summary Class Summary Enum Summary
| Class |
Description |
| AddBuddyRequest |
Adds a new buddy to the current user's buddies list.
|
| AdminMessageRequest |
Sends an administrator message to a specific user or a group of users.
|
| BanMode |
The BanMode class contains the constants describing the possible banning modalities for a BanUserRequest.
|
| BanUserRequest |
Banishes a user from the server.
|
| BaseEvent |
This is the base class of all the events dispatched by the SmartFoxServer 2X Java Client API.
|
| BaseRequest |
|
| BaseVariable |
|
| BlockBuddyRequest |
Blocks or unblocks a buddy in the current user's buddies list.
|
| BoolMatch |
The BoolMatch class is used in matching expressions to check boolean conditions.
|
| Buddy |
The Buddy interface defines all the methods and properties that an object representing a SmartFoxServer Buddy entity exposes.
|
| BuddyMessageRequest |
Sends a message to a buddy in the current user's buddies list.
|
| BuddyVariable |
The BuddyVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Buddy Variable exposes.
|
| ChangeRoomCapacityRequest |
Changes the maximum number of users and/or spectators who can join a Room.
|
| ChangeRoomNameRequest |
Changes the name of a Room.
|
| ChangeRoomPasswordStateRequest |
Changes the password of a Room.
|
| ClientDisconnectionReason |
The ClientDisconnectionReason class contains the constants describing the possible reasons why a disconnection from the server occurred.
|
| ClusterInviteUsersRequest |
|
| ClusterJoinOrCreateRequest |
Creates a new ClusterJoinOrCreateRequest instance.
|
| ClusterRoomSettings |
The ClusterRoomSettings class is a container for the settings required to create a Room in an SFS2X Cluster
|
| ClusterTarget |
Represents a target Room on a Cluster Game Node
|
| ConfigData |
The ConfigData class stores the client configuration data loaded from an external XML file or
passed directly to the deputy connect method.
|
| ConnectionMode |
The ConnectionMode class contains the constants defining the possible connection modes of the client with the server.
|
| CreateRoomRequest |
Creates a new Room in the current Zone.
|
| CreateSFSGameRequest |
Creates a new public or private game, including player matching criteria, invitations settings and more.
|
| ExtensionRequest |
Sends a command to the server-side Extension attached to the Zone or to a Room.
|
| FindRoomsRequest |
Retrieves a list of Rooms from the server which match the specified criteria.
|
| FindUsersRequest |
Retrieves a list of users from the server which match the specified criteria.
|
| GoOnlineRequest |
Toggles the current user's online/offline state as buddy in other users' buddies lists.
|
| IBuddyManager |
The IBuddyManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Buddy List system.
|
| IEventListener |
The interface can be implemented to handle a single event type or it can be used to capture multiple events.
|
| IMatcher |
The IMatcher interface defines the properties of an object representing a condition to be used in a matching expression exposes.
|
| IMMOItem |
|
| IMMOItemVariable |
The IMMOItemVariable interface defines all the public methods and properties that an object representing a SmartFoxServer MMOItem Variable exposes in addition to those inherited from the parent interface.
|
| InitBuddyListRequest |
Initializes the Buddy List system on the current client.
|
| Invitation |
The Invitation interface defines all the methods and properties that an object representing an invitation entity exposes.
|
| InvitationReply |
The InvitationReply class contains the constants describing the possible replies to an invitation.
|
| InvitationReplyRequest |
Replies to an invitation received by the current user.
|
| InviteUsersRequest |
Sends a generic invitation to a list of users.
|
| IRoomManager |
The IRoomManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Room entities.
|
| ISmartFox |
|
| IUserManager |
The IUserManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer User entities.
|
| JoinRoomInvitationRequest |
|
| JoinRoomRequest |
Joins the current user in a Room.
|
| KickUserRequest |
Kicks a user out of the server.
|
| LeaveRoomRequest |
Leaves one of the Rooms joined by the current user.
|
| LogicOperator |
The LogicOperator class is used to concatenate two matching expressions using the AND or OR logical operator.
|
| LoginRequest |
Logs the current user in one of the server Zones.
|
| LogoutRequest |
Logs the user out of the current server Zone.
|
| MapLimits |
The class describes the lowest and highest 2D/3D coordinates available inside an MMORoom
|
| MatchExpression |
The MatchExpression class represents a matching expression used to compare custom variables or predefined properties when searching for users or Rooms.
|
| MessageRecipientMode |
The MessageRecipientMode class is used to specify the recipient/s of moderator and administrator messages.
|
| MMOItem |
An MMOItem represents an active non-player entity inside an MMORoom.
|
| MMOItemVariable |
|
| MMORoom |
The MMORoom object represents a specialized type of Room entity on the client.
|
| MMORoomSettings |
The MMORoomSettings class is a container for the settings required to create an MMORoom using the CreateRoomRequest request.
|
| ModeratorMessageRequest |
Sends a moderator message to a specific user or a group of users.
|
| NumberMatch |
The NumberMatch class is used in matching expressions to check numeric conditions.
|
| ObjectMessageRequest |
Sends an object containing custom data to all users in a Room, or a subset of them.
|
| PlayerToSpectatorRequest |
Turns the current user from player to spectator in a Game Room.
|
| PrivateMessageRequest |
Sends a private chat message.
|
| PublicMessageRequest |
Sends a public chat message.
|
| QuickGameJoinRequest |
Quickly joins the current user in a public game.
|
| RemoveBuddyRequest |
Removes a buddy from the current user's buddies list.
|
| ReservedBuddyVariables |
The ReservedBuddyVariables class contains the constants describing the SmartFoxServer API reserved Buddy Variable names.
|
| ReservedRoomVariables |
The ReservedRoomVariables class contains the constants describing the SmartFoxServer API reserved Room Variable names.
|
| Room |
The Room interface defines all the methods and properties that an object representing a SmartFoxServer Room entity exposes.
|
| RoomEvents |
The RoomEvents class contains a specific subset of the RoomSettings required to create a Room.
|
| RoomExtension |
The RoomExtension class contains a specific subset of the RoomSettings required to create a Room.
|
| RoomPermissions |
The RoomPermissions class contains a specific subset of the RoomSettings required to create a Room.
|
| RoomProperties |
The RoomProperties class contains the names of predefined properties that can be used in matching expressions to search/filter Rooms.
|
| RoomSettings |
The RoomSettings class is a container for the settings required to create a Room using the CreateRoomRequest request.
|
| RoomVariable |
The RoomVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Room Variable exposes.
|
| SetBuddyVariablesRequest |
Sets one or more Buddy Variables for the current user.
|
| SetMMOItemVariables |
USED FOR CONSTANTS ONLY
|
| SetRoomVariablesRequest |
Sets one or more custom Room Variables in a Room.
|
| SetUserPositionRequest |
Updates the User position inside an MMORoom.
|
| SetUserVariablesRequest |
Sets one or more custom User Variables for the current user.
|
| SFSBuddy |
The SFSBuddy object represents a buddy in the current user's buddies list.
|
| SFSBuddyEvent |
SFSBuddyEvent is the class representing all the events related to the Buddy List system dispatched by the SmartFoxServer 2X Java client API.
|
| SFSBuddyManager |
The SFSBuddyManager class is the entity in charge of managing the current user's Buddy List system.
|
| SFSBuddyVariable |
The SFSBuddyVariable object represents a SmartFoxServer Buddy Variable entity on the client.
|
| SFSErrorCodes |
The SFSErrorCodes class provides a mean of translation between server error codes and their relative error messages.
|
| SFSEvent |
SFSEvent is the class representing most of the events dispatched by the SmartFoxServer 2X Java client API.
|
| SFSGameSettings |
The SFSGameSettings class is a container for the settings required to create a Game Room using the CreateSFSGameRequest request.
|
| SFSInvitation |
The SFSInvitation object contains all the informations about an invitation received by the current user.
|
| SFSRoom |
The SFSRoom object represents a SmartFoxServer Room entity on the client.
|
| SFSRoomManager |
The SFSRoomManager class is the entity in charge of managing the client-side Rooms list.
|
| SFSRoomVariable |
The SFSRoomVariable object represents a SmartFoxServer Room Variable entity on the client.
|
| SFSUser |
The SFSUser object represents a client logged in SmartFoxServer.
|
| SFSUserManager |
The SFSUserManager class is the entity in charge of managing the local (client-side) users list.
|
| SFSUserVariable |
The SFSUserVariable object represents a SmartFoxServer User Variable entity on the client.
|
| SmartFox |
SmartFox is the main class of the SmartFoxServer 2X API.
|
| SpectatorToPlayerRequest |
Turns the current user from spectator to player in a Game Room.
|
| StringMatch |
The StringMatch class is used in matching expressions to check string conditions.
|
| SubscribeRoomGroupRequest |
Subscribes the current user to Room-related events occurring in the specified Group.
|
| UnsubscribeRoomGroupRequest |
Unsubscribes the current user to Room-related events occurring in the specified Group.
|
| User |
The User interface defines all the methods and properties that an object representing a SmartFoxServer User entity exposes.
|
| UserPrivileges |
The UserPrivileges class contains the constants describing the default user types known by SmartFoxServer.
|
| UserProperties |
The UserProperties class contains the names of predefined properties that can be used in matching expressions to search/filter users.
|
| UserVariable |
The UserVariable interface defines all the public methods and properties that an object representing a SmartFoxServer User Variable exposes.
|
| Variable |
|
| VariableType |
The VariableType class contains the constants defining the valid types of User, Buddy and Room Variables to be passed to their constructors.
|
| Vec3D |
A vector 3D class used for defining coordinates in the MMORoom virtual world.
|