mirror of
https://github.com/ArchipelagoMW/Archipelago.git
synced 2026-04-30 22:53:28 -07:00
Docs: Rewrite get_filler_item_name's docstring to avoid implying it's for filling all unfilled locations #5956
This commit is contained in:
@@ -512,7 +512,9 @@ class World(metaclass=AutoWorldRegister):
|
||||
|
||||
def get_filler_item_name(self) -> str:
|
||||
"""
|
||||
Called when the item pool needs to be filled with additional items to match location count.
|
||||
If core AP removes an item from your item pool, this method is called to choose a replacement item
|
||||
so item count and location count remain equal.
|
||||
For example: plando, item_links and start_inventory_from_pool are features that may cause this.
|
||||
|
||||
Any returned item name must be for a "repeatable" item, i.e. one that it's okay to generate arbitrarily many of.
|
||||
For most worlds this will be one or more of your filler items, but the classification of these items
|
||||
|
||||
Reference in New Issue
Block a user