Photon.Bolt.PhotonRoomProperties Class Reference

Inheritance diagram for Photon.Bolt.PhotonRoomProperties:

Public Member Functions
bool	AddRoomProperty (string key, object value, bool showInLobby=true)
	Adds the room property. More...
	PhotonRoomProperties ()
void	Read (UdpPacket packet)
	Used to deserialize the Token reading data from the data packet. More...
bool	RemoveRoomProperty (string key)
	Removes the room property. More...
void	Write (UdpPacket packet)
	Used to serialize the Token by writing data into the data packet. More...

Properties
Dictionary< object, object >	CustomRoomProperties [get]
HashSet< string >	CustomRoomPropertiesInLobby [get]
bool	IsOpen [get, set]
bool	IsVisible [get, set]
object	this[string key] [get, set]

Constructor & Destructor Documentation

PhotonRoomProperties()

Photon.Bolt.PhotonRoomProperties.PhotonRoomProperties ( )

inline

Member Function Documentation

AddRoomProperty()

bool Photon.Bolt.PhotonRoomProperties.AddRoomProperty ( string  key, object  value, bool  showInLobby = true  )

inline

Adds the room property.

Returns

true, if room property was added, false otherwise.

Parameters

key	Propety Key.
value	Property Value.
showInLobby	If set to true show this property on the Lobby too, so the client can see the properties before entering the room.

Read()

void Photon.Bolt.PhotonRoomProperties.Read ( UdpPacket  packet )

inline

Used to deserialize the Token reading data from the data packet.

Parameters

packet

Data packet that contains the Token info

Implements Photon.Bolt.IProtocolToken.

RemoveRoomProperty()

bool Photon.Bolt.PhotonRoomProperties.RemoveRoomProperty ( string  key )

inline

Removes the room property.

Returns

true, if room property was removed, false otherwise.

Parameters

key	Property Key.

Write()

void Photon.Bolt.PhotonRoomProperties.Write ( UdpPacket  packet )

inline

Used to serialize the Token by writing data into the data packet.

Parameters

packet

Data packet used to store the Token info

Implements Photon.Bolt.IProtocolToken.

Property Documentation

CustomRoomProperties

Dictionary<object, object> Photon.Bolt.PhotonRoomProperties.CustomRoomProperties

get

CustomRoomPropertiesInLobby

HashSet<string> Photon.Bolt.PhotonRoomProperties.CustomRoomPropertiesInLobby

get

IsOpen

bool Photon.Bolt.PhotonRoomProperties.IsOpen

getset

IsVisible

bool Photon.Bolt.PhotonRoomProperties.IsVisible

getset

this[string key]

object Photon.Bolt.PhotonRoomProperties.this[string key]

getset