TextStudioEmitter
[AddComponentMenu("Text Studio/Text Emitter")][DisallowMultipleComponent]public sealed class TextStudioEmitter : MonoBehaviourOwns bounded, temporary Text Studio hosts. Presentation remains in profiles and prefabs.
Methods
Section titled “Methods”
EmitValue(double, Transform)
Section titled “EmitValue(double, Transform)”public TextStudioEmissionHandle EmitValue(double value, Transform target)Formats and emits a number with the default preset at a target transform.
Parameters
| Name | Type |
|---|---|
value |
System.Double |
target |
UnityEngine.Transform |
Returns
TextStudio.TextStudioEmissionHandle
EmitValue(TextStudioEmissionPreset, double, Transform)
Section titled “EmitValue(TextStudioEmissionPreset, double, Transform)”public TextStudioEmissionHandle EmitValue(TextStudioEmissionPreset preset, double value, Transform target)Formats and emits a number with an explicit preset at a target transform.
Parameters
| Name | Type |
|---|---|
preset |
TextStudio.TextStudioEmissionPreset |
value |
System.Double |
target |
UnityEngine.Transform |
Returns
TextStudio.TextStudioEmissionHandle
EmitValue(TextStudioEmissionPreset, double, Vector3, string)
Section titled “EmitValue(TextStudioEmissionPreset, double, Vector3, string)”public TextStudioEmissionHandle EmitValue(TextStudioEmissionPreset preset, double value, Vector3 worldPosition, string groupKey = null)Formats and emits a number at a world position with an optional merge-group key.
Parameters
| Name | Type |
|---|---|
preset |
TextStudio.TextStudioEmissionPreset |
value |
System.Double |
worldPosition |
UnityEngine.Vector3 |
groupKey |
System.String |
Returns
TextStudio.TextStudioEmissionHandle
EmitText(TextStudioEmissionPreset, string, Transform)
Section titled “EmitText(TextStudioEmissionPreset, string, Transform)”public TextStudioEmissionHandle EmitText(TextStudioEmissionPreset preset, string text, Transform target)Emits text with an explicit preset at a target transform.
Parameters
| Name | Type |
|---|---|
preset |
TextStudio.TextStudioEmissionPreset |
text |
System.String |
target |
UnityEngine.Transform |
Returns
TextStudio.TextStudioEmissionHandle
EmitText(TextStudioEmissionPreset, string, Vector3, string)
Section titled “EmitText(TextStudioEmissionPreset, string, Vector3, string)”public TextStudioEmissionHandle EmitText(TextStudioEmissionPreset preset, string text, Vector3 worldPosition, string groupKey = null)Emits text at a world position with an optional merge-group key.
Parameters
| Name | Type |
|---|---|
preset |
TextStudio.TextStudioEmissionPreset |
text |
System.String |
worldPosition |
UnityEngine.Vector3 |
groupKey |
System.String |
Returns
TextStudio.TextStudioEmissionHandle
Emit(TextStudioEmissionRequest)
Section titled “Emit(TextStudioEmissionRequest)”public TextStudioEmissionHandle Emit(TextStudioEmissionRequest request)Emits, replaces, or merges one complete request and returns a generation-safe handle.
Parameters
| Name | Type |
|---|---|
request |
TextStudio.TextStudioEmissionRequest |
Returns
TextStudio.TextStudioEmissionHandle: An invalid handle when the emitter is inactive, tearing down, or cannot resolve a host.
Prewarm()
Section titled “Prewarm()”public void Prewarm()Creates inactive pooled hosts for the default and registered preset prefabs.
ReleaseAll()
Section titled “ReleaseAll()”public void ReleaseAll()Dismisses all active emissions immediately and returns their hosts to the pool.
Constructors
Section titled “Constructors”
TextStudioEmitter()
Section titled “TextStudioEmitter()”public TextStudioEmitter()Properties
Section titled “Properties”
DefaultHostPrefab
Section titled “DefaultHostPrefab”public GameObject DefaultHostPrefab { get; set; }Returns
UnityEngine.GameObject
DefaultPreset
Section titled “DefaultPreset”public TextStudioEmissionPreset DefaultPreset { get; set; }Returns
TextStudio.TextStudioEmissionPreset
InstanceParent
Section titled “InstanceParent”public Transform InstanceParent { get; set; }Returns
UnityEngine.Transform
PrewarmCount
Section titled “PrewarmCount”public int PrewarmCount { get; set; }Returns
System.Int32
MaximumInactivePerHost
Section titled “MaximumInactivePerHost”public int MaximumInactivePerHost { get; set; }Returns
System.Int32
MaximumActiveEmissions
Section titled “MaximumActiveEmissions”public int MaximumActiveEmissions { get; set; }Returns
System.Int32
OverflowPolicy
Section titled “OverflowPolicy”public TextStudioEmissionOverflowPolicy OverflowPolicy { get; set; }Returns
TextStudio.TextStudioEmissionOverflowPolicy
OutputSpace
Section titled “OutputSpace”public TextStudioEmissionOutputSpace OutputSpace { get; set; }Returns
TextStudio.TextStudioEmissionOutputSpace
FollowTargets
Section titled “FollowTargets”public bool FollowTargets { get; set; }Returns
System.Boolean
FaceCamera
Section titled “FaceCamera”public bool FaceCamera { get; set; }Returns
System.Boolean
Camera
Section titled “Camera”public Camera Camera { get; set; }Returns
UnityEngine.Camera
StackMatchingAnchors
Section titled “StackMatchingAnchors”public bool StackMatchingAnchors { get; set; }Returns
System.Boolean
StackSpacing
Section titled “StackSpacing”public float StackSpacing { get; set; }Returns
System.Single
ActiveCount
Section titled “ActiveCount”public int ActiveCount { get; }Returns
System.Int32
InactiveCount
Section titled “InactiveCount”public int InactiveCount { get; }Returns
System.Int32
CreatedCount
Section titled “CreatedCount”public int CreatedCount { get; }Returns
System.Int32
Events
Section titled “Events”
Emitted
Section titled “Emitted”public event Action<TextStudioEmissionHandle> EmittedOccurs after a new host accepts an emission.
Returns
System.Action{TextStudio.TextStudioEmissionHandle}
Merged
Section titled “Merged”public event Action<TextStudioEmissionHandle> MergedOccurs after a request is combined with an active emission under its merge policy.
Returns
System.Action{TextStudio.TextStudioEmissionHandle}
Released
Section titled “Released”public event Action<TextStudioEmissionHandle> ReleasedOccurs immediately before an emission handle becomes invalid and its host returns to the pool.
Returns
System.Action{TextStudio.TextStudioEmissionHandle}