Photon .NET Client API
Public Attributes | List of all members
ExitGames.Client.Photon.LoadBalancing.GamePropertyKey Class Reference

Class for constants. These (byte) values are for "well known" room/game properties used in Photon Loadbalancing. More...

Public Attributes

const byte MaxPlayers = 255
 (255) Max number of players that "fit" into this room. 0 is for "unlimited". More...
 
const byte IsVisible = 254
 (254) Makes this room listed or not in the lobby on master. More...
 
const byte IsOpen = 253
 (253) Allows more players to join a room (or not). More...
 
const byte PlayerCount = 252
 (252) Current count of players in the room. Used only in the lobby on master. More...
 
const byte Removed = 251
 (251) True if the room is to be removed from room listing (used in update to room list in lobby on master) More...
 
const byte PropsListedInLobby = 250
 (250) A list of the room properties to pass to the RoomInfo list in a lobby. This is used in CreateRoom, which defines this list once per room. More...
 
const byte CleanupCacheOnLeave = 249
 (249) Equivalent of Operation Join parameter CleanupCacheOnLeave. More...
 
const byte MasterClientId = (byte)248
 (248) Code for MasterClientId, which is synced by server. When sent as op-parameter this is (byte)203. As room property this is (byte)248. More...
 

Detailed Description

Class for constants. These (byte) values are for "well known" room/game properties used in Photon Loadbalancing.

"Custom properties" have to use a string-type as key. They can be assigned at will.

Member Data Documentation

const byte ExitGames.Client.Photon.LoadBalancing.GamePropertyKey.CleanupCacheOnLeave = 249

(249) Equivalent of Operation Join parameter CleanupCacheOnLeave.

const byte ExitGames.Client.Photon.LoadBalancing.GamePropertyKey.IsOpen = 253

(253) Allows more players to join a room (or not).

const byte ExitGames.Client.Photon.LoadBalancing.GamePropertyKey.IsVisible = 254

(254) Makes this room listed or not in the lobby on master.

const byte ExitGames.Client.Photon.LoadBalancing.GamePropertyKey.MasterClientId = (byte)248

(248) Code for MasterClientId, which is synced by server. When sent as op-parameter this is (byte)203. As room property this is (byte)248.

Tightly related to ParameterCode.MasterClientId.

const byte ExitGames.Client.Photon.LoadBalancing.GamePropertyKey.MaxPlayers = 255

(255) Max number of players that "fit" into this room. 0 is for "unlimited".

const byte ExitGames.Client.Photon.LoadBalancing.GamePropertyKey.PlayerCount = 252

(252) Current count of players in the room. Used only in the lobby on master.

const byte ExitGames.Client.Photon.LoadBalancing.GamePropertyKey.PropsListedInLobby = 250

(250) A list of the room properties to pass to the RoomInfo list in a lobby. This is used in CreateRoom, which defines this list once per room.

const byte ExitGames.Client.Photon.LoadBalancing.GamePropertyKey.Removed = 251

(251) True if the room is to be removed from room listing (used in update to room list in lobby on master)


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