Creating a Room Variable

Top  Previous  Next

When a client creates a room variable the following are specified:

Room Id (integer) – The id of the room in which to create the Room Variable.
Zone Id (integer) – The id of the zone that owns the room.
Name (string) – The name of the Room Variable.
Value (EsObject) – The EsObject value of the Room Variable.
Locked (Boolean) – If true then the variable cannot be modified until it is unlocked. If false then the variable value can be modified.
Persistent (Boolean) – If true then when the user that creates the Room Variable leaves the room the variable remains. If false then when the user that created the Room Variable leaves the room the variable is removed.