Interface IProgressBarTask

Define ProgressBarTask Interface.

interface IProgressBarTask {
    currentProgress: number;
    description: string;
    id: number;
    isCompleted: boolean;
    quest: IQuest;
    totalProgress: number;
    type: CompletionTypes;
    addProgress(increment?: number): void;
    fire<T>(event: T, ...args?: any[]): EventHandler;
    off<T>(event: T, listener: IProgressBarTaskEvents[T]): EventHandler;
    on<T>(event: T, listener: IProgressBarTaskEvents[T]): EventHandle;
}

Hierarchy (view full)

ITask
- IProgressBarTask

Index

Properties

currentProgress description id isCompleted quest totalProgress type

Methods

addProgress fire off on

Properties

`Readonly` `Planned`currentProgress

currentProgress: number

The current progress steps.

`Readonly` `Planned`description

description: string

The description of the task.

`Readonly` `Planned`id

id: number

The ID of the task.

`Readonly` `Planned`isCompleted

isCompleted: boolean

Whether the task is completed.

`Readonly` `Planned`quest

quest: IQuest

The parent quest of the task.

`Readonly` `Planned`totalProgress

totalProgress: number

The total progress steps needed to complete the task.

`Readonly` `Planned`type

type: CompletionTypes

The type of the task.

Methods

addProgress

addProgress(increment?): void
Planned
Update the progress of the task.
Parameters
- Optionalincrement: number
  Optional increment value. If not provided, the progress is incremented by 1.
Returns void
- Defined in services/quest/interface/IProgressBarTask.ts:22

fire

fire<T>(event, ...args?): EventHandler
Send a specific event.
Type Parameters
- T extends keyof IProgressBarTaskEvents
Parameters
- event: T
  Event name
- Optional Rest...args: any[]
  Event parameters
Returns EventHandler
Overrides ITask.fire
- Defined in services/quest/interface/IProgressBarTask.ts:50

off

off<T>(event, listener): EventHandler
Unsubscribe from a specific event.
Type Parameters
- T extends keyof IProgressBarTaskEvents
Parameters
- event: T
  Event name.
- listener: IProgressBarTaskEvents[T]
  Callback function.
Returns EventHandler
Overrides ITask.off
- Defined in services/quest/interface/IProgressBarTask.ts:40

on

on<T>(event, listener): EventHandle
Subscribe to a specific event.
Type Parameters
- T extends keyof IProgressBarTaskEvents
Parameters
- event: T
  Event name.
- listener: IProgressBarTaskEvents[T]
  Callback function.
Returns EventHandle
Overrides ITask.on
- Defined in services/quest/interface/IProgressBarTask.ts:30