osrlib 2.0.1__tar.gz → 2.2.0__tar.gz

{osrlib-2.0.1 → osrlib-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osrlib
-Version: 2.0.1
+Version: 2.2.0
 Summary: B/X (1981 Basic/Expert) tabletop RPG rules engine for turn-based dungeon crawlers
 Keywords: basic-expert,bx,dungeon-crawler,game-engine,osr,rpg,srd,ttrpg
 Author: Marsh Macy

{osrlib-2.0.1 → osrlib-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "osrlib"
-version = "2.0.1"
+version = "2.2.0"
 description = "B/X (1981 Basic/Expert) tabletop RPG rules engine for turn-based dungeon crawlers"
 readme = "README.md"
 # The wheel ships Open Game Content (osrlib/data/*.json and its LICENSE-OGL.md

{osrlib-2.0.1 → osrlib-2.2.0}/src/osrlib/core/character.py

@@ -228,9 +228,10 @@ class Character(BaseModel):
     id: str | None = None
     """The character's id within a game, like `"character-0001"`, or `None` before a session assigns one.
 
-    [`GameSession.new`][osrlib.crawl.session.GameSession.new] assigns an id to each party member whose id is `None`,
-    from the session's [`IdAllocator`][osrlib.core.monsters.IdAllocator]. Commands refer to a character by this id. An
-    event about a character with no id uses the character's `name` instead.
+    [`GameSession.new`][osrlib.crawl.session.GameSession.new] assigns an id from the session's
+    [`IdAllocator`][osrlib.core.monsters.IdAllocator] to each party member whose id is `None`.
+    [`AddMember`][osrlib.crawl.commands.AddMember] does the same for a character who joins during play. Commands refer
+    to a character by this id. An event about a character with no id uses the character's `name` instead.
     """
 
     name: str = Field(min_length=1)
@@ -287,6 +288,15 @@ class Character(BaseModel):
     [`kill`][osrlib.core.effects.kill] applies, not a hit point value.
     """
 
+    nonregen_damage: int = Field(default=0, ge=0)
+    """The fire and acid damage that a worn ring of regeneration can't heal, up to `max_hp`.
+
+    While the character wears the ring, [`deal_damage`][osrlib.core.combat.deal_damage] adds fire and acid damage
+    here. The ring heals the character only up to `max_hp` less this amount. Other healing, like a potion, heals this
+    damage too. So each time the character takes damage while wearing the ring, `deal_damage` first lowers this value
+    to the damage the character had before that hit. It's 0 for a character who has never worn the ring.
+    """
+
     inventory: Inventory = Field(default_factory=Inventory)
     """Everything the character carries, wears, and wields, and their coins. See
     [`Inventory`][osrlib.core.items.Inventory] and the buying and equipping functions in

{osrlib-2.0.1 → osrlib-2.2.0}/src/osrlib/core/classes.py

@@ -1180,9 +1180,10 @@ class DrainResult(BaseModel):
     """
 
     hp_lost: int
-    """The hit points the drain takes, from both maximum and current hit points.
+    """The hit points the drain rolls to take, from both maximum and current hit points.
 
     Neither total drops below 1 while the character has a level left, so the totals can fall by less than this.
+    The drain event in `events` has its own `hp_lost`, which is how far the maximum actually fell.
     """
 
     xp_after: int | None = None
@@ -1249,8 +1250,10 @@ def drain_levels(
             `streams.get(`[`ADVANCEMENT_STREAM`][osrlib.core.character.ADVANCEMENT_STREAM]`)`,
             the stream that level gains draw from.
         spawn_consequence: A description of what a victim drained of all levels becomes, like the
-            description of the monster's `energy_drain` ability. This function copies it onto the
-            drain event for you to show, and osrlib doesn't act on it. `None` leaves it off.
+            description of the monster's `energy_drain` ability. When the drain kills the character,
+            this function copies it onto the `combat.drain.slain` event for you to show. osrlib
+            doesn't act on it. When the character survives, the function doesn't copy it, because
+            the character hasn't become anything. `None` leaves it off.
 
     Returns:
         What the character lost, and the events that describe it.
@@ -1290,6 +1293,9 @@ def drain_levels(
         result = drain_levels(character, fighter, levels=1, xp_policy="halfway", stream=advancement)
         print(result.levels_lost, result.new_level, result.hp_lost, result.slain)
         # 1 1 9 False
+
+        # The lost level's d8 came up 8, and Rurik's CON modifier adds 1, so the drain takes 9
+        # hit points: maximum hit points fall from 10 to 1.
         print(character.level, character.xp, character.max_hp)
         # 1 1000 1
         ```
@@ -1301,6 +1307,7 @@ def drain_levels(
     if xp_policy not in ("halfway", "level_minimum"):
         raise ValueError(f"unknown xp policy {xp_policy!r}")
     former_level = character.level
+    former_max_hp = character.max_hp
     hp_rolls: list[int] = []
     hp_lost = 0
     slain = False
@@ -1334,7 +1341,7 @@ def drain_levels(
                 target_id=character.id or character.name,
                 levels_lost=levels_lost,
                 new_level=0,
-                hp_lost=hp_lost,
+                hp_lost=former_max_hp - character.max_hp,
                 spawn_consequence=spawn_consequence,
             )
         )
@@ -1360,9 +1367,8 @@ def drain_levels(
             target_id=character.id or character.name,
             levels_lost=former_level - character.level,
             new_level=character.level,
-            hp_lost=hp_lost,
+            hp_lost=former_max_hp - character.max_hp,
             xp_after=xp_after,
-            spawn_consequence=spawn_consequence,
         )
     )
     events.append(