VDH
85 lines
3.8 KiB
C#
85 lines
3.8 KiB
C#
// Animancer // https://kybernetik.com.au/animancer // Copyright 2021 Kybernetik //
|
|
|
|
#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value.
|
|
|
|
using Animancer.FSM;
|
|
using System;
|
|
using UnityEngine;
|
|
|
|
namespace Animancer.Examples.StateMachines.Characters
|
|
{
|
|
/// <summary>
|
|
/// A centralised group of references to the common parts of a character and a state machine for their actions.
|
|
/// </summary>
|
|
/// <example><see href="https://kybernetik.com.au/animancer/docs/examples/fsm/characters">Characters</see></example>
|
|
/// https://kybernetik.com.au/animancer/api/Animancer.Examples.StateMachines.Characters/Character
|
|
///
|
|
[AddComponentMenu(Strings.ExamplesMenuPrefix + "Characters - Character")]
|
|
[HelpURL(Strings.DocsURLs.ExampleAPIDocumentation + nameof(StateMachines) + "." + nameof(Characters) + "/" + nameof(Character))]
|
|
public sealed class Character : MonoBehaviour
|
|
{
|
|
/************************************************************************************************************************/
|
|
|
|
[SerializeField]
|
|
private AnimancerComponent _Animancer;
|
|
public AnimancerComponent Animancer => _Animancer;
|
|
|
|
[SerializeField]
|
|
private CharacterState _Idle;
|
|
public CharacterState Idle => _Idle;
|
|
|
|
// Rigidbody.
|
|
// Ground Detector.
|
|
// Stats.
|
|
// Health and Mana.
|
|
// Pathfinding.
|
|
// Etc.
|
|
// Anything common to most characters.
|
|
|
|
/************************************************************************************************************************/
|
|
|
|
/// <summary>The Finite State Machine that manages the actions of this character.</summary>
|
|
public readonly StateMachine<CharacterState>.WithDefault
|
|
StateMachine = new StateMachine<CharacterState>.WithDefault();
|
|
|
|
private void Awake()
|
|
{
|
|
StateMachine.DefaultState = _Idle;
|
|
}
|
|
|
|
/************************************************************************************************************************/
|
|
|
|
/// <summary>
|
|
/// Calls <see cref="StateMachine{TState}.TrySetState"/>. Normally you would just access the
|
|
/// <see cref="StateMachine"/> directly. This method only exists to be called by UI buttons.
|
|
/// </summary>
|
|
public void TrySetState(CharacterState state) => StateMachine.TrySetState(state);
|
|
|
|
/************************************************************************************************************************/
|
|
#if UNITY_EDITOR
|
|
/************************************************************************************************************************/
|
|
|
|
/// <summary>[Editor-Only]
|
|
/// Inspector Gadgets Pro calls this method after drawing the regular Inspector GUI, allowing this script to
|
|
/// display its current state in Play Mode.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <see cref="https://kybernetik.com.au/inspector-gadgets/pro">Inspector Gadgets Pro</see> allows you to
|
|
/// easily customise the Inspector without writing a full custom Inspector class by simply adding a method with
|
|
/// this name. Without Inspector Gadgets, this method will do nothing.
|
|
/// </remarks>
|
|
private void AfterInspectorGUI()
|
|
{
|
|
if (UnityEditor.EditorApplication.isPlaying)
|
|
{
|
|
using (new UnityEditor.EditorGUI.DisabledScope(true))
|
|
UnityEditor.EditorGUILayout.ObjectField("Current State", StateMachine.CurrentState, typeof(CharacterState), true);
|
|
}
|
|
}
|
|
|
|
/************************************************************************************************************************/
|
|
#endif
|
|
/************************************************************************************************************************/
|
|
}
|
|
}
|