Core: Don't return placed items twice in multiworld.get_items() after fill - #6336
Open
Mysteryem wants to merge 1 commit into
Open
Core: Don't return placed items twice in multiworld.get_items() after fill#6336Mysteryem wants to merge 1 commit into
Mysteryem wants to merge 1 commit into
Conversation
Similar to using `multiworld.get_all_state()` after core AP's main fill is complete (see ArchipelagoMW#6335), using `multiworld.get_items()` after core AP's main fill is complete is another common 'gotcha' that apworld developers fall for, not realising that it will end up returning a list containing most items twice. This changes `multiworld.get_items()` to only return items from `self.itempool` that are not placed, therefore avoiding the issue of returning an item twice if it is both placed and in `self.itempool`, which often occurs after core AP's main fill is complete. There are still potentially some issues from the fact that not necessarily all items from `self.itempool` will be placed somewhere, e.g. additional items could have been added into the multiworld through item plando. But, I don't know how `get_items()` is actually supposed to work due to it being undocumented. Additionally, changing `get_items()` to be aware of what it should return depending on which generation steps have been run would be a more involved change to parts of core AP.
Contributor
Author
|
An alternative to filtering the items from
|
Collaborator
|
Did not test as the only two usages outside tests seem trivial. Code LGTM. |
Jouramie
approved these changes
Jul 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is this fixing or adding?
Similar to using
multiworld.get_all_state()after core AP's main fill is complete (see #6335), usingmultiworld.get_items()after core AP's main fill is complete is another common 'gotcha' that apworld developers fall for, not realising that it will end up returning a list containing most items twice.This changes
multiworld.get_items()to only return items fromself.itempoolthat are not placed, therefore avoiding the issue of returning an item twice if it is both placed and inself.itempool, which often occurs after core AP's main fill is complete.There are still potentially some issues from the fact that not necessarily all items from
self.itempoolwill be placed somewhere, e.g. additional items could have been added into the multiworld through item plando. But, I don't know howget_items()is actually supposed to work due to it being undocumented. Additionally, changingget_items()to be aware of what it should return depending on which generation steps have been run would be a more involved change to parts of core AP.How was this tested?
Only by running the unit tests.