|
SmartFoxServer 3 C++ Client API 3.1.0-beta
Client API for SmartFoxServer 3
|
| Nsfs3 | |
| Ncore | |
| Nbuddy | |
| CBuddyManager | Manages the current user's Buddy List system |
| CBaseRequest | The base of every request an application sends to the server |
| CRoomManager | Manages the Rooms the client knows about |
| CUserManager | Manages the users the client knows about, that is, the users inside the Rooms the client joined |
| Nentities | |
| Nmatch | |
| CMatchExpression | The MatchExpression class represents a matching expression used to compare custom variables or predefined properties when searching for users or Rooms |
| CCondition | A single condition of a matching expression |
| CBuddy | A buddy in the current user's buddy list |
| CBuddyVariable | A custom value attached to a buddy in a buddy list, kept in sync between client and server |
| CBufferView | A read-only window on bytes that somebody else owns |
| CByteBuffer | A growable buffer of bytes, with a read cursor and a write cursor |
| CInvitation | All the details of an invitation received by the current user |
| CMMOItem | An active non-player entity inside an MMORoom |
| CMMOItemVariable | A 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 |
| CMMORoom | A specialized Room working with proximity lists instead of "regular" user lists |
| CRoom | A Room in a Zone |
| CRoomVariable | A custom value attached to a Room, kept in sync between client and server |
| CSFSArray | A platform-neutral list of values, used to exchange data between client and server |
| CSFSBuddy | The standard implementation of Buddy: a buddy in the current user's buddy list |
| CSFSBuddyVariable | The 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 |
| CSFSObject | A platform-neutral container of named values, used to exchange data between client and server |
| CSFSRoom | The standard implementation of Room: a SmartFoxServer Room on the client |
| CSFSRoomVariable | The standard implementation of RoomVariable |
| CSFSUser | The standard implementation of User: a client logged in SmartFoxServer |
| CSFSUserVariable | The standard implementation of UserVariable |
| CSFSVector2 | A class representing a Vector in 2D space |
| CSFSVector3 | A class representing a Vector in 3D space |
| CUser | A client logged in SmartFoxServer that is "known" by the current client, that is, one who is inside one of the joined Rooms |
| CUserVariable | A custom value attached to a user, kept in sync between client and server |
| CVariable | The base of every variable kind: User, Room, Buddy and MMOItem Variables |
| CVec3D | A vector 3D class used for defining coordinates in the MMORoom virtual world |
| Nevent | |
| CAdminMessage | Dispatched when the current user receives a message from an administrator |
| CApiEvent | The base of every event dispatched by the API |
| CBuddyAdd | Dispatched when a buddy is added successfully to the current user's buddies list |
| CBuddyBlock | Dispatched when a buddy is blocked or unblocked by the current user |
| CBuddyError | Dispatched when a request related to the Buddy List system fails |
| CBuddyListInit | Dispatched when the Buddy List system is initialized successfully |
| CBuddyMessage | Dispatched when a buddy message is received |
| CBuddyOnlineStateChange | Dispatched when a buddy in the current user's buddies list changes his online state |
| CBuddyRemove | Dispatched when a buddy is removed successfully from the current user's buddies list |
| CBuddyVariablesUpdate | Dispatched when a buddy updates one or more of his Buddy Variables |
| CConnection | Dispatched when a connection to a SmartFoxServer 3 instance is attempted |
| CConnectionLost | Dispatched when the connection to the server is interrupted |
| CConnectionResume | Dispatched when the connection to the server is re-established after a temporary loss, while the SmartFoxServer 3 HRC system is available in the Zone |
| CConnectionRetry | Dispatched when the connection to the server is interrupted abruptly, while the SmartFoxServer 3 HRC system is available in the Zone |
| CExtensionResponse | Dispatched when data from a server-side Extension is received |
| CInvitation | Dispatched when the current user receives an invitation from another user |
| CInvitationReply | Dispatched to the inviter when one of the users he invited replies to the invitation, and when an invitation left unanswered expires |
| CInvitationReplyError | Dispatched when an error occurs while the current user replies to an invitation, usually because the invitation already expired |
| CListenable | Gives a class the capability to dispatch events, and the methods to listen to them |
| CLogin | Dispatched after a successful login in a Zone |
| CLoginError | Dispatched when the login fails |
| CLogout | Dispatched when the current user logs out of the Zone |
| CMMOItemVariablesUpdate | Dispatched when one or more MMOItem Variables are updated in the current MMORoom |
| CModeratorMessage | Dispatched when the current user receives a message from a moderator |
| CObjectMessage | Dispatched when an object with custom data is received from another user in one of the joined Rooms |
| CPingPong | Dispatched when a new lag measurement is available |
| CPlayerToSpectator | Dispatched when a player is turned into a spectator inside a Game Room |
| CPlayerToSpectatorError | Dispatched when the current user cannot be turned from player into spectator in a Game Room |
| CPrivateMessage | Dispatched when a private message is received |
| CProximityListUpdate | Dispatched 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 |
| CPublicMessage | Dispatched when a public message is received |
| CRoomAdd | Dispatched when a Room is created in a Group this client subscribes to, whoever created it |
| CRoomCapacityChange | Dispatched when the capacity of a Room is changed |
| CRoomCapacityChangeError | Dispatched when the capacity of a Room cannot be changed |
| CRoomCreationError | Dispatched when the creation of a Room fails |
| CRoomFindResult | Dispatched when a Rooms search is completed |
| CRoomGroupSubscribe | Dispatched when a Room Group is subscribed successfully |
| CRoomGroupSubscribeError | Dispatched when a Room Group cannot be subscribed |
| CRoomGroupUnsubscribe | Dispatched when a Room Group is unsubscribed successfully |
| CRoomGroupUnsubscribeError | Dispatched when a Room Group cannot be unsubscribed |
| CRoomJoin | Dispatched when a Room is joined by the current user |
| CRoomJoinError | Dispatched when the current user fails to join a Room |
| CRoomNameChange | Dispatched when the name of a Room is changed |
| CRoomNameChangeError | Dispatched when the name of a Room cannot be changed |
| CRoomPasswordStateChange | Dispatched when the password of a Room is set, changed or removed |
| CRoomPasswordStateChangeError | Dispatched when the password of a Room cannot be set, changed or removed |
| CRoomRemove | Dispatched when a Room is destroyed in a Group this client subscribes to |
| CRoomVariablesUpdate | Dispatched when one or more Room Variables are updated |
| CSpectatorToPlayer | Dispatched when a spectator is turned into a player inside a Game Room |
| CSpectatorToPlayerError | Dispatched when the current user cannot be turned from spectator into player in a Game Room |
| CUdpConnection | Dispatched with the result of the UDP handshake |
| CUdpConnectionLost | Dispatched when an active UDP connection is lost |
| CUserCountChange | Dispatched when the number of users, players or spectators inside a Room changes |
| CUserEnterRoom | Dispatched when another user enters one of the Rooms joined by the current user |
| CUserExitRoom | Dispatched when one of the Rooms joined by the current user is left by another user, or by the current user himself |
| CUserFindResult | Dispatched when a users search is completed |
| CUserVariablesUpdate | Dispatched when one or more User Variables are updated |
| Nrequests | |
| Nbuddy | |
| CAddBuddyRequest | Adds a new buddy to the current user's buddies list |
| CBlockBuddyRequest | Blocks or unblocks a buddy in the current user's buddies list |
| CBuddyMessageRequest | Sends a message to a buddy in the current user's buddies list |
| CGoOnlineRequest | Toggles the current user's online/offline state as buddy in other users' buddies lists |
| CInitBuddyListRequest | Initializes the Buddy List system on the current client |
| CRemoveBuddyRequest | Removes a buddy from the current user's buddies list |
| CSetBuddyVariablesRequest | Sets one or more Buddy Variables for the current user |
| Ninv | |
| CInvitationReplyRequest | Replies to an invitation received by the current user |
| CInviteUsersRequest | Sends a generic invitation to a list of users |
| CJoinRoomInvitationRequest | Sends an invitation to other users/players to join a specific Room |
| CAdminMessageRequest | Sends an administrator message to a specific user or a group of users |
| CBanUserRequest | Banishes a user from the server |
| CBanUsersFromRoomRequest | Bans one or more users from a Room for a certain amount of time |
| CChangeRoomCapacityRequest | Changes the maximum number of users and/or spectators who can join a Room |
| CChangeRoomNameRequest | Changes the name of a Room |
| CChangeRoomPasswordStateRequest | Changes the password of a Room |
| CCreateRoomRequest | Creates a new Room in the current Zone |
| CCreateSFSGameRequest | Creates a new public or private game, including player matching criteria, invitation settings and more |
| CExtensionAsyncRequest | Calls a server side Extension, letting it run beside the other requests instead of in turn with them |
| CExtensionRequest | Sends a command to the server-side Extension attached to the Zone or to a Room |
| CFindRoomsRequest | Retrieves a list of Rooms from the server which match the specified criteria |
| CFindUsersRequest | Retrieves a list of users from the server which match the specified criteria |
| CGameSettings | The settings specific to a Game Room, passed to CreateSFSGameRequest through RoomSettings::game |
| CJoinRoomRequest | Joins the current user in a Room |
| CKickUserRequest | Kicks a user out of the server |
| CLeaveRoomRequest | Leaves one of the Rooms joined by the current user |
| CLoginRequest | Logs the current user in one of the server Zones |
| CLogoutRequest | Logs the user out of the current Zone |
| CMapLimits | The lowest and highest coordinates available inside an MMORoom |
| CMMOSettings | The settings specific to an MMORoom, passed to CreateRoomRequest through RoomSettings::mmoSettings |
| CModeratorMessageRequest | Sends a moderator message to a specific user or a group of users |
| CObjectMessageRequest | Sends an object containing custom data to all users in a Room, or a subset of them |
| CPlayerToSpectatorRequest | Turns the current user from player to spectator in a Game Room |
| CPrivateMessageRequest | Sends a private chat message |
| CPublicMessageRequest | Sends a public chat message |
| CQuickJoinGameRequest | Quickly joins the current user in a public game |
| CQuickJoinOrCreateRoomRequest | Joins the first Room matching a given expression, or creates a new one when nothing matches |
| CRoomEvents | The events a Room fires to the users inside it, passed to CreateRoomRequest |
| CRoomExtension | The server side Extension to attach to a Room upon creation |
| CRoomPermissions | The permissions a Room grants to the users inside it, passed to CreateRoomRequest |
| CRoomSettings | Describes the Room to be created by a CreateRoomRequest |
| CSetRoomVariablesRequest | Sets one or more custom Room Variables in a Room |
| CSetUserPositionRequest | Updates the current user's position inside an MMORoom |
| CSetUserVariablesRequest | Sets one or more custom User Variables for the current user |
| CSpectatorToPlayerRequest | Turns the current user from spectator to player in a Game Room |
| CSubscribeRoomGroupRequest | Subscribes the current user to Room-related events occurring in the specified Group |
| CUnbanUsersFromRoomRequest | Unbans one or more users that were previously banned from a Room |
| CUnsubscribeRoomGroupRequest | Unsubscribes the current user from Room-related events occurring in the specified Group |
| Nutil | |
| CScheduler | Runs functions after a delay, on a dedicated background thread |
| CConfigData | Holds all the settings for the connection |
| CBlueBoxCfg | Settings of the HTTP tunnel (BlueBox), used when a TCP connection cannot be established |
| CSmartFox | The main class of the SmartFoxServer 3 API |