Class: LoadBalancingClient

Members

(static, readonly) PeerErrorCode

Enum for client peers error codes.

Properties:

(static, readonly) State

Enum for client states.

Properties:

Methods

actorFactory(name, actorNr, isLocal)

Override with creation of custom actor (extended from Actor): { return new CustomActor(...); }

Parameters:

availableRooms() → {Array.<Photon.LoadBalancing.RoomInfo>}

Current room list from Master server.

Returns:

Type

Array.<Photon.LoadBalancing.RoomInfo>

changeGroups(groupsToRemove, groupsToAdd)

Changes client's interest groups (for events in room).
Note the difference between passing null and []: null won't add/remove any groups, [] will add/remove all (existing) groups.
First, removing groups is executed. This way, you could leave all groups and join only the ones provided.

Parameters:

connect(optionsopt) → {boolean}

Starts connection to Master server.

Parameters:

Properties:

Returns:

Type

boolean

connectToNameServer(optionsopt) → {boolean}

Starts connection to NameServer.

Parameters:

Properties:

Returns:

Type

boolean

connectToRegionMaster(region) → {boolean}

Connects to a specific region's Master server, using the NameServer to find the IP.

Parameters:

Returns:

Type

boolean

createRoom(roomNameopt, optionsopt) → {boolean}

Creates a new room on the server (or fails when the name is already taken).

Parameters:

Properties:

Returns:

Type

boolean

createRoomFromMy(roomNameopt, optionsopt)

Creates a new room on the server (or fails when the name is already taken). Takes parameters (except name) for new room from myRoom() object. Set them before call.

Parameters:

Properties:

disconnect()

Disconnects from all servers.

findFriends(friendsToFind)

Requests Master server for actors online status and joined rooms.
Override onFindFriendsResult to handle request results.

Parameters:

getMasterServerAddress() → {string}

Returns current Master server address.

Returns:

Type

string

getNameServerAddress() → {string}

Returns current NameServer address.

Returns:

Type

string

getRegions()

Requests NameServer for regions list.
Override onGetRegionsResult to handle request results.

getRtt() → {number}

Returns the latest measurement of game server Round Trip Time.
RTT is measured once on connection and then on each updateRtt() call.

Returns:

Type

number

getServerTimeMs() → {number}

Returns game server time extrapolation in milliseconds based on the server time fetched on connection or on syncServerTime() call.
The server time is a signed 32 bit integer making a full cycle in 49.71 days.

Returns:

Type

number

getUserId() → {string}

Returns previously set user id.

Returns:

Type

string

isConnectedToMaster() → {boolean}

Checks if client is connected to Master server (usually joined to lobby and receives room list updates).

Returns:

Type

boolean

isConnectedToNameServer() → {boolean}

Checks if client is connected to NameServer server.

Returns:

Type

boolean

isInLobby() → {boolean}

Checks if client is in lobby and ready to join or create game.

Returns:

Type

boolean

isJoinedToRoom() → {boolean}

Checks if client is joined to game.

Returns:

Type

boolean

joinRandomOrCreateRoom(optionsopt, createRoomNameopt, createOptionsopt) → {boolean}

Attempts to join a room that matches the specified filter and creates a room if none found. This operation is a combination of filter-based random matchmaking with the option to create a new room, if no fitting room exists. The benefit of that is that the room creation is done by the same operation and the room can be found by the very next client, looking for similar rooms. There are separate parameters for joining and creating a room. This method can only be called while connected to a Master Server. This client's State is set to ClientState.Joining immediately. Either IMatchmakingCallbacks.OnJoinedRoom or IMatchmakingCallbacks.OnCreatedRoom get called. More about matchmaking: https://doc.photonengine.com/en-us/realtime/current/reference/matchmaking-and-lobby Check the return value to make sure the operation will be called on the server. Note: There will be no callbacks if this method returned false.

Parameters:

Properties:

Returns:

Type

boolean

joinRandomRoom(optionsopt) → {boolean}

Joins a random, available room. This operation fails if all rooms are closed or full.

Parameters:

Properties:

Returns:

Type

boolean

joinRoom(roomName, optionsopt, createOptionsopt) → {boolean}

Joins a room by name and sets this player's properties.

Parameters:

Properties:

Returns:

Type

boolean

leaveRoom()

Leaves room and connects to Master server if not connected.

Properties:

myActor() → {Photon.LoadBalancing.Actor}

Returns local actor. Client always has local actor even if not joined.

Returns:

Type

Photon.LoadBalancing.Actor

myRoom() → {Photon.LoadBalancing.Room}

Returns client's room. Client always has it's room even if not joined. It's used for room creation operation.

Returns:

Type

Photon.LoadBalancing.Room

myRoomActorCount() → {number}

Returns numer of actors in room client currently joined including local actor.

Returns:

Type

number

myRoomActors() → {object}

Returns actors in room client currently joined including local actor.

Returns:

Type

object

myRoomMasterActorNr() → {number}

Actor number of the player who's the master of this Room. Note: This changes when the current master leaves the room.

Returns:

Type

number

onActorJoin(actor)

Called when new actor joins the room client joined to. Override to handle it.

Parameters:

onActorLeave(actor, cleanup)

Called when actor leaves the room client joined to. Also called for every actor during room cleanup. Override to handle it.

Parameters:

onActorPropertiesChange(actor)

Called on actor properties changed event. Override to handle it.

Parameters:

onActorSuspend(actor)

Called when actor suspended in the room client joined to.Override to handle it.

Parameters:

onAppStats(errorCode, errorMsg, stats)

Called when application statistics update received.
Override to handle request results.

Parameters:

Properties:

onError(errorCode, errorMsg)

Called if client error occures. Override to handle it.

Parameters:

onEvent(code, content, actorNr)

Called on custom event. Override to handle it.

Parameters:

onFindFriendsResult(errorCode, errorMsg, friends)

Called when findFriends request completed.
Override to handle request results.

Parameters:

Properties:

onJoinRoom(createdByMe)

Called when client joins room. Override to handle it.

Parameters:

onLobbyStats(errorCode, errorMsg, lobbies)

Called when lobbies statistics update received.
Update can be automated by set up during connect or requested explicitly by requestLobbyStats.
Override to handle request results.

Parameters:

Properties:

onMyRoomPropertiesChange()

Called on joined room properties changed event. Override to handle it.

onOperationResponse(errorCode, errorMsg, code, content)

Called on operation response. Override if need custom workflow or response error handling.

Parameters:

onRoomList(rooms)

Called on room list received from Master server (on connection). Override to handle it.

Parameters:

onRoomListUpdate(rooms, roomsUpdated, roomsAdded, roomsRemoved)

Called on room list updates received from Master server. Override to handle it.

Parameters:

onServerErrorInfo(info)

Called when the server reports non-critical error.
Override to handle the event.

Parameters:

onStateChange(state)

Called on client state change. Override to handle it.

Parameters:

onWebRpcResult(errorCode, message, uriPath, resultCode, data)

Called when webRpc request completed.
Override to handle request results.

Parameters:

raiseEvent(eventCode, dataopt, optionsopt)

Raises game custom event

Parameters:

Properties:

reconnectToMaster() → {boolean}

Can be used to reconnect to the master server after a disconnect. Common use case: Press the Lock Button on a iOS device and you get disconnected immediately

Returns:

Type

boolean

reconnectToMaster() → {boolean}

Can be used to return to a room quickly by directly reconnecting to a game server to rejoin a room. Rejoining room will not send any player properties. Instead client will receive up-to-date ones from server. If you want to set new player properties, do it once rejoined.

Returns:

Type

boolean

requestLobbyStats(lobbiesToRequest)

Requests Master server for lobbies statistics.
Override onLobbyStats to handle request results.
Alternatively, automated updates can be set up during connect.

Parameters:

roomFactory(name)

Override with creation of custom room (extended from Room): { return new CustomRoom(...); }

Parameters:

setAppId(appId)

Changes application id.

Parameters:

setAppVersion(appVersion)

Changes application version.

Parameters:

setCustomAuthentication(authParameters, authTypeopt, authDataopt)

Enables custom authentication and sets it's parameters.

Parameters:

setLogLevel(level)

Sets client log level

Parameters:

setMasterServerAddress(address)

Changes default Master server address and port before connecting to Master server.

Parameters:

setNameServerAddress(address)

Changes default NameServer address and port before connecting to NameServer.

Parameters:

setUserId(userId)

Sets user ID required for authentication and FindFriends service. The value will be used the next time you connect. Set this ID before you connect, not while being connected.

Parameters:

state() → {number}

Returns the current client state.

Returns:

Type

number

suspendRoom()

Disconnects client from Game server keeping player in room (to rejoin later) and connects to Master server if not connected.

Properties:

syncServerTime()

Fetches server time from the game server and updates the base value used for extrapolation in getServerTimeMs().

updateRtt()

Triggers game server Round Trip Time measurement.

webRpc(uriPath, parameters, optionsopt)

Sends web rpc request to Master server.
Override onWebRpcResult to handle request results.

Parameters:

Properties:

(static) StateToName(state) → {string}

Converts State element to string name.

Parameters:

Returns:

Type

string