Class QuestRequirement<O, D>

Type Parameters

O extends any[] = []
D extends {} = {}

Hierarchy

QuestRequirement

Index

Constructors

constructor

new QuestRequirement<O, D>(defaultData: D): QuestRequirement<O, D>
Type Parameters
- O extends any[] = []
- D extends {} = {}
Parameters
- defaultData: D
Returns QuestRequirement<O, D>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:34

Properties

`Readonly` defaultData

defaultData: D

Methods

getCompletionAmount

getCompletionAmount(api: IQuestRequirementApi<O, D>): number
Parameters
- api: IQuestRequirementApi<O, D>
Returns number
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:96

getEventBusTriggers

getEventBusTriggers(): Stream<readonly [GameEmitterOrBus, string | number | symbol, ((api: IQuestRequirementApi<O, D>, ...args: any[]) => boolean)]>
Returns Stream<readonly [GameEmitterOrBus, string | number | symbol, ((api: IQuestRequirementApi<O, D>, ...args: any[]) => boolean)]>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:42

getHostTriggers

getHostTriggers(): IteratorObject<[keyof IPlayerEvents, ((api: IQuestRequirementApi<O, D>, player: default, ...args: any[]) => boolean)]>
Returns IteratorObject<[keyof IPlayerEvents, ((api: IQuestRequirementApi<O, D>, player: default, ...args: any[]) => boolean)]>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:53

getInitializeTrigger

getInitializeTrigger(): undefined | ((api: IQuestRequirementApi<O, D>) => boolean)
Returns undefined | ((api: IQuestRequirementApi<O, D>) => boolean)
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:62

getRelations

getRelations(api: IQuestRequirementApi<O, D>): HighlightSelector[]
Parameters
- api: IQuestRequirementApi<O, D>
Returns HighlightSelector[]
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:73

getTranslation

getTranslation(api: IQuestRequirementApi<O, D>): default
Parameters
- api: IQuestRequirementApi<O, D>
Returns default
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:82

setCompletionAmountGetter

setCompletionAmountGetter(getter: ((api: IQuestRequirementApi<O, D>) => number)): QuestRequirement<O, D>
Parameters
- getter: ((api: IQuestRequirementApi<O, D>) => number)
  - - (api: IQuestRequirementApi<O, D>): number
    - Parameters
      
      api: IQuestRequirementApi<O, D>
      
      Returns number
Returns QuestRequirement<O, D>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:91

setEventTrigger

setEventTrigger<E, K>(bus: E, event: K, checker: ((api: IQuestRequirementApi<O, D>, ...args: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any, undefined>;
    11(): Game;
    12(): default<unknown, number, NPC | Player>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): default;
    21(): MilestoneManager;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default;
    28(): default.Events;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): default;
    34(): Ui;
    35(): default;
    36(): default;
    37(): default;
    38(): default;
    39(): default;
    4(): default;
    40(): default;
    41(): default;
    42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
    43(): WorldRenderer;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, EntityReferenceTypes, unknown>;
    9(): default<unknown, number, EntityReferenceTypes, unknown>;
}[E]> : E>, ...args: Extract<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any, undefined>;
    11(): Game;
    12(): default<unknown, number, NPC | Player>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): default;
    21(): MilestoneManager;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default;
    28(): default.Events;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): default;
    34(): Ui;
    35(): default;
    36(): default;
    37(): default;
    38(): default;
    39(): default;
    4(): default;
    40(): default;
    41(): default;
    42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
    43(): WorldRenderer;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, EntityReferenceTypes, unknown>;
    9(): default<unknown, number, EntityReferenceTypes, unknown>;
}[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>, any[]>[]]) => boolean)): QuestRequirement<O, D>
Type Parameters
- E extends GameEmitterOrBus
- K extends string | number | symbol
Parameters
- bus: E
- event: K
- checker: ((api: IQuestRequirementApi<O, D>, ...args: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any, undefined>;
      11(): Game;
      12(): default<unknown, number, NPC | Player>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): default;
      21(): MilestoneManager;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default;
      28(): default.Events;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): default;
      34(): Ui;
      35(): default;
      36(): default;
      37(): default;
      38(): default;
      39(): default;
      4(): default;
      40(): default;
      41(): default;
      42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
      43(): WorldRenderer;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, EntityReferenceTypes, unknown>;
      9(): default<unknown, number, EntityReferenceTypes, unknown>;
  }[E]> : E>, ...args: Extract<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any, undefined>;
      11(): Game;
      12(): default<unknown, number, NPC | Player>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): default;
      21(): MilestoneManager;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default;
      28(): default.Events;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): default;
      34(): Ui;
      35(): default;
      36(): default;
      37(): default;
      38(): default;
      39(): default;
      4(): default;
      40(): default;
      41(): default;
      42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
      43(): WorldRenderer;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, EntityReferenceTypes, unknown>;
      9(): default<unknown, number, EntityReferenceTypes, unknown>;
  }[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>, any[]>[]]) => boolean)
  - - (api: IQuestRequirementApi<O, D>, ...args: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
          0(): default<any, any, any, any, any>;
          1(): default;
          10(): default<any, undefined>;
          11(): Game;
          12(): default<unknown, number, NPC | Player>;
          13(): default;
          14(): default;
          15(): default;
          16(): default;
          17(): default.Events;
          18(): default;
          19(): default;
          2(): default;
          20(): default;
          21(): MilestoneManager;
          22(): default;
          23(): default;
          24(): default;
          25(): default;
          26(): default;
          27(): default;
          28(): default.Events;
          29(): default;
          3(): default;
          30(): default;
          31(): default;
          32(): default;
          33(): default;
          34(): Ui;
          35(): default;
          36(): default;
          37(): default;
          38(): default;
          39(): default;
          4(): default;
          40(): default;
          41(): default;
          42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
          43(): WorldRenderer;
          5(): default;
          6(): default;
          7(): default;
          8(): default<unknown, number, EntityReferenceTypes, unknown>;
          9(): default<unknown, number, EntityReferenceTypes, unknown>;
      }[E]> : E>, ...args: Extract<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
          0(): default<any, any, any, any, any>;
          1(): default;
          10(): default<any, undefined>;
          11(): Game;
          12(): default<unknown, number, NPC | Player>;
          13(): default;
          14(): default;
          15(): default;
          16(): default;
          17(): default.Events;
          18(): default;
          19(): default;
          2(): default;
          20(): default;
          21(): MilestoneManager;
          22(): default;
          23(): default;
          24(): default;
          25(): default;
          26(): default;
          27(): default;
          28(): default.Events;
          29(): default;
          3(): default;
          30(): default;
          31(): default;
          32(): default;
          33(): default;
          34(): Ui;
          35(): default;
          36(): default;
          37(): default;
          38(): default;
          39(): default;
          4(): default;
          40(): default;
          41(): default;
          42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
          43(): WorldRenderer;
          5(): default;
          6(): default;
          7(): default;
          8(): default<unknown, number, EntityReferenceTypes, unknown>;
          9(): default<unknown, number, EntityReferenceTypes, unknown>;
      }[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>, any[]>[]]): boolean
    - Parameters
      
      api: IQuestRequirementApi<O, D>
      
      Rest ...args: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
          0(): default<any, any, any, any, any>;
          1(): default;
          10(): default<any, undefined>;
          11(): Game;
          12(): default<unknown, number, NPC | Player>;
          13(): default;
          14(): default;
          15(): default;
          16(): default;
          17(): default.Events;
          18(): default;
          19(): default;
          2(): default;
          20(): default;
          21(): MilestoneManager;
          22(): default;
          23(): default;
          24(): default;
          25(): default;
          26(): default;
          27(): default;
          28(): default.Events;
          29(): default;
          3(): default;
          30(): default;
          31(): default;
          32(): default;
          33(): default;
          34(): Ui;
          35(): default;
          36(): default;
          37(): default;
          38(): default;
          39(): default;
          4(): default;
          40(): default;
          41(): default;
          42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
          43(): WorldRenderer;
          5(): default;
          6(): default;
          7(): default;
          8(): default<unknown, number, EntityReferenceTypes, unknown>;
          9(): default<unknown, number, EntityReferenceTypes, unknown>;
      }[E]> : E>, ...args: Extract<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
          0(): default<any, any, any, any, any>;
          1(): default;
          10(): default<any, undefined>;
          11(): Game;
          12(): default<unknown, number, NPC | Player>;
          13(): default;
          14(): default;
          15(): default;
          16(): default;
          17(): default.Events;
          18(): default;
          19(): default;
          2(): default;
          20(): default;
          21(): MilestoneManager;
          22(): default;
          23(): default;
          24(): default;
          25(): default;
          26(): default;
          27(): default;
          28(): default.Events;
          29(): default;
          3(): default;
          30(): default;
          31(): default;
          32(): default;
          33(): default;
          34(): Ui;
          35(): default;
          36(): default;
          37(): default;
          38(): default;
          39(): default;
          4(): default;
          40(): default;
          41(): default;
          42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
          43(): WorldRenderer;
          5(): default;
          6(): default;
          7(): default;
          8(): default<unknown, number, EntityReferenceTypes, unknown>;
          9(): default<unknown, number, EntityReferenceTypes, unknown>;
      }[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>, any[]>[]]
      
      Returns boolean
Returns QuestRequirement<O, D>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:36

setHostTrigger

setHostTrigger<E>(event: E, checker: ((api: IQuestRequirementApi<O, D>, player: default, ...args: Extract<Parameters<Extract<IPlayerEvents[E], AnyFunction<any>>>, any[]>) => boolean)): QuestRequirement<O, D>
Type Parameters
- E extends keyof IPlayerEvents
Parameters
- event: E
- checker: ((api: IQuestRequirementApi<O, D>, player: default, ...args: Extract<Parameters<Extract<IPlayerEvents[E], AnyFunction<any>>>, any[]>) => boolean)
  - - (api: IQuestRequirementApi<O, D>, player: default, ...args: Extract<Parameters<Extract<IPlayerEvents[E], AnyFunction<any>>>, any[]>): boolean
    - Parameters
      
      api: IQuestRequirementApi<O, D>
      
      player: default
      
      Rest ...args: Extract<Parameters<Extract<IPlayerEvents[E], AnyFunction<any>>>, any[]>
      
      Returns boolean
Returns QuestRequirement<O, D>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:48

setInitializeTrigger

setInitializeTrigger(checker: ((api: IQuestRequirementApi<O, D>) => boolean)): QuestRequirement<O, D>
Parameters
- checker: ((api: IQuestRequirementApi<O, D>) => boolean)
  - - (api: IQuestRequirementApi<O, D>): boolean
    - Parameters
      
      api: IQuestRequirementApi<O, D>
      
      Returns boolean
Returns QuestRequirement<O, D>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:57

setRelations

setRelations(relations: HighlightSelector[]): QuestRequirement<O, D>
Parameters
- relations: HighlightSelector[]
Returns QuestRequirement<O, D>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:66
setRelations(handler: ((api: IQuestRequirementApi<O, D>) => HighlightSelector[])): QuestRequirement<O, D>
Parameters
- handler: ((api: IQuestRequirementApi<O, D>) => HighlightSelector[])
  - - (api: IQuestRequirementApi<O, D>): HighlightSelector[]
    - Parameters
      
      api: IQuestRequirementApi<O, D>
      
      Returns HighlightSelector[]
Returns QuestRequirement<O, D>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:67

setTranslation

setTranslation(translation: default | ((api: IQuestRequirementApi<O, D>) => default)): QuestRequirement<O, D>
Parameters
- translation: default | ((api: IQuestRequirementApi<O, D>) => default)
Returns QuestRequirement<O, D>
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:77

`Protected` validateOptions

validateOptions(...options: O): boolean
Parameters
- Rest ...options: O
Returns boolean
- Defined in src/game/game/entity/player/quest/requirement/Requirement.ts:101

Class QuestRequirement<O, D>

Type Parameters

O extends any[] = []

D extends {} = {}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

O extends any[] = []

D extends {} = {}

Parameters

defaultData: D

Returns QuestRequirement<O, D>

Properties

Readonly defaultData

Methods

getCompletionAmount

Parameters

api: IQuestRequirementApi<O, D>

Returns number

getEventBusTriggers

Returns Stream<readonly [GameEmitterOrBus, string | number | symbol, ((api: IQuestRequirementApi<O, D>, ...args: any[]) => boolean)]>

getHostTriggers

Returns IteratorObject<[keyof IPlayerEvents, ((api: IQuestRequirementApi<O, D>, player: default, ...args: any[]) => boolean)]>

getInitializeTrigger

Returns undefined | ((api: IQuestRequirementApi<O, D>) => boolean)

getRelations

Parameters

api: IQuestRequirementApi<O, D>

Returns HighlightSelector[]

getTranslation

Parameters

api: IQuestRequirementApi<O, D>

Returns default

setCompletionAmountGetter

Parameters

getter: ((api: IQuestRequirementApi<O, D>) => number)

Parameters

api: IQuestRequirementApi<O, D>

Returns number

Returns QuestRequirement<O, D>

setEventTrigger

Type Parameters

E extends GameEmitterOrBus

K extends string | number | symbol

Parameters

bus: E

event: K

Parameters

api: IQuestRequirementApi<O, D>

Returns boolean

Returns QuestRequirement<O, D>

setHostTrigger

Type Parameters

E extends keyof IPlayerEvents

Parameters

event: E

checker: ((api: IQuestRequirementApi<O, D>, player: default, ...args: Extract<Parameters<Extract<IPlayerEvents[E], AnyFunction<any>>>, any[]>) => boolean)

Parameters

api: IQuestRequirementApi<O, D>

player: default

Rest ...args: Extract<Parameters<Extract<IPlayerEvents[E], AnyFunction<any>>>, any[]>

Returns boolean

Returns QuestRequirement<O, D>

setInitializeTrigger

Parameters

checker: ((api: IQuestRequirementApi<O, D>) => boolean)

Parameters

api: IQuestRequirementApi<O, D>

Returns boolean

Returns QuestRequirement<O, D>

setRelations

Parameters

relations: HighlightSelector[]

Returns QuestRequirement<O, D>

Parameters

`Readonly` defaultData

`Rest` ...args: Extract<Parameters<Extract<IPlayerEvents[E], AnyFunction<any>>>, any[]>

`Protected` validateOptions

`Rest` ...options: O