Bug: Worlds Applying Rules After set_rules

[Exempt-Medic]

What happened?

Rules are supposed to be finished by the end of set_rules

• https://discord.com/channels/731205301247803413/731214280439103580/1333774025415065601
• https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/world%20api.md#generation

The following worlds don't do this:

• Adventure
  

  Archipelago/worlds/adventure/__init__.py

  Line 247 in a53bcb4

  self.multiworld.completion_condition[self.player] = lambda state: state.has("Victory", self.player)

• KDL3
  

  Archipelago/worlds/kdl3/__init__.py

  Line 316 in a53bcb4

  self.multiworld.completion_condition[self.player] = lambda state: state.has("Love-Love Rod", self.player)

• Meritous
  

  Archipelago/worlds/meritous/__init__.py

  Lines 169 to 174 in a53bcb4

  	if self.goal == 0:
  	self.multiworld.completion_condition[self.player] = lambda state: state.has_any(
  	["Victory", "Full Victory"], self.player)
  	else:
  	self.multiworld.completion_condition[self.player] = lambda state: state.has(
  	"Full Victory", self.player)

• Meritous: move completion_condition to set_rules #4567

• MM2
  

  Archipelago/worlds/mm2/__init__.py

  Line 195 in a53bcb4

  self.multiworld.completion_condition[self.player] = lambda state: state.has("Victory", self.player)

• TLOZ
  

  Archipelago/worlds/tloz/__init__.py

  Lines 193 to 198 in a53bcb4

  	add_rule(ganon, lambda state: state.has("Silver Arrow", self.player) and state.has("Bow", self.player))
  	self.multiworld.get_location("Zelda", self.player).place_locked_item(self.create_event("Rescued Zelda!"))
  	add_rule(self.multiworld.get_location("Zelda", self.player),
  	lambda state: state.has("Triforce of Power", self.player))
  	self.multiworld.completion_condition[self.player] = lambda state: state.has("Rescued Zelda!", self.player)

• Zillion
  

  Archipelago/worlds/zillion/__init__.py

  Lines 283 to 284 in a53bcb4

  	self.multiworld.completion_condition[self.player] = \
  	lambda state: state.has("Win", self.player)

• Zork
  

  Archipelago/worlds/zork_grand_inquisitor/world.py

  Line 193 in a53bcb4

  self.multiworld.completion_condition[self.player] = lambda state: state.has("Victory", self.player)

@JusticePS @Silvris @FelicitusNeko @Rosalie-A @t3hf1gm3nt @beauxq @nbrochu

What were the expected results?

Rules to be done by set_rules

Software

Local generation

[t3hf1gm3nt]

I'll leave TLOZ's bit to Rosalie (since she's been working on a TLOZ overhaul). Should be simple enough to just move it out of generate basic and add it to the end of our set_rules in Rules.py, I think.

[Exempt-Medic]

I'll leave TLOZ's bit to Rosalie (since she's been working on a TLOZ overhaul). Should be simple enough to just move it out of generate basic and add it to the end of our set_rules in Rules.py, I think.

Yeah, pretty much all of these should be that same simple change

[Mysteryem]

I think HK 'all' grub hunt should be included as a note here.
Technically, HK does not change its completion condition function after set_rules, but it does change what its completion condition function checks so it can require extra grubs added by item plando or item link replacements and linked replacements.

It is impossible to know in advance exactly how many extra grubs will be added to the multiworld by set_rules. Item link replacement items specifically have a random cut-off for when the number of items to replace is not divisible by the number of players, e.g. 3 items to link together becomes 1 linked item and 2 replacements, so one player would not get a replacement item, and the player that loses out is chosen randomly.

[Exempt-Medic]

I think HK 'all' grub hunt should be included as a note here.

Yeah I'm aware of it and don't really know what to do about it. It passes this test, but it's unclear to me whether what it's doing is supposed to be allowed.

[beauxq]

In case someone wonders why so many worlds do this, it's what the official documentation said to do for a long time.

This was the example code in the documentation:

def generate_basic(self) -> None:
    # place "Victory" at "Final Boss" and set collection as win condition
    self.multiworld.get_location("Final Boss", self.player)
        .place_locked_item(self.create_event("Victory"))
    self.multiworld.completion_condition[self.player] =
        lambda state: state.has("Victory", self.player)