Documentation

Namespace: questApi

Playbasis. questApi

Playbasis Quest API

Methods

<static> cancelQuest(questId, playerId)

Cancel an already joined quest for player

Parameters:
Name Type Description
questId String

quest id
playerId String

player id
Returns:

Promise object

Type
Object

<static> joinAllQuests(playerId)

Join all quests for player

Parameters:
Name Type Description
playerId String

player id
Returns:

Promise object

Type
Object

<static> joinQuest(questId, playerId)

Join quest for player.

Parameters:
Name Type Description
questId String

quest id
playerId String

player id
Returns:

Promise object

Type
Object

<static> missionInfo(questId, missionId)

Return information about the mission with the specified id.

Parameters:
Name Type Description
questId String

quest id
missionId String

mission id
Returns:
Type
Object

<static> questAvailableForPlayer(questId, playerId)

Return information about the quest which is available for player.

Parameters:
Name Type Description
questId String

quest id
playerId String

player id
Returns:

Promise object

Type
Object

<static> questInfo(questId)

Return information about the quest with the specified id.

Parameters:
Name Type Description
questId String

quest id
Returns:

Promise object

Type
Object

<static> questListAvailableForPlayer(playerId)

Return information about list of quest which is available for player.

Parameters:
Name Type Description
playerId String

player id
Returns:

Promise object

Type
Object

<static> questListInfo(options)

Return information about all quest for the current site.

Parameters:
Name Type Description
options Object

(optional) options as object. It can include { tags: String = tag to query separated by comma }
Returns:

Promise object

Type
Object

<static> resetQuest(playerId, options)

Reset progress of quests for player. If options is null, then it will reset all progress for all quests that player has joined.

Parameters:
Name Type Description
playerId String

player id
options Object

(optional) options as object. It can include { quest_id: String = quest id to reset progress }
Returns:

Promise object

Type
Object