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

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,
@@ -12621,6 +12671,16 @@ class JpItcmOverlay10Data:
         ),
     )
 
+    KECLEON_SHOP_BOOST_CHANCE_MULTIPLIER = Symbol(
+        None,
+        None,
+        None,
+        (
+            "The boosted kecleon shop spawn chance multiplier (~1.2) as a binary"
+            " fixed-point number (8 fraction bits)."
+        ),
+    )
+
     HIDDEN_STAIRS_SPAWN_CHANCE_MULTIPLIER = Symbol(
         None,
         None,
@@ -13305,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"
         ),
     )
 
@@ -13583,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,
@@ -16430,6 +16496,127 @@ class JpItcmOverlay29Functions:
         ),
     )
 
+    ApplyMudTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Randomly lowers attack, special attack, defense, or special defense of the"
+            " defender by 3 stages.\n\nr0: attacker entity pointer\nr1: defender entity"
+            " pointer"
+        ),
+    )
+
+    ApplyStickyTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "If the defender is the leader, randomly try to make something in the bag"
+            " sticky. Otherwise, try to make the item the monster is holding"
+            " sticky.\n\nr0: attacker entity pointer\nr1: defender entity pointer"
+        ),
+    )
+
+    ApplyGrimyTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "If the defender is the leader, randomly try to turn food items in the"
+            " toolbox into\ngrimy food. Otherwise, try to make the food item the"
+            " monster is holding grimy food.\n\nr0: attacker entity pointer\nr1:"
+            " defender entity pointer"
+        ),
+    )
+
+    ApplyPitfallTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "If the defender is the leader, end the current floor unless it has a"
+            " rescue point.\nOtherwise, make the entity faint and ignore reviver seeds."
+            " If not called by a random\ntrap, break the grate on the pitfall"
+            " trap.\n\nr0: attacker entity pointer\nr1: defender entity pointer\nr2:"
+            " tile pointer\nr3: bool caused by random trap"
+        ),
+    )
+
+    ApplySummonTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Randomly spawns 2-4 enemy monsters around the position. The entity is only"
+            " used for\nlogging messages.\n\nr0: entity pointer\nr1: position"
+        ),
+    )
+
+    ApplyPpZeroTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Tries to reduce the PP of one of the defender's moves to 0.\n\nr0:"
+            " attacker entity pointer\nr1: defender entity pointer"
+        ),
+    )
+
+    ApplyPokemonTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Turns item in the same room as the tile at the position (usually just the"
+            " entities's\nposition) into monsters. If the position is in a hallway,"
+            " convert items in a 3x3 area\ncentered on the position into"
+            " monsters.\n\nr0: entity pointer\nr1: position"
+        ),
+    )
+
+    ApplyTripTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Tries to drop the defender's item and places it on the floor.\n\nr0:"
+            " attacker entity pointer\nr1: defender entity pointer"
+        ),
+    )
+
+    ApplyToxicSpikesTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Tries to inflict 10 damage on the defender and then tries to poison"
+            " them.\n\nr0: attacker entity pointer\nr1: defender entity pointer"
+        ),
+    )
+
+    ApplyRandomTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Selects a random trap that isn't a wonder tile and isn't a random trap and"
+            " calls\nApplyTrapEffect on all monsters that is different from the trap's"
+            " team.\n\nr0: Triggered trap\nr1: User\nr2: Target, normally same as"
+            " user\nr3: Tile that contains the trap\nstack[0]: position"
+        ),
+    )
+
+    ApplyGrudgeTrapEffect = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Spawns several monsters around the position and gives all monsters on the"
+            " floor the\ngrudge status condition.\n\nr0: entity pointer\nr1: position"
+        ),
+    )
+
     ApplyTrapEffect = Symbol(
         None,
         None,
@@ -16437,11 +16624,20 @@ class JpItcmOverlay29Functions:
         (
             "Performs the effect of a triggered trap.\n\nThe trap's animation happens"
             " before this function is called.\n\nr0: Triggered trap\nr1: User\nr2:"
-            " Target, normally same as user\nr3: Tile that contains the trap\nreturn:"
-            " True if the trap should be destroyed after the effect is applied"
+            " Target, normally same as user\nr3: Tile that contains the trap\nstack[0]:"
+            " position\nstack[1]: trap ID\nstack[2]: bool caused by random"
+            " trap\nreturn: True if the trap should be destroyed after the effect is"
+            " applied"
         ),
     )
 
+    RevealTrapsNearby = Symbol(
+        None,
+        None,
+        None,
+        "Reveals traps within the monster's viewing range.\n\nr0: entity pointer",
+    )
+
     DebugRecruitingEnabled = Symbol(
         None,
         None,
@@ -16802,6 +16998,20 @@ class JpItcmOverlay29Functions:
         ),
     )
 
+    TryEndStatusWithAbility = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Checks if any of the defender's active abilities would end one of their"
+            " current status\nconditions. For example, if the ability Own Tempo will"
+            " stop confusion.\n\nCalled after changing a monster's ability with skill"
+            " swap, role play, or trace to\nremove statuses the monster should no"
+            " longer be affected by.\n\nr0: attacker entity pointer\nr1: defender"
+            " entity pointer"
+        ),
+    )
+
     ExclusiveItemEffectIsActive = Symbol(
         None,
         None,
@@ -18723,6 +18933,16 @@ class JpItcmOverlay29Functions:
         ),
     )
 
+    TryResetStatChanges = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Tries to reset the stat changes of the defender.\n\nr0: attacker entity"
+            " pointer\nr1: defender entity pointer\nr3: bool to force animation"
+        ),
+    )
+
     MirrorMoveIsActive = Symbol(
         None,
         None,
@@ -19025,7 +19245,21 @@ class JpItcmOverlay29Functions:
             "Creates an explosion if possible.\n\nThe target monster is considered the"
             " source of the explosion.\n\nr0: user entity pointer\nr1: target entity"
             " pointer\nr2: coordinates where the explosion should take place"
-            " (unverified)\nr3: ?\nstack[0]: ?\nstack[1]: damage source (normally"
+            " (center)\nr3: explosion radius (only works correctly with 1 and"
+            " 2)\nstack[0]: damage type\nstack[1]: damage source"
+        ),
+    )
+
+    TryAftermathExplosion = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Creates the explosion for the ability aftermath if possible.\n\nThe target"
+            " monster is considered the source of the explosion.\n\nr0: user entity"
+            " pointer\nr1: target entity pointer\nr2: coordinates where the explosion"
+            " should take place (center)\nr3: explosion radius (only works correctly"
+            " with 1 and 2)\nstack[0]: damage type\nstack[1]: damage source (normally"
             " DAMAGE_SOURCE_EXPLOSION)"
         ),
     )
@@ -20511,6 +20745,19 @@ class JpItcmOverlay29Functions:
         ),
     )
 
+    GetFinalKecleonShopSpawnChance = Symbol(
+        None,
+        None,
+        None,
+        (
+            "Gets the kecleon shop spawn chance for the floor.\n\nWhen"
+            " dungeon::boost_kecleon_shop_spawn_chance is false, returns the same value"
+            " as the input. When it's true, returns the input (chance * 1.2).\n\nr0:"
+            " base kecleon shop spawn chance,"
+            " floor_properties::kecleon_shop_spawn_chance\nreturn: int"
+        ),
+    )
+
     ResetHiddenStairsSpawn = Symbol(
         None,
         None,