|
SmartFoxServer 3 C++ Client API 3.1.0-beta
Client API for SmartFoxServer 3
|
| Csfs3::event::ApiEvent | The base of every event dispatched by the API |
| Csfs3::core::BaseRequest | The base of every request an application sends to the server |
| Csfs3::requests::BanUserRequest | Banishes a user from the server |
| Csfs3::requests::BanUsersFromRoomRequest | Bans one or more users from a Room for a certain amount of time |
| Csfs3::requests::ChangeRoomCapacityRequest | Changes the maximum number of users and/or spectators who can join a Room |
| Csfs3::requests::ChangeRoomNameRequest | Changes the name of a Room |
| Csfs3::requests::ChangeRoomPasswordStateRequest | Changes the password of a Room |
| Csfs3::requests::CreateRoomRequest | Creates a new Room in the current Zone |
| Csfs3::requests::CreateSFSGameRequest | Creates a new public or private game, including player matching criteria, invitation settings and more |
| Csfs3::requests::ExtensionRequest | Sends a command to the server-side Extension attached to the Zone or to a Room |
| Csfs3::requests::ExtensionAsyncRequest | Calls a server side Extension, letting it run beside the other requests instead of in turn with them |
| Csfs3::requests::FindRoomsRequest | Retrieves a list of Rooms from the server which match the specified criteria |
| Csfs3::requests::FindUsersRequest | Retrieves a list of users from the server which match the specified criteria |
| Csfs3::requests::JoinRoomRequest | Joins the current user in a Room |
| Csfs3::requests::KickUserRequest | Kicks a user out of the server |
| Csfs3::requests::LeaveRoomRequest | Leaves one of the Rooms joined by the current user |
| Csfs3::requests::LoginRequest | Logs the current user in one of the server Zones |
| Csfs3::requests::LogoutRequest | Logs the user out of the current Zone |
| Csfs3::requests::PlayerToSpectatorRequest | Turns the current user from player to spectator in a Game Room |
| Csfs3::requests::QuickJoinGameRequest | Quickly joins the current user in a public game |
| Csfs3::requests::QuickJoinOrCreateRoomRequest | Joins the first Room matching a given expression, or creates a new one when nothing matches |
| Csfs3::requests::SetRoomVariablesRequest | Sets one or more custom Room Variables in a Room |
| Csfs3::requests::SetUserPositionRequest | Updates the current user's position inside an MMORoom |
| Csfs3::requests::SetUserVariablesRequest | Sets one or more custom User Variables for the current user |
| Csfs3::requests::SpectatorToPlayerRequest | Turns the current user from spectator to player in a Game Room |
| Csfs3::requests::SubscribeRoomGroupRequest | Subscribes the current user to Room-related events occurring in the specified Group |
| Csfs3::requests::UnbanUsersFromRoomRequest | Unbans one or more users that were previously banned from a Room |
| Csfs3::requests::UnsubscribeRoomGroupRequest | Unsubscribes the current user from Room-related events occurring in the specified Group |
| Csfs3::requests::buddy::AddBuddyRequest | Adds a new buddy to the current user's buddies list |
| Csfs3::requests::buddy::BlockBuddyRequest | Blocks or unblocks a buddy in the current user's buddies list |
| Csfs3::requests::buddy::GoOnlineRequest | Toggles the current user's online/offline state as buddy in other users' buddies lists |
| Csfs3::requests::buddy::InitBuddyListRequest | Initializes the Buddy List system on the current client |
| Csfs3::requests::buddy::RemoveBuddyRequest | Removes a buddy from the current user's buddies list |
| Csfs3::requests::buddy::SetBuddyVariablesRequest | Sets one or more Buddy Variables for the current user |
| Csfs3::requests::inv::InvitationReplyRequest | Replies to an invitation received by the current user |
| Csfs3::requests::inv::InviteUsersRequest | Sends a generic invitation to a list of users |
| Csfs3::requests::inv::JoinRoomInvitationRequest | Sends an invitation to other users/players to join a specific Room |
| Csfs3::ConfigData::BlueBoxCfg | Settings of the HTTP tunnel (BlueBox), used when a TCP connection cannot be established |
| Csfs3::entities::Buddy | A buddy in the current user's buddy list |
| Csfs3::entities::SFSBuddy | The standard implementation of Buddy: a buddy in the current user's buddy list |
| Csfs3::core::buddy::BuddyManager | Manages the current user's Buddy List system |
| Csfs3::entities::BufferView | A read-only window on bytes that somebody else owns |
| Csfs3::entities::ByteBuffer | A growable buffer of bytes, with a read cursor and a write cursor |
| Csfs3::entities::match::MatchExpression::Condition | A single condition of a matching expression |
| Csfs3::ConfigData | Holds all the settings for the connection |
| Csfs3::requests::GameSettings | The settings specific to a Game Room, passed to CreateSFSGameRequest through RoomSettings::game |
| Csfs3::entities::Invitation | All the details of an invitation received by the current user |
| Csfs3::event::Listenable< EventType > | Gives a class the capability to dispatch events, and the methods to listen to them |
| Csfs3::event::Listenable< event::internal::BitSwarmEvent > | |
| Csfs3::event::Listenable< event::internal::BlueBoxEvent > | |
| Csfs3::event::Listenable< event::internal::CryptoEvent > | |
| Csfs3::event::Listenable< event::internal::SocketEvent > | |
| Csfs3::event::Listenable< event::SFSEvent > | |
| Csfs3::SmartFox | The main class of the SmartFoxServer 3 API |
| Csfs3::requests::MapLimits | The lowest and highest coordinates available inside an MMORoom |
| Csfs3::entities::match::MatchExpression | The MatchExpression class represents a matching expression used to compare custom variables or predefined properties when searching for users or Rooms |
| Csfs3::entities::MMOItem | An active non-player entity inside an MMORoom |
| Csfs3::requests::MMOSettings | The settings specific to an MMORoom, passed to CreateRoomRequest through RoomSettings::mmoSettings |
| Csfs3::entities::Room | A Room in a Zone |
| Csfs3::entities::SFSRoom | The standard implementation of Room: a SmartFoxServer Room on the client |
| Csfs3::entities::MMORoom | A specialized Room working with proximity lists instead of "regular" user lists |
| Csfs3::requests::RoomEvents | The events a Room fires to the users inside it, passed to CreateRoomRequest |
| Csfs3::requests::RoomExtension | The server side Extension to attach to a Room upon creation |
| Csfs3::core::RoomManager | Manages the Rooms the client knows about |
| Csfs3::requests::RoomPermissions | The permissions a Room grants to the users inside it, passed to CreateRoomRequest |
| Csfs3::requests::RoomSettings | Describes the Room to be created by a CreateRoomRequest |
| Csfs3::util::Scheduler | Runs functions after a delay, on a dedicated background thread |
| Csfs3::entities::SFSArray | A platform-neutral list of values, used to exchange data between client and server |
| Csfs3::entities::SFSObject | A platform-neutral container of named values, used to exchange data between client and server |
| Csfs3::entities::SFSVector2 | A class representing a Vector in 2D space |
| Csfs3::entities::SFSVector3 | A class representing a Vector in 3D space |
| Csfs3::entities::User | A client logged in SmartFoxServer that is "known" by the current client, that is, one who is inside one of the joined Rooms |
| Csfs3::entities::SFSUser | The standard implementation of User: a client logged in SmartFoxServer |
| Csfs3::core::UserManager | Manages the users the client knows about, that is, the users inside the Rooms the client joined |
| Csfs3::entities::Variable | The base of every variable kind: User, Room, Buddy and MMOItem Variables |
| Csfs3::entities::BuddyVariable | A custom value attached to a buddy in a buddy list, kept in sync between client and server |
| Csfs3::entities::SFSBuddyVariable | 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 |
| Csfs3::entities::MMOItemVariable | 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 |
| Csfs3::entities::RoomVariable | A custom value attached to a Room, kept in sync between client and server |
| Csfs3::entities::SFSRoomVariable | The standard implementation of RoomVariable |
| Csfs3::entities::UserVariable | A custom value attached to a user, kept in sync between client and server |
| Csfs3::entities::SFSUserVariable | The standard implementation of UserVariable |
| Csfs3::entities::Vec3D | A vector 3D class used for defining coordinates in the MMORoom virtual world |