Skip to content

Commit

Permalink
Document more attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
ExcaliburZero committed Oct 23, 2023
1 parent 4669546 commit c68be03
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
6 changes: 3 additions & 3 deletions cbpickaxe/item.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ class Item:
An item that the player can obtain.
"""

name: str
description: str
name: str #: String ID of the name of the item.
description: str #: String ID of the description of the item.
category: str
icon: Optional[str]
icon: Optional[str] #: res:// path to the item's icon.

@staticmethod
def from_tres(input_stream: IO[str]) -> "Item":
Expand Down
4 changes: 3 additions & 1 deletion cbpickaxe/monster_form.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ class MonsterForm:
str
] #: List of tags that the monster can equip moves of. (Note that all monsters can also equip stickers with the "all" tag, which is not included in this list)
battle_sprite_path: str #: res:// path to the monster's battle sprite animation file.
tape_upgrades: List[Union[TapeUpgrade, str]]
tape_upgrades: List[
Union[TapeUpgrade, str]
] #: Events that occur when the monster form increases its grade.
bestiary_bios: List[
str
] #: List of string ids for the monster's bestiary entries. Typically a list of two string ids.
Expand Down
4 changes: 2 additions & 2 deletions cbpickaxe/move.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ class Move:
max_hits: int
can_be_copied: bool
priority: int
tags: List[str]
elemental_types: List[str]
tags: List[str] #: Tags that determine which monsters can use the move.
elemental_types: List[str] #: Type(s) of the move.

@staticmethod
def from_tres(input_stream: IO[str]) -> "Move":
Expand Down

0 comments on commit c68be03

Please sign in to comment.