The SFSRoomVariable object represents a SmartFoxServer Room Variable entity on the client.

Namespace: Sfs2X.Entities.Variables
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.7.3.0 (1.7.3)

Syntax

C#
public class SFSRoomVariable : BaseVariable, 
	RoomVariable, Variable

Remarks

This is a custom value attached to a Room object that gets automatically synchronized between client and server on every change.

Room Variables are particularly useful to store custom Room data such as a game status and other Room-level informations. Room Variables can be set by means of the SetRoomVariablesRequest request; they support the data types listed in the class (also nested). A Room Variable can also be null.

Room Variables also support a number of specific flags:

  • Private: a private Room Variable can only be modified by its creator.
  • Persistent: a persistent Room Variable will continue to exist even if its creator has left the Room (but will be deleted when the creator will get disconnected).
  • Global: a global Room Variable will fire update events not only to all users in the Room, but also to all users in the Group to which the Room belongs (NOTE: this flag is not available on the client-side because clients are not allowed to create global Room Variables).

Inheritance Hierarchy

System..::..Object
  Sfs2X.Entities.Variables..::..BaseVariable
    Sfs2X.Entities.Variables..::..SFSRoomVariable

See Also