s&box TaskStatus: NPC task status enum

TaskStatus Enum API Reference

TaskStatus is an enum returned by task execution in the NPC system to indicate the current state of a task.

Type Signature

namespace Sandbox.Npcs;

public enum TaskStatus
{
    Running,
    Success,
    Failed,
    Interrupted
}

Values

• Running - Task is still running, continue executing
• Success - Task completed successfully
• Failed - Task failed or was cancelled
• Interrupted - Task was interrupted by conditions

Usage

public class MyTask : BaseTask
{
    public override TaskStatus Execute()
    {
        if (conditionMet)
            return TaskStatus.Success;
        
        if (shouldFail)
            return TaskStatus.Failed;
        
        if (interrupted)
            return TaskStatus.Interrupted;
        
        return TaskStatus.Running;
    }
}

Notes

• Used by the NPC task system for task state management
• Running indicates the task should continue executing next frame
• Success and Failed are terminal states
• Interrupted allows tasks to be stopped by external conditions