SmartFoxServer 3 C++ Client API 3.1.0-beta
Client API for SmartFoxServer 3
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 Nsfs3
  Ncore
   Nbuddy
    CBuddyManagerManages the current user's Buddy List system
   CBaseRequestThe base of every request an application sends to the server
   CRoomManagerManages the Rooms the client knows about
   CUserManagerManages the users the client knows about, that is, the users inside the Rooms the client joined
  Nentities
   Nmatch
    CMatchExpressionThe MatchExpression class represents a matching expression used to compare custom variables or predefined properties when searching for users or Rooms
     CConditionA single condition of a matching expression
   CBuddyA buddy in the current user's buddy list
   CBuddyVariableA custom value attached to a buddy in a buddy list, kept in sync between client and server
   CBufferViewA read-only window on bytes that somebody else owns
   CByteBufferA growable buffer of bytes, with a read cursor and a write cursor
   CInvitationAll the details of an invitation received by the current user
   CMMOItemAn active non-player entity inside an MMORoom
   CMMOItemVariableA custom value attached to an MMOItem, kept in sync with the server for as long as the item stays inside the area of interest of the current user
   CMMORoomA specialized Room working with proximity lists instead of "regular" user lists
   CRoomA Room in a Zone
   CRoomVariableA custom value attached to a Room, kept in sync between client and server
   CSFSArrayA platform-neutral list of values, used to exchange data between client and server
   CSFSBuddyThe standard implementation of Buddy: a buddy in the current user's buddy list
   CSFSBuddyVariableThe standard implementation of BuddyVariable: a custom value attached to a buddy in a buddy list, kept in sync between client and server on every change
   CSFSObjectA platform-neutral container of named values, used to exchange data between client and server
   CSFSRoomThe standard implementation of Room: a SmartFoxServer Room on the client
   CSFSRoomVariableThe standard implementation of RoomVariable
   CSFSUserThe standard implementation of User: a client logged in SmartFoxServer
   CSFSUserVariableThe standard implementation of UserVariable
   CSFSVector2A class representing a Vector in 2D space
   CSFSVector3A class representing a Vector in 3D space
   CUserA client logged in SmartFoxServer that is "known" by the current client, that is, one who is inside one of the joined Rooms
   CUserVariableA custom value attached to a user, kept in sync between client and server
   CVariableThe base of every variable kind: User, Room, Buddy and MMOItem Variables
   CVec3DA vector 3D class used for defining coordinates in the MMORoom virtual world
  Nevent
   CAdminMessageDispatched when the current user receives a message from an administrator
   CApiEventThe base of every event dispatched by the API
   CBuddyAddDispatched when a buddy is added successfully to the current user's buddies list
   CBuddyBlockDispatched when a buddy is blocked or unblocked by the current user
   CBuddyErrorDispatched when a request related to the Buddy List system fails
   CBuddyListInitDispatched when the Buddy List system is initialized successfully
   CBuddyMessageDispatched when a buddy message is received
   CBuddyOnlineStateChangeDispatched when a buddy in the current user's buddies list changes his online state
   CBuddyRemoveDispatched when a buddy is removed successfully from the current user's buddies list
   CBuddyVariablesUpdateDispatched when a buddy updates one or more of his Buddy Variables
   CConnectionDispatched when a connection to a SmartFoxServer 3 instance is attempted
   CConnectionLostDispatched when the connection to the server is interrupted
   CConnectionResumeDispatched when the connection to the server is re-established after a temporary loss, while the SmartFoxServer 3 HRC system is available in the Zone
   CConnectionRetryDispatched when the connection to the server is interrupted abruptly, while the SmartFoxServer 3 HRC system is available in the Zone
   CExtensionResponseDispatched when data from a server-side Extension is received
   CInvitationDispatched when the current user receives an invitation from another user
   CInvitationReplyDispatched to the inviter when one of the users he invited replies to the invitation, and when an invitation left unanswered expires
   CInvitationReplyErrorDispatched when an error occurs while the current user replies to an invitation, usually because the invitation already expired
   CListenableGives a class the capability to dispatch events, and the methods to listen to them
   CLoginDispatched after a successful login in a Zone
   CLoginErrorDispatched when the login fails
   CLogoutDispatched when the current user logs out of the Zone
   CMMOItemVariablesUpdateDispatched when one or more MMOItem Variables are updated in the current MMORoom
   CModeratorMessageDispatched when the current user receives a message from a moderator
   CObjectMessageDispatched when an object with custom data is received from another user in one of the joined Rooms
   CPingPongDispatched when a new lag measurement is available
   CPlayerToSpectatorDispatched when a player is turned into a spectator inside a Game Room
   CPlayerToSpectatorErrorDispatched when the current user cannot be turned from player into spectator in a Game Room
   CPrivateMessageDispatched when a private message is received
   CProximityListUpdateDispatched when the current user's proximity list changes in an MMORoom, after he or another user moved: it reports who and what entered or left his Area of Interest
   CPublicMessageDispatched when a public message is received
   CRoomAddDispatched when a Room is created in a Group this client subscribes to, whoever created it
   CRoomCapacityChangeDispatched when the capacity of a Room is changed
   CRoomCapacityChangeErrorDispatched when the capacity of a Room cannot be changed
   CRoomCreationErrorDispatched when the creation of a Room fails
   CRoomFindResultDispatched when a Rooms search is completed
   CRoomGroupSubscribeDispatched when a Room Group is subscribed successfully
   CRoomGroupSubscribeErrorDispatched when a Room Group cannot be subscribed
   CRoomGroupUnsubscribeDispatched when a Room Group is unsubscribed successfully
   CRoomGroupUnsubscribeErrorDispatched when a Room Group cannot be unsubscribed
   CRoomJoinDispatched when a Room is joined by the current user
   CRoomJoinErrorDispatched when the current user fails to join a Room
   CRoomNameChangeDispatched when the name of a Room is changed
   CRoomNameChangeErrorDispatched when the name of a Room cannot be changed
   CRoomPasswordStateChangeDispatched when the password of a Room is set, changed or removed
   CRoomPasswordStateChangeErrorDispatched when the password of a Room cannot be set, changed or removed
   CRoomRemoveDispatched when a Room is destroyed in a Group this client subscribes to
   CRoomVariablesUpdateDispatched when one or more Room Variables are updated
   CSpectatorToPlayerDispatched when a spectator is turned into a player inside a Game Room
   CSpectatorToPlayerErrorDispatched when the current user cannot be turned from spectator into player in a Game Room
   CUdpConnectionDispatched with the result of the UDP handshake
   CUdpConnectionLostDispatched when an active UDP connection is lost
   CUserCountChangeDispatched when the number of users, players or spectators inside a Room changes
   CUserEnterRoomDispatched when another user enters one of the Rooms joined by the current user
   CUserExitRoomDispatched when one of the Rooms joined by the current user is left by another user, or by the current user himself
   CUserFindResultDispatched when a users search is completed
   CUserVariablesUpdateDispatched when one or more User Variables are updated
  Nrequests
   Nbuddy
    CAddBuddyRequestAdds a new buddy to the current user's buddies list
    CBlockBuddyRequestBlocks or unblocks a buddy in the current user's buddies list
    CBuddyMessageRequestSends a message to a buddy in the current user's buddies list
    CGoOnlineRequestToggles the current user's online/offline state as buddy in other users' buddies lists
    CInitBuddyListRequestInitializes the Buddy List system on the current client
    CRemoveBuddyRequestRemoves a buddy from the current user's buddies list
    CSetBuddyVariablesRequestSets one or more Buddy Variables for the current user
   Ninv
    CInvitationReplyRequestReplies to an invitation received by the current user
    CInviteUsersRequestSends a generic invitation to a list of users
    CJoinRoomInvitationRequestSends an invitation to other users/players to join a specific Room
   CAdminMessageRequestSends an administrator message to a specific user or a group of users
   CBanUserRequestBanishes a user from the server
   CBanUsersFromRoomRequestBans one or more users from a Room for a certain amount of time
   CChangeRoomCapacityRequestChanges the maximum number of users and/or spectators who can join a Room
   CChangeRoomNameRequestChanges the name of a Room
   CChangeRoomPasswordStateRequestChanges the password of a Room
   CCreateRoomRequestCreates a new Room in the current Zone
   CCreateSFSGameRequestCreates a new public or private game, including player matching criteria, invitation settings and more
   CExtensionAsyncRequestCalls a server side Extension, letting it run beside the other requests instead of in turn with them
   CExtensionRequestSends a command to the server-side Extension attached to the Zone or to a Room
   CFindRoomsRequestRetrieves a list of Rooms from the server which match the specified criteria
   CFindUsersRequestRetrieves a list of users from the server which match the specified criteria
   CGameSettingsThe settings specific to a Game Room, passed to CreateSFSGameRequest through RoomSettings::game
   CJoinRoomRequestJoins the current user in a Room
   CKickUserRequestKicks a user out of the server
   CLeaveRoomRequestLeaves one of the Rooms joined by the current user
   CLoginRequestLogs the current user in one of the server Zones
   CLogoutRequestLogs the user out of the current Zone
   CMapLimitsThe lowest and highest coordinates available inside an MMORoom
   CMMOSettingsThe settings specific to an MMORoom, passed to CreateRoomRequest through RoomSettings::mmoSettings
   CModeratorMessageRequestSends a moderator message to a specific user or a group of users
   CObjectMessageRequestSends an object containing custom data to all users in a Room, or a subset of them
   CPlayerToSpectatorRequestTurns the current user from player to spectator in a Game Room
   CPrivateMessageRequestSends a private chat message
   CPublicMessageRequestSends a public chat message
   CQuickJoinGameRequestQuickly joins the current user in a public game
   CQuickJoinOrCreateRoomRequestJoins the first Room matching a given expression, or creates a new one when nothing matches
   CRoomEventsThe events a Room fires to the users inside it, passed to CreateRoomRequest
   CRoomExtensionThe server side Extension to attach to a Room upon creation
   CRoomPermissionsThe permissions a Room grants to the users inside it, passed to CreateRoomRequest
   CRoomSettingsDescribes the Room to be created by a CreateRoomRequest
   CSetRoomVariablesRequestSets one or more custom Room Variables in a Room
   CSetUserPositionRequestUpdates the current user's position inside an MMORoom
   CSetUserVariablesRequestSets one or more custom User Variables for the current user
   CSpectatorToPlayerRequestTurns the current user from spectator to player in a Game Room
   CSubscribeRoomGroupRequestSubscribes the current user to Room-related events occurring in the specified Group
   CUnbanUsersFromRoomRequestUnbans one or more users that were previously banned from a Room
   CUnsubscribeRoomGroupRequestUnsubscribes the current user from Room-related events occurring in the specified Group
  Nutil
   CSchedulerRuns functions after a delay, on a dedicated background thread
  CConfigDataHolds all the settings for the connection
   CBlueBoxCfgSettings of the HTTP tunnel (BlueBox), used when a TCP connection cannot be established
  CSmartFoxThe main class of the SmartFoxServer 3 API