Class Quest

Hierarchy

Host<IQuestEvents>
- Quest
  - default

Constructors

constructor

new Quest(type?: Challenge): Quest
Parameters
- Optional type: Challenge
Returns Quest
Overrides EventEmitter.Host<IQuestEvents>.constructor
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:49

Properties

`Optional` description

description?: default | ((quest: IQuest) => default)

`Readonly` event

event: IEventEmitter<Quest, IQuestEvents>

`Optional` title

title?: default | ((quest: IQuest) => default)

`Optional` type

type?: Challenge

Methods

addChildQuests

addChildQuests(...children: Challenge[]): Quest
Parameters
- Rest ...children: Challenge[]
Returns Quest
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:79

addRequirement

addRequirement<R>(type: R, ...args: RequirementArgs<R>): Quest
Type Parameters
- R extends QuestRequirementType
Parameters
- type: R
- Rest ...args: RequirementArgs<R>
Returns Quest
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:62
addRequirement<RA>(type: QuestRequirementType, ...args: RA): Quest
Type Parameters
- RA extends any[]
Parameters
- type: QuestRequirementType
- Rest ...args: RA
Returns Quest
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:63

create

create(island: default, type?: undefined | Challenge): IQuest
Parameters
- island: default
- type: undefined | Challenge = ...
Returns IQuest
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:106

`Protected` createRequirement

createRequirement<R>(type: R, ...options: RequirementArgs<R>): IQuestRequirement<RequirementArgs<R>, {}>
Type Parameters
- R extends QuestRequirementType
Parameters
- type: R
- Rest ...options: RequirementArgs<R>
Returns IQuestRequirement<RequirementArgs<R>, {}>
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:178

`Protected` createRequirements

createRequirements(island: default): IQuestRequirement<any[], {}>[]
Parameters
- island: default
Returns IQuestRequirement<any[], {}>[]
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:173

getChildren

getChildren(): Challenge[]
Returns Challenge[]
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:84

getDescription

getDescription(quest: IQuest): undefined | default
Parameters
- quest: IQuest
Returns undefined | default
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:126

getEventBusTriggers

getEventBusTriggers(instance: IQuest): [IQuestRequirement<any[], {}>, Stream<readonly [GameEmitterOrBus, string | number | symbol, ((api: IQuestRequirementApi<[], {}>, ...args: any[]) => boolean)]>][]
Parameters
- instance: IQuest
Returns [IQuestRequirement<any[], {}>, Stream<readonly [GameEmitterOrBus, string | number | symbol, ((api: IQuestRequirementApi<[], {}>, ...args: any[]) => boolean)]>][]
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:134

getHostTriggers

getHostTriggers(instance: IQuest): [IQuestRequirement<any[], {}>, IteratorObject<[keyof IPlayerEvents, ((api: IQuestRequirementApi<[], {}>, player: default, ...args: any[]) => boolean)]>][]
Parameters
- instance: IQuest
Returns [IQuestRequirement<any[], {}>, IteratorObject<[keyof IPlayerEvents, ((api: IQuestRequirementApi<[], {}>, player: default, ...args: any[]) => boolean)]>][]
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:139

getRequirement

getRequirement(host: default, quest: IQuest, requirement: IQuestRequirement<any[], {}>): undefined | RequirementInstance
Parameters
- host: default
- quest: IQuest
- requirement: IQuestRequirement<any[], {}>
Returns undefined | RequirementInstance
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:153

getRequirements

getRequirements(host: default, instance: IQuest): RequirementInstance[]
Parameters
- host: default
- instance: IQuest
Returns RequirementInstance[]
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:144

getTitle

getTitle(quest: IQuest): undefined | default
Parameters
- quest: IQuest
Returns undefined | default
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:118

needsManualCompletion

needsManualCompletion(): boolean
Returns boolean
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:161

reset

reset(): void
Returns void
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:53

setDescription

setDescription(translation?: default): Quest
Parameters
- Optional translation: default
Returns Quest
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:97

setNeedsManualCompletion

setNeedsManualCompletion(): Quest
Returns Quest
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:69

setSkippable

setSkippable(): Quest
Returns Quest
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:74

setTitle

setTitle(translation?: default | ((quest: IQuest) => default)): Quest
Parameters
- Optional translation: default | ((quest: IQuest) => default)
Returns Quest
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:92

skippable

skippable(): boolean
Returns boolean
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:165

Class Quest

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional type: Challenge

Returns Quest

Properties

Optional description

Readonly event

Optional title

Optional type

Methods

addChildQuests

Parameters

Rest ...children: Challenge[]

Returns Quest

addRequirement

Type Parameters

R extends QuestRequirementType

Parameters

type: R

Rest ...args: RequirementArgs<R>

Returns Quest

Type Parameters

RA extends any[]

Parameters

type: QuestRequirementType

Rest ...args: RA

Returns Quest

create

Parameters

island: default

type: undefined | Challenge = ...

Returns IQuest

Protected createRequirement

Type Parameters

R extends QuestRequirementType

Parameters

type: R

Rest ...options: RequirementArgs<R>

Returns IQuestRequirement<RequirementArgs<R>, {}>

Protected createRequirements

Parameters

island: default

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

getChildren

Returns Challenge[]

getDescription

Parameters

quest: IQuest

Returns undefined | default

getEventBusTriggers

Parameters

instance: IQuest

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

getHostTriggers

Parameters

instance: IQuest

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

getRequirement

Parameters

host: default

quest: IQuest

requirement: IQuestRequirement<any[], {}>

Returns undefined | RequirementInstance

getRequirements

Parameters

host: default

instance: IQuest

Returns RequirementInstance[]

getTitle

Parameters

quest: IQuest

Returns undefined | default

needsManualCompletion

`Optional` type: Challenge

`Optional` description

`Readonly` event

`Optional` title

`Optional` type

`Rest` ...children: Challenge[]

`Rest` ...args: RequirementArgs<R>

`Rest` ...args: RA

`Protected` createRequirement

`Rest` ...options: RequirementArgs<R>

`Protected` createRequirements

`Optional` translation: default

`Optional` translation: default | ((quest: IQuest) => default)