Creature Immunities and Resistances refactor (open5e#724)

* updated Creature model with fields to store immun/vuln/res display text

* 'damages_and_resistances' field on CreatureSerializer now also contains Condition immunities

* wrote script to migrating resistances and immunity display text from v1->v2

* ran get_creature_resistances_immunities_as_string.py on source data

* updated tests

* merged migrations from staging

Author: calumbell

api_v2/migrations/0036_creature_damage_vulnerabilities_display.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-05-02 17:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0035_document_weight_unit'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='creature',
+            name='damage_vulnerabilities_display',
+            field=models.CharField(blank=True, help_text="The Creature's damage vulnerabilities, formatted in a human-readable string", max_length=128, null=True),
+        ),
+    ]

api_v2/migrations/0037_alter_creature_damage_vulnerabilities_display.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-05-02 17:33
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0036_creature_damage_vulnerabilities_display'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='creature',
+            name='damage_vulnerabilities_display',
+            field=models.CharField(blank=True, default='', help_text="The Creature's damage vulnerabilities, formatted in a human-readable string", max_length=128, null=True),
+        ),
+    ]

api_v2/migrations/0038_creature_damage_immunities_display_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.1.2 on 2025-05-02 17:38
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0037_alter_creature_damage_vulnerabilities_display'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='creature',
+            name='damage_immunities_display',
+            field=models.CharField(blank=True, default='', help_text="The Creature's damage immunities, formatted as a human-readable string", max_length=128, null=True),
+        ),
+        migrations.AddField(
+            model_name='creature',
+            name='damage_resistances_display',
+            field=models.CharField(blank=True, default='', help_text="The Creature's damage resistances, formatted as a human-readable string", max_length=128, null=True),
+        ),
+        migrations.AlterField(
+            model_name='creature',
+            name='damage_vulnerabilities_display',
+            field=models.CharField(blank=True, default='', help_text="The Creature's damage vulnerabilities, formatted as a human-readable string", max_length=128, null=True),
+        ),
+    ]

api_v2/migrations/0039_creature_condition_immunity_display.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-05-02 18:06
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0038_creature_damage_immunities_display_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='creature',
+            name='condition_immunity_display',
+            field=models.CharField(blank=True, default='', help_text="The Creature's condition immunities, formatted as a human-readable string", max_length=128, null=True),
+        ),
+    ]

api_v2/migrations/0040_rename_condition_immunity_display_creature_condition_immunities_display.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-05-02 18:10
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0039_creature_condition_immunity_display'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='creature',
+            old_name='condition_immunity_display',
+            new_name='condition_immunities_display',
+        ),
+    ]

api_v2/migrations/0041_merge_20250509_0736.py

@@ -0,0 +1,14 @@
+# Generated by Django 5.1.2 on 2025-05-09 07:36
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0039_alter_image_attribution'),
+        ('api_v2', '0040_rename_condition_immunity_display_creature_condition_immunities_display'),
+    ]
+
+    operations = [
+    ]

api_v2/models/creature.py

@@ -53,15 +53,48 @@ class Creature(Object, HasAbilities, HasSenses, HasLanguage, HasSpeed, FromDocum
         help_text='The creature\'s allowed alignments.'
     )
 
+
+    damage_vulnerabilities_display = models.CharField(
+        max_length=128,
+        blank=True,
+        null=True,
+        help_text='The Creature\'s damage vulnerabilities, formatted as a human-readable string',
+        default=''
+    )
+
     damage_vulnerabilities = models.ManyToManyField(DamageType,
         related_name="creature_damage_vulnerabilities")
 
+    damage_immunities_display = models.CharField(
+        max_length=128,
+        blank=True,
+        null=True,
+        help_text='The Creature\'s damage immunities, formatted as a human-readable string',
+        default=''
+    )
+
     damage_immunities = models.ManyToManyField(DamageType,
         related_name="creature_damage_immunities")
 
+
+    damage_resistances_display = models.CharField(
+        max_length=128,
+        blank=True,
+        null=True,
+        help_text='The Creature\'s damage resistances, formatted as a human-readable string',
+        default=''
+    )
+
     damage_resistances = models.ManyToManyField(DamageType,
         related_name="creature_damage_resistances")
 
+    condition_immunities_display = models.CharField(
+        max_length=128,
+        blank=True,
+        null=True,
+        help_text='The Creature\'s condition immunities, formatted as a human-readable string',
+        default=''
+    )
     condition_immunities = models.ManyToManyField(
         Condition,
         help_text="Conditions that this creature is immune to."

api_v2/serializers/creature.py

@@ -110,6 +110,30 @@ class Meta:
         model = models.Creature
         fields = ['as_string', 'data']
 
+class CreatureResistancesAndImmunitiesSerializer(GameContentSerializer):
+    '''This serializer formats a Creature's damage modifier as a single obj '''
+    damage_immunities_display = serializers.CharField()
+    damage_immunities = DamageTypeSummarySerializer(many=True)
+    damage_resistances_display = serializers.CharField()
+    damage_resistances = DamageTypeSummarySerializer(many=True)
+    damage_vulnerabilities_display = serializers.CharField()
+    damage_vulnerabilities = DamageTypeSummarySerializer(many=True)
+    condition_immunities_display = serializers.CharField()
+    condition_immunities = ConditionSummarySerializer(many=True)
+
+    class Meta:
+        model = models.Creature
+        fields = [
+            'damage_immunities_display',
+            'damage_immunities',
+            'damage_resistances_display',
+            'damage_resistances',
+            'damage_vulnerabilities_display',
+            'damage_vulnerabilities',
+            'condition_immunities_display',
+            'condition_immunities',
+        ]
+
 class CreatureSerializer(GameContentSerializer):
     '''The serializer for the Creature object.'''
 
@@ -120,10 +144,7 @@ class CreatureSerializer(GameContentSerializer):
     saving_throws_all = serializers.SerializerMethodField()
     skill_bonuses = serializers.SerializerMethodField()
     skill_bonuses_all = serializers.SerializerMethodField()
-    damage_immunities = DamageTypeSummarySerializer(many=True)
-    damage_resistances = DamageTypeSummarySerializer(many=True)
-    damage_vulnerabilities = DamageTypeSummarySerializer(many=True)
-    condition_immunities = ConditionSummarySerializer(many=True)
+    resistances_and_immunities = CreatureResistancesAndImmunitiesSerializer(source='*')
     actions = CreatureActionSerializer(many=True)
     traits = CreatureTraitSerializer(many=True, read_only=True)
     speed = serializers.SerializerMethodField()
@@ -168,12 +189,7 @@ class Meta:
             'skill_bonuses',
             'skill_bonuses_all',
             'passive_perception',
-            'damage_immunities',
-            'nonmagical_attack_immunity',
-            'damage_resistances',
-            'nonmagical_attack_resistance',
-            'damage_vulnerabilities',
-            'condition_immunities',
+            'resistances_and_immunities',
             'normal_sight_range',
             'darkvision_range',
             'blindsight_range',

api_v2/tests/responses/TestObjects.test_creature_ancient_example.approved.json

@@ -179,17 +179,7 @@
     "category": "Monsters",
     "challenge_rating_decimal": "24.000",
     "challenge_rating_text": "24",
-    "condition_immunities": [],
     "creaturesets": [],
-    "damage_immunities": [
-        {
-            "key": "fire",
-            "name": "Fire",
-            "url": "http://localhost:8000/v2/damagetypes/fire/"
-        }
-    ],
-    "damage_resistances": [],
-    "damage_vulnerabilities": [],
     "darkvision_range": 120.0,
     "document": {
         "gamesystem": {
@@ -249,10 +239,24 @@
         "wisdom": 2
     },
     "name": "Ancient Red Dragon",
-    "nonmagical_attack_immunity": false,
-    "nonmagical_attack_resistance": false,
     "normal_sight_range": 10560.0,
     "passive_perception": 26,
+    "resistances_and_immunities": {
+        "condition_immunities": [],
+        "condition_immunities_display": "",
+        "damage_immunities": [
+            {
+                "key": "fire",
+                "name": "Fire",
+                "url": "http://localhost:8000/v2/damagetypes/fire/"
+            }
+        ],
+        "damage_immunities_display": "fire",
+        "damage_resistances": [],
+        "damage_resistances_display": "",
+        "damage_vulnerabilities": [],
+        "damage_vulnerabilities_display": ""
+    },
     "saving_throws": {
         "charisma": 13,
         "constitution": 16,

api_v2/tests/responses/TestObjects.test_creature_goblin_example.approved.json

@@ -82,11 +82,7 @@
     "category": "Monsters",
     "challenge_rating_decimal": "0.250",
     "challenge_rating_text": "1/4",
-    "condition_immunities": [],
     "creaturesets": [],
-    "damage_immunities": [],
-    "damage_resistances": [],
-    "damage_vulnerabilities": [],
     "darkvision_range": 60.0,
     "document": {
         "gamesystem": {
@@ -201,10 +197,18 @@
         "wisdom": -1
     },
     "name": "Goblin",
-    "nonmagical_attack_immunity": false,
-    "nonmagical_attack_resistance": false,
     "normal_sight_range": 10560.0,
     "passive_perception": 9,
+    "resistances_and_immunities": {
+        "condition_immunities": [],
+        "condition_immunities_display": "",
+        "damage_immunities": [],
+        "damage_immunities_display": "",
+        "damage_resistances": [],
+        "damage_resistances_display": "",
+        "damage_vulnerabilities": [],
+        "damage_vulnerabilities_display": ""
+    },
     "saving_throws": {},
     "saving_throws_all": {
         "charisma": -1,