Action

Abstract base class for all actions. Provides async execution with cancellation support.

Definition

Namespace: Paragon.Core.ActionSystem Assembly: Paragon.dll

[Serializable]
public abstract class Action : IAction

Inheritance: Object → Action Implements: IAction

Properties

IsRunning

Gets whether the action is currently executing.

public bool IsRunning { get; }

Methods

Execute()

Fire-and-forget execution. Calls ExecuteAsync() internally.

public async void Execute();

---

ExecuteAsync()

Executes the action asynchronously with full lifecycle callbacks.

public async Task ExecuteAsync();

Returns: Task — A task representing the action execution

---

Cancel()

Cancels the running action.

public void Cancel();

Only call Cancel() when IsRunning is true.

---

Complete()

Completes the running action.

public void Complete();

---

SetVariable<TValue>()

Sets a variable value by name.

public void SetVariable<TValue>(string name, TValue value);

---

GetVariable<TValue>()

Gets a variable value by name.

public TValue GetVariable<TValue>(string name);

---

HasVariable()

Checks if a variable exists.

public bool HasVariable(string name);

Protected Methods

Override these in your action subclasses.

OnBegin()

Called before execution starts.

protected virtual void OnBegin();

---

OnExecute()

Abstract. Implement your action logic here.

protected abstract Task OnExecute();

---

OnComplete()

Called when the action completes normally.

protected virtual void OnComplete();

---

OnCancel()

Called when the action is canceled.

protected virtual void OnCancel();

---

OnEnd()

Called after completion OR cancellation.

protected virtual void OnEnd();

Execution Lifecycle

Execute() / ExecuteAsync()
        │
        ▼
    OnBegin()
        │
        ▼
    OnExecute()
        │
        ├── (completed) ──► OnComplete()
        │                        │
        └── (canceled) ──► OnCancel()
                                 │
                                 ▼
                            OnEnd()

Example

public class FadeOutAction : Action
{
    [Variable]
    private float duration = 1.0f;
    
    [Variable]
    private CanvasGroup target;
    
    protected override async Task OnExecute()
    {
        float elapsed = 0f;
        float startAlpha = target.alpha;
        
        while (elapsed < duration)
        {
            elapsed += Time.deltaTime;
            target.alpha = Mathf.Lerp(startAlpha, 0f, elapsed / duration);
            await Task.Yield();
        }
        
        target.alpha = 0f;
    }
}

See Also

• IAction

• ActionSequence

• ActionPlayer

• VariableAttribute