Quests

Group
player
Methods
4
Fields
None

Getting one

player:quests()

Methods

MethodReturnsDescription
state(Quest)QuestState?A quest's state: not started, in progress, or finished.
isCompleted(Quest)booleanWhether a quest is finished.
progressValue(Quest)number?The raw progress var behind a quest, for the steps within it.
allProgress(){ { quest: Quest, state: QuestState?, value: number? } }Every quest with a Quest constant, with its state and progress value; state and value are nil while its var is unread.

Returned by

MethodReturnsDescription
PlayerDomain.questsQuestsQuest states and progress.

Method details

state

state: (Quests, Quest) -> QuestState?

A quest's state: not started, in progress, or finished.

quest
The quest, as its constant: Quest.DRAGON_SLAYER_I.
Returns
nil when the quest's var is unread.

isCompleted

isCompleted: (Quests, Quest) -> boolean

Whether a quest is finished.

quest
The quest, as its constant.

progressValue

progressValue: (Quests, Quest) -> number?

The raw progress var behind a quest, for the steps within it.

quest
The quest, as its constant.
Returns
nil when the quest's var is unread.

allProgress

allProgress: (Quests) -> { { quest: Quest, state: QuestState?, value: number? } }

Every quest with a Quest constant, with its state and progress value; state and value are nil while its var is unread.