SFSEvent Class |
This class represents most of the events dispatched by the SmartFoxServer 2X C# API.
Inheritance HierarchyNamespace: Sfs2X.Core
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class SFSEvent : BaseEvent
The SFSEvent type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Params |
A Dictionary containing the event's parameters.
(Inherited from BaseEvent.) |
| Target | (Inherited from BaseEvent.) |
| Type | (Inherited from BaseEvent.) |
Methods
Fields| Name | Description | |
|---|---|---|
   | ADMIN_MESSAGE |
Dispatched when the current user receives a message from an administrator user.
|
| CONFIG_LOAD_FAILURE |
Dispatched when an error occurs while loading the external SmartFox configuration file.
|
| CONFIG_LOAD_SUCCESS |
Dispatched when the external client configuration file is loaded successfully.
|
| CONNECTION |
Dispatched when a connection between the client and a SmartFoxServer 2X instance is attempted.
|
| CONNECTION_ATTEMPT_HTTP |
Dispatched when the client cannot establish a socket connection to the server and the useBlueBox parameter is active in the configuration.
|
| CONNECTION_LOST |
Dispatched when the connection between the client and the SmartFoxServer 2X instance is interrupted.
|
| CONNECTION_RESUME |
Dispatched when the connection between the client and the SmartFoxServer 2X instance is re-established after a temporary disconnection,
while the SmartFoxServer 2X HRC system is available in the Zone.
|
| CONNECTION_RETRY |
Dispatched when the connection between the client and the SmartFoxServer 2X instance is interrupted abruptly while the SmartFoxServer 2X HRC system is available in the Zone.
|
| CRYPTO_INIT |
Dispatched in return to the initialization of an encrypted connection.
|
| EXTENSION_RESPONSE |
Dispatched when data coming from a server-side Extension is received by the current user.
|
| HANDSHAKE | |
| INVITATION |
Dispatched when the current user receives an invitation from another user.
|
| INVITATION_REPLY |
Dispatched when the current user receives a reply to an invitation he sent previously.
|
| INVITATION_REPLY_ERROR |
Dispatched when an error occurs while the current user is sending a reply to an invitation he received.
|
| LOGIN |
Dispatched when the current user performs a successful login in a server Zone.
|
| LOGIN_ERROR |
Dispatched if an error occurs while the user login is being performed.
|
| LOGOUT |
Dispatched when the current user performs logs out of the server Zone.
|
| MMOITEM_VARIABLES_UPDATE |
Dispatched when an MMOItem Variable is updated in an MMORoom.
|
| MODERATOR_MESSAGE |
Dispatched when the current user receives a message from a moderator user.
|
| OBJECT_MESSAGE |
Dispatched when an object containing custom data is received by the current user.
|
| PING_PONG |
Dispatched when a new lag value measurement is available.
|
| PLAYER_TO_SPECTATOR |
Dispatched when a player is turned to a spectator inside a Game Room.
|
| PLAYER_TO_SPECTATOR_ERROR |
Dispatched when an error occurs while the current user is being turned from player to spectator in a Game Room.
|
| PRIVATE_MESSAGE |
Dispatched when a private message is received by the current user.
|
| PROXIMITY_LIST_UPDATE |
Dispatched when one more users or one or more MMOItem objects enter/leave the current user's Area of Interest in MMORooms.
|
| PUBLIC_MESSAGE |
Dispatched when a public message is received by the current user.
|
| ROOM_ADD |
Dispatched when a new Room is created inside the Zone under any of the Room Groups that the client subscribed.
|
| ROOM_CAPACITY_CHANGE |
Dispatched when the capacity of a Room is changed.
|
| ROOM_CAPACITY_CHANGE_ERROR |
Dispatched when an error occurs while attempting to change the capacity of a Room.
|
| ROOM_CREATION_ERROR |
Dispatched if an error occurs while creating a new Room.
|
| ROOM_FIND_RESULT |
Dispatched when a Rooms search is completed.
|
| ROOM_GROUP_SUBSCRIBE |
Dispatched when a Group is subscribed by the current user.
|
| ROOM_GROUP_SUBSCRIBE_ERROR |
Dispatched when an error occurs while a Room Group is being subscribed.
|
| ROOM_GROUP_UNSUBSCRIBE |
Dispatched when a Group is unsubscribed by the current user.
|
| ROOM_GROUP_UNSUBSCRIBE_ERROR |
Dispatched when an error occurs while a Room Group is being unsubscribed.
|
| ROOM_JOIN |
Dispatched when a Room is joined by the current user.
|
| ROOM_JOIN_ERROR |
Dispatched when an error occurs while the current user is trying to join a Room.
|
| ROOM_NAME_CHANGE |
Dispatched when the name of a Room is changed.
|
| ROOM_NAME_CHANGE_ERROR |
Dispatched when an error occurs while attempting to change the name of a Room.
|
| ROOM_PASSWORD_STATE_CHANGE |
Dispatched when the password of a Room is set, changed or removed.
|
| ROOM_PASSWORD_STATE_CHANGE_ERROR |
Dispatched when an error occurs while attempting to set, change or remove the password of a Room.
|
| ROOM_REMOVE |
Dispatched when a Room belonging to one of the Groups subscribed by the client is removed from the Zone.
|
| ROOM_VARIABLES_UPDATE |
Dispatched when a Room Variable is updated.
|
| SOCKET_ERROR |
Dispatched when a low level socket error is detected, for example bad/inconsistent data.
|
| SPECTATOR_TO_PLAYER |
Dispatched when a spectator is turned to a player inside a Game Room.
|
| SPECTATOR_TO_PLAYER_ERROR |
Dispatched when an error occurs while the current user is being turned from spectator to player in a Game Room.
|
| UDP_INIT |
Dispatched when the result of the UDP handshake is notified.
|
| USER_COUNT_CHANGE |
Dispatched when the number of users/players or spectators inside a Room changes.
|
| USER_ENTER_ROOM |
Dispatched when one of the Rooms joined by the current user is entered by another user.
|
| USER_EXIT_ROOM |
Dispatched when one of the Rooms joined by the current user is left by another user, or by the current user himself.
|
| USER_FIND_RESULT |
Dispatched when a users search is completed
|
| USER_VARIABLES_UPDATE |
Dispatched when a User Variable is updated.
|
See Also