Skip to content

Quests

const Quests: object

abandon: (questId) => Effect<boolean, never, never>

number

Effect<boolean, never, never>

accept: (questId, options) => Effect<boolean, never, never>

number

QuestLoadOptions = {}

Effect<boolean, never, never>

acceptBatch: (questIds, options) => Effect<readonly boolean[], never, never>

Loads the quests together, then accepts each in turn. One result per quest, in order.

readonly number[]

QuestLoadOptions = {}

Effect<readonly boolean[], never, never>

canComplete: (questId) => Effect<boolean, never, never>

number

Effect<boolean, never, never>

complete: (questId, options) => Effect<boolean, never, never>

Item rewards land in the drop list.

number

CompleteOptions = {}

Effect<boolean, never, never>

configure: (changes) => Effect<QuestConfig, never, never>

Changes only the given fields and returns the config as stored.

Partial<QuestConfig>

Effect<QuestConfig, never, never>

get: (questId) => Effect<Quest | null, never, never>

Reads see only loaded quests.

number

Effect<Quest | null, never, never>

getAccepted: () => Effect<readonly Quest[], never, never>

Effect<readonly Quest[], never, never>

getConfig: () => Effect<QuestConfig, never, never>

Effect<QuestConfig, never, never>

getMaxTurnIns: (questId) => Effect<number, never, never>

number

Effect<number, never, never>

getRegistered: () => Effect<readonly RegisteredQuest[], never, never>

Effect<readonly RegisteredQuest[], never, never>

isAvailable: (questId) => Effect<boolean, never, never>

number

Effect<boolean, never, never>

isInProgress: (questId) => Effect<boolean, never, never>

number

Effect<boolean, never, never>

load: (questId, options) => Effect<boolean, never, never>

number

QuestLoadOptions = {}

Effect<boolean, never, never>

loadBatch: (questIds, options) => Effect<readonly boolean[], never, never>

One result per quest, in order. Missing quests load together, up to 30 per request.

readonly number[]

QuestLoadOptions = {}

Effect<readonly boolean[], never, never>

register: (quests) => Effect<void, never, never>

Accepts each quest whenever it’s available and completes it with as many turn-ins as the items allow. Registering a quest again replaces its rewardItemId; a quest with choice rewards isn’t completed without one. Registrations and config last until the session closes, after scripts end.

readonly QuestRegistration[]

Effect<void, never, never>

unregister: (questIds) => Effect<void, never, never>

readonly number[]

Effect<void, never, never>

unregisterAll: () => Effect<void, never, never>

Effect<void, never, never>