Class default

Hierarchy

Quest
- default

Constructors

constructor

new default(): default
Returns default
Overrides Quest.constructor
- Defined in src/game/game/entity/player/quest/quest/Challenge.ts:337

Properties

`Optional` description

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

`Readonly` event

event: IEventEmitter<default, IQuestEvents>

`Optional` title

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

`Optional` type

type?: Challenge

Methods

addChildQuests

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

addRequirement

addRequirement<R>(type: R, ...args: RequirementArgs<R>): default
Type Parameters
- R extends QuestRequirementType
Parameters
- type: R
- Rest ...args: RequirementArgs<R>
Returns default
Inherited from Quest.addRequirement
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:62
addRequirement<RA>(type: QuestRequirementType, ...args: RA): default
Type Parameters
- RA extends any[]
Parameters
- type: QuestRequirementType
- Rest ...args: RA
Returns default
Inherited from Quest.addRequirement
- 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
Inherited from Quest.create
- 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>, {}>
Inherited from Quest.createRequirement
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:178

`Protected` createRequirements

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

getChildren

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

getDescription

getDescription(quest: IQuest): undefined | default
Parameters
- quest: IQuest
Returns undefined | default
Inherited from Quest.getDescription
- 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)]>][]
Inherited from Quest.getEventBusTriggers
- 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)]>][]
Inherited from Quest.getHostTriggers
- 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
Inherited from Quest.getRequirement
- 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[]
Inherited from Quest.getRequirements
- Defined in src/game/game/entity/player/quest/quest/Quest.ts:144

getTitle

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

needsManualCompletion

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

`Protected` onRequirementComplete

onRequirementComplete(quest: QuestInstance, completedRequirement: RequirementInstance): void
Parameters
- quest: QuestInstance
- completedRequirement: RequirementInstance
Returns void
- Defined in src/game/game/entity/player/quest/quest/Challenge.ts:385

`Protected` onUpdate

onUpdate(quest: QuestInstance): void
Parameters
- quest: QuestInstance
Returns void
- Defined in src/game/game/entity/player/quest/quest/Challenge.ts:376

reset

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

setDescription

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

setNeedsManualCompletion

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

setSkippable

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

setTitle

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

skippable

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

`Static` getCreaturesOfRequirements

getCreaturesOfRequirements(): CreatureType[]
Returns CreatureType[]
- Defined in src/game/game/entity/player/quest/quest/Challenge.ts:32

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

Optional description

Readonly event

Optional title

Optional type

Methods

addChildQuests

Parameters

Rest ...children: Challenge[]

Returns default

addRequirement

Type Parameters

R extends QuestRequirementType

Parameters

type: R

Rest ...args: RequirementArgs<R>

Returns default

Type Parameters

RA extends any[]

Parameters

type: QuestRequirementType

Rest ...args: RA

Returns default

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, 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

Returns boolean

Protected onRequirementComplete

`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

`Protected` onRequirementComplete

`Protected` onUpdate

`Optional` translation: default

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

`Static` getCreaturesOfRequirements