|
| | QuantumLoadBalancingClient (ConnectionProtocol protocol=ConnectionProtocol.Udp) |
| | Constructor. More...
|
| |
| virtual bool | ConnectUsingSettings (AppSettings appSettings, string nickname) |
| | Overridden connect method. More...
|
| |
| | RealtimeClient (ConnectionProtocol protocol=ConnectionProtocol.Udp) |
| | Creates a RealtimeClient with UDP protocol or the one specified. More...
|
| |
| void | AddCallbackTarget (object target) |
| | Registers an object for callbacks for the implemented callback-interfaces. More...
|
| |
| void | ChangeLocalID (int newID) |
| | Internally used to set the LocalPlayer's ID (from -1 to the actual in-room ID). More...
|
| |
| virtual bool | ConnectUsingSettings (AppSettings appSettings) |
| | Starts the "process" to connect as defined by the appSettings (AppId, AppVersion, Transport Protocol, Port and more). More...
|
| |
| virtual void | DebugReturn (LogLevel level, string message) |
| | Debug output handling for the PhotonPeer. Use LogLevelPeer if you want to check if a message should get logged. More...
|
| |
| void | Disconnect () |
| | Disconnects the client from a server or stays disconnected. If the client was connected, a callback will be triggered (via DispatchIncomingCommands calls). More...
|
| |
| bool | DispatchIncomingCommands () |
| | Dispatches a received message (operation response, event, etc) from the queue. More...
|
| |
| void | GetRegions (AppSettings appSettings, bool ping=true) |
| | Gets the region list for the app (by AppId) pings them. Will callback: OnRegionListReceived. More...
|
| |
| void | OnDisconnectMessage (DisconnectMessage obj) |
| | Called when the client received a Disconnect Message from the server. Signals an error and provides a message to debug the case. More...
|
| |
| virtual void | OnEvent (EventData photonEvent) |
| | Uses the photonEvent's provided by the server to advance the internal state and call ops as needed. More...
|
| |
| virtual void | OnMessage (bool isRawMessage, object message) |
| | Callback for messages. Check documentation in interface. Raw messages are always provided as ArraySegment<byte>. More...
|
| |
| virtual void | OnOperationResponse (OperationResponse operationResponse) |
| | Uses the OperationResponses provided by the server to advance the internal state and call ops as needed. More...
|
| |
| virtual void | OnStatusChanged (StatusCode statusCode) |
| | Uses the connection's statusCodes to advance the internal state and call operations as needed. More...
|
| |
| virtual bool | OpAuthenticate (string appId, string appVersion, AuthenticationValues authValues, string regionCode, bool getLobbyStatistics) |
| | Sends this app's appId and appVersion to identify this application server side. This is an async request which triggers a OnOperationResponse() call. More...
|
| |
| virtual bool | OpAuthenticateOnce (string appId, string appVersion, AuthenticationValues authValues, string regionCode, EncryptionMode encryptionMode, ConnectionProtocol expectedProtocol) |
| | Sends this app's appId and appVersion to identify this application server side. This is an async request which triggers a OnOperationResponse() call. More...
|
| |
| virtual bool | OpChangeGroups (byte[] groupsToRemove, byte[] groupsToAdd) |
| | Operation to handle this client's interest groups (for events in room). More...
|
| |
| bool | OpCreateMatchmakingTicket (int[] actorsToInclude) |
| | Uses RaiseEvent to communicate with the Party Ticket Plugin. More...
|
| |
| bool | OpCreateRoom (EnterRoomArgs enterRoomArgs) |
| | Creates a new room. Will callback: OnCreatedRoom and OnJoinedRoom or OnCreateRoomFailed. More...
|
| |
| bool | OpFindFriends (string[] friendsToFind, FindFriendsArgs args=null) |
| | Request the rooms and online status for a list of friends. All clients should set a unique UserId before connecting. The result is available in this.FriendList. More...
|
| |
| virtual bool | OpGetGameList (TypedLobby lobby, string queryData) |
| | Gets a list of rooms matching the (non empty) SQL filter for the given SQL-typed lobby. More...
|
| |
| virtual bool | OpGetRegions () |
| | Operation to get the list of available regions (short names and their IPs to ping them) for the set AppId. Results via OnRegionListReceived. Only available on Name Server. More...
|
| |
| virtual bool | OpJoinLobby (TypedLobby lobby=null) |
| | Joins the lobby on the Master Server, where you get a list of RoomInfos of currently open rooms. This is an async request triggers an OnOperationResponse() call and the callback OnJoinedLobby(). More...
|
| |
| bool | OpJoinOrCreateRoom (EnterRoomArgs enterRoomArgs) |
| | Joins a specific room by name and creates it on demand. Will callback: OnJoinedRoom or OnJoinRoomFailed. More...
|
| |
| bool | OpJoinRandomOrCreateRoom (JoinRandomRoomArgs joinRandomRoomArgs=null, EnterRoomArgs createRoomArgs=null) |
| | Attempts to join a room that matches the specified filter and creates a room if none found. More...
|
| |
| bool | OpJoinRandomRoom (JoinRandomRoomArgs joinRandomRoomArgs=null) |
| | Joins a random room that matches the filter. Will callback: OnJoinedRoom or OnJoinRandomFailed. More...
|
| |
| bool | OpJoinRoom (EnterRoomArgs enterRoomArgs) |
| | Joins a room by name. Will callback: OnJoinedRoom or OnJoinRoomFailed. More...
|
| |
| bool | OpLeaveLobby () |
| | Opposite of joining a lobby. You don't have to explicitly leave a lobby to join another (client can be in one max, at any time). More...
|
| |
| virtual bool | OpLeaveRoom (bool becomeInactive) |
| | Leaves the current room, optionally telling the server that the user is just becoming inactive. Will callback: OnLeftRoom. More...
|
| |
| virtual bool | OpRaiseEvent (byte eventCode, object customEventContent, RaiseEventArgs raiseEventArgs, SendOptions sendOptions) |
| | Send an event with custom code/type and any content to the other players in the same room. More...
|
| |
| bool | OpRejoinRoom (string roomName, object ticket=null) |
| | Rejoins a room by roomName (using the userID internally to return). Will callback: OnJoinedRoom or OnJoinRoomFailed. More...
|
| |
| bool | OpSetCustomPropertiesOfActor (int actorNr, PhotonHashtable actorProperties) |
| | Operation to set Custom Properties for a player / actor. Only available in a room on a Game Server. More...
|
| |
| bool | OpSetCustomPropertiesOfActor (int actorNr, PhotonHashtable propertiesToSet, PhotonHashtable expectedProperties=null) |
| | Updates and synchronizes a Player's Custom Properties. Optionally, expectedProperties can be provided as condition. More...
|
| |
| bool | OpSetCustomPropertiesOfRoom (PhotonHashtable gameProperties) |
| | Operation to set Custom Room Properties. Only available in a room on a Game Server. More...
|
| |
| bool | OpSetCustomPropertiesOfRoom (PhotonHashtable propertiesToSet, PhotonHashtable expectedProperties=null) |
| | Updates and synchronizes this Room's Custom Properties. Optionally, expectedProperties can be provided as condition. More...
|
| |
| bool | ReconnectAndRejoin (object ticket=null) |
| | Directly return to a room by reconnecting to a game server to attempt a rejoin. This is allowed until the PlayerTtl expired. More...
|
| |
| bool | ReconnectToMaster () |
| | Can be used to reconnect to the master server after a disconnect. More...
|
| |
| void | RemoveCallbackTarget (object target) |
| | Unregisters an object from callbacks for the implemented callback-interfaces. More...
|
| |
| bool | SendOutgoingCommands () |
| | Sends messages or a datagram with multiple commands (operations, acks, etc.) from the outgoing queue. More...
|
| |
| void | Service () |
| | This method dispatches all available incoming commands and then sends this client's outgoing commands. It uses DispatchIncomingCommands and SendOutgoingCommands to do that. More...
|
| |
| void | SimulateConnectionLoss (bool simulateTimeout) |
| | Useful to test loss of connection which will end in a client timeout. This modifies RealtimePeer.NetworkSimulationSettings. Read remarks. More...
|
| |
|
| Func< string, ServerConnection, string > | AddressRewriter |
| | Provides a custom function to re-write server addresses in case the client must use a third party relay. More...
|
| |
| EventBetter | CallbackMessage = new EventBetter() |
| | Provides callbacks via messages, which can be subscribed to individually. More...
|
| |
| string | DisconnectMessage |
| | Defaults to null. Set when the client receives a disconnect info message with a debug string. Reset to null in connect methods. More...
|
| |
| EncryptionMode | EncryptionMode = EncryptionMode.PayloadEncryption |
| | Defines how the communication gets encrypted. More...
|
| |
| readonly Player | LocalPlayer = new Player(string.Empty, -1, true, null) |
| | The local player is never null but not valid unless the client is in a room, too. The ID will be -1 outside of rooms. More...
|
| |
| LogLevel | LogLevel = LogLevel.Warning |
| | Level of logging this client does. Default: LogLevel.Warn. This is independent from LogLevelPeer. More...
|
| |
| string | LogPrefix |
| | Prefixes for all logging messages. Useful if there are multiple clients. More...
|
| |
| int | LogStatsInterval = 5000 |
| | Millisecond interval at which stats are being logged if the LogLevel is at least Info. Default: 5000. More...
|
| |
| string | NameServerHost = "ns.photonengine.io" |
| | Name Server Host Name for Photon Cloud. Without port and without any prefix. More...
|
| |
| ProtocolPorts | ProtocolPorts = new ProtocolPorts() |
| | Defines the ports to use per protocol and server-type. More...
|
| |
| readonly PhotonPeer | RealtimePeer |
| | The client uses a PhotonPeer to communicate with the server. Public for ease-of-use, as some settings are directly made on it. More...
|
| |
| RegionHandler | RegionHandler |
| | Contains the list if enabled regions this client may use. Null, unless the client got a response to OpGetRegions. More...
|
| |
| SystemConnectionSummary | SystemConnectionSummary |
| | After a to a connection loss or timeout, this summarizes the most relevant system conditions which might have contributed to the loss. More...
|
| |
| const string | Version = "5.1.21" |
| | RealtimeClient / SDK version as const string. More...
|
| |
| string | AppId [get] |
| | The AppID for the Photon Cloud. If you host a Photon Server yourself, make up and use a GUID. More...
|
| |
| AppSettings | AppSettings [get] |
| | Stores this client's AppSettings, as applied by ConnectUsingSettings(). More...
|
| |
| string | AppVersion [get] |
| | The AppVersion this client should use. Replaced by this.AppSettings.AppVersion. More...
|
| |
| AuthenticationValues | AuthValues [get, set] |
| | User authentication values to be sent to the Photon server right after connecting. More...
|
| |
| ClientAppType | ClientType [get, set] |
| | The ClientAppType defines which sort of AppId should be expected. The RealtimeClient supports Realtime and Voice app types. Default: Realtime. More...
|
| |
| string | CloudRegion [get] |
| | While online, this is the region the client connected to. More...
|
| |
| bool | CrcEnabled [get, set] |
| | Enables CRC checksums on outgoing and incoming packets. Adds a small CPU cost in exchange for detecting corrupted data on the wire. More...
|
| |
| string | CurrentCluster [get] |
| | The cluster name provided by the Name Server. More...
|
| |
| TypedLobby | CurrentLobby [get] |
| | The lobby this client currently uses. Defined when joining a lobby or creating rooms More...
|
| |
| string | CurrentRegion [get] |
| | String code of the Region the client is connected to. Null if none. More...
|
| |
| Room | CurrentRoom [get, set] |
| | The current room this client is connected to (null if none available). More...
|
| |
| string | CurrentServerAddress [get] |
| | The currently used server address (if any). The type of server is defined by Server property. More...
|
| |
| DisconnectCause | DisconnectedCause [get, protected set] |
| | Summarizes (aggregates) the different causes for disconnects of a client. More...
|
| |
| string | GameServerAddress [get] |
| | The game server's address for a particular room. In use temporarily, as assigned by master. More...
|
| |
| ConnectionHandler | Handler [get] |
| | The ConnectionHandler instance, which is used to keep alive the connection if this client's Service() does not get called regularly. More...
|
| |
| bool | InLobby [get] |
| | Returns CurrentLobby != null. More...
|
| |
| bool | InRoom [get] |
| | Is true while being in a room (this.state == ClientState.Joined). More...
|
| |
| bool | IsConnected [get] |
| | Returns if this client is currently connected or connecting to some type of server. More...
|
| |
| bool | IsConnectedAndReady [get] |
| | A refined version of IsConnected which is true only if your connection is ready to send operations. More...
|
| |
| bool | IsFetchingFriendList [get] |
| | Internal flag to know if the client currently fetches a friend list. More...
|
| |
| LogLevel | LogLevelPeer [get, set] |
| | Level of logging for PhotonPeer (networking layer). More...
|
| |
| string | MasterServerAddress [get, set] |
| | Your Master Server address. In PhotonCloud, call ConnectUsingSettings() to find your Master Server via the Name Server. More...
|
| |
| string | NameServerAddress [get] |
| | Name Server Address for Photon Cloud (based on current protocol). You can use the default values and usually won't have to set this value. More...
|
| |
| string | NickName [get, set] |
| | The nickname of the player (synced with others). Same as client.LocalPlayer.NickName. More...
|
| |
| int | PlayersInRoomsCount [get] |
| | Statistic value available on master server: Players in rooms (playing). More...
|
| |
| int | PlayersOnMasterCount [get] |
| | Statistic value available on master server: Players on master (looking for games). More...
|
| |
| int | RoomsCount [get] |
| | Statistic value available on master server: Rooms currently created. More...
|
| |
| SerializationProtocol | SerializationProtocol [get, set] |
| | Gets or sets the binary protocol version used by this client More...
|
| |
| ServerConnection | Server [get] |
| | The server this client is currently connected or connecting to. More...
|
| |
| ClientState? | State [get, set] |
| | Current state this client is in. Careful: several states are "transitions" that lead to other states. More...
|
| |
| string? | SummaryToCache [get] |
| | Accesses this.RegionHandler?.SummaryToCache. May be null. More...
|
| |
| string | UserId [get, set] |
| | Access for AuthValues.UserId. Identifier for the player / user. More...
|
| |
| Action< EventData > | EventReceived |
| | Register a method to be called when an event got dispatched. Gets called after the RealtimeClient handled the internal events first. More...
|
| |
| Action< bool, object > | MessageReceived |
| | Register a method to be called when a message got dispatched. Gets called after the RealtimeClient handled the message internally. More...
|
| |
| Action< OperationResponse > | OpResponseReceived |
| | Register a method to be called when an operation response is received. More...
|
| |
| Action< ClientState, ClientState > | StateChanged |
| | Register a method to be called when this client's ClientState gets set. Better use the callbacks to react to specific situations. More...
|
| |
Obsolete: Not used anymore. Replace by using RealtimeClient directly.