All Classes and Interfaces
Class
Description
Provides access to the standard server API
and the specialized API such as BuddyAPI, GameApi, MMOApi
Using SFSExtension as the base class for an Extension we can register separate request handlers for every supported client request.
Basic invitation
Using
SFSExtension as the base class for an Extension we can register separate handlers for different server side events.SFSExtension's base class.
Use
Use
SFSExtension insteadBase class for Storage Configuration
This matcher is used in MatchExpressions to check boolean conditions
The BuddyProperties class is attached to each User and represents the Buddy status of each User.
Provides country name and iso code for geolocation.
The MMORoom Settings extends the
CreateRoomSettings adding new functionalities that are unique to an MMORoom.Container data class that holds the minimum and maximum coordinates available in virtual World.
This class specifies the configuration of a Room that we want to create: from its name and user capacity, to the events it
can triggers, to its permissions and lots more.
Define the Extension settings of the Room
This class provides all the settings required to create an SFSGame.
The DBConfig class describes all the settings necessary to setup a JDBC connection to the database and to configure the connection pool.
Provides configuration settings for the Database based Room persistence API
Provides configuration settings for the File based Room persistence API
Default (file system based) BuddyStorage class
Overview
Configuration should be done via AdminTool > ZoneConfigurator > Flood Filter
/** @internal
ADVANCED USERS ONLY
Callback handler invoked after sending an email.
MMOItems are generic objects that can be placed in an MMORoom to represent
interactive or non-interactive items as part of the virtual world, such as obstacles, doors, collectibles,
etc...
Base interface for
MMOItemVariable implementation
Indicates how a dynamic class should be managed by the class that instantiate it
The mode parameter by default is set to NEW_INSTANCE.
Represents an Invitation object
The InvitationCallback is used to handle the client response to an invitation.
Overview
Basic interface for Room Storage implementations.
A Session object is created every time a TCP/Websocket or HTTP connection to the server is made.
SFSObject and SFSArray represent a platform-neutral, high level object used to exchange data
between client and server.
ADVANCED USERS ONLY
Overview
This is the main configuration object used by the Login Assistant to load data from
the user's database.
This object is passed to an ILoginAssistantPlugin at runtime, during the login process.
Overview
An MMOItem represents a non-player entity inside an MMORoom.
MMOItem Variables allow to attach custom properties to MMOItems inside an MMORoom.
Overview
Indicates if an handler class (e.g. for extension request/event) handling is a multi-handler.
This matcher is used in MatchExpressions to check Numeric conditions
Indicates how the password should be stored in the database
This filter can be added to any existing application to provide read-only User Variables.
Determines the mode of the Password Recovery service
Contains a series of Reserved BuddyVariables with a special meaning for the BuddyList system:
BV_ONLINE: the Buddy Online status
BV_STATE: the Buddy State message
BV_NICKNAME: the Buddy nickname
The class contains static fields that represent names of "reserved" Room Variables.
A list of properties that can be used in MatchExpressions for Room objects
Represent the size of a Room.
Provides several modes for the Room Storage API
Overview
Overview
SFSArray and SFSObject represent a platform-neutral, high-level objects that abstract the data transport
between client and server.
Introduction
Provides access to the API for managing Buddies and Buddy lists.
An SFSBuddyList represents one BuddyList in the Buddy System.
BuddyVariables are custom values attached to any Buddy in a BuddyList.
SFSDBManager is the default implementation of the IDBManager interface provided by the SmartFoxServer platform.
The class represent an email message in either plain text or valid HTML format that can be sent
via the mail service provided by the SmartFoxServer class.
Events are notified to Server Extensions via listeners.
The SFSExtension class provides an invocation mechanism that promotes clear separation between
the main extension class and each request and event handlers.
For a quick introduction see:
The Filter Chain allows the developer to configure a number of Filters that will run prior to executing a Client request or dispatching a Server side
event.
Introduction
Provides specialized methods for advanced game functionalities such as:
Match making
Creation of private/invitation-only games
Invitations
Quick joining games matching specific parameters
Etc...
Overview
Provides access to the API for managing MMORooms.
SFSPostOffice provides a simple mailing service for sending text/html emails via
a configured SMTP service.
Overview
The Remove Mode tells the RoomManager how to auto-remove dynamically created Rooms.
These flags are used to configure the Room behavior
RoomVariables are custom values assigned to Room objects that get automatically synchronized between client and server
on every change.
Overview
UserVariables are custom values assigned to User objects that are automatically synchronized between client and server
on every change.
A class representing a Vector in 2D space
A class representing a Vector in 23 space
Overview
Overview
Provides all the necessary settings for the SignUpAssistant Component
Configures the options related to sending an email response, after a successful user registration.
Configures the Password Recovery feature of the SignUp Assistant.
Provides several error codes that are associated with customizable error messages.
Signal a validation error during the SignUp process
Main Server class, provides access to a series of services that can be sometimes useful
for more advanced operations.
This matcher is used in MatchExpressions to check String conditions
A filter can be used to intercept any API client request (not Extension requests) and interact with the parameter,
adding extra validation, custom logic etc...
The SystemFilterChain can contain one or several SystemController Filter instances that can be applied before
a client request is executed by the SystemController.
Overview
A list of properties that can be used in MatchExpressions for User objects
Top level interface common to all 'variable' types in SmartfoxServer, such as
RoomVariable, UserVariable, BuddyVariable, MMOItemVariableA vector 3D class used for defining coordinates in the MMORoom virtual world.