Version: 2021.3
LanguageEnglish
  • C#

IConnectionState

interface in UnityEngine.Networking.PlayerConnection

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The state of an Editor-to-Player or Editor-to-Editor connection to be used in PlayerConnectionGUI.ConnectionTargetSelectionDropdown or PlayerConnectionGUILayout.ConnectionTargetSelectionDropdown.

The interface inherits from IDisposable and all instances of it need to be disposed of before the reference to them is lost, for example by closing the window or during an assembly reload. You can get an instance from Networking.PlayerConnection.PlayerConnectionGUIUtility.GetAttachToPlayerState. For usage and code examples see: PlayerConnectionGUI.ConnectionTargetSelectionDropdown or PlayerConnectionGUILayout.ConnectionTargetSelectionDropdown

Properties

connectedToTargetSupplies the type of the established connection, as in whether the target is a Player or an Editor.
connectionNameThe name of the connected target.