Class UITKToast

Namespace

FishMMO.Client

Assembly

FishMMO.Client.dll

Transient messages stacked at the top of the screen: what just happened, and why it did not.

public class UITKToast : UITKControl

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

UITKControl

UITKToast

Inherited Members

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.OnAfterStarting()

UITKControl.SetClient(Client)

UITKControl.OnTick()

UITKControl.OnQuitToLogin()

UITKControl.ToggleVisibility()

UITKControl.InventoryPanelName

UITKControl.OpensInventoryOnShow

UITKControl.ShowInventoryIfClosed()

UITKControl.Show()

UITKControl.OnAfterShow()

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

Built general rather than for any one caller. Several server systems already compute a precise reason for refusing something and then have nowhere to put it — BindstoneAction knows whether a bind failed because the player was inside an instance, in the wrong scene, or standing somewhere with too little clearance, and wrote all three to a server-side debug log. The player saw an identical nothing in every case, including success.

Anything may post one: the server through ToastBroadcast, or client code directly through Show(string, ToastSeverity) for things the server never hears about. There is no queue behind the visible set — a toast that would overflow MaximumVisible evicts the oldest instead of waiting, because a message that arrives late enough to be shown after the thing it describes has scrolled past is worse than one that is dropped.

Fields

FadeSeconds

Seconds the fade-out takes once the hold has elapsed.

[Tooltip("Seconds the fade-out takes once the hold expires.")]
public float FadeSeconds

Field Value

float

HoldSeconds

Seconds a toast stays fully visible before it begins to fade.

[Tooltip("Seconds a toast stays fully visible before it begins to fade.")]
public float HoldSeconds

Field Value

float

MaximumLength

Longest text a toast will show. Anything beyond this is truncated with an ellipsis.

public const int MaximumLength = 160

Field Value

int

Remarks

A cap rather than a wrap, so a caller cannot turn this into a scrolling log. The server sends free text, and this is the only thing bounding it.

MaximumVisible

How many toasts may be on screen at once before the oldest is evicted.

public const int MaximumVisible = 5

Field Value

int

Properties

Layer

Draw order tier. Toasts sit with the HUD, above the world and below windows.

protected override UITKPanelLayer Layer { get; }

Property Value

UITKPanelLayer

Methods

OnClientSet()

Subscribes to server-sent toasts.

public override void OnClientSet()

OnClientUnset()

Unsubscribes from server-sent toasts.

public override void OnClientUnset()

OnDestroying()

Clears any live toasts when the panel goes away.

public override void OnDestroying()

OnStarting()

Resolves the stack container from the visual tree.

public override void OnStarting()

Remarks

Re-resolved rather than cached across rebuilds: OnStarting runs again whenever the visual tree is replaced, and an element reference held from the previous tree points at something no longer on screen.

Show(string, ToastSeverity)

Shows a toast.

public void Show(string text, ToastSeverity severity = ToastSeverity.Info)

Parameters

text string

What to show. Truncated at MaximumLength.

severity ToastSeverity

How prominently it reads.

Remarks

Safe to call before the visual tree exists — the toast is dropped rather than queued. A message posted while the HUD is being rebuilt describes something the player has already moved past.