Merge pull request open5e#648 from open5e/eepMoody/issue644

EepMoody/issue644

Author: calumbell

.gitignore

@@ -2,6 +2,7 @@ local.env
 selfsigned.*
 
 **/.DS_Store
+__pycache__
 staticfiles/
 db\.sqlite3
 
@@ -15,6 +16,7 @@ server/whoosh_index/
 
 # pycharm config
 .idea/
+
 # pyenv env file
 .python-version
 

api_v2/migrations/0025_creature_initiative_bonus.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-03-08 01:20
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0024_alter_classfeatureitem_detail'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='creature',
+            name='initiative_bonus',
+            field=models.SmallIntegerField(blank=True, help_text='Initiative bonus. If not set, defaults to dexterity modifier.', null=True),
+        ),
+    ]

api_v2/models/creature.py

@@ -85,6 +85,21 @@ class Creature(Object, HasAbilities, HasSenses, HasLanguage, HasSpeed, FromDocum
     environments = models.ManyToManyField(Environment,
         related_name="creature_environments")
 
+    initiative_bonus = models.SmallIntegerField(
+        null=True,
+        blank=True,
+        help_text="Initiative bonus. If not set, defaults to dexterity modifier."
+    )
+
+    def get_initiative_bonus(self):
+        """
+        Returns the creature's initiative bonus. If no explicit bonus is set,
+        returns the dexterity modifier.
+        """
+        if self.initiative_bonus is not None:
+            return self.initiative_bonus
+        return self.modifier_dexterity
+
     def as_text(self):
         text = self.name + '\n'
         for action in self.creatureaction_set.all():
@@ -156,7 +171,6 @@ def experience_points(self):
             except:
                 return None
 
-
     @property
     def actions(self):
         """Returns the set of actions that are related to this creature."""

api_v2/serializers/creature.py

@@ -81,6 +81,7 @@ class CreatureSerializer(GameContentSerializer):
     size = SizeSerializer()
     languages = LanguageSerializer(many=True)
     environments = EnvironmentSerializer(many=True)
+    initiative_bonus = serializers.SerializerMethodField()
 
     class Meta:
         '''Serializer meta options.'''
@@ -106,6 +107,7 @@ class Meta:
             'experience_points',
             'ability_scores',
             'modifiers',
+            'initiative_bonus',
             'saving_throws',
             'saving_throws_all',
             'skill_bonuses',
@@ -325,10 +327,14 @@ def get_challenge_rating_text(self, creature):
     @extend_schema_field(OpenApiTypes.INT)
     def get_experience_points(self, creature):
         return creature.experience_points
-
+    
+    @extend_schema_field(OpenApiTypes.INT)
+    def get_initiative_bonus(self, creature):
+        return creature.get_initiative_bonus()
 
 class CreatureSetSerializer(GameContentSerializer):
     '''Serializer for the Creature Set object'''
+    
     key = serializers.ReadOnlyField()
     creatures = CreatureSerializer(many=True, read_only=True, context={'request':{}})
 

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

@@ -238,6 +238,7 @@
     "experience_points": 62000,
     "hit_dice": "28d20+252",
     "hit_points": 546,
+    "initiative_bonus": 0,
     "key": "srd_ancient-red-dragon",
     "languages": [
         {

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

@@ -235,6 +235,7 @@
     "experience_points": 50,
     "hit_dice": "2d6",
     "hit_points": 7,
+    "initiative_bonus": 2,
     "key": "srd_goblin",
     "languages": [
         {

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

@@ -162,6 +162,7 @@
     "experience_points": 25,
     "hit_dice": "2d8+2",
     "hit_points": 11,
+    "initiative_bonus": 1,
     "key": "srd_guard",
     "languages": [
         {

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

@@ -96,6 +96,7 @@
             "experience_points": 25,
             "hit_dice": "2d10+4",
             "hit_points": 15,
+            "initiative_bonus": -1,
             "key": "srd_camel",
             "languages": [],
             "modifiers": {
@@ -230,6 +231,7 @@
             "experience_points": 0,
             "hit_dice": null,
             "hit_points": 11,
+            "initiative_bonus": 0,
             "key": "srd_donkey",
             "languages": [],
             "modifiers": {
@@ -409,6 +411,7 @@
             "experience_points": 50,
             "hit_dice": "3d10+3",
             "hit_points": 19,
+            "initiative_bonus": 0,
             "key": "srd_draft-horse",
             "languages": [],
             "modifiers": {
@@ -641,6 +644,7 @@
             "experience_points": 1100,
             "hit_dice": "8d12+24",
             "hit_points": 76,
+            "initiative_bonus": -1,
             "key": "srd_elephant",
             "languages": [],
             "modifiers": {
@@ -849,6 +853,7 @@
             "experience_points": 25,
             "hit_dice": "1d8+1",
             "hit_points": 5,
+            "initiative_bonus": 2,
             "key": "srd_mastiff",
             "languages": [],
             "modifiers": {
@@ -1057,6 +1062,7 @@
             "experience_points": 25,
             "hit_dice": "2d8+2",
             "hit_points": 11,
+            "initiative_bonus": 0,
             "key": "srd_mule",
             "languages": [],
             "modifiers": {
@@ -1263,6 +1269,7 @@
             "experience_points": 25,
             "hit_dice": "2d8+2",
             "hit_points": 11,
+            "initiative_bonus": 0,
             "key": "srd_pony",
             "languages": [],
             "modifiers": {
@@ -1452,6 +1459,7 @@
             "experience_points": 50,
             "hit_dice": "2d10+2",
             "hit_points": 13,
+            "initiative_bonus": 0,
             "key": "srd_riding-horse",
             "languages": [],
             "modifiers": {
@@ -1631,6 +1639,7 @@
             "experience_points": 100,
             "hit_dice": "3d10+3",
             "hit_points": 19,
+            "initiative_bonus": 1,
             "key": "srd_warhorse",
             "languages": [],
             "modifiers": {