Class UITKInstance

Namespace

FishMMO.Client

Assembly

FishMMO.Client.dll

UI Toolkit instance-management panel. Shows which instance the character is in, how long it has left, and who else is in it; lets the member who opened it remove others, and lets anyone leave.

public class UITKInstance : UITKCharacterControl

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

UITKControl

UITKCharacterControl

UITKInstance

Inherited Members

UITKCharacterControl.OnSetCharacter

UITKCharacterControl.OnUnsetCharacter

UITKCharacterControl.Character

UITKCharacterControl.OnDestroying()

UITKCharacterControl.OnPreSetCharacter()

UITKCharacterControl.OnPostSetCharacter()

UITKCharacterControl.SetCharacter(IPlayerCharacter)

UITKCharacterControl.OnPreUnsetCharacter()

UITKCharacterControl.UnsetCharacter()

UITKControl.Document

UITKControl.StartOpen

UITKControl.IsAlwaysOpen

UITKControl.CloseOnQuitToMenu

UITKControl.ReleasesCursor

UITKControl.CloseOnEscape

UITKControl.ConsumesEscape

UITKControl.Name

UITKControl.Client

UITKControl.Visible

UITKControl.Root

UITKControl.HasFocus

UITKControl.IsInputFieldFocused

UITKControl.CanDrag

UITKControl.OnLoseFocus

UITKControl.FocusOnSelect

UITKControl.BringToFront()

UITKControl.BindListChrome(VisualElement, Label, Label, Label, string, string)

UITKControl.SetClient(Client)

UITKControl.OnQuitToLogin()

UITKControl.ToggleVisibility()

UITKControl.Show()

UITKControl.ReloadStoredPosition()

UITKControl.ResetPosition()

UITKControl.Hide()

UITKControl.Hide(bool)

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

The roster is a MODEL (FishMMO.Client.UITKInstance.members, plain data) rendered into a VIEW rebuilt from scratch on every open, because UIDocument re-clones the UXML each time it is enabled — the rule UITKParty documents at length.

Every open asks the server, and it keeps asking. Membership changes without this client being told — someone leaves, someone is removed, the leader walks out — and there is no push channel for it, so the panel refreshes on a timer while it is visible rather than showing a roster that quietly goes stale. The remaining time counts down locally between those refreshes, so the number moves without a message per second.

The leader check here only decides what is drawn. `ViewerIsLeader` arrives from the server, and the server re-derives it from the scene row's owner when a removal actually arrives. A drawn control is not an authorisation, and the broadcast can be sent without one.

Properties

Layer

Draw order tier. See UITKPanelLayer.

protected override UITKPanelLayer Layer { get; }

Property Value

UITKPanelLayer

Remarks

Popup for the same reason the scene-channel picker uses it: this opens from the game menu and has to clear it, and UI Toolkit orders input as well as drawing by sorting order, so a panel that loses that ordering receives no pointer events at all. Sharing the Settings tier with Options would leave the winner decided by which scene happened to load first.

Methods

OnAfterShow()

Asks for a fresh readout every time the panel opens.

protected override void OnAfterShow()

OnAfterStarting()

Re-renders after the visual tree has been rebuilt.

protected override void OnAfterStarting()

OnClick_Leave()

public void OnClick_Leave()

OnClientSet()

Subscribes to the instance readout.

public override void OnClientSet()

OnClientUnset()

Unsubscribes from the instance readout.

public override void OnClientUnset()

OnPostUnsetCharacter()

Drops the roster when the character goes away.

public override void OnPostUnsetCharacter()

Remarks

The roster describes one instance on one scene server. Carrying it across a scene transfer would show members of a dungeon this character has left, and offer a Remove button whose request means nothing on the server it would be sent to.

OnStarting()

Queries the elements and wires the footer buttons.

public override void OnStarting()

OnTick()

Runs the local countdown, the refresh timer and the request timeout.

protected override void OnTick()