Merge pull request ArchipelagoMW#2 from YourAverageLink/more-invalid-states

Defer receiving items on the title screen or while sleeping

Author: Battlecats59

worlds/ss/Constants.py

@@ -19,6 +19,9 @@
 # This is the address that holds the player's file name.
 FILE_NAME_ADDR = 0x80955D38  # ARRAY[16]
 
+# A bit at this address is set if on the title screen
+GLOBAL_TITLE_LOADER_ADDR = 0x80575780
+
 AP_VISITED_STAGE_NAMES_KEY_FORMAT = "ss_visited_stages_%i"
 
 LINK_INVALID_STATES = [
@@ -27,6 +30,8 @@
     b'\x5A\x32\x8C', # Door
     b'\x5A\x12\xA8', # Diving
     b'\xB4\xF4\x50', # Bird picking up link
+    b'\x5A\x31\xAC', # Sleeping
+    b'\x5A\x33\x6C', # Waking up
 ]
 
 # Valid addresses for storyflags (ending in zero - final bit is added to this address)

worlds/ss/SSClient.py

@@ -307,7 +307,7 @@ async def _give_item(ctx: SSContext, item_name: str) -> bool:
     :param item_name: Name of the item to give.
     :return: Whether the item was successfully given.
     """
-    if not (check_link_state_for_giveitem() and check_alive()):
+    if not (check_link_state_for_giveitem() and check_alive() and not check_on_title_screen()):
         return False
 
     item_id = ITEM_TABLE[item_name].item_id  # In game item ID
@@ -331,7 +331,7 @@ async def give_items(ctx: SSContext) -> None:
 
     :param ctx: The SS client context.
     """
-    if check_link_state_for_giveitem() and check_alive():
+    if check_link_state_for_giveitem() and check_alive() and not check_on_title_screen():
         # Read the expected index of the player, which is the index of the latest item they've received.
         expected_idx = dme_read_short(EXPECTED_INDEX_ADDR)
 
@@ -460,15 +460,23 @@ def check_ingame() -> bool:
 
     :return: `True` if the player is in-game, otherwise `False`.
     """
-    return dolphin_memory_engine.read_bytes(CURR_STATE_ADDR, 3) != 0x0
+    return int.from_bytes(dolphin_memory_engine.read_bytes(CURR_STATE_ADDR, 3)) != 0x0
+
+def check_on_title_screen() -> bool:
+    """
+    Check if the player is on the Title Screen.
+    
+    :return: `True` if the player is on the title screen, otherwise `False`.
+    """
+    return int.from_bytes(dolphin_memory_engine.read_bytes(GLOBAL_TITLE_LOADER_ADDR, 1)) != 0x0
 
 def check_link_state_for_giveitem() -> bool:
     """
     Returns a bool determining whether Link is in a valid or invalid state to receive items.
 
     :return: True if Link is in a valid state, False if Link is in an invalid state
     """
-    linkstate = dolphin_memory_engine.read_bytes(CURR_STATE_ADDR, 4) != 0x0
+    linkstate = dolphin_memory_engine.read_bytes(CURR_STATE_ADDR, 3)
     if linkstate in LINK_INVALID_STATES:
         return False
     else: