85 lines
3.3 KiB
C#
85 lines
3.3 KiB
C#
|
// Animancer // https://kybernetik.com.au/animancer // Copyright 2018-2023 Kybernetik //
|
||
|
|
|
||
|
|
#if ! UNITY_EDITOR
|
||
|
|
#pragma warning disable CS0612 // Type or member is obsolete (for Layers in Animancer Lite).
|
||
|
|
#pragma warning disable CS0618 // Type or member is obsolete (for Layers in Animancer Lite).
|
||
|
|
#endif
|
||
|
|
|
||
|
|
using UnityEngine;
|
||
|
|
|
||
|
|
namespace Animancer
|
||
|
|
{
|
||
|
|
/// <summary>An <see cref="IUpdatable"/> that cancels any fades and logs warnings when they occur.</summary>
|
||
|
|
///
|
||
|
|
/// <remarks>
|
||
|
|
/// This is useful for <see cref="Sprite"/> based characters since fading does nothing for them.
|
||
|
|
/// <para></para>
|
||
|
|
/// You can also set the <see cref="AnimancerPlayable.DefaultFadeDuration"/> to 0 so that you don't need to set it
|
||
|
|
/// manually on all your transitions.
|
||
|
|
/// </remarks>
|
||
|
|
///
|
||
|
|
/// <example><code>
|
||
|
|
/// [SerializeField] private AnimancerComponent _Animancer;
|
||
|
|
///
|
||
|
|
/// private void Awake()
|
||
|
|
/// {
|
||
|
|
/// // To only apply it only in the Unity Editor and Development Builds:
|
||
|
|
/// DontAllowFade.Assert(_Animancer);
|
||
|
|
///
|
||
|
|
/// // Or to apply it at all times:
|
||
|
|
/// _Animancer.Playable.RequireUpdate(new DontAllowFade());
|
||
|
|
/// }
|
||
|
|
/// </code></example>
|
||
|
|
///
|
||
|
|
/// https://kybernetik.com.au/animancer/api/Animancer/DontAllowFade
|
||
|
|
///
|
||
|
|
public class DontAllowFade : Key, IUpdatable
|
||
|
|
{
|
||
|
|
/************************************************************************************************************************/
|
||
|
|
|
||
|
|
/// <summary>[Assert-Conditional] Applies a <see cref="DontAllowFade"/> to `animancer`.</summary>
|
||
|
|
[System.Diagnostics.Conditional(Strings.Assertions)]
|
||
|
|
public static void Assert(AnimancerPlayable animancer)
|
||
|
|
{
|
||
|
|
#if UNITY_EDITOR
|
||
|
|
var warnings = OptionalWarning.ProOnly.DisableTemporarily();
|
||
|
|
animancer.RequirePreUpdate(new DontAllowFade());
|
||
|
|
warnings.Enable();
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
/************************************************************************************************************************/
|
||
|
|
|
||
|
|
/// <summary>If the `node` is fading, this methods logs a warning (Assert-Only) and cancels the fade.</summary>
|
||
|
|
private static void Validate(AnimancerNode node)
|
||
|
|
{
|
||
|
|
if (node != null && node.FadeSpeed != 0)
|
||
|
|
{
|
||
|
|
#if UNITY_ASSERTIONS
|
||
|
|
Debug.LogWarning($"The following {node.GetType().Name} is fading even though " +
|
||
|
|
$"{nameof(DontAllowFade)} is active: {node.GetDescription()}",
|
||
|
|
node.Root.Component as Object);
|
||
|
|
#endif
|
||
|
|
|
||
|
|
node.Weight = node.TargetWeight;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/************************************************************************************************************************/
|
||
|
|
|
||
|
|
/// <summary>Calls <see cref="Validate"/> on all layers and their <see cref="AnimancerLayer.CurrentState"/>.</summary>
|
||
|
|
void IUpdatable.Update()
|
||
|
|
{
|
||
|
|
var layers = AnimancerPlayable.Current.Layers;
|
||
|
|
for (int i = layers.Count - 1; i >= 0; i--)
|
||
|
|
{
|
||
|
|
var layer = layers[i];
|
||
|
|
Validate(layer);
|
||
|
|
Validate(layer.CurrentState);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/************************************************************************************************************************/
|
||
|
|
}
|
||
|
|
}
|