Photon Server API Documentation v5.0RC1

Classes | Enumerations
Photon.LoadBalancing.Operations Namespace Reference

Classes

class  AuthenticateRequest
 
class  AuthenticateResponse
 
class  CreateGameResponse
 Defines the response paramters for create game requests. More...
 
class  FindFriendsOptions
 
class  FindFriendsRequest
 
class  FindFriendsResponse
 
class  GetGameListRequest
 
class  GetGameListResponse
 
class  GetLobbyStatsRequest
 
class  GetLobbyStatsResponse
 
class  JoinGameResponse
 used by master code and by tests to not create extra overloads for JoinGame methods More...
 
class  JoinGameResponseBase
 
class  JoinLobbyRequest
 
class  JoinRandomGameRequest
 
class  JoinRandomGameResponse
 
class  RedirectRepeatResponse
 
class  SettingsRequest
 
class  SettingsRequestParameters
 

Enumerations

enum  JoinRandomType { JoinRandomType.FillRoom = 0, JoinRandomType.SerialMatching = 1, JoinRandomType.RandomMatching = 2 }
 
enum  OperationCode : byte {
  OperationCode.Leave = Photon.Hive.Operations.OperationCode.Leave, OperationCode.RaiseEvent = Photon.Hive.Operations.OperationCode.RaiseEvent, OperationCode.SetProperties = Photon.Hive.Operations.OperationCode.SetProperties, OperationCode.GetProperties = Photon.Hive.Operations.OperationCode.GetProperties,
  OperationCode.Ping = Photon.Hive.Operations.OperationCode.Ping, OperationCode.ChangeGroups = Photon.Hive.Operations.OperationCode.ChangeGroups, OperationCode.AuthOnce = Photon.Hive.Operations.OperationCode.AuthOnce, OperationCode.Authenticate = Photon.Hive.Operations.OperationCode.Authenticate,
  OperationCode.JoinLobby = Photon.Hive.Operations.OperationCode.JoinLobby, OperationCode.LeaveLobby = Photon.Hive.Operations.OperationCode.LeaveLobby, OperationCode.CreateGame = Photon.Hive.Operations.OperationCode.CreateGame, OperationCode.JoinGame = Photon.Hive.Operations.OperationCode.JoinGame,
  OperationCode.JoinRandomGame = Photon.Hive.Operations.OperationCode.JoinRandomGame, OperationCode.DebugGame = Photon.Hive.Operations.OperationCode.DebugGame, OperationCode.FindFriends = Photon.Hive.Operations.OperationCode.FindFriends, OperationCode.LobbyStats = Photon.Hive.Operations.OperationCode.LobbyStats,
  OperationCode.Rpc = Photon.Hive.Operations.OperationCode.Rpc, OperationCode.Settings = Photon.Hive.Operations.OperationCode.Settings, OperationCode.GetGameList = Photon.Hive.Operations.OperationCode.GetGameList, OperationCode.LoadBalancingMin = Rpc - 10
}
 
enum  ParameterCode : byte {
  ParameterCode.GameId = Photon.Hive.Operations.ParameterKey.GameId, ParameterCode.ActorNr = Photon.Hive.Operations.ParameterKey.ActorNr, ParameterCode.TargetActorNr = Photon.Hive.Operations.ParameterKey.TargetActorNr, ParameterCode.Actors = Photon.Hive.Operations.ParameterKey.Actors,
  ParameterCode.Properties = Photon.Hive.Operations.ParameterKey.Properties, ParameterCode.Broadcast = Photon.Hive.Operations.ParameterKey.Broadcast, ParameterCode.ActorProperties = Photon.Hive.Operations.ParameterKey.ActorProperties, ParameterCode.GameProperties = Photon.Hive.Operations.ParameterKey.GameProperties,
  ParameterCode.Cache = Photon.Hive.Operations.ParameterKey.Cache, ParameterCode.ReceiverGroup = Photon.Hive.Operations.ParameterKey.ReceiverGroup, ParameterCode.Data = Photon.Hive.Operations.ParameterKey.Data, ParameterCode.Code = Photon.Hive.Operations.ParameterKey.Code,
  ParameterCode.Flush = Photon.Hive.Operations.ParameterKey.Flush, ParameterCode.DeleteCacheOnLeave = Photon.Hive.Operations.ParameterKey.DeleteCacheOnLeave, ParameterCode.Group = Photon.Hive.Operations.ParameterKey.Group, ParameterCode.GroupsForRemove = Photon.Hive.Operations.ParameterKey.GroupsForRemove,
  ParameterCode.GroupsForAdd = Photon.Hive.Operations.ParameterKey.GroupsForAdd, ParameterCode.SuppressRoomEvents = Photon.Hive.Operations.ParameterKey.SuppressRoomEvents, ParameterCode.EmptyRoomLiveTime = Photon.Hive.Operations.ParameterKey.EmptyRoomLiveTime, ParameterCode.Address = Photon.Hive.Operations.ParameterKey.Address,
  ParameterCode.PeerCount = Photon.Hive.Operations.ParameterKey.PeerCount, ParameterCode.GameCount = Photon.Hive.Operations.ParameterKey.GameCount, ParameterCode.MasterPeerCount = Photon.Hive.Operations.ParameterKey.MasterPeerCount, ParameterCode.UserId = Photon.Hive.Operations.ParameterKey.UserId,
  ParameterCode.ApplicationId = Photon.Hive.Operations.ParameterKey.ApplicationId, ParameterCode.Position = Photon.Hive.Operations.ParameterKey.Position, ParameterCode.MatchMakingType = Photon.Hive.Operations.ParameterKey.Position, ParameterCode.GameList = Photon.Hive.Operations.ParameterKey.GameList,
  ParameterCode.Token = Photon.Hive.Operations.ParameterKey.Token, ParameterCode.AppVersion = Photon.Hive.Operations.ParameterKey.AppVersion, ParameterCode.NodeId = Photon.Hive.Operations.ParameterKey.NodeId, ParameterCode.Info = Photon.Hive.Operations.ParameterKey.Info,
  ParameterCode.ClientAuthenticationType = Photon.Hive.Operations.ParameterKey.ClientAuthenticationType, ParameterCode.ClientAuthenticationParams = Photon.Hive.Operations.ParameterKey.ClientAuthenticationParams, ParameterCode.CreateIfNotExists = Photon.Hive.Operations.ParameterKey.CreateIfNotExists, ParameterCode.JoinType = Photon.Hive.Operations.ParameterKey.JoinMode,
  ParameterCode.ClientAuthenticationData = Photon.Hive.Operations.ParameterKey.ClientAuthenticationData, ParameterCode.LobbyName = Photon.Hive.Operations.ParameterKey.LobbyName, ParameterCode.LobbyType = Photon.Hive.Operations.ParameterKey.LobbyType, ParameterCode.LobbyStats = Photon.Hive.Operations.ParameterKey.LobbyStats,
  ParameterCode.Region = Photon.Hive.Operations.ParameterKey.Region, ParameterCode.Nickname = Photon.Hive.Operations.ParameterKey.Nickname, ParameterCode.PluginName = Photon.Hive.Operations.ParameterKey.PluginName, ParameterCode.PluginVersion = Photon.Hive.Operations.ParameterKey.PluginVersion,
  ParameterCode.AddUsers = Photon.Hive.Operations.ParameterKey.AddUsers, ParameterCode.CloudType = Photon.Hive.Operations.ParameterKey.CloudType, ParameterCode.GameRemoveReason = Photon.Hive.Operations.ParameterKey.GameRemoveReason
}
 

Enumeration Type Documentation

◆ JoinRandomType

Enumerator
FillRoom 

Fills up rooms (oldest first) to get players together as fast as possible. Default.

Makes most sense with MaxPlayers > 0 and games that can only start with more players.

SerialMatching 

Distributes players across available rooms sequentially but takes filter into account. Without filter, rooms get players evenly distributed.

RandomMatching 

Joins a (fully) random room. Expected properties must match but aside from this, any available room might be selected.

◆ OperationCode

Enumerator
Leave 
RaiseEvent 
SetProperties 
GetProperties 
Ping 
ChangeGroups 
AuthOnce 
Authenticate 
JoinLobby 
LeaveLobby 
CreateGame 
JoinGame 
JoinRandomGame 
DebugGame 
FindFriends 
LobbyStats 
Rpc 
Settings 
GetGameList 
LoadBalancingMin 

◆ ParameterCode

Enumerator
GameId 
ActorNr 
TargetActorNr 
Actors 
Properties 
Broadcast 
ActorProperties 
GameProperties 
Cache 
ReceiverGroup 
Data 
Code 
Flush 
DeleteCacheOnLeave 
Group 
GroupsForRemove 
GroupsForAdd 
SuppressRoomEvents 
EmptyRoomLiveTime 
Address 
PeerCount 
GameCount 
MasterPeerCount 
UserId 
ApplicationId 
Position 
MatchMakingType 
GameList 
Token 
AppVersion 
NodeId 
Info 
ClientAuthenticationType 
ClientAuthenticationParams 
CreateIfNotExists 
JoinType 
ClientAuthenticationData 
LobbyName 
LobbyType 
LobbyStats 
Region 
Nickname 
PluginName 
PluginVersion 
AddUsers 
CloudType 
GameRemoveReason