addedOutput schema / properties / quest
Added value: +{
+ "additionalProperties": false,
+ "description": "Quests only: status, kind, objectives, reward chips and progress as this user may see them.",
+ "properties": {
+ "kind": {
+ "description": "Main | Side | Personal.",
+ "type": "string"
+ },
+ "objectives": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "depth": {
+ "description": "0 for a top-level objective.",
+ "type": "number"
+ },
+ "hidden": {
+ "description": "GM reads only: true when players cannot see it.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Name it in set_quest_objective_state or update_quest_mnemons.",
+ "type": "string"
+ },
+ "optional": {
+ "type": "boolean"
+ },
+ "parentId": {
+ "type": "string"
+ },
+ "state": {
+ "description": "open | done | failed.",
+ "type": "string"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "text",
+ "state",
+ "optional",
+ "depth"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "playersCanTick": {
+ "type": "boolean"
+ },
+ "progress": {
+ "additionalProperties": false,
+ "description": "Required objectives done of those this user can see; optional and failed ones do not count.",
+ "properties": {
+ "done": {
+ "type": "number"
+ },
+ "total": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "done",
+ "total"
+ ],
+ "type": "object"
+ },
+ "rewardTotals": {
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "unit": {
+ "type": "string"
+ },
+ "unitLabel": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "xp": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "currency"
+ ],
+ "type": "object"
+ },
+ "rewards": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "entryId": {
+ "type": "string"
+ },
+ "hidden": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "string"
+ },
+ "kind": {
+ "description": "currency | xp | item | other.",
+ "type": "string"
+ },
+ "label": {
+ "type": "string"
+ },
+ "ruleEntryId": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ },
+ "unitLabel": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Available | Active | Completed | Failed.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "kind",
+ "playersCanTick"
+ ],
+ "type": "object"
+}