YaCharacterQuest¶

YaCharacterQuest is a handle for quest API. You can add, remove, and edit quests with it.

Functions¶

boolean IsValid()¶

Returns true if the struct is valid.

boolean TryAddQuest(number questID, number requesterID)¶

SERVER ONLY

Adds a quest to the current character from the requester.

questID The unique identifier of the quest
requesterID The unique identifier of the requester

boolean ContainsQuest(number questID, number requesterID)¶

Returns true if the current character contains requestID from the requester.

questID The unique identifier of the quest
requesterID The entityID of the requester

boolean RemoveQuest(number questID, number requesterID)¶

SERVER ONLY

Removes a quest from the request from the current character.

questID The unique identifier for the quest
requesterID The entityID of the request

void ClearQuest()¶

SERVER ONLY

Removes all quests on the current character.

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

SERVER ONLY

Updates the progress of the quest on the current character.

questID The unique identifier for the quest
requesterID The entityID of the requester
targetID The quest to update
count The progress to update

Array<YaQuestProgress> GetQuestProgress(number questID, number requesterID)¶

Gets the progress of a quest for the current character.

questID The unique identifier for the quest
requesterID The entityID of the requester

boolean IsQuestCompleted(number questID, number requesterID)¶

Returns true if the quest from the requester is finished.

questID The unique identifier for the quest
requesterID The entityID of the requester

boolean TryAddCompletedQuest(number questID, number requesterID)¶

SERVER ONLY

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

questID The unique identifier for the quest
requesterID The entityID of the requester

boolean ContainsCompletedQuest(number questID, number requesterID)¶

Returns true if the quest from the requester is finished.

questID The unique identifier for the quest
requesterID The entityID of the requester

boolean ContainsCompletedQuestByAny(number questID)¶

Returns true if the quest from the requester is finished.

questID The unique identifier for the quest

boolean RemoveCompletedQuest(number questID, number requesterID)¶

SERVER ONLY

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

questID The unique identifier of the quest
requesterID The entityID of the requester

Events¶

AddQuestEvent<YaQuestData>¶

Fired when new unfinished quests are added.

questData Including information about quest

QuestUpdateProgressEvent<YaQuestProgress>¶

Fired when the unfinished quest makes progress.

progressInfo Quest progress information.

QuestCompletedEvent<YaQuestData>¶

Fired when a completed quest is added.

questData Including information about quest