useGameboardQuestActions
useGameboardQuestActions():
object
Defined in: src/react/react.ts:432
Bind quest actions for spawning objectives and updating quest progress.
Returns
Section titled “Returns”advance
Section titled “advance”advance: (
quest,options) =>GameboardQuestSnapshot
Advance one quest entity.
Parameters
Section titled “Parameters”string | Entity
options?
Section titled “options?”AdvanceGameboardQuestOptions = {}
Returns
Section titled “Returns”advanceAll
Section titled “advanceAll”advanceAll: (
options) =>GameboardQuestSnapshot[]
Advance every quest entity.
Parameters
Section titled “Parameters”options?
Section titled “options?”AdvanceGameboardQuestOptions = {}
Returns
Section titled “Returns”find: (
quest) =>GameboardQuestSnapshot|undefined
Find one quest snapshot.
Parameters
Section titled “Parameters”string | Entity
Returns
Section titled “Returns”GameboardQuestSnapshot | undefined
read: () =>
GameboardQuestSnapshot[]
Read all quest snapshots.
Returns
Section titled “Returns”spawn: (
definition,options) =>Entity
Spawn a quest entity.
Parameters
Section titled “Parameters”definition
Section titled “definition”options?
Section titled “options?”SpawnGameboardQuestOptions = {}
Returns
Section titled “Returns”Entity