IndieGame/client/Assets/Plugins/Animancer/Utilities/ExposedPropertyTable.cs

60 lines
2.7 KiB
C#
Raw Normal View History

2024-10-11 10:12:15 +08:00
// Animancer // https://kybernetik.com.au/animancer // Copyright 2018-2023 Kybernetik //
using UnityEngine;
using UnityEngine.Playables;
namespace Animancer
{
/// <summary>Sets a <see cref="PlayableDirector"/> as Animancer's <see cref="IExposedPropertyTable"/>.</summary>
/// <remarks>
/// This class allows Control Tracks to work properly when played in a <see cref="PlayableAssetState"/>.
/// <para></para>
/// Documentation: <see href="https://kybernetik.com.au/animancer/docs/manual/timeline#exposed-references">Exposed References</see>
/// </remarks>
/// https://kybernetik.com.au/animancer/api/Animancer/ExposedPropertyTable
///
[AddComponentMenu(Strings.MenuPrefix + "Exposed Property Table")]
[HelpURL(Strings.DocsURLs.APIDocumentation + "/" + nameof(ExposedPropertyTable))]
[DefaultExecutionOrder(-10000)]// Initialize before anything else might need to use the table.
public class ExposedPropertyTable : MonoBehaviour
{
/************************************************************************************************************************/
[SerializeField] private AnimancerComponent _Animancer;
[SerializeField] private PlayableDirector _Director;
/************************************************************************************************************************/
/// <summary>Calls <see cref="OnValidate"/> and if no <see cref="PlayableDirector"/> was found it adds one.</summary>
protected virtual void Reset()
{
OnValidate();
if (_Director == null)
_Director = gameObject.AddComponent<PlayableDirector>();
_Director.enabled = false;
_Director.playOnAwake = false;
}
/************************************************************************************************************************/
/// <summary>Tries to automatically find any missing references.</summary>
protected virtual void OnValidate()
{
gameObject.GetComponentInParentOrChildren(ref _Animancer);
gameObject.GetComponentInParentOrChildren(ref _Director);
}
/************************************************************************************************************************/
/// <summary>Sets the <see cref="PlayableDirector"/> as Animancer's <see cref="IExposedPropertyTable"/>.</summary>
protected virtual void Awake()
{
_Animancer.Playable.Graph.SetResolver(_Director);
}
/************************************************************************************************************************/
}
}