Back to Cataclysm Dda

Overview

doc/JSON/FACTION_MISSIONS.md

1.0.02.1 KB
Original Source
<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->

Overview

Faction Camps (aka basecamps) can send NPC followers on missions to perform some actions.

Those missions are currently mostly hardcoded, but we have begun moving them into JSON, starting with their descriptions.

Faction Mission JSON Object

FieldRequired?Description
"type"yesMust be "faction_mission"
"id"yesUnique identifier for the mission, often "camp_something"
"name"yesShort name for identifying the mission in a list or header
"desc"yesLonger description of the mission
"skill"noSkill checked and/or trained by performing the mission
"items_label"noFirst word in "Foo possibilities:" header for list of possible items
"items_possibilities"noArray of names of possible items returned from the mission
"effects"noArray of descriptions of what the mission accomplishes
"risk"noOne of "NONE", "VERY_LOW", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
"difficulty"noOne of "NONE", "VERY_LOW", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
"activity"noExercise level, see Player Activity
"time"noDescription of how long the mission takes
"positions"noNumber of NPCs that can perform this mission at once
"footer"noText to display at the bottom of the entire description

Example

json
  {
    "type": "faction_mission",
    "id": "camp_gathering",
    "name": "Gathering",
    "desc": "Send a companion to gather materials for the next camp upgrade.",
    "skill": "survival",
    "items_label": "Gathering",
    "items_possibilities": [ "stout branches", "withered plants", "splintered wood" ],
    "risk": "VERY_LOW",
    "activity": "LIGHT_EXERCISE",
    "time": "3 Hours, Repeated",
    "positions": 3
  },