YaCharacterQuestByRequester¶

YaCharacterQuestByRequester is an object representing quests from the specified requester. You can only apply this API to a requester. A requester is a non-player character (NPC) with a Quest component.

Functions¶

boolean IsValid()¶

Returns true if the struct is valid.

boolean TryAddQuest(number questID)¶

SERVER ONLY

Takes an available quest from the requester. The quest will be marked as to-do for the current character.

questID The unique identifier of the quest

boolean ContainsQuest(number questID)¶

Returns true if the current character contains the quest.

questID The unique identifier of the quest

boolean RemoveQuest(number questID)¶

SERVER ONLY

Removes a quest from the character.

questID The unique identifier of the quest

void ClearQuest()¶

SERVER ONLY

Removes all quests on the character.

YaQuestProgress UpdateQuestProgress(number questID, number targetID, [number count])¶

SERVER ONLY

Updates the progress of the quest on the current character.

questID The unique identifier of the quest
targetID The unique identifier of the quest to update
count The progress to update

Array<YaQuestProgress> GetQuestProgress(number questID)¶

Gets the progress of a quest for the current character.

questID The unique identifier of the quest

boolean IsQuestCompleted(number questID)¶

Returns true if the quest from the requester is finished.

questID The unique identifier of the quest

boolean TryAddCompletedQuest(number questID)¶

SERVER ONLY

Records the finished quest from the requester for the current character.

questID The unique identifier of the quest

boolean ContainsCompletedQuest(number questID)¶

Returns true if the quest from the requester is finished.

questID The unique identifier of the quest

boolean ContainsCompletedQuestByAny(number questID)¶

Returns true if the quest from the requester is finished.

questID The unique identifier of the quest

boolean RemoveCompletedQuest(number questID)¶

SERVER ONLY

Removes the finished quest from the requester for the current character.

questID The unique identifier of the quest

YaQuestConfig GetQuestConfig(number questID)¶

Gets quest configuration using quest ID.

questID The unique identifier of the quest