Skip to content

TextStudioEmissionHandle

StructTextStudioTextStudio
public readonly struct TextStudioEmissionHandle

Generation-safe reference to one active temporary emission.

public bool SetText(string text)

Replaces active emission text and restarts effects according to its preset.

Parameters

Name Type
text System.String

Returns

System.Boolean: false after release or pool reuse.

public bool SetValue(double value)

Reformats and replaces an active numeric emission.

Parameters

Name Type
value System.Double

Returns

System.Boolean: false after release or pool reuse.

public bool Dismiss()

Starts the configured hide phase, or releases immediately when no transition applies.

Returns

System.Boolean: false after release or pool reuse.

public static TextStudioEmissionHandle Invalid { get; }

Returns

TextStudio.TextStudioEmissionHandle

public bool IsValid { get; }

Returns

System.Boolean