All Classes and Interfaces
Class
Description
Adds a new buddy to the current user's buddies list.
Sends an administrator message to a specific user or a group of users.
This is the base class of all the events dispatched by the SmartFoxServer 3
Java Client API.
The BanMode class contains the constants describing the possible banning modalities for a BanUserRequest.
Banishes a user from the server.
Blocks or unblocks a buddy in the current user's buddies list.
The BoolMatch class is used in matching expressions to check boolean conditions.
In the SmartFoxServer 3 client API this interface is implemented by the SFSBuddy class.
Sends a message to a buddy in the current user's buddies list.
The BuddyVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Buddy Variable exposes.
Changes the maximum number of users and/or spectators who can join a Room.
Changes the name of a Room.
Changes the password of a Room.
The ClientDisconnectionReason class contains the constants
describing the possible reasons why a disconnection from the server occurred.
ConfigData contains all the settings for the connection.
Creates a new Room in the current Zone.
Creates a new public or private game, including player matching criteria, invitations settings and more.
Contains the list of public parameters passed in events by the API.
Sends a command to the server-side Extension attached to the Zone or to a
Room.
Retrieves a list of Rooms from the server which match the specified criteria.
Retrieves a list of users from the server which match the specified criteria.
Toggles the current user's online/offline state as buddy in other users' buddies lists.
The IBuddyManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Buddy List system.
The interface can be implemented to handle a single event type or it can be used to capture multiple events.
The IMatcher interface defines the properties of an object representing a condition to be used in a matching expression exposes.
In the SmartFoxServer 3 client API this interface is implemented by the MMOItemVariable class.
Initializes the Buddy List system on the current client.
The Invitation interface defines all the methods and properties that an object representing an invitation entity exposes.
The InvitationReply class contains the constants describing the possible replies to an invitation.
Replies to an invitation received by the current user.
Sends a generic invitation to a list of users.
The IRoomManager interface defines all the methods and properties
exposed by the client-side manager of the SmartFoxServer Room entities.
SFSObject and SFSArray represent a platform-neutral, high level object used to exchange data
between client and server.
The IUserManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer User entities.
Joins the current user in a Room.
Kicks a user out of the server.
Leaves one of the Rooms joined by the current user.
The LogicOperator class is used to concatenate two matching expressions using the AND or OR logical operator.
Logs the current user in one of the server Zones.
Logs the user out of the current server Zone.
The class describes the lowest and highest 2D/3D coordinates available inside an MMORoom
The MatchExpression class represents a matching expression used to compare custom variables or predefined properties when searching for users or Rooms.
The MessageRecipientMode class is used to specify the recipient/s of moderator and administrator messages.
An MMOItem represents an active non-player entity inside an MMORoom.
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.
The MMORoom object represents a specialized type of Room entity on the client.
The MMORoomSettings class is a container for the settings required to create an MMORoom using the CreateRoomRequest request.
Sends a moderator message to a specific user or a group of users.
The NumberMatch class is used in matching expressions to check numeric conditions.
Sends an object containing custom data to all users in a Room, or a subset of them.
Turns the current user from player to spectator in a Game Room.
Sends a private chat message.
Sends a public chat message.
Quickly joins the current user in a public game.
Removes a buddy from the current user's buddies list.
The ReservedBuddyVariables class contains the constants describing the SmartFoxServer API reserved Buddy Variable names.
The ReservedRoomVariables class contains the constants describing the SmartFoxServer API reserved Room Variable names.
In the SmartFoxServer 3 client API this interface is implemented by the SFSRoom class.
The RoomEvents class contains a specific subset of the
RoomSettings required to create a Room.
The RoomExtension class contains a specific subset of the
RoomSettings required to create a Room.
The RoomPermissions class contains a specific subset of the
RoomSettings required to create a Room.
The RoomProperties class contains the names of predefined properties that can be used in matching expressions to search/filter Rooms.
The RoomSettings class is a container for the settings required to
create a Room using the CreateRoomRequest request.
The RoomVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Room Variable exposes.
Sets one or more Buddy Variables for the current user.
USED FOR CONSTANTS ONLY
Sets one or more custom Room Variables in a Room.
Updates the User position inside an MMORoom.
Sets one or more custom User Variables for the current user.
SFSArray and SFSObject represent a platform-neutral, high-level objects that abstract the data transport
between client and server.
The SFSBuddy object represents a buddy in the current user's buddy list.
SFSBuddyEvent is the class representing all the events related to the Buddy List system dispatched by
the SmartFoxServer 3 Java client API.
The SFSBuddyManager class is the entity in charge of managing the current user's Buddy List system.
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.
The SFSErrorCodes class provides a mean of translation between server error codes and their relative error messages.
SFSEvent is the class representing most of the events dispatched by
the SmartFoxServer 3 Java client API.
The SFSGameSettings class is a container for the settings required to create a Game Room using the CreateSFSGameRequest request.
The SFSInvitation object contains all the informations about an invitation received by the current user.
The SFSRoom object represents a SmartFoxServer Room on the
client.
The SFSRoomManager class is the entity in charge of managing the client-side Rooms list.
The SFSRoomVariable is a custom value attached to a Room object that is automatically synchronized between client and server on every change.
The SFSUser object represents a client logged in SmartFoxServer.
The SFSUserManager class is the entity in charge of managing the local (client-side) users list.
The SFSUserVariable is a custom value attached to a User object that gets automatically synchronized between clients and the server on every change.
A class representing a Vector in 2D space
A class representing a Vector in 23 space
The main class of the SmartFoxServer 3 API: it is responsible for connecting the client to a SmartFoxServer instance and
dispatching all asynchronous events.
Turns the current user from spectator to player in a Game Room.
The StringMatch class is used in matching expressions to check string conditions.
Subscribes the current user to Room-related events occurring in the specified Group.
Unsubscribes the current user to Room-related events occurring in the specified Group.
In the SmartFoxServer 3 API this interface is implemented by the SFSUser class.
The UserPrivileges class contains the constants describing the
default user types known by SmartFoxServer.
The UserProperties class contains the names of predefined properties that can be used in matching expressions to search/filter users.
The UserVariable interface defines all the public methods and properties that an object representing a SmartFoxServer User Variable exposes.
Interface for all variable types in the API.
The VariableType class contains the constants defining the valid types of User, Buddy and Room Variables to be passed to their constructors.
A vector 3D class used for defining coordinates in the MMORoom virtual world.