Quests
constQuests:object
Type Declaration
Section titled “Type Declaration”abandon
Section titled “abandon”abandon: (
questId) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”questId
Section titled “questId”number
Returns
Section titled “Returns”Effect<boolean, never, never>
accept
Section titled “accept”accept: (
questId,options) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”questId
Section titled “questId”number
options?
Section titled “options?”QuestLoadOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
acceptBatch
Section titled “acceptBatch”acceptBatch: (
questIds,options) =>Effect<readonlyboolean[],never,never>
Loads the quests together, then accepts each in turn. One result per quest, in order.
Parameters
Section titled “Parameters”questIds
Section titled “questIds”readonly number[]
options?
Section titled “options?”QuestLoadOptions = {}
Returns
Section titled “Returns”Effect<readonly boolean[], never, never>
canComplete
Section titled “canComplete”canComplete: (
questId) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”questId
Section titled “questId”number
Returns
Section titled “Returns”Effect<boolean, never, never>
complete
Section titled “complete”complete: (
questId,options) =>Effect<boolean,never,never>
Item rewards land in the drop list.
Parameters
Section titled “Parameters”questId
Section titled “questId”number
options?
Section titled “options?”CompleteOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
configure
Section titled “configure”configure: (
changes) =>Effect<QuestConfig,never,never>
Changes only the given fields and returns the config as stored.
Parameters
Section titled “Parameters”changes
Section titled “changes”Partial<QuestConfig>
Returns
Section titled “Returns”Effect<QuestConfig, never, never>
get: (
questId) =>Effect<Quest|null,never,never>
Reads see only loaded quests.
Parameters
Section titled “Parameters”questId
Section titled “questId”number
Returns
Section titled “Returns”Effect<Quest | null, never, never>
getAccepted
Section titled “getAccepted”getAccepted: () =>
Effect<readonlyQuest[],never,never>
Returns
Section titled “Returns”Effect<readonly Quest[], never, never>
getConfig
Section titled “getConfig”getConfig: () =>
Effect<QuestConfig,never,never>
Returns
Section titled “Returns”Effect<QuestConfig, never, never>
getMaxTurnIns
Section titled “getMaxTurnIns”getMaxTurnIns: (
questId) =>Effect<number,never,never>
Parameters
Section titled “Parameters”questId
Section titled “questId”number
Returns
Section titled “Returns”Effect<number, never, never>
getRegistered
Section titled “getRegistered”getRegistered: () =>
Effect<readonlyRegisteredQuest[],never,never>
Returns
Section titled “Returns”Effect<readonly RegisteredQuest[], never, never>
isAvailable
Section titled “isAvailable”isAvailable: (
questId) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”questId
Section titled “questId”number
Returns
Section titled “Returns”Effect<boolean, never, never>
isInProgress
Section titled “isInProgress”isInProgress: (
questId) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”questId
Section titled “questId”number
Returns
Section titled “Returns”Effect<boolean, never, never>
load: (
questId,options) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”questId
Section titled “questId”number
options?
Section titled “options?”QuestLoadOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
loadBatch
Section titled “loadBatch”loadBatch: (
questIds,options) =>Effect<readonlyboolean[],never,never>
One result per quest, in order. Missing quests load together, up to 30 per request.
Parameters
Section titled “Parameters”questIds
Section titled “questIds”readonly number[]
options?
Section titled “options?”QuestLoadOptions = {}
Returns
Section titled “Returns”Effect<readonly boolean[], never, never>
register
Section titled “register”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.
Parameters
Section titled “Parameters”quests
Section titled “quests”readonly QuestRegistration[]
Returns
Section titled “Returns”Effect<void, never, never>
unregister
Section titled “unregister”unregister: (
questIds) =>Effect<void,never,never>
Parameters
Section titled “Parameters”questIds
Section titled “questIds”readonly number[]
Returns
Section titled “Returns”Effect<void, never, never>
unregisterAll
Section titled “unregisterAll”unregisterAll: () =>
Effect<void,never,never>
Returns
Section titled “Returns”Effect<void, never, never>