From c5bbf08259dd763a7439ddf5f4c033aa1a465a34 Mon Sep 17 00:00:00 2001 From: Marsh Macy Date: Tue, 23 Jan 2024 19:50:11 -0800 Subject: [PATCH] minor doc update for Treasure --- osrlib/osrlib/treasure.py | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/osrlib/osrlib/treasure.py b/osrlib/osrlib/treasure.py index 9e9cb01..698868b 100644 --- a/osrlib/osrlib/treasure.py +++ b/osrlib/osrlib/treasure.py @@ -45,7 +45,7 @@ class TreasureDetail: class Treasure: - """Represents a treasure haul within the game, encapsulating various types of loot. + """Represents a treasure haul within the game, encapsulating various physical item rewards. ``Treasure`` manages the generation and valuation of treasures comprising coins, gems, jewelry, and magical items. The treasure is generated based on predefined types, each corresponding to different probabilities and amounts @@ -56,13 +56,6 @@ class Treasure: items (Dict[Union[CoinType, ItemType], int]): A dictionary holding the treasure items. The keys are instances of either CoinType or ItemType enumerations, and the values are integers representing the quantity of each item. - Methods: - __init__(treasure_type: TreasureType = None): Initializes a new Treasure instance, optionally generating - treasure contents based on the provided type. - total_gp_value(): Property that calculates and returns the total value of the treasure in gold pieces. - from_treasure_type(treasure_type: TreasureType): Class method to create a new Treasure instance with contents - generated based on the specified TreasureType. - Example: >>> treasure = Treasure.from_treasure_type(TreasureType.A) >>> treasure.items