Class EffectsSettings

Settings for the animated text effects system.

Inheritance
object
EffectsSettings
Inherited Members
Namespace: Scylla.TextMode
Assembly: ScyllaTextMode.dll
Syntax
[Serializable]
public class EffectsSettings

Fields

DefaultDuration

Default duration in seconds for effects that are not given one.

Declaration
[Tooltip("How long an effect runs when its duration is not set explicitly. Effects that derive their duration from something else, such as a typewriter working from its characters-per-second setting, ignore this.")]
[Range(0, 600)]
public float DefaultDuration
Field Value
Type Description
float

EffectsEnabled

Whether text effects are allowed to run.

Declaration
[Tooltip("When enabled, text effects play normally. When disabled, effect players stop advancing and any running effect freezes where it is. Turn this off to rule out effects while diagnosing a rendering problem.")]
public bool EffectsEnabled
Field Value
Type Description
bool

GlobalSpeedMultiplier

Playback speed multiplier applied to every effect.

Declaration
[Tooltip("A speed multiplier applied on top of each effect's own speed. A value of 2 plays every effect twice as fast. Useful for tuning the overall pace of an interface without editing individual effects.")]
[Range(0.01, 100)]
public float GlobalSpeedMultiplier
Field Value
Type Description
float

MaxConcurrentEffects

Maximum number of effects a single view can run at once.

Declaration
[Tooltip("The number of effects one view can play simultaneously. The player reserves this many slots up front, and refuses further effects with a warning rather than growing. Raise it only if a screen genuinely animates many separate regions at once.")]
[Range(1, 64)]
public int MaxConcurrentEffects
Field Value
Type Description
int

PublishCharacterEvents

Whether effects publish an event for each character they reveal.

Declaration
[Tooltip("When enabled, reveal effects publish an event for every character they show, which is how a keystroke sound gets triggered. Leave this off unless something is listening, because a long line of text would otherwise put one event per character through the event bus.")]
public bool PublishCharacterEvents
Field Value
Type Description
bool

ReduceMotion

Whether effects resolve instantly instead of animating.

Declaration
[Tooltip("An accessibility setting. When enabled, effects jump straight to their finished state instead of animating, so content appears at once. Completion callbacks still fire, so game logic that waits for an effect to finish keeps working.")]
public bool ReduceMotion
Field Value
Type Description
bool

TypewriterCharactersPerSecond

Default typing speed for the typewriter effect.

Declaration
[Tooltip("How many characters a typewriter effect reveals each second when no speed is set on the effect itself. Around 30 reads like a fast terminal; lower values feel more deliberate.")]
[Range(0.1, 10000)]
public float TypewriterCharactersPerSecond
Field Value
Type Description
float