RoomProperties Class |
Data class used to set room properties.
Inheritance HierarchyNamespace: SoftGear.Strix.Unity.Runtime
Assembly: StrixUnityRuntime (in StrixUnityRuntime.dll) Version: 1.5.0
SyntaxC#
public class RoomProperties
The RoomProperties type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RoomProperties | Initializes a new instance of the RoomProperties class |
Properties| Name | Description | |
|---|---|---|
 | capacity |
Maximum number of room members. This value gets clamped to [minRoomCapacity, maxRoomCapacity] range as configured on the server. If not specified, 4 is used by default. You can set the capacity when creating a match room or change it later using SetRoom if you are the room's owner. |
| isJoinable |
Determines if new players are allowed to join the room; by default. You can make the room unjoinable when creating it or change the joinability later using SetRoom if you are the room's owner. |
| key1 |
An arbitrary double value that can be used for application's own purposes.
|
| key2 |
An arbitrary double value that can be used for application's own purposes.
|
| key3 |
An arbitrary double value that can be used for application's own purposes.
|
| key4 |
An arbitrary double value that can be used for application's own purposes.
|
| key5 |
An arbitrary double value that can be used for application's own purposes.
|
| key6 |
An arbitrary double value that can be used for application's own purposes.
|
| key7 |
An arbitrary double value that can be used for application's own purposes.
|
| key8 |
An arbitrary double value that can be used for application's own purposes.
|
| name |
The name of the room. You can set the name when creating the room or change it later using SetRoom if you are the room's owner. |
| password |
Room entry password. If set, new players must provide a matching password to join the room. Empty by default. You can set the password when creating a match room or change it later using SetRoom if you are the room's owner. |
| properties |
A dictionary of custom properties. Can be used to store any data related to the room.
These properties are not available for search.
|
| state |
An integer value that can be used for application's own purposes.
|
| stringKey |
An arbitrary string value that can be used for application's own purposes.
|
Methods| Name | Description | |
|---|---|---|
| AddDefaults | |
| FromDictionary | |
| ToDictionary |
Remarks
Use this to define match room parameters such as room name, maximum number of members, password, etc.
You can also define custom values key1, ..., key8, and stringKey that can be used later in a condition for SearchRoom.
See Also