TextStudioEffects
public static class TextStudioEffectsRegisters and resolves effect definitions, curves, and playback strategies. Runtime registrations have priority over project and built-in entries.
Methods
Section titled “Methods”
Register(ITextStudioEffectDefinition)
Section titled “Register(ITextStudioEffectDefinition)”public static void Register(ITextStudioEffectDefinition effect)Register an effect definition in the runtime tier.
Parameters
| Name | Type |
|---|---|
effect |
TextStudio.ITextStudioEffectDefinition |
TryGet(string, out ITextStudioEffect)
Section titled “TryGet(string, out ITextStudioEffect)”public static bool TryGet(string id, out ITextStudioEffect effect)Resolve a leaf effect evaluator by identifier without logging.
Parameters
| Name | Type |
|---|---|
id |
System.String |
effect |
TextStudio.ITextStudioEffect |
Returns
System.Boolean
TryGetDefinition(string, out ITextStudioEffectDefinition)
Section titled “TryGetDefinition(string, out ITextStudioEffectDefinition)”public static bool TryGetDefinition(string id, out ITextStudioEffectDefinition effect)Resolve a leaf evaluator or expansion-only effect definition by identifier.
Parameters
| Name | Type |
|---|---|
id |
System.String |
effect |
TextStudio.ITextStudioEffectDefinition |
Returns
System.Boolean
TryCreate(string, in TextStudioTagParameters, out ITextStudioEffect)
Section titled “TryCreate(string, in TextStudioTagParameters, out ITextStudioEffect)”public static bool TryCreate(string id, in TextStudioTagParameters parameters, out ITextStudioEffect effect)Create a detached evaluator and apply tag parameters without mutating its registered definition.
Parameters
| Name | Type |
|---|---|
id |
System.String |
parameters |
TextStudio.TextStudioTagParameters |
effect |
TextStudio.ITextStudioEffect |
Returns
System.Boolean
Unregister(string)
Section titled “Unregister(string)”public static bool Unregister(string id)Remove the highest-priority user-owned effect definition.
Parameters
| Name | Type |
|---|---|
id |
System.String |
Returns
System.Boolean
RegisterCurve(string, IEffectCurve)
Section titled “RegisterCurve(string, IEffectCurve)”public static void RegisterCurve(string id, IEffectCurve curve)Register an effect curve in the runtime tier.
Parameters
| Name | Type |
|---|---|
id |
System.String |
curve |
TextStudio.IEffectCurve |
TryGetCurve(string, out IEffectCurve)
Section titled “TryGetCurve(string, out IEffectCurve)”public static bool TryGetCurve(string id, out IEffectCurve curve)Resolve an effect curve by identifier without logging.
Parameters
| Name | Type |
|---|---|
id |
System.String |
curve |
TextStudio.IEffectCurve |
Returns
System.Boolean
UnregisterCurve(string)
Section titled “UnregisterCurve(string)”public static bool UnregisterCurve(string id)Remove the highest-priority user-owned curve.
Parameters
| Name | Type |
|---|---|
id |
System.String |
Returns
System.Boolean
RegisterPlayback(string, IEffectPlayback)
Section titled “RegisterPlayback(string, IEffectPlayback)”public static void RegisterPlayback(string id, IEffectPlayback playback)Register an effect playback strategy in the runtime tier.
Parameters
| Name | Type |
|---|---|
id |
System.String |
playback |
TextStudio.IEffectPlayback |
TryGetPlayback(string, out IEffectPlayback)
Section titled “TryGetPlayback(string, out IEffectPlayback)”public static bool TryGetPlayback(string id, out IEffectPlayback playback)Resolve an effect playback strategy by identifier without logging.
Parameters
| Name | Type |
|---|---|
id |
System.String |
playback |
TextStudio.IEffectPlayback |
Returns
System.Boolean
UnregisterPlayback(string)
Section titled “UnregisterPlayback(string)”public static bool UnregisterPlayback(string id)Remove the highest-priority user-owned playback strategy.
Parameters
| Name | Type |
|---|---|
id |
System.String |
Returns
System.Boolean