Class Index

• SFS2X

• SFS2X.Entities

• SFS2X.Entities.Data

• SFS2X.Entities.Data.Vec3D

  The position in a 2D or 3D space.

• SFS2X.Entities.Invitation

• SFS2X.Entities.Invitation.InvitationReply

  The possible replies to an invitation.

• SFS2X.Entities.Invitation.SFSInvitation

  The details of an invitation received by the current user.

• SFS2X.Entities.Match

• SFS2X.Entities.Match.BoolMatch

  Check boolean conditions in matching expressions.

• SFS2X.Entities.Match.LogicOperator

  Concatenate two matching expressions using the AND or OR logical operators.

• SFS2X.Entities.Match.MatchExpression

  A matching expression used to compare custom variables or predefined properties when searching for users or Rooms.

• SFS2X.Entities.Match.NumberMatch

  Check numeric conditions in matching expressions.

• SFS2X.Entities.Match.RoomProperties

  The predefined properties that can be used in matching expressions to search/filter Rooms.

• SFS2X.Entities.Match.StringMatch

  Check string conditions in matching expressions.

• SFS2X.Entities.Match.UserProperties

  The predefined properties that can be used in matching expressions to search/filter users.

• SFS2X.Entities.MMOItem

  The representation of an active non-player entity inside an MMORoom.

• SFS2X.Entities.MMORoom

  A specialized type of Room entity on the client.

• SFS2X.Entities.SFSBuddy

  The representation of a buddy in the current user's buddy list.

• SFS2X.Entities.SFSRoom

  The SmartFoxServer Room entity representation on the client.

• SFS2X.Entities.SFSUser

  The representation of a client logged in SmartFoxServer.

• SFS2X.Entities.UserPrivileges

  The default user types known by SmartFoxServer.

• SFS2X.Entities.Variables

• SFS2X.Entities.Variables.BaseVariable

  Base class for all SmartFoxServer Variable entities on the client.

• SFS2X.Entities.Variables.MMOItemVariable

  The MMOItem Variable entity representation on the client.

• SFS2X.Entities.Variables.ReservedBuddyVariables

  The reserved Buddy Variable names used by the Buddy List API.

• SFS2X.Entities.Variables.ReservedRoomVariables

  The reserved Room Variable names used by the Game API.

• SFS2X.Entities.Variables.SFSBuddyVariable

  The Buddy Variable entity representation on the client.

• SFS2X.Entities.Variables.SFSRoomVariable

  The Room Variable entity representation on the client.

• SFS2X.Entities.Variables.SFSUserVariable

  The User Variable entity representation on the client.

• SFS2X.Entities.Variables.VariableType

  The valid types for User and Room Variables to be passed to the respective constructors.

• SFS2X.ErrorCodes

  The SmartFoxServer error codes and the related error messages.

• SFS2X.Logger

  The internal logger used by the SmartFoxServer 2X client API.

• SFS2X.LogLevel

  The importance levels of logged messages.

• SFS2X.Managers

• SFS2X.Managers.BuddyManager

  The manager of the current user's Buddy List system.

• SFS2X.Managers.RoomManager

  The manager of the client-side Rooms list.

• SFS2X.Managers.UserManager

  The manager of the local (client-side) users list.

• SFS2X.Requests

• SFS2X.Requests.BanMode

  The available banning modes for a BanUserRequest.

• SFS2X.Requests.BuddyList

• SFS2X.Requests.BuddyList.AddBuddyRequest

  Adds a new buddy to the current user's buddy list.

• SFS2X.Requests.BuddyList.BlockBuddyRequest

  Blocks or unblocks a buddy in the current user's buddy list.

• SFS2X.Requests.BuddyList.BuddyMessageRequest

  Sends a message to a buddy in the current user's buddy list.

• SFS2X.Requests.BuddyList.GoOnlineRequest

  Toggles the current user's online/offline state as buddy in other users' buddy lists.

• SFS2X.Requests.BuddyList.InitBuddyListRequest

  Initializes the Buddy List system on the current client.

• SFS2X.Requests.BuddyList.RemoveBuddyRequest

  Removes a buddy from the current user's buddy list.

• SFS2X.Requests.BuddyList.SetBuddyVariablesRequest

  Sets one or more Buddy Variables for the current user.

• SFS2X.Requests.Game

• SFS2X.Requests.Game.CreateSFSGameRequest

  Creates a new public or private Game Room in the current Zone, including player matching criteria, invitations settings and more.

• SFS2X.Requests.Game.InvitationReplyRequest

  Replies to an invitation received by the current user.

• SFS2X.Requests.Game.InviteUsersRequest

  Sends a generic invitation to a list of users.

• SFS2X.Requests.Game.JoinRoomInvitationRequest

  Sends an invitation to other users/players to join a specific Room.

• SFS2X.Requests.Game.QuickJoinGameRequest

  Quickly joins the current user in a public game.

• SFS2X.Requests.Game.SFSGameSettings

  The settings required to create a Game Room using the CreateSFSGameRequest request.

• SFS2X.Requests.MessageRecipientMode

  The recipient/s of moderator and administrator messages.

• SFS2X.Requests.MMO

• SFS2X.Requests.MMO.MapLimits

  A subset of the MMORoomSettings defining the limits of the virtual environment represented by an MMORoom.

• SFS2X.Requests.MMO.MMORoomSettings

  The settings required to create an MMORoom using the CreateRoomRequest request.

• SFS2X.Requests.MMO.SetUserPositionRequest

  Updates the User position inside an MMORoom.

• SFS2X.Requests.RoomEvents

  A subset of the RoomSettings defining which events related to the Room will be fired by the SmartFox client.

• SFS2X.Requests.RoomExtension

  A subset of the RoomSettings defining which server-side Extension should be attached to the Room upon creation.

• SFS2X.Requests.RoomPermissions

  A subset of the RoomSettings defining which operations users will be able to execute on the Room after its creation.

• SFS2X.Requests.RoomSettings

  The settings required to create a Room using the CreateRoomRequest request.

• SFS2X.Requests.System

• SFS2X.Requests.System.AdminMessageRequest

  Sends an administrator message to a specific user or to a group of users.

• SFS2X.Requests.System.BanUserRequest

  Banishes a user from the server.

• SFS2X.Requests.System.ChangeRoomCapacityRequest

  Changes the maximum number of users and/or spectators who can join a Room.

• SFS2X.Requests.System.ChangeRoomNameRequest

  Changes the name of a Room.

• SFS2X.Requests.System.ChangeRoomPasswordStateRequest

  Changes the password of a Room.

• SFS2X.Requests.System.CreateRoomRequest

  Creates a new Room in the current Zone.

• SFS2X.Requests.System.ExtensionRequest

  Sends a command to the server-side Extension attached to the Zone or to a Room.

• SFS2X.Requests.System.FindRoomsRequest

  Retrieves a list of Rooms from the server which match the specified criteria.

• SFS2X.Requests.System.FindUsersRequest

  Retrieves a list of users from the server which match the specified criteria.

• SFS2X.Requests.System.JoinRoomRequest

  Joins the current user in a Room.

• SFS2X.Requests.System.KickUserRequest

  Kicks a user out of the server.

• SFS2X.Requests.System.LeaveRoomRequest

  Leaves one of the Rooms joined by the current user.

• SFS2X.Requests.System.LoginRequest

  Logs the current user in one of the server Zones.

• SFS2X.Requests.System.LogoutRequest

  Logs the user out of the current server Zone.

• SFS2X.Requests.System.ModeratorMessageRequest

  Sends a moderator message to a specific user or to a group of users.

• SFS2X.Requests.System.ObjectMessageRequest

  Sends an object containing custom data to all users in a Room, or a subset of them.

• SFS2X.Requests.System.PlayerToSpectatorRequest

  Turns the current user from player to spectator in a Game Room.

• SFS2X.Requests.System.PrivateMessageRequest

  Sends a private chat message.

• SFS2X.Requests.System.PublicMessageRequest

  Sends a public chat message.

• SFS2X.Requests.System.SetRoomVariablesRequest

  Sets one or more custom Room Variables in a Room.

• SFS2X.Requests.System.SetUserVariablesRequest

  Sets one or more custom User Variables for the current user.

• SFS2X.Requests.System.SpectatorToPlayerRequest

  Turns the current user from spectator to player in a Game Room.

• SFS2X.Requests.System.SubscribeRoomGroupRequest

  Subscribes the current user to Room-related events occurring in the specified Group.

• SFS2X.Requests.System.UnsubscribeRoomGroupRequest

  Unsubscribes the current user to Room-related events occurring in the specified Group.

• SFS2X.SFSBuddyEvent

  The Buddy List related event types dispatched by the SmartFoxServer 2X JavaScript API.

• SFS2X.SFSEvent

  The main event types dispatched by the SmartFoxServer 2X JavaScript API.

• SFS2X.SmartFox

  The SmartFoxServer 2X JavaScript API main class.

• SFS2X.Utils

• SFS2X.Utils.ClientDisconnectionReason

  The possible reasons why a disconnection from the server occurred.