AnimancerSettings Class

Summary

[Editor-Only] Persistent settings used by Animancer.
Assembly
Animancer.dll
Namespace
Animancer.Editor
Base Types
  • ScriptableObject
graph BT Type-->Base0["ScriptableObject"] Type["AnimancerSettings"] class Type type-node

Syntax

[AnimancerHelpUrl(typeof(AnimancerSettings))]
public class AnimancerSettings : ScriptableObject

Remarks

This asset automatically creates itself when first accessed.

The default location is Packages/com.kybernetik.animancer/Code/Editor, but you can freely move it (and the whole Animancer folder) anywhere in your project.

These settings can also be accessed via the Settings in the Animancer.Editor.Tools.AnimancerToolsWindow (Window/Animation/Animancer Tools).

Attributes

Type Description
AnimancerHelpUrlAttribute [Assert-Conditional] A UnityEngine.HelpURLAttribute which points to Animancer's documentation.

Properties

Name Value Summary
Instance AnimancerSettings
Loads an existing Animancer.Editor.AnimancerSettings if there is one anywhere in your project. Otherwise, creates a new one and saves it in the Assets folder.
static
SerializedObject SerializedObject
The UnityEditor.SerializedProperty representing the Animancer.Editor.AnimancerSettings.Instance.
static

Methods

Name Value Summary
GetOrCreateData<T>() T
Returns a stored item of the specified type or creates a new one if necessary.
static
GetSerializedProperty(int, string, string) SerializedProperty
Returns a UnityEditor.SerializedProperty relative to the data at the specified `index`.
static
OnEnable() void
Ensures that there is an instance of each class derived from Animancer.Editor.AnimancerSettingsGroup.
SetDirty() void
Calls UnityEditor.EditorUtility.SetDirty(UnityEngine.Object) on the Animancer.Editor.AnimancerSettings.Instance.
static