Back To Index

NetworkManager

Jump To Parameters
Jump To Delegates
Jump To Function Definitions

Parameter Definitions

Select the parameter name from below to jump directly to it on this page.

_connectStatus
_connecting
_currentLevelIndex
allowTeamDamaging
autoSpawnPlayer
cachedRoomList
connect_attempts
database
debugging
defaultSpawnPoint
displayDebugWindow
gameVersion
initalTeamSpawnPointNames
lobbyEvents
maxPlayerPerRoom
otherEvents
playerEvents
playerPrefab
reconnect
replayScenes
roomEvents
spawnAtSaved
spawnPointsTag
syncScenes
teamName
voiceRecorder

_connectStatus

Shows the current connection process. This is great for UI to reference and use.

Back To Top

_connecting

Says if you’re currently connecting to the Photon Server, Lobby, or Room. (false after connection is made)

Back To Top

_currentLevelIndex

The current index of the Unity scene that your currently in. This is used for internal “
logic in the NetworkManager and ChatBox.

Back To Top

allowTeamDamaging

Allow team members to damage each other.

Back To Top

autoSpawnPlayer

If you want to immediately spawn the player into the scene when joining the lobby. “
If not you need to have a UI that sets this to true before going to the next scene.

Back To Top

cachedRoomList

The current photon room list if in the photon lobby. This is updated via the “
"UpdateCachedRoomList" function which in turn is called via the "OnRoomListUpdate" “
function.

Back To Top

connect_attempts

How many attempts to reconnect to the room if ‘reconnect’ is true.

Back To Top

database

The scene database that holds all of the information about all of the given scenes.

Back To Top

debugging

If you want to log everything to the console that the network manager is doing at runtime.

Back To Top

defaultSpawnPoint

The point where the player will start when they have successfully connected or if no other available spawn point is specified.

Back To Top

displayDebugWindow

If you want to display a visual window of the current settings found in the network manager at runtime.

Back To Top

gameVersion

The version to connect with. Incompatible versions will not connect with each other.

Back To Top

initalTeamSpawnPointNames

The spawn point name that will represent the initial starting point for the team “
If more than one of the spawn points are named with this same name then it will randomly “
choose between those points and spawn the team member at that location.

Back To Top

lobbyEvents

Actions to trigger on events that happen in the lobby. Contains the following UnityEvents: “
_onJoinedLobby, _onLeftLobby

Back To Top

maxPlayerPerRoom

The max number of player per room. When a room is full, it can’t be joined by new players, and so a new room will be created.

Back To Top

otherEvents

Unity events to call based on Misc Network events. This contains the following UnityEvent parameters: “
_onMasterClientSwitched, _onDisconnected, _onConnectedToMaster, _onFailedToConnectToPhoton, _onConnectionFail

Back To Top

playerEvents

Actions to trigger on events that happen with actions according to each player. This contains “
the following UnityEvent parameters: _onPlayerEnteredRoom, _onPlayerLeftRoom

Back To Top

playerPrefab

The _prefab that will be spawned in when a player successfully connects.

Back To Top

reconnect

Automatically attempt to reconnect to the last room you were in if you get disconnected.

Back To Top

replayScenes

Save state between scenes. When you re-enter the scene replay all of the actions on the objects with syncScenes enabled. “
This allows for persistant dropped items, picked up items, interacted objects, etc. between unity scenes/photon rooms.

Back To Top

roomEvents

Actions to trigger on events that happen in the room. Contains the following UnityEvents: “
_onJoinedRoom, _onLeftRoom, _OnCreatedRoom, _onCreateRoomFailed, _onJoinRoomFailed, _onReconnect

Back To Top

spawnAtSaved

On a successfull reconnect, do you want to spawn the character back at the location “
you last were at or just at a random spawn in point?

Back To Top

spawnPointsTag

Will find all transforms with this tag and treat it as a spawn point. If no tag is specified will only us what is placed in the default spawn point tag.

Back To Top

syncScenes

Automatically sync all connected clients scenes. Make sure everyone is always on the same scene together.

Back To Top

teamName

The name of the team you’re currently on. If the team name is never set either manually or “
via the "SetTeamName" function everyone will be able to damage each other. (Free-For-All) “
\n\nWARNING: DO NOT SET THIS MANUALLY! “
The only reason to set this manually is if you are testing something out related to same “
team mechanics.

Back To Top

voiceRecorder

The voice recorder that will be set on owning players Primary Recorder slot. This must be set if using voice chat.

Back To Top

Delegate Definitions

Select the delegate name from below to jump directly to it on this page.

OnClientHostSwitched
OnConnectedToMasterPhotonServer
OnConnectionFailed
OnCreateRoomFailure
OnCreatedPhotonRoom
OnDisconnectedFromPhoton
OnFailToConnectToPhoton
OnJoinRoomFailure
OnJoinedChatDataChannel
OnJoinedPhotonLobby
OnJoinedPhotonRoom
OnLeftPhotonLobby
OnLeftPhotonRoom
OnPlayerJoinedCurrentRoom
OnPlayerKicked
OnPlayerLeftCurrentRoom
OnReconnectingToRoom
OnUpdatedRoomList

public PlayerDelegate OnClientHostSwitched

This delegate is called whenever the master client left and a new master client is selected.

Back To Top

public BasicDelegate OnConnectedToMasterPhotonServer

This delegate is called when you successfully connect to the photon master server.

No parameters

Back To Top

public DisconnectCauseDelegate OnConnectionFailed

This delegate is called when something causes the connection to fail(after it was established), followed by a call to OnDisconnectedFromPhoton(). If the server could not be reached in the first place, OnFailedToConnectToPhoton is called instead.The reason for the error is provided as StatusCode.

Back To Top

public RoomFailure OnCreateRoomFailure

This delegate is called whenever you failed to create to a photon room.

Back To Top

public BasicDelegate OnCreatedPhotonRoom

This delegate is called when you successfully create a the photon room.

No parameters

Back To Top

public DisconnectCauseDelegate OnDisconnectedFromPhoton

This delegate is called whenever you disconnect from the photon room.

Back To Top

public DisconnectCauseDelegate OnFailToConnectToPhoton

This delegate is called when something causes the connection to the Photon master server to fail.

Back To Top

public RoomFailure OnJoinRoomFailure

This delegate is called whenever you failed to connect to a photon room.

Back To Top

public StringDelegate OnJoinedChatDataChannel

This delegate is called when you successfully connected to the ChatBox’s data channel.

No parameters

Back To Top

public BasicDelegate OnJoinedPhotonLobby

This delegate is called when you successfully connect to the photon lobby.

No parameters

Back To Top

public BasicDelegate OnJoinedPhotonRoom

This delegate is called when you successfully connect to the photon room.

No parameters

Back To Top

public BasicDelegate OnLeftPhotonLobby

This delegate is called when you successfully disconnect from the photon lobby.

No parameters

Back To Top

public BasicDelegate OnLeftPhotonRoom

This delegate is called when you successfully disconnect from the photon room.

No parameters

Back To Top

public PlayerDelegate OnPlayerJoinedCurrentRoom

This delegate is called whenever another player joins the photon room. This isn’t called when you first join on yourself.

Back To Top

public PlayerDelegate OnPlayerKicked

This delegate is called whenever another player is kicked from the photon room.

Back To Top

public PlayerDelegate OnPlayerLeftCurrentRoom

This delegate is called whenever another player leaves the photon room. This isn’t called when you leave the photon room on yourself.

Back To Top

public BasicDelegate OnReconnectingToRoom

This delegate is called whenever you are trying to reconnect to a room after you disconnected from it.

No parameters

Back To Top

public RoomListUpdate OnUpdatedRoomList

This delegate is called a update to the photom room list is received.

Back To Top

Function Definitions

Select the function name from below to jump directly to it on this page.

Awake
ConnectToMasterServer
CreateItem
CreateRoom
Disconnect
DoSceneReplay
GetCachedPlayerData
GetChabox
GetChatDataChannel
GetCurrentSceneIndex
GetCurrentSceneName
GetGlobalRoomName
GetIndividualRoomName
GetPlayerCount
GetRandomSpawnPoint
GetTeamSpawnPoint
GetYourPlayer
IsInLobby
IsInRoom
ItemListTheSame
JoinChatDataChannel
JoinLobby
JoinOrCreateRoom
JoinRandomRoom
JoinRoom
KickPlayer
KickPlayer
LeaveLobby
LeaveRoom
LoadPlayerData
NetworkInstantiatePersistantPrefab
NetworkInstantiatePrefab
NetworkLoadLevel
NewSceneLoaded
OnConnectedToMaster
OnConnectionFail
OnCreateRoomFailed
OnCreatedRoom
OnDisconnected
OnFailedToConnectToPhoton
OnJoinRandomFailed
OnJoinRoomFailed
OnJoinedLobby
OnJoinedRoom
OnLeftLobby
OnLeftRoom
OnMasterClientSwitched
OnPlayerEnteredRoom
OnPlayerLeftRoom
OnRoomListUpdate
ReplaySceneDatabase
SavePlayer
SetInDataChannel
SetPlayerName
SetRoomIsOpen
SetRoomVisibility
SetSpawnAtPoint
SetTeamName
Start
UpdateCachedRoomList
UpdateSceneDatabase

protected virtual void Awake()

This is used to make sure this is the only NetworkManager in the scene as well as setup scene loading delegates

No parameters

Back To Top

public virtual void ConnectToMasterServer()

Connect to the PUN master server.

No parameters

Back To Top

private void CreateItem(ObjectAction item)

Used by the DoSceneReplay funcion only, do not modify. This is responsible for creating items in the Unity scene.

Back To Top

public virtual void CreateRoom(string roomName, RoomOptions options = null, ExitGames.Client.Photon.Hashtable customRoomProperties = null, string[] exposePropertiesToLobby = null)

Create a room with the target name for other players to join in the default lobby. Will connect to master server and default lobby if not already connected.

Back To Top

public virtual void Disconnect()

Disconnect from the PUN master server. Will be dropped from any lobby or room.

No parameters

Back To Top

private void DoSceneReplay(bool createsOnly = false, bool updatesOnly = false)

Performs all the actions on this scene that have been stored in the scene database. Actions are received via the Chatbox’s data channel. When someone opens a door, presses a button, drops an item, picks up an item, etc. In another scene that information is recieved by everyone in the session via the ChatBox’s data channel. This function is responsible to replay all of those actions for a particular scene when you enter the unity scene. That way it is in sync with all of the other players that are currently already in the scene. This also deals with keeping Unity scenes persistant between loads.

Back To Top

public virtual PlayerData GetCachedPlayerData()

Get the PlayerData that was saved previously. Used for loading saved player stats, inventory, etc.

No parameters

Back To Top

public virtual ChatBox GetChabox()

Get the chatbox component.

No parameters

Back To Top

public virtual string GetChatDataChannel()

Get the current chatbox’s data channel.

No parameters

Back To Top

public virtual int GetCurrentSceneIndex()

Get the scene index that the network manager thinks it’s in.

No parameters

Back To Top

public virtual string GetCurrentSceneName()

Get the scene name that the network manager thinks it’s in.

No parameters

Back To Top

public virtual string GetGlobalRoomName(string inputName)

Will format the string to be session name compliant.

Back To Top

public virtual string GetIndividualRoomName()

Gets the current session name that your in and combines it with the Unity scene that your in to make it (session name)_(unity scene)

No parameters

Back To Top

public virtual int GetPlayerCount()

Returns the numbers of players connected to this room

No parameters

Back To Top

public virtual Transform GetRandomSpawnPoint()

Returns a random transform from the scene that is tagged with the spawn point tag.

No parameters

Back To Top

public virtual Transform GetTeamSpawnPoint(string teamName)

Get a spawn point that is specific for the specified team.

Back To Top

public virtual vThirdPersonController GetYourPlayer()

Get the vThirdPersonController that you own, not the networked players.

No parameters

Back To Top

public virtual bool IsInLobby()

Are you currently in a photon lobby?

No parameters

Back To Top

public virtual bool IsInRoom()

Are you currently in a photon room?

No parameters

Back To Top

private bool ItemListTheSame(List original, List incoming)

Used by the DoSceneReplay function only, do not modify. This is responsible for building the information array. The is used by the DoSceneReplay function, do not modify. This is used to make sure that the item list on a particular item is the same for the entering player.

Back To Top

protected virtual void JoinChatDataChannel()

Subscribe to the ChatBox’s data channel based on the GetGlobalRoomName function.

No parameters

Back To Top

public virtual void JoinLobby(TypedLobby lobbyType = null)

Join the default lobby. If not connected will connect to master server first. If already in lobby, will do nothing.

Back To Top

public virtual void JoinOrCreateRoom(string roomName, RoomOptions options = null, ExitGames.Client.Photon.Hashtable customRoomProperties = null, string[] exposePropertiesToLobby = null, string[] expectedUsers = null)

Attempts to join the selected room. If it doesn’t exist it will create it.

Back To Top

public virtual void JoinRandomRoom(ExitGames.Client.Photon.Hashtable expectedRoomProperties = null)

Attempt to join a random room in your connected lobby. Will join master server and defaul lobby if not already connected prior to joining.

Back To Top

public virtual void JoinRoom(string roomName)

Join a room with name in your connected lobby. Will join master server and defaul lobby if not already connected prior to joining.

Back To Top

public virtual void KickPlayer(Photon.Realtime.Player playerToKick)

Boots a player from a photon room.

Back To Top

public virtual void KickPlayer(string userId)

Boots a player from a photon room.

Back To Top

public virtual void LeaveLobby()

Leave your currently connected lobby but stay connect to the master server.

No parameters

Back To Top

public virtual void LeaveRoom()

Makes the caller leave the room they are connected to but stay connected to default lobby and master server.

No parameters

Back To Top

public virtual void LoadPlayerData(string playerName, vThirdPersonController player = null, bool useSavedNickname = true, bool loadFromCache = false, bool overrideStartMaxHealth = false)

Load the player data into the target vThirdPersonController.

Back To Top

public virtual GameObject NetworkInstantiatePersistantPrefab(string prefabName, Vector3 position, Quaternion rotation, byte group = 0, object[] data = null)

Spawn a object from the “Resources” folder on every instance of the game over the network that is owned by the scene, no player.

Back To Top

public virtual GameObject NetworkInstantiatePrefab(string prefabName, Vector3 position, Quaternion rotation, byte group=0, object[] data=null)

Spawn a object from the “Resources” folder on every instance of the game over the network that is owned by a particular player

Back To Top

public virtual void NetworkLoadLevel(int level, string spawnAtPoint = null, bool sendEveryone = false)

Loads a Unity Scene and triggers creating or joining a room based on the GetIndividualRoomName function’s return. Can send one person or everyone together. If everyone only the MasterClient can do this. Calling this also saves the current settings of your player and restores them in the new unity scene when it has spawned your player there.

Back To Top

public virtual void NewSceneLoaded(Scene scene, LoadSceneMode mode)

Callback method that is called every time a new scene is loaded. Will potentially spawn your character in the new scene. It also replays the items that were dropped/picked up in this scene as well as other network actions.

Back To Top

public override void OnConnectedToMaster()

Callback method. Called when you connect to the photon master server.

No parameters

Back To Top

public virtual void OnConnectionFail(DisconnectCause cause)

Callback Method. Called when you fail to connect to a Photon Room/Lobby. Calls the otherEvents._onConnectionFail UnityEvent and OnConnectionFailed delegate.

Back To Top

public override void OnCreateRoomFailed(short returnCode, string message)

Callback method. called when you fail to create a photon room. This also triggers the roomEvents._onCreateRoomFailed UnityEvent and the OnCreateRoomFailure delegate.

Back To Top

public override void OnCreatedRoom()

Callback method. Called when you have successfully create a photon room. Calls JoinChatDataChannel function, roomEvents._OnCreatedRoom UnityEvent, and OnCreatedPhotonRoom delegate.

No parameters

Back To Top

public override void OnDisconnected(DisconnectCause cause)

Callback method. Called when you disconnect from a photon room. Calls the otherEvents._onDisconnected UnityEvent and OnDisconnectedFromPhoton delegate.

Back To Top

public virtual void OnFailedToConnectToPhoton(DisconnectCause cause)

Callback method. Called when you fail to connect to the photon master server. Calls the otherEvents._onFailedToConnectToPhoton UnityEvent and OnFailToConnectToPhoton delegate.

Back To Top

public override void OnJoinRandomFailed(short returnCode, string message)

Callback method. Called when you fail to join a random photon room. Calls the roomEvents._onJoinRoomFailed UnityEvent and OnJoinRoomFailure delegate.

Back To Top

public override void OnJoinRoomFailed(short returnCode, string message)

Callback method. Called when you fail to join a specified room. Calls the OnJoinRoomFailure delegate and roomEvents._onJoinRoomFailed UnityEvent. If the return code is 32758 (timeout) it will attempt to recreate the room.

Back To Top

public override void OnJoinedLobby()

Callback method. Called when successfully joined the photon lobby. Calls lobbyEvents._onJoinedLobby UnityEvent and OnJoinedPhotonLobby delegate. Will also call JoinRandomRoom, JoinRoom, or CreateRoom based on if you’re switching UnityScenes and attempting to join a Photon room or not.

No parameters

Back To Top

public override void OnJoinedRoom()

Callback method. Calls JoinChatDataChannel and NetworkInstantiatePrefab functions. Calls OnJoinedPhotonRoom delegate and roomEvents._onJoinedRoom UnityEvent.

No parameters

Back To Top

public override void OnLeftLobby()

Callback method. Called when you have succesfully left the Photon Lobby. Calls lobbyEvents._onLeftLobby UnityEvent and OnLeftPhotonLobby delegate.

No parameters

Back To Top

public override void OnLeftRoom()

Callback method. Called when you have left a photon room. Calls the JoinRoom function or CreateRoom function if switching Unity scenes. Calls roomEvents._onLeftRoom UnityEvent and OnLeftPhotonRoom delegate.

No parameters

Back To Top

public override void OnMasterClientSwitched(Photon.Realtime.Player newMasterClient)

Callback method. Callwed when the photon master client is switched.

Back To Top

public override void OnPlayerEnteredRoom(Photon.Realtime.Player newPlayer)

Callback method. Called when another player enters the photon room. Isn’t called for yourself.

Back To Top

public override void OnPlayerLeftRoom(Photon.Realtime.Player otherPlayer)

Callback method. Called when a player leaves a room. Isn’t called for yourself.

Back To Top

public override void OnRoomListUpdate(List roomList)

Callback method. Called when in a photon lobby and the number of photon rooms changes. Calls UpdateCachedRoomList.

Back To Top

public virtual void ReplaySceneDatabase(bool createsOnly = false, bool updatesOnly = false)

Triggers the WaitForReplay IEnumerator which triggers DoSceneReplay function.

Back To Top

public virtual void SavePlayer(vThirdPersonController player)

Save your players stats, inventory, etc.

Back To Top

public virtual void SetInDataChannel(bool value)

Set if you are currently joined to the chatbox’s data channel or not

Back To Top

public virtual void SetPlayerName(string name = “”)

Set the players network name, if nothing is supplied will auto name as ‘Un-named Player’

Back To Top

public virtual void SetRoomIsOpen(bool isOpen)

Set the current photon room as open and joinable

Back To Top

public virtual void SetRoomVisibility(bool isVisible)

The current photon room will be listed or not

Back To Top

public virtual void SetSpawnAtPoint(string pointName)

Set the spawn at point then trigger the “NewSceneLoaded” function.

Back To Top

public virtual void SetTeamName(string inputName)

Set the name of the team you are a member of. This is for your local player only and is not designed to work with Network players.

Back To Top

protected virtual void Start()

This is used to find the chatbox in the scene. Used in start to give awake enough time to destroy duplicate Chatbox’s if any.

No parameters

Back To Top

protected virtual void UpdateCachedRoomList(List roomList)

This is called via “OnRoomListUpdate” function. This will update the list of available rooms and store it in the cachedRoomList parameter. Only usable when in the Photon Lobby

Back To Top

public virtual void UpdateSceneDatabase(ObjectAction hashData)

This is used to add/remove actions to be performed by the DoSceneReplay function. The scene database is responsible for playing actions for a player that is entering a Unity scene for the first time. This function will add or remove actions to the scene database.

Back To Top