codingame_tools.client.common.protocol.quest¶
JSON-serializable dataclasses for the Quest service's findQuestMap Codingame API method.
module-attribute
¶
CgQuestType = str
The category of a quest, e.g. "INTRODUCTION", "ALGORITHMS", "OPTIMIZATION", "AI", "CLASH_OF_CODE", "CONTRIBUTE", "LEARNING".
module-attribute
¶
CgQuestRewardType = str
The kind of reward for completing a quest, e.g. "XP", "TEXT".
module-attribute
¶
CgCertificationCategory = str
The category of a quest certification, e.g. "ALGORITHMS", "OPTIMIZATION", "AI", "CODING_SPEED", "COLLABORATION".
module-attribute
¶
CgCertificationLevel = str
The tier of a quest certification, e.g. "BRONZE", "SILVER", "GOLD", "LEGEND".
dataclass
¶
CgQuestMapPoint(x, y, extra_data=dict())
Bases: JSONWizardX
A single waypoint coordinate in a CgQuestMapLink's path.
dataclass
¶
CgQuestMapLink(from_node_id, to_node_id, path, extra_data=dict())
Bases: JSONWizardX
A directed edge between two quest map nodes, as returned (in CgQuestMap.links) by
findQuestMap.
instance-attribute
¶
path
Intermediate waypoints for drawing a curved/routed edge on the quest map; often empty (a straight line between the two nodes).
dataclass
¶
CgQuestReward(id, reward_type=Alias('type'), extra_data=dict(), data=None)
Bases: JSONWizardX
A single reward granted for completing a quest, as embedded in
CgQuestDetails.rewards.
class-attribute
instance-attribute
¶
reward_type = Alias('type')
The kind of reward; see CgQuestRewardType. Determines the shape of data.
class-attribute
instance-attribute
¶
data = None
Reward-type-specific payload; e.g. {"xpPoints": 25} for an "XP" reward. Left as a raw
dict rather than a further-typed class pending examples of more reward types.
dataclass
¶
CgQuestCertification(category, level, description, extra_data=dict())
Bases: JSONWizardX
A certification awarded for completing a quest, as embedded in
CgQuest.certification.
dataclass
¶
CgQuestDetails(handle, title, description, progress_title, progress_max, rewards, extra_data=dict(), url=None)
Bases: JSONWizardX
Full details for a quest, as embedded in CgQuest.details. Not always present--e.g.
observed absent for some "CLASH_OF_CODE" quests that had neither details nor a
certification.
instance-attribute
¶
handle
Opaque (but human-readable) slug for the quest, e.g. "optim-zombies".
instance-attribute
¶
progress_title
Display text describing the completion goal, e.g. "Get a score of 40k+ points in Code vs Zombies".
instance-attribute
¶
progress_max
The progress value that represents 100% completion; compare against
CgCodingamerQuest.progress.
class-attribute
instance-attribute
¶
url = None
Relative URL path to the quest's target page (e.g. a multiplayer game). Not always present--observed absent for a few quests.
dataclass
¶
CgQuest(id, quest_type=Alias('type'), extra_data=dict(), details=None, certification=None)
Bases: JSONWizardX
A quest definition, as embedded in CgQuestMapNode.quest. details and/or
certification may each independently be present, both present, or both absent,
depending on the quest.
class-attribute
instance-attribute
¶
quest_type = Alias('type')
The quest's category; see CgQuestType.
class-attribute
instance-attribute
¶
details = None
Full quest details (title, description, progress goal, rewards). See class docstring.
class-attribute
instance-attribute
¶
certification = None
The certification awarded for completing this quest, if any. See class docstring.
dataclass
¶
CgCodingamerQuest(quest_id, progress, _creation_time=Alias('creationTime'), extra_data=dict(), _completion_time=Alias('completionTime', default=None), _loot_time=Alias('lootTime', default=None))
Bases: JSONWizardX
The requesting codingamer's own progress on a quest, as embedded in
CgQuestMapNode.codingamer_quest. Absent from the enclosing node entirely for quests
the codingamer has not started.
instance-attribute
¶
progress
Current progress value; compare against CgQuestDetails.progress_max.
property
writable
¶
creation_time
See the field docstring for _creation_time. Always UTC.
property
writable
¶
completion_time
See the field docstring for _completion_time. Always UTC. None if not completed.
property
writable
¶
loot_time
See the field docstring for _loot_time. Always UTC. None if not yet claimed.
dataclass
¶
CgQuestMapNode(id, x, y, quest, node_type=Alias('type'), extra_data=dict(), codingamer_quest=None)
Bases: JSONWizardX
A single node in a codingamer's quest map, as returned (in CgQuestMap.nodes) by
findQuestMap. Only node_type == "QUEST" has been observed so far.
instance-attribute
¶
id
Numeric ID of the node. Matches quest.id, and is referenced by CgQuestMapLink.
class-attribute
instance-attribute
¶
node_type = Alias('type')
Discriminator for the kind of node; only "QUEST" observed so far.
class-attribute
instance-attribute
¶
codingamer_quest = None
The requesting codingamer's progress on this quest. Absent if not yet started.
dataclass
¶
CgQuestMap(nodes, links, extra_data=dict())