Class UITKLabelMaker

Namespace

FishMMO.Client

Assembly

FishMMO.Client.dll

Manages a pool of reusable UITKWorldLabel instances for efficient world-anchored text, drawn by UITKWorldLabelLayer.

[DisallowMultipleComponent]
public sealed class UITKLabelMaker : MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

UITKLabelMaker

Inherited Members

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.ReferenceEquals(object, object)

Remarks

The UI Toolkit successor to LabelMaker. The pooling contract is unchanged — the same Dequeue/Enqueue/Display3D/Cache surface, so combat display and target frame code carries over with only the type names swapped.

What changed is that a pooled label no longer needs a prefab. The old one carried a TextMeshPro component, a MeshRenderer and a material, so it had to be authored as an asset; a label is now a transform plus two plain components, which this builds on demand. That removes the "labels silently do nothing because the prefab reference was lost" failure the old pool had, and takes Cached3DLabel.prefab out of the project with it.

The budget. The pool used to be bounded and nothing else was: the cap only limited how many idle labels were kept, and Dequeue(out UITKWorldLabel, bool) built a new GameObject whenever the pool ran dry. Nothing bounded how many labels could be live at once or how fast they could be created, so a large area-of-effect hit — or a server sending combat events faster than a client can draw them — allocated GameObjects without limit until the client stalled. That is reachable from the network, so it is a denial of service and not merely a performance note.

Two limits close it. FishMMO.Client.UITKLabelMaker.maxLiveLabels caps how many labels exist at once; past the cap the oldest auto-expiring label is recycled instead of a new one being built, which for damage numbers is also the behaviour a player wants — the newest hit is the one worth reading. FishMMO.Client.UITKLabelMaker.maxSpawnsPerSecond is a token bucket that caps the rate, so a burst that would churn the whole cap in one frame is dropped rather than served. Labels the caller holds itself (manualCache, used by nameplates and the target frame) are never recycled out from under it.

The draw half of the budget lives in UITKWorldLabelLayer; both are needed, because capping the draw alone still leaves the GameObjects allocated.

Methods

Cache(UITKWorldLabel)

Returns the given label to the pool for reuse.

public static void Cache(UITKWorldLabel label)

Parameters

label UITKWorldLabel

The label to cache.

Clear()

Clears all cached labels from the pool.

public static void Clear()

ClearCache()

Clears all cached labels from the pool and destroys their game objects.

public void ClearCache()

Remarks

Live labels are released first. Leaving them out would strand every label currently on screen: nothing else holds them, so they would tick forever against a pool that no longer knows about them.

Dequeue(out UITKWorldLabel, bool)

Retrieves a label from the pool, recycles the oldest timed label when the live cap is reached, or builds a new one.

public bool Dequeue(out UITKWorldLabel label, bool persistent = false)

Parameters

label UITKWorldLabel

The dequeued, recycled or newly created label.

persistent bool

True for a label the caller will hold and cache itself. Persistent labels bypass the rate limit, because the budget exists to bound transient combat spam and a nameplate that silently fails to appear because a damage burst exhausted the bucket is a worse outcome than the spam it was protecting against. They are still subject to the live cap.

Returns

bool

True if a label is provided, false when the budget refuses one.

Remarks

Returning false is a normal outcome, not an error: it is how the rate limit and the live cap are enforced, and Display3D(string, Vector3, Color, float, float, bool, int) turns it into a dropped label rather than a stall.

Display3D(string, Vector3, Color, float, float, bool, int)

Displays a world-anchored label at the specified position with the given properties.

public static UITKWorldLabel Display3D(string text, Vector3 position, Color color, float fontSize, float persistTime, bool manualCache, int effectFlags = 0)

Parameters

text string

Text to display.

position Vector3

World position for the label.

color Color

Text color.

fontSize float

Font size in world units, scaled by distance at render time.

persistTime float

Duration in seconds before the label is automatically cached. Ignored if manualCache is true.

manualCache bool

If true, the label must be cached manually via Cache(UITKWorldLabel).

effectFlags int

Bit-flag field of LabelEffect values. 0 for no effects.

Returns

UITKWorldLabel

The displayed label, or null if the instance is unavailable or the budget refused one.

Enqueue(UITKWorldLabel)

Returns a label to the pool for reuse, or destroys it if the pool has reached maximum capacity.

public void Enqueue(UITKWorldLabel label)

Parameters

label UITKWorldLabel

The label to enqueue.

Remarks

Re-entrant by design. The old version enqueued unconditionally, so a label that was cached twice — trivially reachable, because the expiry path cached it and a caller holding the same reference could cache it again — sat in the pool twice and was then handed to two different callers at once, each overwriting the other's text. The pooled flag on the label makes the second call a no-op.