Photon .NET Client API 4.1.4.8

Public Attributes | List of all members
Photon.Realtime.EnterRoomParams Class Reference

Parameters for creating rooms. More...

Public Attributes

string RoomName
 The name of the room to create. If null, the server generates a unique name. If not null, it must be unique and new or will cause an error. More...
 
RoomOptions RoomOptions
 The RoomOptions define the optional behaviour of rooms. More...
 
TypedLobby Lobby
 A lobby to attach the new room to. If set, this overrides a joined lobby (if any). More...
 
Hashtable PlayerProperties
 The custom player properties that describe this client / user. Keys must be strings. More...
 
bool CreateIfNotExists
 Matchmaking can optionally create a room if it is not existing. Also useful, when joining a room with a team: It does not matter who is first. More...
 
bool RejoinOnly
 Signals, if the user attempts to return to a room or joins one. Set by the methods that call an operation. More...
 
string[] ExpectedUsers
 A list of users who are expected to join the room along with this client. Reserves slots for rooms with MaxPlayers value. More...
 

Detailed Description

Parameters for creating rooms.

Member Data Documentation

◆ CreateIfNotExists

bool Photon.Realtime.EnterRoomParams.CreateIfNotExists

Matchmaking can optionally create a room if it is not existing. Also useful, when joining a room with a team: It does not matter who is first.

◆ ExpectedUsers

string [] Photon.Realtime.EnterRoomParams.ExpectedUsers

A list of users who are expected to join the room along with this client. Reserves slots for rooms with MaxPlayers value.

◆ Lobby

TypedLobby Photon.Realtime.EnterRoomParams.Lobby

A lobby to attach the new room to. If set, this overrides a joined lobby (if any).

◆ PlayerProperties

Hashtable Photon.Realtime.EnterRoomParams.PlayerProperties

The custom player properties that describe this client / user. Keys must be strings.

◆ RejoinOnly

bool Photon.Realtime.EnterRoomParams.RejoinOnly

Signals, if the user attempts to return to a room or joins one. Set by the methods that call an operation.

◆ RoomName

string Photon.Realtime.EnterRoomParams.RoomName

The name of the room to create. If null, the server generates a unique name. If not null, it must be unique and new or will cause an error.

◆ RoomOptions

RoomOptions Photon.Realtime.EnterRoomParams.RoomOptions

The RoomOptions define the optional behaviour of rooms.


The documentation for this class was generated from the following file: