Photon Plugins API Documentation
Properties | List of all members
Photon.Hive.Plugin.IJoinGameRequest Interface Reference

Base interface of Op Join request containing the parameters as sent by client. More...

Inheritance diagram for Photon.Hive.Plugin.IJoinGameRequest:
Photon.Hive.Plugin.IOperationRequest Photon.Hive.Plugin.IJoinRequest

Properties

int ActorNr [get, set]
 Actor number, which will be used for rejoin More...
 
Hashtable ActorProperties [get, set]
 Gets or sets custom actor properties. More...
 
bool BroadcastActorProperties [get, set]
 Gets or sets a value indicating whether the actor properties should be included in the JoinEvent event which will be sent to all clients currently in the room. More...
 
bool DeleteCacheOnLeave [get, set]
 Gets or sets a value indicating whether cached events are automaticly deleted for actors which are leaving a room. More...
 
int EmptyRoomLiveTime [get, set]
 Gets or sets a value indicating how long the room instance will be kept alive in the room cache after all peers have left the room. More...
 
string GameId [get, set]
 Gets or sets the name of the game (room). More...
 
Hashtable GameProperties [get, set]
 Gets or sets custom game properties. More...
 
bool SuppressRoomEvents [get, set]
 Gets or sets a value indicating if common room events (Join, Leave) will be suppressed. More...
 
bool CreateIfNotExists [get]
 True if JoinMode is CreateIfNotExists. More...
 
string LobbyName [get]
 Name of the lobby to which this room belongs. More...
 
byte LobbyType [get]
 Type of the lobby to which this room belongs. More...
 
byte JoinMode [get]
 Op Join mode. For possible values, Photon.Hive.Plugin.JoinModeConstants. More...
 
- Properties inherited from Photon.Hive.Plugin.IOperationRequest
byte OperationCode [get]
 Unique reserved code per operation. More...
 
Dictionary< byte, object > Parameters [get]
 Operation request parameters combined as sent by client. More...
 
byte WebFlags [get, set]
 Request webflags optionnaly set by client to control webhooks behaviour. More...
 

Detailed Description

Base interface of Op Join request containing the parameters as sent by client.

Property Documentation

int Photon.Hive.Plugin.IJoinGameRequest.ActorNr
getset

Actor number, which will be used for rejoin

Hashtable Photon.Hive.Plugin.IJoinGameRequest.ActorProperties
getset

Gets or sets custom actor properties.

bool Photon.Hive.Plugin.IJoinGameRequest.BroadcastActorProperties
getset

Gets or sets a value indicating whether the actor properties should be included in the JoinEvent event which will be sent to all clients currently in the room.

bool Photon.Hive.Plugin.IJoinGameRequest.CreateIfNotExists
get

True if JoinMode is CreateIfNotExists.

bool Photon.Hive.Plugin.IJoinGameRequest.DeleteCacheOnLeave
getset

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

int Photon.Hive.Plugin.IJoinGameRequest.EmptyRoomLiveTime
getset

Gets or sets a value indicating how long the room instance will be kept alive in the room cache after all peers have left the room.

This property will only be applied for the room creator.

string Photon.Hive.Plugin.IJoinGameRequest.GameId
getset

Gets or sets the name of the game (room).

Hashtable Photon.Hive.Plugin.IJoinGameRequest.GameProperties
getset

Gets or sets custom game properties.

Game properties will only be applied for the game creator.

byte Photon.Hive.Plugin.IJoinGameRequest.JoinMode
get

Op Join mode. For possible values, Photon.Hive.Plugin.JoinModeConstants.

string Photon.Hive.Plugin.IJoinGameRequest.LobbyName
get

Name of the lobby to which this room belongs.

byte Photon.Hive.Plugin.IJoinGameRequest.LobbyType
get

Type of the lobby to which this room belongs.

bool Photon.Hive.Plugin.IJoinGameRequest.SuppressRoomEvents
getset

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

This property will only be applied for the game creator.