pmdsky-debug-py 5.1.12__py3-none-any.whl → 5.1.13__py3-none-any.whl

pmdsky_debug_py/_release.py

@@ -1 +1 @@
-RELEASE = "v0.5.1+ccc99b9550"
+RELEASE = "v0.5.1+20669e221f"

pmdsky_debug_py/eu.py

@@ -1037,9 +1037,9 @@ class EuArm9Functions:
         None,
         (
             "Call LoadFileInPack after looking up the global Pack archive by its"
-            " identifier\n\nr0: pack file identifier\nr1: [output] target buffer\nr2:"
-            " file index\nreturn: number of read bytes (identical to the length of the"
-            " pack from the Table of Content)"
+            " identifier\n\nr0: pack file identifier\nr1: file index\nr2: [output]"
+            " target buffer\nreturn: number of read bytes (identical to the length of"
+            " the pack from the Table of Content)"
         ),
     )
 
@@ -2679,17 +2679,30 @@ class EuArm9Functions:
         [0x201D278],
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: wan_table_ptr\nr1:"
+            "Always delete an entry if the file is allocated externally"
+            " (file_externally_allocated is set), otherwise, decrease the reference"
+            " counter. If it reach 0, delete the sprite.\n\nr0: wan_table_ptr\nr1:"
             " wan_id"
         ),
     )
 
+    AllocateWanTableEntry = Symbol(
+        [0x1D2E0],
+        [0x201D2E0],
+        None,
+        (
+            "Return the identifier to a free wan table entry (-1 if none are"
+            " avalaible). The entry is zeroed.\n\nr0: wan_table_ptr\nreturn: the entry"
+            " id in wan_table"
+        ),
+    )
+
     FindWanTableEntry = Symbol(
         [0x1D370],
         [0x201D370],
         None,
         (
-            "Appears to search in the given table (in practice always seems to be"
+            "Search in the given table (in practice always seems to be"
             " LOADED_WAN_TABLE_PTR) for an entry with the given file name.\n\nr0: table"
             " pointer\nr1: file name\nreturn: index of the found file, if found, or -1"
             " if not found"
@@ -2701,8 +2714,19 @@ class EuArm9Functions:
         [0x201D3D0],
         None,
         (
-            "wan_id = -1 if it is not loaded\n\nNote: unverified, ported from Irdkwia's"
-            " notes\n\nr0: wan_table_ptr\nr1: bin_file_id\nr2: file_id\nreturn: wan_id"
+            "Look up a sprite with the provided pack_id and file_index in the wan"
+            " table.\n\nr0: wan_table_ptr\nr1: pack_id\nr2: file_index\nreturn: sprite"
+            " id in the wan table, -1 if not found"
+        ),
+    )
+
+    InitWanTable = Symbol(
+        [0x1D458],
+        [0x201D458],
+        None,
+        (
+            "Initialize the input WAN table with 0x60 free entries (it needs a length"
+            " of 0x1510 bytes)\n\nr0: wan_table_ptr"
         ),
     )
 
@@ -2718,6 +2742,32 @@ class EuArm9Functions:
         ),
     )
 
+    LoadWanTableEntryFromPack = Symbol(
+        [0x1D520],
+        [0x201D520],
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3: allocation"
+            " flags\nstack[0]: compressed\nreturn: the entry id in wan_table"
+        ),
+    )
+
+    LoadWanTableEntryFromPackUseProvidedMemory = Symbol(
+        [0x1D62C],
+        [0x201D62C],
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite into the"
+            " provided memory area. Mark the sprite as externally allocated.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3:"
+            " sprite_storage_ptr\nstack[0]: compressed\nreturn: the entry id in"
+            " wan_table"
+        ),
+    )
+
     ReplaceWanFromBinFile = Symbol(
         [0x1D720],
         [0x201D720],
@@ -13614,8 +13664,10 @@ class EuOverlay11Functions:
         [0x22EC480],
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: [output]"
-            " bg_attr_str\nr1: bg_id"
+            "Open and read an entry from the MAP_BG/bg_list.dat\n\nDocumentation on"
+            " this format can be found"
+            " here:\nhttps://github.com/SkyTemple/skytemple-files/tree/55b3017631a8a1b0f106111ef91a901dc394c6df/skytemple_files/graphics/bg_list_dat\n\nr0:"
+            " [output] The entry\nr1: background ID"
         ),
     )
 
@@ -13892,6 +13944,13 @@ class EuOverlay11Data:
 
     GROUND_STATE_MAP = Symbol([0x48C80], [0x2325800], None, "[Runtime]")
 
+    GROUND_STATE_WEATHER = Symbol(
+        [0x48C8C],
+        [0x232580C],
+        None,
+        "[Runtime] Same structure format as GROUND_STATE_MAP",
+    )
+
     GROUND_STATE_PTRS = Symbol(
         [0x48CB4],
         [0x2325834],

pmdsky_debug_py/eu_itcm.py

@@ -1024,9 +1024,9 @@ class EuItcmArm9Functions:
         None,
         (
             "Call LoadFileInPack after looking up the global Pack archive by its"
-            " identifier\n\nr0: pack file identifier\nr1: [output] target buffer\nr2:"
-            " file index\nreturn: number of read bytes (identical to the length of the"
-            " pack from the Table of Content)"
+            " identifier\n\nr0: pack file identifier\nr1: file index\nr2: [output]"
+            " target buffer\nreturn: number of read bytes (identical to the length of"
+            " the pack from the Table of Content)"
         ),
     )
 
@@ -2592,17 +2592,30 @@ class EuItcmArm9Functions:
         None,
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: wan_table_ptr\nr1:"
+            "Always delete an entry if the file is allocated externally"
+            " (file_externally_allocated is set), otherwise, decrease the reference"
+            " counter. If it reach 0, delete the sprite.\n\nr0: wan_table_ptr\nr1:"
             " wan_id"
         ),
     )
 
+    AllocateWanTableEntry = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return the identifier to a free wan table entry (-1 if none are"
+            " avalaible). The entry is zeroed.\n\nr0: wan_table_ptr\nreturn: the entry"
+            " id in wan_table"
+        ),
+    )
+
     FindWanTableEntry = Symbol(
         None,
         None,
         None,
         (
-            "Appears to search in the given table (in practice always seems to be"
+            "Search in the given table (in practice always seems to be"
             " LOADED_WAN_TABLE_PTR) for an entry with the given file name.\n\nr0: table"
             " pointer\nr1: file name\nreturn: index of the found file, if found, or -1"
             " if not found"
@@ -2614,8 +2627,19 @@ class EuItcmArm9Functions:
         None,
         None,
         (
-            "wan_id = -1 if it is not loaded\n\nNote: unverified, ported from Irdkwia's"
-            " notes\n\nr0: wan_table_ptr\nr1: bin_file_id\nr2: file_id\nreturn: wan_id"
+            "Look up a sprite with the provided pack_id and file_index in the wan"
+            " table.\n\nr0: wan_table_ptr\nr1: pack_id\nr2: file_index\nreturn: sprite"
+            " id in the wan table, -1 if not found"
+        ),
+    )
+
+    InitWanTable = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Initialize the input WAN table with 0x60 free entries (it needs a length"
+            " of 0x1510 bytes)\n\nr0: wan_table_ptr"
         ),
     )
 
@@ -2631,6 +2655,32 @@ class EuItcmArm9Functions:
         ),
     )
 
+    LoadWanTableEntryFromPack = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3: allocation"
+            " flags\nstack[0]: compressed\nreturn: the entry id in wan_table"
+        ),
+    )
+
+    LoadWanTableEntryFromPackUseProvidedMemory = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite into the"
+            " provided memory area. Mark the sprite as externally allocated.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3:"
+            " sprite_storage_ptr\nstack[0]: compressed\nreturn: the entry id in"
+            " wan_table"
+        ),
+    )
+
     ReplaceWanFromBinFile = Symbol(
         None,
         None,
@@ -13315,8 +13365,10 @@ class EuItcmOverlay11Functions:
         None,
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: [output]"
-            " bg_attr_str\nr1: bg_id"
+            "Open and read an entry from the MAP_BG/bg_list.dat\n\nDocumentation on"
+            " this format can be found"
+            " here:\nhttps://github.com/SkyTemple/skytemple-files/tree/55b3017631a8a1b0f106111ef91a901dc394c6df/skytemple_files/graphics/bg_list_dat\n\nr0:"
+            " [output] The entry\nr1: background ID"
         ),
     )
 
@@ -13593,6 +13645,10 @@ class EuItcmOverlay11Data:
 
     GROUND_STATE_MAP = Symbol(None, None, None, "[Runtime]")
 
+    GROUND_STATE_WEATHER = Symbol(
+        None, None, None, "[Runtime] Same structure format as GROUND_STATE_MAP"
+    )
+
     GROUND_STATE_PTRS = Symbol(
         None,
         None,

pmdsky_debug_py/jp.py

@@ -1037,9 +1037,9 @@ class JpArm9Functions:
         None,
         (
             "Call LoadFileInPack after looking up the global Pack archive by its"
-            " identifier\n\nr0: pack file identifier\nr1: [output] target buffer\nr2:"
-            " file index\nreturn: number of read bytes (identical to the length of the"
-            " pack from the Table of Content)"
+            " identifier\n\nr0: pack file identifier\nr1: file index\nr2: [output]"
+            " target buffer\nreturn: number of read bytes (identical to the length of"
+            " the pack from the Table of Content)"
         ),
     )
 
@@ -2677,17 +2677,30 @@ class JpArm9Functions:
         [0x201D234],
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: wan_table_ptr\nr1:"
+            "Always delete an entry if the file is allocated externally"
+            " (file_externally_allocated is set), otherwise, decrease the reference"
+            " counter. If it reach 0, delete the sprite.\n\nr0: wan_table_ptr\nr1:"
             " wan_id"
         ),
     )
 
+    AllocateWanTableEntry = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return the identifier to a free wan table entry (-1 if none are"
+            " avalaible). The entry is zeroed.\n\nr0: wan_table_ptr\nreturn: the entry"
+            " id in wan_table"
+        ),
+    )
+
     FindWanTableEntry = Symbol(
         [0x1D32C],
         [0x201D32C],
         None,
         (
-            "Appears to search in the given table (in practice always seems to be"
+            "Search in the given table (in practice always seems to be"
             " LOADED_WAN_TABLE_PTR) for an entry with the given file name.\n\nr0: table"
             " pointer\nr1: file name\nreturn: index of the found file, if found, or -1"
             " if not found"
@@ -2699,8 +2712,19 @@ class JpArm9Functions:
         [0x201D38C],
         None,
         (
-            "wan_id = -1 if it is not loaded\n\nNote: unverified, ported from Irdkwia's"
-            " notes\n\nr0: wan_table_ptr\nr1: bin_file_id\nr2: file_id\nreturn: wan_id"
+            "Look up a sprite with the provided pack_id and file_index in the wan"
+            " table.\n\nr0: wan_table_ptr\nr1: pack_id\nr2: file_index\nreturn: sprite"
+            " id in the wan table, -1 if not found"
+        ),
+    )
+
+    InitWanTable = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Initialize the input WAN table with 0x60 free entries (it needs a length"
+            " of 0x1510 bytes)\n\nr0: wan_table_ptr"
         ),
     )
 
@@ -2716,6 +2740,32 @@ class JpArm9Functions:
         ),
     )
 
+    LoadWanTableEntryFromPack = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3: allocation"
+            " flags\nstack[0]: compressed\nreturn: the entry id in wan_table"
+        ),
+    )
+
+    LoadWanTableEntryFromPackUseProvidedMemory = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite into the"
+            " provided memory area. Mark the sprite as externally allocated.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3:"
+            " sprite_storage_ptr\nstack[0]: compressed\nreturn: the entry id in"
+            " wan_table"
+        ),
+    )
+
     ReplaceWanFromBinFile = Symbol(
         [0x1D6DC],
         [0x201D6DC],
@@ -13550,8 +13600,10 @@ class JpOverlay11Functions:
         [0x22ED174],
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: [output]"
-            " bg_attr_str\nr1: bg_id"
+            "Open and read an entry from the MAP_BG/bg_list.dat\n\nDocumentation on"
+            " this format can be found"
+            " here:\nhttps://github.com/SkyTemple/skytemple-files/tree/55b3017631a8a1b0f106111ef91a901dc394c6df/skytemple_files/graphics/bg_list_dat\n\nr0:"
+            " [output] The entry\nr1: background ID"
         ),
     )
 
@@ -13828,6 +13880,10 @@ class JpOverlay11Data:
 
     GROUND_STATE_MAP = Symbol(None, None, None, "[Runtime]")
 
+    GROUND_STATE_WEATHER = Symbol(
+        None, None, None, "[Runtime] Same structure format as GROUND_STATE_MAP"
+    )
+
     GROUND_STATE_PTRS = Symbol(
         None,
         None,

pmdsky_debug_py/jp_itcm.py

@@ -1024,9 +1024,9 @@ class JpItcmArm9Functions:
         None,
         (
             "Call LoadFileInPack after looking up the global Pack archive by its"
-            " identifier\n\nr0: pack file identifier\nr1: [output] target buffer\nr2:"
-            " file index\nreturn: number of read bytes (identical to the length of the"
-            " pack from the Table of Content)"
+            " identifier\n\nr0: pack file identifier\nr1: file index\nr2: [output]"
+            " target buffer\nreturn: number of read bytes (identical to the length of"
+            " the pack from the Table of Content)"
         ),
     )
 
@@ -2592,17 +2592,30 @@ class JpItcmArm9Functions:
         None,
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: wan_table_ptr\nr1:"
+            "Always delete an entry if the file is allocated externally"
+            " (file_externally_allocated is set), otherwise, decrease the reference"
+            " counter. If it reach 0, delete the sprite.\n\nr0: wan_table_ptr\nr1:"
             " wan_id"
         ),
     )
 
+    AllocateWanTableEntry = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return the identifier to a free wan table entry (-1 if none are"
+            " avalaible). The entry is zeroed.\n\nr0: wan_table_ptr\nreturn: the entry"
+            " id in wan_table"
+        ),
+    )
+
     FindWanTableEntry = Symbol(
         None,
         None,
         None,
         (
-            "Appears to search in the given table (in practice always seems to be"
+            "Search in the given table (in practice always seems to be"
             " LOADED_WAN_TABLE_PTR) for an entry with the given file name.\n\nr0: table"
             " pointer\nr1: file name\nreturn: index of the found file, if found, or -1"
             " if not found"
@@ -2614,8 +2627,19 @@ class JpItcmArm9Functions:
         None,
         None,
         (
-            "wan_id = -1 if it is not loaded\n\nNote: unverified, ported from Irdkwia's"
-            " notes\n\nr0: wan_table_ptr\nr1: bin_file_id\nr2: file_id\nreturn: wan_id"
+            "Look up a sprite with the provided pack_id and file_index in the wan"
+            " table.\n\nr0: wan_table_ptr\nr1: pack_id\nr2: file_index\nreturn: sprite"
+            " id in the wan table, -1 if not found"
+        ),
+    )
+
+    InitWanTable = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Initialize the input WAN table with 0x60 free entries (it needs a length"
+            " of 0x1510 bytes)\n\nr0: wan_table_ptr"
         ),
     )
 
@@ -2631,6 +2655,32 @@ class JpItcmArm9Functions:
         ),
     )
 
+    LoadWanTableEntryFromPack = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3: allocation"
+            " flags\nstack[0]: compressed\nreturn: the entry id in wan_table"
+        ),
+    )
+
+    LoadWanTableEntryFromPackUseProvidedMemory = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite into the"
+            " provided memory area. Mark the sprite as externally allocated.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3:"
+            " sprite_storage_ptr\nstack[0]: compressed\nreturn: the entry id in"
+            " wan_table"
+        ),
+    )
+
     ReplaceWanFromBinFile = Symbol(
         None,
         None,
@@ -13315,8 +13365,10 @@ class JpItcmOverlay11Functions:
         None,
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: [output]"
-            " bg_attr_str\nr1: bg_id"
+            "Open and read an entry from the MAP_BG/bg_list.dat\n\nDocumentation on"
+            " this format can be found"
+            " here:\nhttps://github.com/SkyTemple/skytemple-files/tree/55b3017631a8a1b0f106111ef91a901dc394c6df/skytemple_files/graphics/bg_list_dat\n\nr0:"
+            " [output] The entry\nr1: background ID"
         ),
     )
 
@@ -13593,6 +13645,10 @@ class JpItcmOverlay11Data:
 
     GROUND_STATE_MAP = Symbol(None, None, None, "[Runtime]")
 
+    GROUND_STATE_WEATHER = Symbol(
+        None, None, None, "[Runtime] Same structure format as GROUND_STATE_MAP"
+    )
+
     GROUND_STATE_PTRS = Symbol(
         None,
         None,

pmdsky_debug_py/na.py

@@ -1037,9 +1037,9 @@ class NaArm9Functions:
         None,
         (
             "Call LoadFileInPack after looking up the global Pack archive by its"
-            " identifier\n\nr0: pack file identifier\nr1: [output] target buffer\nr2:"
-            " file index\nreturn: number of read bytes (identical to the length of the"
-            " pack from the Table of Content)"
+            " identifier\n\nr0: pack file identifier\nr1: file index\nr2: [output]"
+            " target buffer\nreturn: number of read bytes (identical to the length of"
+            " the pack from the Table of Content)"
         ),
     )
 
@@ -2679,17 +2679,30 @@ class NaArm9Functions:
         [0x201D1DC],
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: wan_table_ptr\nr1:"
+            "Always delete an entry if the file is allocated externally"
+            " (file_externally_allocated is set), otherwise, decrease the reference"
+            " counter. If it reach 0, delete the sprite.\n\nr0: wan_table_ptr\nr1:"
             " wan_id"
         ),
     )
 
+    AllocateWanTableEntry = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return the identifier to a free wan table entry (-1 if none are"
+            " avalaible). The entry is zeroed.\n\nr0: wan_table_ptr\nreturn: the entry"
+            " id in wan_table"
+        ),
+    )
+
     FindWanTableEntry = Symbol(
         [0x1D2D4],
         [0x201D2D4],
         None,
         (
-            "Appears to search in the given table (in practice always seems to be"
+            "Search in the given table (in practice always seems to be"
             " LOADED_WAN_TABLE_PTR) for an entry with the given file name.\n\nr0: table"
             " pointer\nr1: file name\nreturn: index of the found file, if found, or -1"
             " if not found"
@@ -2701,8 +2714,19 @@ class NaArm9Functions:
         [0x201D334],
         None,
         (
-            "wan_id = -1 if it is not loaded\n\nNote: unverified, ported from Irdkwia's"
-            " notes\n\nr0: wan_table_ptr\nr1: bin_file_id\nr2: file_id\nreturn: wan_id"
+            "Look up a sprite with the provided pack_id and file_index in the wan"
+            " table.\n\nr0: wan_table_ptr\nr1: pack_id\nr2: file_index\nreturn: sprite"
+            " id in the wan table, -1 if not found"
+        ),
+    )
+
+    InitWanTable = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Initialize the input WAN table with 0x60 free entries (it needs a length"
+            " of 0x1510 bytes)\n\nr0: wan_table_ptr"
         ),
     )
 
@@ -2718,6 +2742,32 @@ class NaArm9Functions:
         ),
     )
 
+    LoadWanTableEntryFromPack = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3: allocation"
+            " flags\nstack[0]: compressed\nreturn: the entry id in wan_table"
+        ),
+    )
+
+    LoadWanTableEntryFromPackUseProvidedMemory = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite into the"
+            " provided memory area. Mark the sprite as externally allocated.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3:"
+            " sprite_storage_ptr\nstack[0]: compressed\nreturn: the entry id in"
+            " wan_table"
+        ),
+    )
+
     ReplaceWanFromBinFile = Symbol(
         [0x1D684],
         [0x201D684],
@@ -13669,8 +13719,10 @@ class NaOverlay11Functions:
         [0x22EBB40],
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: [output]"
-            " bg_attr_str\nr1: bg_id"
+            "Open and read an entry from the MAP_BG/bg_list.dat\n\nDocumentation on"
+            " this format can be found"
+            " here:\nhttps://github.com/SkyTemple/skytemple-files/tree/55b3017631a8a1b0f106111ef91a901dc394c6df/skytemple_files/graphics/bg_list_dat\n\nr0:"
+            " [output] The entry\nr1: background ID"
         ),
     )
 
@@ -13947,6 +13999,10 @@ class NaOverlay11Data:
 
     GROUND_STATE_MAP = Symbol([0x48A80], [0x2324CC0], None, "[Runtime]")
 
+    GROUND_STATE_WEATHER = Symbol(
+        None, None, None, "[Runtime] Same structure format as GROUND_STATE_MAP"
+    )
+
     GROUND_STATE_PTRS = Symbol(
         [0x48AB4],
         [0x2324CF4],

pmdsky_debug_py/na_itcm.py

@@ -1024,9 +1024,9 @@ class NaItcmArm9Functions:
         None,
         (
             "Call LoadFileInPack after looking up the global Pack archive by its"
-            " identifier\n\nr0: pack file identifier\nr1: [output] target buffer\nr2:"
-            " file index\nreturn: number of read bytes (identical to the length of the"
-            " pack from the Table of Content)"
+            " identifier\n\nr0: pack file identifier\nr1: file index\nr2: [output]"
+            " target buffer\nreturn: number of read bytes (identical to the length of"
+            " the pack from the Table of Content)"
         ),
     )
 
@@ -2592,17 +2592,30 @@ class NaItcmArm9Functions:
         None,
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: wan_table_ptr\nr1:"
+            "Always delete an entry if the file is allocated externally"
+            " (file_externally_allocated is set), otherwise, decrease the reference"
+            " counter. If it reach 0, delete the sprite.\n\nr0: wan_table_ptr\nr1:"
             " wan_id"
         ),
     )
 
+    AllocateWanTableEntry = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return the identifier to a free wan table entry (-1 if none are"
+            " avalaible). The entry is zeroed.\n\nr0: wan_table_ptr\nreturn: the entry"
+            " id in wan_table"
+        ),
+    )
+
     FindWanTableEntry = Symbol(
         None,
         None,
         None,
         (
-            "Appears to search in the given table (in practice always seems to be"
+            "Search in the given table (in practice always seems to be"
             " LOADED_WAN_TABLE_PTR) for an entry with the given file name.\n\nr0: table"
             " pointer\nr1: file name\nreturn: index of the found file, if found, or -1"
             " if not found"
@@ -2614,8 +2627,19 @@ class NaItcmArm9Functions:
         None,
         None,
         (
-            "wan_id = -1 if it is not loaded\n\nNote: unverified, ported from Irdkwia's"
-            " notes\n\nr0: wan_table_ptr\nr1: bin_file_id\nr2: file_id\nreturn: wan_id"
+            "Look up a sprite with the provided pack_id and file_index in the wan"
+            " table.\n\nr0: wan_table_ptr\nr1: pack_id\nr2: file_index\nreturn: sprite"
+            " id in the wan table, -1 if not found"
+        ),
+    )
+
+    InitWanTable = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Initialize the input WAN table with 0x60 free entries (it needs a length"
+            " of 0x1510 bytes)\n\nr0: wan_table_ptr"
         ),
     )
 
@@ -2631,6 +2655,32 @@ class NaItcmArm9Functions:
         ),
     )
 
+    LoadWanTableEntryFromPack = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3: allocation"
+            " flags\nstack[0]: compressed\nreturn: the entry id in wan_table"
+        ),
+    )
+
+    LoadWanTableEntryFromPackUseProvidedMemory = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Return an already allocated entry for this sprite if it exists, otherwise"
+            " allocate a new one and load the optionally compressed sprite into the"
+            " provided memory area. Mark the sprite as externally allocated.\n\nr0:"
+            " wan_table_ptr\nr1: pack_id\nr2: file_index\nr3:"
+            " sprite_storage_ptr\nstack[0]: compressed\nreturn: the entry id in"
+            " wan_table"
+        ),
+    )
+
     ReplaceWanFromBinFile = Symbol(
         None,
         None,
@@ -13315,8 +13365,10 @@ class NaItcmOverlay11Functions:
         None,
         None,
         (
-            "Note: unverified, ported from Irdkwia's notes\n\nr0: [output]"
-            " bg_attr_str\nr1: bg_id"
+            "Open and read an entry from the MAP_BG/bg_list.dat\n\nDocumentation on"
+            " this format can be found"
+            " here:\nhttps://github.com/SkyTemple/skytemple-files/tree/55b3017631a8a1b0f106111ef91a901dc394c6df/skytemple_files/graphics/bg_list_dat\n\nr0:"
+            " [output] The entry\nr1: background ID"
         ),
     )
 
@@ -13593,6 +13645,10 @@ class NaItcmOverlay11Data:
 
     GROUND_STATE_MAP = Symbol(None, None, None, "[Runtime]")
 
+    GROUND_STATE_WEATHER = Symbol(
+        None, None, None, "[Runtime] Same structure format as GROUND_STATE_MAP"
+    )
+
     GROUND_STATE_PTRS = Symbol(
         None,
         None,

pmdsky_debug_py/protocol.py

@@ -1491,6 +1491,11 @@ class Arm9FunctionsProtocol(Protocol):
         None,
     ]
 
+    AllocateWanTableEntry: Symbol[
+        Optional[List[int]],
+        None,
+    ]
+
     FindWanTableEntry: Symbol[
         Optional[List[int]],
         None,
@@ -1501,11 +1506,26 @@ class Arm9FunctionsProtocol(Protocol):
         None,
     ]
 
+    InitWanTable: Symbol[
+        Optional[List[int]],
+        None,
+    ]
+
     LoadWanTableEntry: Symbol[
         Optional[List[int]],
         None,
     ]
 
+    LoadWanTableEntryFromPack: Symbol[
+        Optional[List[int]],
+        None,
+    ]
+
+    LoadWanTableEntryFromPackUseProvidedMemory: Symbol[
+        Optional[List[int]],
+        None,
+    ]
+
     ReplaceWanFromBinFile: Symbol[
         Optional[List[int]],
         None,
@@ -7551,6 +7571,11 @@ class Overlay11DataProtocol(Protocol):
         None,
     ]
 
+    GROUND_STATE_WEATHER: Symbol[
+        Optional[List[int]],
+        None,
+    ]
+
     GROUND_STATE_PTRS: Symbol[
         Optional[List[int]],
         Optional[int],

{pmdsky_debug_py-5.1.12.dist-info → pmdsky_debug_py-5.1.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pmdsky-debug-py
-Version: 5.1.12
+Version: 5.1.13
 Summary: pmdsky-debug symbols for Python.
 Author-email: Marco 'Capypara' Köpcke <hello@capypara.de>
 License: MIT

pmdsky_debug_py-5.1.13.dist-info/RECORD

@@ -0,0 +1,14 @@
+pmdsky_debug_py/__init__.py,sha256=xvXjdxEqeoQaaS6ssZYVI9jARzv5M4q6FNwA3Z6fOw4,1831
+pmdsky_debug_py/_release.py,sha256=m_4wHUAh7fIkJhLghvXDMx60svb5_T9jGHMSLmdHu0k,30
+pmdsky_debug_py/eu.py,sha256=eEnB9Mvk_HjKGbQIShZIbFaC3GSDKbzaCT7N_sQDzBA,735398
+pmdsky_debug_py/eu_itcm.py,sha256=qtuFAnJOqdbuLCwbYaJGSma-xxhYCfKG_46mpRNHPXE,702961
+pmdsky_debug_py/jp.py,sha256=R2KFcWNF91hKc1wHowrN5BxKUcRCsuaXEvPDnV2SAJk,724050
+pmdsky_debug_py/jp_itcm.py,sha256=hXYmxKwrSLCFdH1ee9KhsQEl7Rqa_W-vTHhOJFalJB0,702961
+pmdsky_debug_py/na.py,sha256=ZiJqfrWKBeIPnCtUi1Ryo4KLkPRPWKF75B_XV7cBvGM,741954
+pmdsky_debug_py/na_itcm.py,sha256=w_Bc6QfViXM-636X03p9SO2XHromghFFtO7KsSkfdo0,702972
+pmdsky_debug_py/protocol.py,sha256=nnuBhWc32dYuiPcIrxybr7iox1rYcHTn6I4TPfQh2zs,233116
+pmdsky_debug_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pmdsky_debug_py-5.1.13.dist-info/METADATA,sha256=8PD_e4cKWuRuS2tFg98xVbVKN2UomJq7IO-bHoQh3YM,1321
+pmdsky_debug_py-5.1.13.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+pmdsky_debug_py-5.1.13.dist-info/top_level.txt,sha256=cqvpcJbud2s8IyBAc1MfCySwniko_6qO5LWSSxNIoXI,16
+pmdsky_debug_py-5.1.13.dist-info/RECORD,,

pmdsky_debug_py-5.1.12.dist-info/RECORD

@@ -1,14 +0,0 @@
-pmdsky_debug_py/__init__.py,sha256=xvXjdxEqeoQaaS6ssZYVI9jARzv5M4q6FNwA3Z6fOw4,1831
-pmdsky_debug_py/_release.py,sha256=eGcYhhnGzdVhPNBmICHxTaT0mTwCIUjiVYyS4N3Cbv0,30
-pmdsky_debug_py/eu.py,sha256=jrYZYgj5YLilSUWLSYZrDN70rex9OqcOwOYYUQvKx2M,733251
-pmdsky_debug_py/eu_itcm.py,sha256=vwlYQ7GROyrgqc3-mPhCHMiAq0orA35vPFGq4RRlRWQ,700899
-pmdsky_debug_py/jp.py,sha256=xyVg-lwBpGaTkbS6jMAW1no5BksmeDJRKM8cku75f0k,721988
-pmdsky_debug_py/jp_itcm.py,sha256=kLWNLkjuzzBZQs4dqOKL7ASrF9t1tVdpXwN5kkwa3UQ,700899
-pmdsky_debug_py/na.py,sha256=4TMK2spDw2aoFwP_O2keG9dRVpumspLrfFpir65c3TI,739892
-pmdsky_debug_py/na_itcm.py,sha256=0a4DPJmpdFmXrmc9bsZdodn6oZCOlH5L9BptJyZDCak,700910
-pmdsky_debug_py/protocol.py,sha256=zMuv8AMk1bKZ5_qs8WziTziwVYBwLDumrZVn42NjcaY,232676
-pmdsky_debug_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pmdsky_debug_py-5.1.12.dist-info/METADATA,sha256=MrAGGNw9nMhAHdIVSq430OXW03e61QHM0u8lBTxF10k,1321
-pmdsky_debug_py-5.1.12.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-pmdsky_debug_py-5.1.12.dist-info/top_level.txt,sha256=cqvpcJbud2s8IyBAc1MfCySwniko_6qO5LWSSxNIoXI,16
-pmdsky_debug_py-5.1.12.dist-info/RECORD,,