Class QuestService

Define QuestService interface.

Implements

Constructors

constructor

Accessors

isSystemReady quests

Methods

addQuest fire getQuestById getQuestByName off on resetAllQuests

Constructors

constructor

Accessors

isSystemReady

  • get isSystemReady(): boolean

  • Whether the system is ready.

    Returns boolean

    Example

    // The quest system might not be ready when the script is loaded.
    if(questService.isSystemReady){
      console.log('Quest system is ready', questService.quests);
    } else {
      questService.on('system:ready', () => {
        console.log('Quest system is ready', questService.quests);
      });
    }

quests

Methods

addQuest

  • addQuest(name, options?): IQuest

  • Add a new quest.

    Parameters

    • name: string

      The name of the quest.

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

      Optional parameters.

      • Optionaldescription?: string

        The description of the quest.

      • OptionalonCompleted?: (() => void)

        Callback function triggered when the quest is completed.

          • (): void

          • Returns void

    Returns IQuest

    The quest object.

    Example

    const quest = questService.addQuest(
     'Quest 1',
     {
     description: 'This is a quest.',
     onCompleted: () => console.log('Quest 1 is completed.')
     }
    );
    quest.addCheckTask('Task 1: Move', {onCompleted: () => console.log('Task 1 is completed.')});
    quest.addProgressBarTask('Task 2: Jump 3 times', 3, {onCompleted: () => console.log('Task 2 is completed.')});
    quest.start();

fire

getQuestById

getQuestByName

off

on

resetAllQuests

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods