diff --git a/gachapy/controller.py b/gachapy/controller.py index aeabf4e..375f75e 100644 --- a/gachapy/controller.py +++ b/gachapy/controller.py @@ -61,41 +61,6 @@ class Controller: the list of banners that are available for the gacha players : List[Player] the list of players enrolled in the gacha - - Methods - ------- - find_item_by_name(item_name) : Optional[Item] - Returns the Item object with the given name or None if not found - find_banner_by_name(banner_name) : Optional[Banner] - Returns the Banner object with the given name or None if not found - find_player_by_name(player_name) : Optional[Banner] - Returns the Player object with the given name or None if not found - find_item_by_id(item_id) : Optional[Item] - Returns the Item object with the given id or None if not found - find_player_by_id(player_id) : Optional[Player] - Returns the Player object with the given id or None if not found - pull(player_id,banner_name) : Optional[Item] - Pulls and returns an item from the specified banner for the specified player - add_new_item(name,id,rarity) : Optional[Item] - Adds a new item to the gacha game - add_new_banner(name,item_list_str,price) : Optional[Banner] - Adds a new banner to the gacha game - add_new_player(name,id,start_money,items_str) : Optional[Player] - Adds a new player to the gacha game - remove_item(id) : Optional[Item] - Removes the specified item from the gacha game - remove_banner(name) : Optional[Banner] - Removes the specified banner from the gacha game - remove_player(id) : Optional[Player] - Removes the specified player from the gacha game - create_random_banner(name,num_items,price) -> Optional[Banner] - Creates a random banner with the given name and number of items - remove_all_banners() : None - Removes all of the banners in the game - top_items(num_items) : List[Item] - Returns the top specified number of items in the game in terms of rarity - top_players(num_players) : List[Player] - Returns the top specified number of players in the game in terms of net worth """ def __init__( diff --git a/gachapy/objects.py b/gachapy/objects.py index f5c7c4d..289fe16 100644 --- a/gachapy/objects.py +++ b/gachapy/objects.py @@ -25,11 +25,6 @@ class Item: id : int rarity of the item where the higher the numer, the higher the rarity Invariant: must be >= 1 - - Methods - ------- - change_rarity(rarity) : bool - changes the rarity of the Item """ def __init__(self, name: str, id: str, rarity: int) -> None: @@ -103,15 +98,6 @@ class Banner: weights : List[float] list of drop weights for items Invariant: weights[i] corresponds to item_list[i] - - Methods - ------- - add_item(item) : None - Adds an item to the banner - remove_item(item) : bool - Removes an item from the banner - pull() : Item - Returns a random item out of a banner randomized by weight """ def __init__( @@ -234,18 +220,6 @@ class Player: the list of items that the player owns money : float the amount of money that the player owns - - Methods - ------- - add_item(item) : None - Adds an item to the player's inventory - remove_item(item) : bool - Removes an item from the player's inventory - change_money(amount) : bool - Adds or removes money from player - get_net_worth() : int - Returns the net worth of the player, calculated by the sum of the - rarities of all of the items they own """ def __init__(self, name: str, id: str, items: List[Item], money: float) -> None: