Class ToggleActiveGameObjectGameAction<TContext>

Namespace

ElectricDrill.AstraRpgFramework.GameActions.Actions

Assembly

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

Base action to set the active state of a Component's GameObject.

public abstract class ToggleActiveGameObjectGameAction<TContext> : GameAction<TContext>, IExecutable<TContext> where TContext : Component

Type Parameters

TContext

Inheritance

object

Object

ScriptableObject

GameAction<TContext>

ToggleActiveGameObjectGameAction<TContext>

Implements

IExecutable<TContext>

Derived

ToggleActiveGameObjectComponentGameAction

Inherited Members

GameAction<TContext>.DisplayName

GameAction<TContext>.ExecuteAsyncForUnityEvent(TContext)

GameAction<TContext>.OnOperationCanceled()

GameAction<TContext>.RunFireAndForget(TContext, MonoBehaviour)

Fields

_isActive

[SerializeField]
[Tooltip("The active state to apply.")]
protected bool _isActive

Field Value

bool

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.