Discussion

This event is fired when a User receives an Admin message.

 -(void)onAdminMessage:(SFSEvent *)evt
 {
    NSLog(@"Admin says: %@", [evt.params objectForKey:@"message"]);
 }

Discussion

This event is fired in response to a AddBuddyRequest.

Discussion

This event is fired in response to a BlockBuddyRequest.

Discussion

This event is fired in response to a failed Buddy request, such as AddBuddy, RemoveBuddy etc…

Discussion

This event is fired in response to a InitBuddyListRequest.

After the Buddy List initialization the User will return to his previous Buddy state. His online/offline status, the Buddy state and his persistent Buddy Variables will all be loaded and broadcast in the system. In particular the online status determines if the User will appear online or not to other Users that have added him/her to their lists.

At this stage the custom Buddy states are also loaded and populated locally by the API.

 NSLog(@"Buddy States: " + [smartFox.buddyManager buddyStates]);

Discussion

This event is fired in response to a BuddyMessageRequest.

Discussion

This event is fired in response to a GoOnlineRequest.

Discussion

This event is fired in response to a RemoveBuddyRequest.

Discussion

This event is fired in response to a SetBuddyVariablesRequest.

Discussion

This event notifies an attempt to establish an HTTP tunnel connection with SmartFoxServer 2X.

The following example shows how to handle a reconnection

 -(void)onConectionAttempHTTP:(SFSEvent *)evt
 {
    // Provide feedback to client on BlueBox(HTTP) connection attempt.
 }

Discussion

Dispatched when an error occurs while loading the external SmartFox configuration file.

.

Discussion

Dispatched when the external SmartFox configuration file has been loaded successfully.

This event is dispatched only if the connectOnSuccess parameter of the SmartFox2XClient::loadConfig:connectOnSuccess: method is set to NO; otherwise the connection is made and the related onConnection: event is fired.

No parameters are provided.

The following example shows how to handle a successful configuration loading.

 [smartFox loadConfig:@"testEnvironmentConfig.xml" connectOnSuccess:NO];

 function onConfigLoadSuccess(evt:SFSEvent):void
 {
     NSLog(@"Config file loaded, now connecting...");
     [smartFox connect:smartFox.currentIp port:smartFox.currentPort];
 }

Discussion

This event notifies the result of a connection attempt.

Discussion

This event notifies of a disconnection from the Server.

When possible the API will also provide a reason for the disconnection:

• Idle: the connection was dropped because the User was inactive for too long
• Manual: the User requested the disconnection
• Kick: the connection was dropped because the User was kicked
• Ban: the connection was dropped because the User was banned
• Unknown: the connection was lost for reasons outside of the API (slow or bad connection, network problems etc…)

Discussion

This event is dispatched after a temporary disconnection, when the connection to the Server has been re-establisehd.

SmartFoxServer 2X provides a powerful new feature that allows a broken connection to be re-established transparently without loosing any of the current application state. This allows any player to get back in the game without fear of loosing the match because of a sloppy internet connection or a sudden disconnection.

In case the re-connection attempts fail onConnectionLost: event will be fired.

The following example shows how to handle a reconnection

 -(void)onConnectionRetry:(SFSEvent *)evt
 {
    // Freeze your GUI and provide some feedback to the Player
 }

 -(void)onConnectionResume:(SFSEvent *)evt
 {
    // Unfreeze the GUI and let the player continue with the game...
 }

 -(void)onConnectionLost:(SFSEvent *)evt
 {
    NSLog(@"Ouch, connection was lost. Reason: %@", [evt.params objectForKey:@"reason"]);
 }

Discussion

This event notifies a temporary disconnection from the Server followed by an immediate attempt to reconnect.

SmartFoxServer 2X provides a powerful new feature that allows a broken connection to be re-established transparently without loosing any of the current application state. This allows any player to get back in the game without fear of loosing the match because of a sloppy internet connection.

When this event is dispatched the API enter a “freeze” mode where no new requests can be sent until the reconnection is successfully performed. It is highly recommended to handle this event and freeze your application interface accordingly until the onConnectionResume: event is fired.

The following example shows how to handle a reconnection

 -(void)onConnectionRetry:(SFSEvent *)evt
 {
    // Freeze your GUI and provide some feedback to the Player
 }

 -(void)onConnectionResume:(SFSEvent *)evt
 {
    // Unfreeze the GUI and let the player continue with the game...
 }

Discussion

This event is fired in response to a console message from logger…

Discussion

This event is fired every time a server-side Extension sends a message, usually in response to an ExtensionRequest.

(A server Extension can send messages at any moment, not just in response to a specific client request)

 -(void)onExtensionResponse:(SFSEvent *)evt
 {
     NSArray *keys = [evt.params allKeys];
     for (NSString *key in keys)
     {
         NSLog(@"%@: %@", key, [evt.params objectForKey:key]);
     }
 }

Discussion

This event is fired when another User has sent you an Invitation

Discussion

This event is fired when a User sends a reply to your Invitation

Discussion

This event is fired in response to a failed InvitationReplyRequest The failure is usually caused by a late reply which doesn’t make it to the server within the expected time

Discussion

This event is dispatched in response to a login request.

The params object may contain the following keys.

Discussion

This event is dispatched in response to a failed login request.

Discussion

This event is dispatched in response to a logout request.

Usually this event needs to be handled when you want to logout from the current Zone and join another one. In order to perform the operation correctly you need to do as follows:

• Send a LogoutRequest to the Server
• Handle the onLogout event on the client
• Perform a new login in the new Zone

No parameters are passed for this event

 -(void)onLogout:(SFSEvent *)evt
 {
    NSLog(@"Logout was successful");
    // Proceed with more logic here...
 }

Discussion

This event is fired when a User receives a Moderator message.

 -(void)onModeratorMessage:(SFSEvent *)evt
 {
    SFSUser *sender = [evt.params objectForKey:@"sender"];
    NSLog(@"Moderator says: %@, from: %@", [evt.params objectForKey:@"message"], sender.name);
 }

Discussion

This event is received when a User has sent an ObjectMessage request

The object sent by the sender can contain custom data, such as a game move etc…

 -(void)onObjectMessage:(SFSEvent *)evt
 {
    SFSObject *obj = [evt.params objectForKey:@"message"];
    NSLog(@"Received data: %@", [obj getDump]);
 }

Discussion

This event is fired in response to a successful PlayerToSpectatorRequest

Discussion

This event is fired in response to a failed PlayerToSpectatorRequest

Discussion

This event is fired when a User receives a private message.

 -(void)onPrivateMessage:(SFSEvent *)evt
 {
    SFSUser *sender = [evt.params objectForKey:@"sender"];
    NSLog(@"PM: %@, from: %@", [evt.params objectForKey:@"message"], sender.name);
 }

Discussion

This event is fired when a User sends a public message.

Also the User receives this event every time he sends a public message.

 -(void)onPublicMessage:(SFSEvent *)evt
 {
    SFSUser *sender = [evt.params objectForKey:@"sender"];
    NSLog(@"%@: %@", sender.name, [evt.params objectForKey:@"message"]);
 }

Discussion

This event is dispatched when a new Room was created inside the Zone under any of the Room Groups that the User is listening for.

The params object contains the following keys.

Discussion

This event is fired in response to a ChangeRoomCapacityRequest

Discussion

This event is fired in response to a failed ChangeRoomCapacityRequest

Discussion

This event is dispatched in response to a failed create room request.

Discussion

This event is fired in response to a FindRoomsRequest

Discussion

This event is dispatched in response to a JoinRoomRequest.

Discussion

This event is dispatched in response to a failed JoinRoomRequest.

The params object contains the following parameters.

Discussion

This event is fired in response to a ChangeRoomNameRequest

Discussion

This event is fired in response to a failed ChangeRoomNameRequest

Discussion

This event is fired in response to a ChangeRoomPasswordStateRequest.

In particular this event when the password state is changed. For example when a non-password protected Room is assigned a password, or vice-versa

Discussion

This event is fired in response to a failed ChangeRoomPasswordStateRequest

Discussion

This event is dispatched whenever a Room is removed from the Zone, under any of the Room Groups that the User is listening for.

Discussion

This event is fired in response to a SetRoomVariablesRequest

Discussion

This event is fired in response to a successful SpectatorToPlayerRequest

Discussion

This event is fired in response to a failed SpectatorToPlayerRequest

Discussion

This event is fired in response to a SubscribeRoomGroupRequest

Discussion

This event is fired in response to a failed SubscribeRoomGroupRequest

The params object contains the following parameters.

Discussion

The onUDPSocketConnect event is dispatched after a UDP connection has been attempted and either failed (0) or succedded (1) to establish a connection.

The client will attempt to connect three (3) time before dispatching a failed event.

The following example shows how to handle the event

-(void)onUDPSocketConnect:(SFSEvent *)evt
{
    if ([[evt.params objectForKey:@"success"] boolValue])
    {
        NSLog(@"UDP connected");
    }
    else
    {
        NSLog(@"UDP not connected");
    }
}

Discussion

This event is fired in response to an UnsubscribeRoomGroupRequest

Discussion

This event is fired in response to a failed UnsubscribeRoomGroupRequest

The params object contains the following parameters.

Discussion

This event is fired whenever the number of users/spectators in a Room changes.

The client receives updates for all Rooms inside the Room Groups that he is listening to.

 -(void)onUserCountChange:(SFSEvent *)evt
 {
     SFSRoom *room = [evt.params objectForKey:@"room"];
     int uCount = [[evt.params objectForKey:@"uCount"] intValue];
     int sCount = [[evt.params objectForKey:@"sCount"] intValue];

     NSLog(@"Room: %@ contains %d users and %d spectators", room.name, uCount, sCount);     
 }

Discussion

This event is fired whenever a User enters one of the Rooms where the current User is joined.

Discussion

This event is fired whenever a User leaves one of the Rooms where the current User is joined.

Discussion

This event is fired in response to a FindUsersRequest

Discussion

This event is fired in response to a SetUserVariablesRequest