useGameboardQuest
useGameboardQuest(
entity): {activeObjectiveIndex:number;metadata:Record<string,GameboardQuestMetadataValue>;objectives:GameboardQuestObjective[];progress:GameboardQuestObjectiveProgress[];questId:string;schemaVersion:string;status:GameboardQuestStatus;title:string; } |undefined
Defined in: src/react/react.ts:933
Read quest metadata and progress for one quest entity.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity | null | undefined
Returns
Section titled “Returns”Type Literal
Section titled “Type Literal”{ activeObjectiveIndex: number; metadata: Record<string, GameboardQuestMetadataValue>; objectives: GameboardQuestObjective[]; progress: GameboardQuestObjectiveProgress[]; questId: string; schemaVersion: string; status: GameboardQuestStatus; title: string; }
activeObjectiveIndex
Section titled “activeObjectiveIndex”activeObjectiveIndex:
number=0
Index of the active objective in objectives.
metadata
Section titled “metadata”metadata:
Record<string,GameboardQuestMetadataValue>
Serializable quest metadata.
objectives
Section titled “objectives”objectives:
GameboardQuestObjective[]
Ordered objective definitions.
progress
Section titled “progress”progress:
GameboardQuestObjectiveProgress[]
Objective progress records.
questId
Section titled “questId”questId:
string=''
Stable quest id.
schemaVersion
Section titled “schemaVersion”schemaVersion:
string=GAMEBOARD_QUEST_SCHEMA_VERSION
Quest schema version.
status
Section titled “status”status:
GameboardQuestStatus
Runtime quest lifecycle status.
title:
string=''
Quest display title.
undefined