Photon Server API

Public Member Functions | Protected Attributes | Properties | List of all members
Photon.Hive.GameState Class Reference
Inheritance diagram for Photon.Hive.GameState:
Photon.Hive.Tests.TestGameState

Public Member Functions

 GameState ()
 
bool SetState (SerializableGameState state)
 
bool SetState (Dictionary< string, object > state)
 
SerializableGameState GetSerializableGameState ()
 
Dictionary< string, object > GetState ()
 

Protected Attributes

ActorsManager actorsManager
 

Properties

PropertyBag< object > Properties [get]
 Gets a PropertyBag instance used to store custom room properties. More...
 
int EmptyRoomLiveTime [get, set]
 
bool IsOpen [get, set]
 
bool IsVisible [get, set]
 
string LobbyId [get, set]
 
bool CheckUserOnJoin [get, set]
 
bool PublishUserId [get, set]
 
bool DeleteCacheOnLeave [get, set]
 Gets or sets a value indicating whether cached events are automaticly deleted for actors which are leaving a room. More...
 
HashSet< object > LobbyProperties [get, set]
 Contains the keys of the game properties hashtable which should be listet in the lobby. More...
 
AppLobbyType LobbyType [get, set]
 
byte MaxPlayers [get, set]
 
int PlayerTTL [get, set]
 Player live time More...
 
bool SuppressRoomEvents [get, set]
 Gets or sets a value indicating if common room events (Join, Leave) will suppressed. More...
 
RoomEventCacheManager EventCache [get]
 
EventCacheDictionary ActorEventCache [get]
 Contains Caching.EventCaches for all actors. More...
 
GroupManager GroupManager [get]
 
ActorsManager ActorsManager [get]
 

Constructor & Destructor Documentation

◆ GameState()

Photon.Hive.GameState.GameState ( )
inline

Member Function Documentation

◆ GetSerializableGameState()

SerializableGameState Photon.Hive.GameState.GetSerializableGameState ( )
inline

◆ GetState()

Dictionary<string, object> Photon.Hive.GameState.GetState ( )
inline

◆ SetState() [1/2]

bool Photon.Hive.GameState.SetState ( Dictionary< string, object >  state)
inline

◆ SetState() [2/2]

bool Photon.Hive.GameState.SetState ( SerializableGameState  state)
inline

Member Data Documentation

◆ actorsManager

ActorsManager Photon.Hive.GameState.actorsManager
protected

Property Documentation

◆ ActorEventCache

EventCacheDictionary Photon.Hive.GameState.ActorEventCache
get

Contains Caching.EventCaches for all actors.

◆ ActorsManager

ActorsManager Photon.Hive.GameState.ActorsManager
get

◆ CheckUserOnJoin

bool Photon.Hive.GameState.CheckUserOnJoin
getset

◆ DeleteCacheOnLeave

bool Photon.Hive.GameState.DeleteCacheOnLeave
getset

Gets or sets a value indicating whether cached events are automaticly deleted for actors which are leaving a room.

◆ EmptyRoomLiveTime

int Photon.Hive.GameState.EmptyRoomLiveTime
getset

◆ EventCache

RoomEventCacheManager Photon.Hive.GameState.EventCache
get

◆ GroupManager

GroupManager Photon.Hive.GameState.GroupManager
get

◆ IsOpen

bool Photon.Hive.GameState.IsOpen
getset

◆ IsVisible

bool Photon.Hive.GameState.IsVisible
getset

◆ LobbyId

string Photon.Hive.GameState.LobbyId
getset

◆ LobbyProperties

HashSet<object> Photon.Hive.GameState.LobbyProperties
getset

Contains the keys of the game properties hashtable which should be listet in the lobby.

◆ LobbyType

AppLobbyType Photon.Hive.GameState.LobbyType
getset

◆ MaxPlayers

byte Photon.Hive.GameState.MaxPlayers
getset

◆ PlayerTTL

int Photon.Hive.GameState.PlayerTTL
getset

Player live time

◆ Properties

PropertyBag<object> Photon.Hive.GameState.Properties
get

Gets a PropertyBag instance used to store custom room properties.

◆ PublishUserId

bool Photon.Hive.GameState.PublishUserId
getset

◆ SuppressRoomEvents

bool Photon.Hive.GameState.SuppressRoomEvents
getset

Gets or sets a value indicating if common room events (Join, Leave) will suppressed.