Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Quest

Hierarchy

Implements

Index

Constructors

constructor

  • Parameters

    Returns Quest

Properties

Optional description

description: Translation | ((quest: IQuest) => Translation)

Readonly event

event: IEventEmitter<this, IQuestEvents> = new EventEmitter<this, E>(this)

Optional title

title: Translation | ((quest: IQuest) => Translation)

Optional type

type: QuestType

Methods

addChildQuests

  • addChildQuests(...children: QuestType[]): this
  • Parameters

    Returns this

addRequirement

  • Type parameters

    Parameters

    Returns this

  • Type parameters

    • RA: any[]

    Parameters

    Returns this

create

  • Parameters

    • Default value type: undefined | Challenge = this.type

    Returns IQuest

Protected createRequirement

Protected createRequirements

  • Returns Stream<IQuestRequirement<any[], {}>>

getChildren

  • Returns Stream<Challenge>

getDescription

  • Parameters

    Returns undefined | Translation

getEventBusTriggers

getHostTriggers

  • getHostTriggers(instance: IQuest): Stream<[IQuestRequirement<any[], {}>, IterableIterator<["respawn" | "damage" | "spawn" | "tickStart" | "tickEnd" | "restored" | "updateOption" | "displayMessage" | "interruptResponse" | "getMaxHealth" | "getMaxWeight" | "shouldDie" | "die" | "shouldRespawn" | "inventoryItemAdd" | "inventoryItemRemove" | "inventoryItemUpdate" | "processMovement" | "getMovementIntent" | "noInput" | "walkPathChange" | "moveComplete" | "changeZ" | "getWeightStatus" | "getWeightOrStaminaMovementPenalty" | "restStart" | "restEnd" | "writeNote" | "writtenNote" | "readNote" | "reregister" | "deregister" | "canConsumeItem" | "canDropItem" | "canAttack" | "calculateEquipmentStats" | "isSwimming" | "statusChange" | "created" | "removed" | "preMove" | "postMove" | "statChanged" | "statTimerChanged" | "statTimerWillChange" | "statTimerRemoved" | "statMaxChanged" | "statBonusChanged" | "skillChange", (api: IQuestRequirementApi<O, D>, player: Player, ...args: any[]) => boolean]>]>
  • Parameters

    Returns Stream<[IQuestRequirement<any[], {}>, IterableIterator<["respawn" | "damage" | "spawn" | "tickStart" | "tickEnd" | "restored" | "updateOption" | "displayMessage" | "interruptResponse" | "getMaxHealth" | "getMaxWeight" | "shouldDie" | "die" | "shouldRespawn" | "inventoryItemAdd" | "inventoryItemRemove" | "inventoryItemUpdate" | "processMovement" | "getMovementIntent" | "noInput" | "walkPathChange" | "moveComplete" | "changeZ" | "getWeightStatus" | "getWeightOrStaminaMovementPenalty" | "restStart" | "restEnd" | "writeNote" | "writtenNote" | "readNote" | "reregister" | "deregister" | "canConsumeItem" | "canDropItem" | "canAttack" | "calculateEquipmentStats" | "isSwimming" | "statusChange" | "created" | "removed" | "preMove" | "postMove" | "statChanged" | "statTimerChanged" | "statTimerWillChange" | "statTimerRemoved" | "statMaxChanged" | "statBonusChanged" | "skillChange", (api: IQuestRequirementApi<O, D>, player: Player, ...args: any[]) => boolean]>]>

getRequirement

getRequirements

getTitle

  • Parameters

    Returns undefined | Translation

getTriggers

needsManualCompletion

  • needsManualCompletion(): boolean
  • Returns boolean

setDescription

  • Parameters

    Returns this

setNeedsManualCompletion

  • setNeedsManualCompletion(): this
  • Returns this

setTitle

  • Parameters

    Returns this

Generated using TypeDoc