gpgs.quests.load()

Type Function
Return value none
Revision Release 2024.3703
Keywords Google Play Games Services, game network, gpgs, quests, load
See also gpgs.quests
gpgs.*

Overview

Retrieves information on quests available in the game. Optionally, this call can load a specific quest, a subset of quests, or filter all results.

Syntax

gpgs.quests.load( params )
params (required)

Table. Contains parameters for the call — see the next section for details.

Parameter Reference

The params table contains parameters for the call.

questId (optional)

String. If provided, loads only this quest information. If omitted, information on all quests is loaded.

questIds (optional)

Array. Populate with string elements to load information on each specified quest. If provided, this has higher priority than questId.

filters (optional)

Array. Populate with string elements to load only specific types of quests. Elements of this array can include: "accepted", "completed", "completed unclaimed", "ending soon", "expired", "failed", "open", "recently failed", and "upcoming". Note that "ending soon" and "recently failed" are only supported on Android.

recentlyUpdatedFirst (optional)

Boolean. Supported only on Android; if true, the results will be sorted by date of modification.

reload (optional)

Boolean. If true, the data will be retrieved fresh, not from a cache.

listener (optional)

Listener. Listener function which receives a load event.