Interface IQuest

Define Quest Interface.

interface IQuest {
    description: string;
    id: number;
    isActive: boolean;
    isCompleted: boolean;
    name: string;
    tasks: null | Map<number, ITask>;
    addCheckTask(description: string, options?: {
        onCompleted?: (() => void);
    }): ICheckTask;
    addProgressBarTask(description: string, totalProgress: number, options?: {
        onCompleted?: (() => void);
    }): IProgressBarTask;
    fire<T>(event: T, ...args?: any[]): EventHandler;
    getTaskById(id: number): null | ITask;
    off<T>(event: T, listener: IQuestEvents[T]): EventHandler;
    on<T>(event: T, listener: IQuestEvents[T]): EventHandle;
    reset(): void;
    start(): void;
}

Properties

description id isActive isCompleted name tasks

Methods

addCheckTask addProgressBarTask fire getTaskById off on reset start

Properties

Readonly Planneddescription

description: string

The description of the quest.

Readonly Plannedid

id: number

The ID of the quest.

Readonly PlannedisActive

isActive: boolean

Whether the quest is active.

Readonly PlannedisCompleted

isCompleted: boolean

Whether the quest is completed.

Readonly Plannedname

name: string

The name of the quest.

Readonly Plannedtasks

tasks: null | Map<number, ITask>

Get the list of tasks in the quest.

Methods

addCheckTask

  • addCheckTask(description, options?): ICheckTask
  • Planned

    Add a new check task.

    Parameters

    • description: string

      The description of the task.

    • Optionaloptions: {
          onCompleted?: (() => void);
      }

      Optional parameters.

      • OptionalonCompleted?: (() => void)

        Callback function triggered when the task is completed.

          • (): void

          • Returns void

    Returns ICheckTask

    The check task object.

addProgressBarTask

  • addProgressBarTask(description, totalProgress, options?): IProgressBarTask
  • Planned

    Add a new progress bar task.

    Parameters

    • description: string

      The description of the task.

    • totalProgress: number
    • Optionaloptions: {
          onCompleted?: (() => void);
      }

      Optional parameters.

      • OptionalonCompleted?: (() => void)

        Callback function triggered when the task is completed.

          • (): void

          • Returns void

    Returns IProgressBarTask

    The progress bar task object.

fire

  • fire<T>(event, ...args?): EventHandler

  • Send a specific event.

    Type Parameters

    Parameters

    • event: T

      Event name

    • Optional Rest...args: any[]

      Event parameters

    Returns EventHandler

getTaskById

  • getTaskById(id): null | ITask
  • Planned

    Get a task by ID.

    Parameters

    • id: number

      Task ID.

    Returns null | ITask

off

  • off<T>(event, listener): EventHandler

  • Unsubscribe from a specific event.

    Type Parameters

    Parameters

    Returns EventHandler

on

  • on<T>(event, listener): EventHandle

  • Subscribe to a specific event.

    Type Parameters

    Parameters

    Returns EventHandle

reset

  • reset(): void
  • Planned

    Reset the quest.

    Returns void

start

  • start(): void
  • Planned

    Start the quest.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods