The Witness: Make location order in the spoiler log deterministic #3895
Conversation
This file contains 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
github-actions
bot
added
the
waiting-on: peer-review
NewSoupVi
added
the
is: refactor/cleanup
nicholassaylor
approved these changes
Dec 26, 2024
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
Exempt-Medic
approved these changes
Dec 29, 2024
AustinSumigray
pushed a commit
to AustinSumigray/Archipelago
that referenced
this pull request
Jan 4, 2025
…chipelagoMW#3895) * Fix location order * Update worlds/witness/data/static_logic.py Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --------- Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
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.
The Witness adds its locations to its regions in a non-deterministic order.
This is mostly fine, but it does mean the spoiler log is not fully deterministic (the only thing I'm aware of that cares about insertion order of locations)
This PR makes it so that the order of processing of entities is tracked when creating the entity list from WitnessLogic.txt, and then uses that to sort the locations before adding them to the regions.
This also looks quite nice:
The Panel Hunt event "Symmetry Island Right 3 (Panel Hunt)" now shows up "in its proper place" ahead of the actual real location check "Symmetry Island Right 5"