Photon Server API Documentation
v5.0RC1
Classes | |
| class | ChangeGroups |
| class | CloseRequest |
| class | CreateGameRequest |
| we use CreateGameRequest only on master, because only on master it is allowed to NOT set GameId. it will be set automatically in this case on GS we use JoinGameRequest even in case of game creation. because it does not allow empty game Id More... | |
| class | DebugGameRequest |
| class | DebugGameResponse |
| class | GetPropertiesRequest |
| The get properties request. More... | |
| class | GetPropertiesResponse |
| Response for GetPropertiesRequest. More... | |
| class | HiveErrorMessages |
| class | JoinGameRequest |
| This class implements the Join operation. More... | |
| class | JoinModes |
| class | JoinResponse |
| Response for JoinGameRequest. More... | |
| class | LeaveRequest |
| Implements the Leave operation. More... | |
| class | RaiseEventRequest |
| Implements the RaiseEvent operation. More... | |
| class | SetPropertiesRequest |
| The set properties operation. More... | |
|
strong |
|
strong |
Parameter value of RaiseEventRequest.
|
strong |
Event codes of events (defining their type and keys).
|
strong |
|
strong |
Defines the operation codes used by the Lite application. These codes match events (in parts).
| Enumerator | |
|---|---|
| Join | The operation code for the join operation. |
| Leave | Operation code for the leave operation. |
| RaiseEvent | Operation code for the raise event operation. |
| SetProperties | Operation code for the set properties operation. |
| GetProperties | Operation code for the get properties operation. |
| Ping | Operation code for the ping operation. |
| ChangeGroups | Operation code for the ChangeGroups operation. |
| AuthOnce | |
| Authenticate | |
| JoinLobby | |
| LeaveLobby | |
| CreateGame | |
| JoinGame | |
| JoinRandomGame | |
| DebugGame | |
| FindFriends | |
| LobbyStats | |
| Rpc | |
| Settings | |
| GetGameList | |
|
strong |
Parameter keys are used as event-keys, operation-parameter keys and operation-return keys alike. The values are partly taken from Exit Games Photon, which contains many more keys.
| Enumerator | |
|---|---|
| GameId | The game id. |
| ActorNr | The actor nr used as op-key and ev-key |
| TargetActorNr | The target actor nr. |
| Actors | The actors. |
| Properties | The properties. |
| Broadcast | The broadcast. |
| ActorProperties | The actor properties. |
| GameProperties | The game properties. |
| Cache | Event parameter to indicate whether events are cached for new actors. |
| ReceiverGroup | Event parameter containing a Photon.Hive.Operations.ReceiverGroup value. |
| Data | The data. |
| Code | The paramter code for the raise event operations event code. |
| Flush | the flush event code for raise event. |
| DeleteCacheOnLeave | Event parameter to indicate whether cached events are deleted automaticly for actors leaving a room. |
| Group | The group this event should be sent to. No error is happening if the group is empty or not existing. |
| GroupsForRemove | Groups to leave. Null won't remove any groups. byte[0] will remove ALL groups. Otherwise only the groups listed will be removed. |
| PublishUserId | Should or not JoinGame response and JoinEvent contain user ids |
| GroupsForAdd | Groups to enter. Null won't add groups. byte[0] will add ALL groups. Otherwise only the groups listed will be added. |
| AddUsers | |
| SuppressRoomEvents | A parameter indicating if common room events (Join, Leave) will be suppressed. |
| EmptyRoomLiveTime | A parameter indicating how long a room instance should be kept alive in the room cache after all players left the room. |
| PlayerTTL | A parameter indicating how long a player is allowd to rejoin. |
| HttpForward | A parameter indicating that content of room event should be forwarded to some server |
| WebFlags | |
| IsInactive | Allows the player to re-join the game. |
| CheckUserOnJoin | Activates UserId checks on joining - allowing a users to be only once in the room. Default is deactivated for backwards compatibility, but we recomend to use in future Note: Should be active for saved games. |
| ExpectedValues | Expected values for actor and game properties |
| Address | |
| PeerCount | |
| ForceRejoin | |
| GameCount | |
| MasterPeerCount | |
| UserId | |
| ApplicationId | |
| Position | |
| GameList | |
| Token | |
| AppVersion | |
| NodeId | |
| Info | |
| ClientAuthenticationType | |
| ClientAuthenticationParams | |
| CreateIfNotExists | |
| JoinMode | |
| ClientAuthenticationData | |
| LobbyName | |
| LobbyType | |
| LobbyStats | |
| Region | |
| UriPath | |
| RpcCallParams | |
| RpcCallRetCode | |
| RpcCallRetMessage | |
| CacheSliceIndex | |
| Plugins | |
| MasterClientId | |
| Nickname | |
| PluginName | |
| PluginVersion | |
| Flags | |
| CloudType | |
| GameRemoveReason | |
| Cluster | |
| ExpectedProtocol | |
| RoomOptionFlags | |
|
strong |
|
strong |
|
strong |