Class TextAnimatorSettings
Contains global settings for Text Animator, like effects enabled status and default databases.
Inheritance
TextAnimatorSettings
Assembly: Febucci.TextAnimator.Runtime.dll
Syntax
public sealed class TextAnimatorSettings : ScriptableObject
Fields
actions
Declaration
public TextAnimatorSettings.Category<ActionDatabase> actions
Field Value
appearances
Declaration
public TextAnimatorSettings.Category<AnimationsDatabase> appearances
Field Value
behaviors
Declaration
public TextAnimatorSettings.Category<AnimationsDatabase> behaviors
Field Value
defaultStyleSheet
Declaration
public StyleSheetScriptable defaultStyleSheet
Field Value
expectedName
Declaration
public const string expectedName = null
Field Value
| Type |
Description |
| System.String |
|
Properties
Instance
The current instance of the settings. If it's null, it will be loaded from the resources.
(Make sure to have one "TextAnimatorSettings" file in the Resources folder.)
Declaration
public static TextAnimatorSettings Instance { get; }
Property Value
Methods
LoadSettings()
Manually loads the settings ScriptableObject in case it wasn't loaded yet.
Declaration
public static void LoadSettings()
SetAllEffectsActive(Boolean)
Sets all the effects (both appearances/disappearances and behaviors) status.
Declaration
public static void SetAllEffectsActive(bool enabled)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enabled |
|
SetAppearancesActive(Boolean)
Sets all appearances effects status.
Declaration
public static void SetAppearancesActive(bool enabled)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enabled |
|
SetBehaviorsActive(Boolean)
Sets all behaviors effects status.
Declaration
public static void SetBehaviorsActive(bool enabled)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enabled |
|
UnloadSettings()
Manually unloads the settings ScriptableObject instance.
Declaration
public static void UnloadSettings()