Class CompositeGameAction<TContext>

Namespace

ElectricDrill.AstraRpgFramework.GameActions.Actions

Assembly

com.electricdrill.astra-rpg-framework.Runtime.dll

Executes a list of actions in sequence. Useful for chaining multiple behaviors (e.g., play sound, wait, disable object). Will gracefully terminate if the context is destroyed or cancellation is requested.

public abstract class CompositeGameAction<TContext> : GameAction<TContext>, IExecutable<TContext>, ITaggable

Type Parameters

TContext

Inheritance

object

Object

ScriptableObject

GameActionBase

GameAction<TContext>

CompositeGameAction<TContext>

Implements

IExecutable<TContext>

ITaggable

Derived

CompositeComponentGameAction

CompositeEntityContextGameAction

Inherited Members

GameAction<TContext>.Tags

GameAction<TContext>.DisplayName

GameAction<TContext>.ExecuteAsyncForUnityEvent(TContext)

GameAction<TContext>.OnOperationCanceled()

GameAction<TContext>.RunFireAndForget(TContext, MonoBehaviour)

Methods

ExecuteAsync(TContext, CancellationToken)

Executes the action asynchronously with the provided context. Override this method to implement your action logic.

public override Awaitable ExecuteAsync(TContext context, CancellationToken cancellationToken = default)

Parameters

context TContext

The context object containing information needed for execution.

cancellationToken CancellationToken

Token to cancel the operation. MonoBehaviour owners can use their "destroyCancellationToken" to automatically cancel when destroyed.

Returns

Awaitable

An Awaitable that completes when the action finishes.

ExecuteWithOwnerAsync(TContext, MonoBehaviour, CancellationToken)

Owner-aware execution path. The runtimeOwner identifies the MonoBehaviour (typically a listener or runner) whose entity is the logical owner of this action invocation. Wrapper actions must override this to forward the owner to children.

The default implementation ignores the owner and delegates to ExecuteAsync(TContext, CancellationToken), so leaf actions that do not need owner information require no changes.

public override Awaitable ExecuteWithOwnerAsync(TContext context, MonoBehaviour runtimeOwner, CancellationToken cancellationToken = default)

Parameters

context TContext

The context object containing information needed for execution.

runtimeOwner MonoBehaviour

The MonoBehaviour that owns this action invocation at runtime. Used by conditional actions to populate EvaluationContext.Holder.

cancellationToken CancellationToken

Token to cancel the operation.

Returns

Awaitable

An Awaitable that completes when the action finishes.