pmdsky-debug-py 10.2.19__py3-none-any.whl → 10.2.22__py3-none-any.whl

pmdsky_debug_py/na.py

@@ -6447,7 +6447,70 @@ class NaArm9Functions:
         [0x204BCAC],
         None,
         "CalcScriptVariables",
-        "Performs a calculation on two loaded script variables.\n\nr0: script variable 1\nr1: script variable 2\nr2: calculation to perform on the script variables\nreturn: calculation result",
+        "Performs a calculation on two loaded script variables.\n\nr0: script variable value 1\nr1: script variable value 2\nr2: calculation to perform on the script variables\nreturn: calculation result",
+        None,
+    )
+
+    CompareScriptVariables = Symbol(
+        [0x4BD98],
+        [0x204BD98],
+        None,
+        "CompareScriptVariables",
+        "Compares two loaded script variables and returns the comparison result.\n\nr0: script variable value 1\nr1: script variable value 2\nr2: comparison to perform on the script variables\nreturn: comparison result",
+        None,
+    )
+
+    CalcScriptVariablesVeneer = Symbol(
+        [0x4BECC],
+        [0x204BECC],
+        None,
+        "CalcScriptVariablesVeneer",
+        "Likely a linker-generated veneer for CalcScriptVariables.\n\nSee https://developer.arm.com/documentation/dui0474/k/image-structure-and-generation/linker-generated-veneers/what-is-a-veneer-\n\nr0: script variable value 1\nr1: script variable value 2\nr2: calculation to perform on the script variables\nreturn: calculation result",
+        None,
+    )
+
+    CalcAndUpdateScriptVarWithOtherValue = Symbol(
+        [0x4BED8],
+        [0x204BED8],
+        None,
+        "CalcAndUpdateScriptVarWithOtherValue",
+        "Runs a calculation on a script variable, then sets the script variable to the calculation result.\n\nr0: pointer to the local variable table\nr1: script variable ID\nr2: other value to use in the calculation\nr3: calculation to perform on the script variables",
+        None,
+    )
+
+    CalcAndUpdateScriptVarWithOtherScriptVar = Symbol(
+        [0x4BF10],
+        [0x204BF10],
+        None,
+        "CalcAndUpdateScriptVarWithOtherScriptVar",
+        "Runs a calculation on a script variable, then sets the script variable to the calculation result.\n\nr0: pointer to the local variable table\nr1: script variable ID\nr2: other script variable to use in the calculation\nr3: calculation to perform on the script variables",
+        None,
+    )
+
+    CompareScriptVariablesVeneer = Symbol(
+        [0x4BF5C],
+        [0x204BF5C],
+        None,
+        "CompareScriptVariablesVeneer",
+        "Likely a linker-generated veneer for CompareScriptVariables.\n\nSee https://developer.arm.com/documentation/dui0474/k/image-structure-and-generation/linker-generated-veneers/what-is-a-veneer-\n\nr0: script variable value 1\nr1: script variable value 2\nr2: comparison to perform on the script variables\nreturn: comparison result",
+        None,
+    )
+
+    LoadAndCompareScriptVarAndValue = Symbol(
+        [0x4BF68],
+        [0x204BF68],
+        None,
+        "LoadAndCompareScriptVarAndValue",
+        "Runs a comparison on a script variable and another value, then returns the comparison result.\n\nr0: pointer to the local variable table\nr1: script variable ID\nr2: other script variable to use in the comparison\nr3: comparison to perform on the script variables\nreturn: comparison result",
+        None,
+    )
+
+    LoadAndCompareScriptVars = Symbol(
+        [0x4BF88],
+        [0x204BF88],
+        None,
+        "LoadAndCompareScriptVars",
+        "Runs a comparison on two script variables, then returns the comparison result.\n\nr0: pointer to the local variable table\nr1: script variable ID\nr2: other script variable to use in the comparison\nr3: comparison to perform on the script variables\nreturn: comparison result",
         None,
     )
 
@@ -6496,6 +6559,15 @@ class NaArm9Functions:
         None,
     )
 
+    LoadScriptVarValuePair = Symbol(
+        [0x4C5DC],
+        [0x204C5DC],
+        None,
+        "LoadScriptVarValuePair",
+        "Loads values [val0, val1] from a script variable.\n\nr0: script variable ID\nr1: Pointer to store index 0 of the script variable.\nr2: Pointer to store index 1 of the script variable.",
+        None,
+    )
+
     SetScenarioScriptVar = Symbol(
         [0x4C618],
         [0x204C618],
@@ -6505,6 +6577,51 @@ class NaArm9Functions:
         None,
     )
 
+    IsStoryBeforePoint = Symbol(
+        [0x4C6C8],
+        [0x204C6C8],
+        None,
+        "IsStoryBeforePoint",
+        "Checks if the current story progress is before a certain point in the story.\n\nr0: script variable ID\nr1: story chapter to compare to\nr2: story chapter subsection to compare to\nreturn: whether the story progress is before the given chapter and subsection.",
+        None,
+    )
+
+    IsStoryBeforeOrAtPoint = Symbol(
+        [0x4C734],
+        [0x204C734],
+        None,
+        "IsStoryBeforeOrAtPoint",
+        "Checks if the current story progress is before or at a certain point in the story.\n\nr0: script variable ID\nr1: story chapter to compare to\nr2: story chapter subsection to compare to\nreturn: whether the story progress is before or at the given chapter and subsection.",
+        None,
+    )
+
+    IsStoryAtPoint = Symbol(
+        [0x4C7AC],
+        [0x204C7AC],
+        None,
+        "IsStoryAtPoint",
+        "Checks if the current story progress is at a certain point in the story.\n\nr0: script variable ID\nr1: story chapter to compare to\nr2: story chapter subsection to compare to\nreturn: whether the story progress is at the given chapter and subsection.",
+        None,
+    )
+
+    IsStoryAtOrAfterPoint = Symbol(
+        [0x4C808],
+        [0x204C808],
+        None,
+        "IsStoryAtOrAfterPoint",
+        "Checks if the current story progress is at or after a certain point in the story.\n\nr0: script variable ID\nr1: story chapter to compare to\nr2: story chapter subsection to compare to\nreturn: whether the story progress is at or after the given chapter and subsection.",
+        None,
+    )
+
+    IsStoryAfterPoint = Symbol(
+        [0x4C880],
+        [0x204C880],
+        None,
+        "IsStoryAfterPoint",
+        "Checks if the current story progress is after a certain point in the story.\n\nr0: script variable ID\nr1: story chapter to compare to\nr2: story chapter subsection to compare to\nreturn: whether the story progress is after the given chapter and subsection.",
+        None,
+    )
+
     GetSpecialEpisodeType = Symbol(
         [0x4C8EC],
         [0x204C8EC],
@@ -6523,6 +6640,24 @@ class NaArm9Functions:
         None,
     )
 
+    GetDebugSpecialEpisodeNumber = Symbol(
+        [0x4C918],
+        [0x204C918],
+        None,
+        "GetDebugSpecialEpisodeNumber",
+        "Gets the value of DEBUG_SPECIAL_EPISODE_NUMBER.\n\nreturn: value of DEBUG_SPECIAL_EPISODE_NUMBER",
+        None,
+    )
+
+    SetDebugSpecialEpisodeNumber = Symbol(
+        [0x4C928],
+        [0x204C928],
+        None,
+        "SetDebugSpecialEpisodeNumber",
+        "Sets the value of DEBUG_SPECIAL_EPISODE_NUMBER.\n\nr0: new value of DEBUG_SPECIAL_EPISODE_NUMBER",
+        None,
+    )
+
     GetExecuteSpecialEpisodeType = Symbol(
         [0x4C938],
         [0x204C938],
@@ -6541,6 +6676,60 @@ class NaArm9Functions:
         None,
     )
 
+    SetSpecialEpisodeOpen = Symbol(
+        [0x4C978],
+        [0x204C978],
+        None,
+        "SetSpecialEpisodeOpen",
+        "Sets the value of the script variable SPECIAL_EPISODE_OPEN, which indicates if a special episode is unlocked.\n\nr0: special episode type\nr1: new SPECIAL_EPISODE_OPEN value",
+        None,
+    )
+
+    IsSpecialEpisodeOpenMismatch = Symbol(
+        [0x4C9A0],
+        [0x204C9A0],
+        None,
+        "IsSpecialEpisodeOpenMismatch",
+        "Checks if there is a mismatch between the values of the script variables SPECIAL_EPISODE_OPEN and VAR_SPECIAL_EPISODE_OPEN_OLD.\nThis checks for all special episodes at once.\n\nreturn: bool",
+        None,
+    )
+
+    IsSpecialEpisodeOpenOld = Symbol(
+        [0x4C9C8],
+        [0x204C9C8],
+        None,
+        "IsSpecialEpisodeOpenOld",
+        "Checks if the SPECIAL_EPISODE_OPEN_OLD script variable is set to true.\n\nr0: special episode type\nreturn: bool",
+        None,
+    )
+
+    SetSpecialEpisodeOpenOld = Symbol(
+        [0x4C9F4],
+        [0x204C9F4],
+        None,
+        "SetSpecialEpisodeOpenOld",
+        "Sets the value of the script variable SPECIAL_EPISODE_OPEN_OLD.\n\nr0: special episode type\nr1: new SPECIAL_EPISODE_OPEN_OLD value",
+        None,
+    )
+
+    IsSpecialEpisodeBeaten = Symbol(
+        [0x4CA1C],
+        [0x204CA1C],
+        None,
+        "IsSpecialEpisodeBeaten",
+        "Checks if a special episode is beaten from the SPECIAL_EPISODE_CONQUEST script variable.\n\nr0: special episode type\nreturn: bool",
+        None,
+    )
+
+    SetSpecialEpisodeBeaten = Symbol(
+        [0x4CA48],
+        [0x204CA48],
+        None,
+        "SetSpecialEpisodeBeaten",
+        "Sets the value of the script variable SPECIAL_EPISODE_CONQUEST, which indicates if a special episode is beaten.\n\nr0: special episode type\nr1: new SPECIAL_EPISODE_CONQUEST value",
+        None,
+    )
+
     HasPlayedOldGame = Symbol(
         [0x4CA70],
         [0x204CA70],
@@ -6559,6 +6748,15 @@ class NaArm9Functions:
         None,
     )
 
+    SetPerformanceFlagWithChecks = Symbol(
+        [0x4CB2C],
+        [0x204CB2C],
+        None,
+        "SetPerformanceFlagWithChecks",
+        "Sets the value of one of the flags in VAR_PERFORMANCE_PROGRESS_LIST, with some edge cases.\n\nList of cases where the function behaves differently:\n- If the requested flag is 0, sets the flag to false if the new value is 0, and true otherwise\n- If the requested flag is 7 and GAME_MODE == GAME_MODE_SPECIAL_EPISODE, the flag is not set\n\nr0: ID of the flag to get\nr1: Value to set the flag to.",
+        None,
+    )
+
     GetScenarioBalance = Symbol(
         [0x4CB94],
         [0x204CB94],
@@ -9571,6 +9769,22 @@ class NaArm9Functions:
 
     IsMoveRangeString19 = _Deprecated("IsMoveRangeString19", IsMoveRangeStringUser)
 
+    InitScenarioProgressScriptVars = _Deprecated(
+        "InitScenarioProgressScriptVars", InitScenarioScriptVars
+    )
+
+    SetScenarioProgressScriptVar = _Deprecated(
+        "SetScenarioProgressScriptVar", SetScenarioScriptVar
+    )
+
+    GetResolvedPerformanceProgressFlag = _Deprecated(
+        "GetResolvedPerformanceProgressFlag", GetPerformanceFlagWithChecks
+    )
+
+    SetResolvedPerformanceProgressFlag = _Deprecated(
+        "SetResolvedPerformanceProgressFlag", SetPerformanceFlagWithChecks
+    )
+
     GetLowKickMultiplier = _Deprecated("GetLowKickMultiplier", GetWeightMultiplier)
 
     GetActorMatchingStorageId = _Deprecated(
@@ -10094,15 +10308,33 @@ class NaArm9Data:
         "struct partner_talk_kind_table_entry[11]",
     )
 
-    EVENT_FLAG_PROG_POS_INFO = Symbol(
+    EVENT_FLAG_PROG_POS_INFO_CALC_SCRIPT_VARIABLES = Symbol(
         [0x9CEAC],
         [0x209CEAC],
         0x8,
-        "EVENT_FLAG_PROG_POS_INFO",
+        "EVENT_FLAG_PROG_POS_INFO_CALC_SCRIPT_VARIABLES",
         "Debug information used to log an error with an unrecognized operation in CalcScriptVariables.",
         "struct prog_pos_info",
     )
 
+    EVENT_FLAG_PROG_POS_INFO_COMPARE_SCRIPT_VARIABLES = Symbol(
+        [0x9CEB4],
+        [0x209CEB4],
+        0x8,
+        "EVENT_FLAG_PROG_POS_INFO_COMPARE_SCRIPT_VARIABLES",
+        "Debug information used to log an error with an unrecognized operation in CompareScriptVariables.",
+        "struct prog_pos_info",
+    )
+
+    EVENT_FLAG_FILE_NAME = Symbol(
+        [0x9CEBC],
+        [0x209CEBC],
+        0x10,
+        "EVENT_FLAG_FILE_NAME",
+        "The file name 'event_flag.c', used for debug logging.",
+        "",
+    )
+
     SCRIPT_VARS_LOCALS = Symbol(
         [0x9CECC],
         [0x209CECC],
@@ -10112,15 +10344,42 @@ class NaArm9Data:
         "struct script_local_var_table",
     )
 
-    EVENT_FLAG_EXPANSION_ERROR = Symbol(
+    EVENT_FLAG_CALC_SCRIPT_VARIABLES_ERROR = Symbol(
         [0x9CF28],
         [0x209CF28],
         0x20,
-        "EVENT_FLAG_EXPANSION_ERROR",
+        "EVENT_FLAG_CALC_SCRIPT_VARIABLES_ERROR",
         "Error log message for an unrecognized operation in CalcScriptVariables.",
         "",
     )
 
+    EVENT_FLAG_COMPARE_SCRIPT_VARIABLES_ERROR = Symbol(
+        [0x9CF48],
+        [0x209CF48],
+        0x1C,
+        "EVENT_FLAG_COMPARE_SCRIPT_VARIABLES_ERROR",
+        "Error log message for an unrecognized operation in CompareScriptVariables.",
+        "",
+    )
+
+    EVENT_FLAG_GAME_MODE_DEBUG_MSG = Symbol(
+        [0x9CF64],
+        [0x209CF64],
+        0x20,
+        "EVENT_FLAG_GAME_MODE_DEBUG_MSG",
+        "Debug log message when EventFlagResume runs.",
+        "",
+    )
+
+    EVENT_FLAG_BACKUP_DEBUG_MSG = Symbol(
+        [0x9CF84],
+        [0x209CF84],
+        0x20,
+        "EVENT_FLAG_BACKUP_DEBUG_MSG",
+        "Debug log message when EventFlagBackup runs.",
+        "",
+    )
+
     SCRIPT_VARS = Symbol(
         [0x9D870],
         [0x209D870],
@@ -10130,6 +10389,15 @@ class NaArm9Data:
         "struct script_var_table",
     )
 
+    SCENARIO_CALC_DEBUG_MSG = Symbol(
+        [0x9DFA0],
+        [0x209DFA0],
+        0x28,
+        "SCENARIO_CALC_DEBUG_MSG",
+        "Debug log message with the old and new scenario values when SetScenarioScriptVar runs.",
+        "",
+    )
+
     PORTRAIT_LAYOUTS = Symbol(
         [0x9E014],
         [0x209E014],
@@ -11625,6 +11893,14 @@ class NaArm9Data:
         "EXCLUSIVE_ITEM_ATTACK_BOOSTS", EXCLUSIVE_ITEM_STAT_BOOST_DATA
     )
 
+    EVENT_FLAG_PROG_POS_INFO = _Deprecated(
+        "EVENT_FLAG_PROG_POS_INFO", EVENT_FLAG_PROG_POS_INFO_CALC_SCRIPT_VARIABLES
+    )
+
+    EVENT_FLAG_EXPANSION_ERROR = _Deprecated(
+        "EVENT_FLAG_EXPANSION_ERROR", EVENT_FLAG_CALC_SCRIPT_VARIABLES_ERROR
+    )
+
     DIRECTORY_FILES_EXTRACTED = _Deprecated(
         "DIRECTORY_FILES_EXTRACTED", PACK_FILES_OPENED
     )
@@ -35125,6 +35401,15 @@ class NaRamData:
         "struct move",
     )
 
+    OPTIONS = Symbol(
+        [0x2AB0A0],
+        [0x22AB0A0],
+        0x9,
+        "OPTIONS",
+        "The game's options as controlled by the player through the Others -> Options menu\n\nThe option for 'Grids On/Off' is not stored here.\n\ntype: struct options",
+        "struct options",
+    )
+
     SCRIPT_VARS_VALUES = Symbol(
         [0x2AB0AC],
         [0x22AB0AC],