94 lines
3.3 KiB
C#
94 lines
3.3 KiB
C#
|
// ReSharper disable once CheckNamespace
|
|||
|
|
|
|||
|
|
namespace GodotStateCharts
|
|||
|
|
{
|
|||
|
|
using Godot;
|
|||
|
|
using System;
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// A wrapper around the state node that allows interacting with it from C#.
|
|||
|
|
/// </summary>
|
|||
|
|
public class State : NodeWrapper
|
|||
|
|
{
|
|||
|
|
|
|||
|
|
protected State(Node wrapped) : base(wrapped) { }
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Creates a wrapper object around the given node and verifies that the node
|
|||
|
|
/// is actually a state. The wrapper object can then be used to interact
|
|||
|
|
/// with the state chart from C#.
|
|||
|
|
/// </summary>
|
|||
|
|
/// <param name="state">the node that is the state</param>
|
|||
|
|
/// <returns>a State wrapper.</returns>
|
|||
|
|
/// <throws>ArgumentException if the node is not a state.</throws>
|
|||
|
|
public static State Of(Node state)
|
|||
|
|
{
|
|||
|
|
if (state.GetScript().As<Script>() is not GDScript gdScript ||
|
|||
|
|
!gdScript.ResourcePath.EndsWith("state.gd"))
|
|||
|
|
{
|
|||
|
|
throw new ArgumentException("Given node is not a state.");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return new State(state);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Returns true if this state is currently active.
|
|||
|
|
/// </summary>
|
|||
|
|
public bool Active => Wrapped.Get("active").As<bool>();
|
|||
|
|
|
|||
|
|
|
|||
|
|
public class SignalName : Godot.Node.SignalName
|
|||
|
|
{
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called when the state is entered.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName StateEntered = "state_entered";
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called when the state is exited.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName StateExited = "state_exited";
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called when the state receives an event. Only called if the state is active.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName EventReceived = "event_received";
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called when the state is processing.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName StateProcessing = "state_processing";
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called when the state is physics processing.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName StatePhysicsProcessing = "state_physics_processing";
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called when the state chart <code>Step</code> function is called.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName StateStepped = "state_stepped";
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called when the state is receiving input.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName StateInput = "state_input";
|
|||
|
|
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called when the state is receiving unhandled input.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName StateUnhandledInput = "state_unhandled_input";
|
|||
|
|
|
|||
|
|
/// <summary>
|
|||
|
|
/// Called every frame while a delayed transition is pending for this state.
|
|||
|
|
/// Returns the initial delay and the remaining delay of the transition.
|
|||
|
|
/// </summary>
|
|||
|
|
public static readonly StringName TransitionPending = "transition_pending";
|
|||
|
|
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|