JSONify addictions

[dseguin]

Summary

None

(alternate summary: "pldata.h is dead, long live addictions.json")

Purpose of change

• Fixes JSONized Addictions.cpp #56523

Describe the solution

Promote the add_type enum into an object with it's own string_id, and migrate hardcoded addiction functions to the "addiction_type" JSON object:

{
  "type": "addiction_type",
  "id": "caffeine",
  "name": "Caffeine Withdrawal",
  "type_name": "caffeine",
  "description": "Strength - 1;   Slight sluggishness;   Occasional cravings",
  "craving_morale": "morale_craving_caffeine",
  "effect_on_condition": "EOC_CAFFEINE_ADDICTION"
}

(definition of EOC_CAFFEINE_ADDICTION)

{
  "type": "effect_on_condition",
  "id": "EOC_CAFFEINE_ADDICTION",
  "condition": {
    "compare_int": [
      { "rand": 2000 },
      "<=",
      { "u_val": "addiction_intensity", "addiction": "caffeine", "mod": { "val": 2000, "step": 20 } }
    ]
  },
  "effect": [
    { "u_message": "You want some caffeine.", "type": "warning" },
    { "u_add_morale": "morale_craving_caffeine", "bonus": -5, "max_bonus": -30 },
    {
      "run_eocs": [
        {
          "id": "EOC_CAFFEINE_ADDICTION_MODSTIM",
          "condition": {
            "and": [
              { "compare_int": [ { "u_val": "stim" }, ">", { "u_val": "addiction_intensity", "addiction": "caffeine", "mod": -10 } ] },
              {
                "compare_int": [ { "rand": 10 }, "<", { "u_val": "addiction_intensity", "addiction": "caffeine" } ]
              }
            ]
          },
          "effect": { "arithmetic": [ { "u_val": "stim" }, "-=", { "const": 1 } ] }
        },
        {
          "id": "EOC_CAFFEINE_ADDICTION_SHAKES",
          "condition": {
            "and": [
              { "compare_int": [ { "u_val": "addiction_intensity", "addiction": "caffeine" }, ">=", { "const": 8 } ] },
              {
                "compare_int": [ { "rand": 392 }, "<", { "u_val": "addiction_intensity", "addiction": "caffeine" } ]
              }
            ]
          },
          "effect": [
            { "u_message": "Your hands start shaking… you need it bad!", "type": "bad" },
            { "u_add_effect": "shakes", "duration": "2 minutes" }
          ]
        }
      ]
    }
  ]
}

Field definitions

Field	Description
"name"	The name of the addiction's effect as it appears in the player's status
"type_name"	The name of the addiction's source
"description"	Description of the addiction's effects as it appears in the player's status
"craving_morale"	ID of the morale_type penalty
"effect_on_condition"	ID of the effect_on_condition (can also be an inline EOC) which activates on each update_body (aka every turn)
"builtin"	(for legacy addiction code) Name of a hardcoded function to process the addiction's effect. For new addictions, use "effect_on_condition" instead.

Describe alternatives you've considered

Using a different mechanism for applying addiction effects, like some custom built-ins or effect stuff.

Testing

Added extensive unit tests for validating JSON vs. hardcoded addiction effects:

./tests/cata_test --rng-seed time "[addiction]"

Additional context

TODO:

• Promote add_type to data object
• Remove pldata.h
• Convert existing save data
• Add conditions and dialogue effects for processing addiction EOCs
• Convert addiction effects to EOCs
  • Note: some harcoded addiction effects are incompatible with current EOC infrastructure. Those effects use the "builtin" field
• Documentation
• Unit tests