api.quests

Members

`api.quests.abandon()`

api.quests.abandon(questId: number): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`questId`	`number`

Returns: boolean

Errors: never

`api.quests.accept()`

api.quests.accept(questId: number, silent?: boolean): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`questId`	`number`
`silent`	`boolean`		`false`	Whether to load the quest without opening its UI.

Returns: boolean

Errors: never

`api.quests.acceptBatch()`

api.quests.acceptBatch(questIds: readonly number[], silent?: boolean): Effect.Effect<boolean[]>

Name	Type	Required	Default	Description
`questIds`	`readonly` `number`[]
`silent`	`boolean`		`false`	Whether to load the quests without opening their UI.

Returns: boolean[]

Errors: never

`api.quests.canComplete()`

api.quests.canComplete(questId: number): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`questId`	`number`

Returns: boolean

Errors: never

`api.quests.complete()`

api.quests.complete(questId: number, options?: CompleteQuestOptions): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`questId`	`number`
`options`	`CompleteQuestOptions`

Returns: boolean

Errors: never

`api.quests.get()`

api.quests.get(questId: number): Effect.Effect<LiveQuest | null>

Name	Type	Required	Default	Description
`questId`	`number`

Returns: LiveQuest | null

Errors: never

`api.quests.getAccepted()`

api.quests.getAccepted(): Effect.Effect<readonly LiveQuest[]>

Returns: readonly LiveQuest[]

Errors: never

`api.quests.getAll()`

api.quests.getAll(): Effect.Effect<readonly LiveQuest[]>

Returns: readonly LiveQuest[]

Errors: never

`api.quests.getMaxTurnIns()`

api.quests.getMaxTurnIns(questId: number): Effect.Effect<number>

Name	Type	Required	Default	Description
`questId`	`number`

Returns: number

Errors: never

`api.quests.isAvailable()`

api.quests.isAvailable(questId: number): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`questId`	`number`

Returns: boolean

Errors: never

`api.quests.isInProgress()`

api.quests.isInProgress(questId: number): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`questId`	`number`

Returns: boolean

Errors: never

`api.quests.load()`

api.quests.load(questId: number, silent?: boolean): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`questId`	`number`
`silent`	`boolean`		`false`	Whether to load the quest without opening its UI.

Returns: boolean

Errors: never

`api.quests.loadBatch()`

api.quests.loadBatch(questIds: readonly number[], silent?: boolean): Effect.Effect<boolean[]>

Name	Type	Required	Default	Description
`questIds`	`readonly` `number`[]
`silent`	`boolean`		`false`	Whether to load the quests without opening their UI.

Returns: boolean[]

Errors: never