pmdsky-debug-py 10.0.50__py3-none-any.whl → 10.0.51__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5676,12 +5676,21 @@ class NaItcmArm9Functions:
5676
5676
  None,
5677
5677
  )
5678
5678
 
5679
+ SetupAndShowKeyboard = Symbol(
5680
+ None,
5681
+ None,
5682
+ None,
5683
+ "SetupAndShowKeyboard",
5684
+ "Calls a function that seems to set up info for the keyboard menu before ending with a call to ShowKeyboard.\n\nr0: menu type\nr1: buffer1\nr2: buffer2\nreturn: ?",
5685
+ None,
5686
+ )
5687
+
5679
5688
  ShowKeyboard = Symbol(
5680
5689
  None,
5681
5690
  None,
5682
5691
  None,
5683
5692
  "ShowKeyboard",
5684
- "Note: unverified, ported from Irdkwia's notes\n\nr0: string ID\nr1: buffer1\nr2: ???\nr3: buffer2\nreturn: ?",
5693
+ "Note: unverified, ported from Irdkwia's notes\n\nr0: menu type\nr1: buffer1\nr2: ???\nr3: buffer2\nreturn: ?",
5685
5694
  None,
5686
5695
  )
5687
5696
 
@@ -7764,6 +7773,15 @@ class NaItcmArm9Functions:
7764
7773
  None,
7765
7774
  )
7766
7775
 
7776
+ SetBaseStatsMovesGroundMonster = Symbol(
7777
+ None,
7778
+ None,
7779
+ None,
7780
+ "SetBaseStatsMovesGroundMonster",
7781
+ "Sets a ground monster to have the base stats and Level 1 moves of its species, along with 1 IQ.\n\nr0: ground monster pointer",
7782
+ None,
7783
+ )
7784
+
7767
7785
  StrcmpMonsterName = Symbol(
7768
7786
  None,
7769
7787
  None,
@@ -7899,6 +7917,15 @@ class NaItcmArm9Functions:
7899
7917
  None,
7900
7918
  )
7901
7919
 
7920
+ ApplyLevelUpBoostsToGroundMonster = Symbol(
7921
+ None,
7922
+ None,
7923
+ None,
7924
+ "ApplyLevelUpBoostsToGroundMonster",
7925
+ "Applies the level up boosts to stats and moves (until moveset is full) to a target monster.\n\nr0: ground monster pointer\nr1: level\nr2: flag that enables further editing of the monster",
7926
+ None,
7927
+ )
7928
+
7902
7929
  GetMonsterGenderVeneer = Symbol(
7903
7930
  None,
7904
7931
  None,
@@ -18351,6 +18378,42 @@ class NaItcmOverlay10Section:
18351
18378
 
18352
18379
  class NaItcmOverlay11Functions:
18353
18380
 
18381
+ InitScriptRoutineState = Symbol(
18382
+ None,
18383
+ None,
18384
+ None,
18385
+ "InitScriptRoutineState",
18386
+ "Initializes the various fields of script_routine_state, a struct that seems relevant when handling script opcode operations.\n\nr0: script_routine_state pointer",
18387
+ None,
18388
+ )
18389
+
18390
+ InitScriptRoutine = Symbol(
18391
+ None,
18392
+ None,
18393
+ None,
18394
+ "InitScriptRoutine",
18395
+ "Initializes the various fields of script_routine.\n\nr0: routine pointer\nr1: ground entity function table pointer\nr2: live entity pointer",
18396
+ None,
18397
+ )
18398
+
18399
+ LockRoutine = Symbol(
18400
+ None,
18401
+ None,
18402
+ None,
18403
+ "LockRoutine",
18404
+ "Sets a routine to be locked via the Lock opcode.\n\nr0: script routine pointer\nr1: lock id\nreturn: Always 1, but this does seem to get checked in RunNextOpcode for some reason",
18405
+ None,
18406
+ )
18407
+
18408
+ UnlockRoutine = Symbol(
18409
+ None,
18410
+ None,
18411
+ None,
18412
+ "UnlockRoutine",
18413
+ "Attempts to unlock a script routine via the Unlock opcode.\n\nr0: script routine pointer\nr1: lock id\nreturn: True if the script routine was successfully unlocked",
18414
+ None,
18415
+ )
18416
+
18354
18417
  UnlockScriptingLock = Symbol(
18355
18418
  None,
18356
18419
  None,
@@ -18365,7 +18428,7 @@ class NaItcmOverlay11Functions:
18365
18428
  None,
18366
18429
  None,
18367
18430
  "FuncThatCallsRunNextOpcode",
18368
- "Called up to 16 times per frame. Exact purpose unknown.\n\nr0: Looks like a pointer to some struct containing data about the current state of scripting engine",
18431
+ "Called up to 16 times per frame. Exact purpose unknown.\n\nr0: script routine pointer",
18369
18432
  None,
18370
18433
  )
18371
18434
 
@@ -18374,7 +18437,16 @@ class NaItcmOverlay11Functions:
18374
18437
  None,
18375
18438
  None,
18376
18439
  "RunNextOpcode",
18377
- "Runs the next scripting opcode.\n\nContains a switch statement based on the opcode ([r0+1C]).\n\nr0: Looks like a pointer to some struct containing data about the current state of scripting engine",
18440
+ "Runs the next scripting opcode.\n\nContains a switch statement based on the routine's next opcode to run.\n\nr0: script routine pointer\nreturn: status",
18441
+ None,
18442
+ )
18443
+
18444
+ GetSsbString = Symbol(
18445
+ None,
18446
+ None,
18447
+ None,
18448
+ "GetSsbString",
18449
+ "Returns a string from a given SSB runtime struct.\n\nr0: ssb runtime info pointer\nr1: idx",
18378
18450
  None,
18379
18451
  )
18380
18452
 
@@ -18387,6 +18459,15 @@ class NaItcmOverlay11Functions:
18387
18459
  None,
18388
18460
  )
18389
18461
 
18462
+ ScriptCaseProcess = Symbol(
18463
+ None,
18464
+ None,
18465
+ None,
18466
+ "ScriptCaseProcess",
18467
+ "Calculates the next opcode address for a script routine as the result of a switch-statement.\n\nr0: script routine pointer\nr1: case id\nreturn: Next opcode address for the routine to execute",
18468
+ None,
18469
+ )
18470
+
18390
18471
  LoadFileFromRomVeneer = Symbol(
18391
18472
  None,
18392
18473
  None,
@@ -18692,6 +18773,15 @@ class NaItcmOverlay11Functions:
18692
18773
  None,
18693
18774
  )
18694
18775
 
18776
+ UnlockMainRoutine = Symbol(
18777
+ None,
18778
+ None,
18779
+ None,
18780
+ "UnlockMainRoutine",
18781
+ "Unlocks the main routine of the current script, as specified in GROUND_STATE_PTRS::main_routine.\n\nr0: lock id\nreturn: True if the script routine was successfully unlocked",
18782
+ None,
18783
+ )
18784
+
18695
18785
  AllocAndInitPartnerFollowDataAndLiveActorList = Symbol(
18696
18786
  None,
18697
18787
  None,
@@ -18706,7 +18796,16 @@ class NaItcmOverlay11Functions:
18706
18796
  None,
18707
18797
  None,
18708
18798
  "InitPartnerFollowDataAndLiveActorList",
18709
- "Initialize the partner follow data and the live actor list (in GROUND_STATE_PTRS, doesnt perform the allocation of the structures)\n\nNo params.",
18799
+ "Initialize the partner follow data and the live actor list (in GROUND_STATE_PTRS, doesn't perform the allocation of the structures)\n\nNo params.",
18800
+ None,
18801
+ )
18802
+
18803
+ GetLiveActorIdxFromScriptEntityId = Symbol(
18804
+ None,
18805
+ None,
18806
+ None,
18807
+ "GetLiveActorIdxFromScriptEntityId",
18808
+ "Searches through the live actor list to find the first matching actor who has an ID matching that of a script_entity_id.\n\nr0: script_entity_id\nreturn: index of the live actor, or -1 if the specified actor could not be found",
18710
18809
  None,
18711
18810
  )
18712
18811
 
@@ -18715,7 +18814,43 @@ class NaItcmOverlay11Functions:
18715
18814
  None,
18716
18815
  None,
18717
18816
  "DeleteLiveActor",
18718
- "Remove the actor from the overworld actor list (in GROUND_STATE_PTRS)\n\nr0: the index of the actor in the live actor list",
18817
+ "Remove the actor from the actor list (in GROUND_STATE_PTRS)\n\nr0: the index of the actor in the live actor list",
18818
+ None,
18819
+ )
18820
+
18821
+ SetAttributeBitfieldLiveActor = Symbol(
18822
+ None,
18823
+ None,
18824
+ None,
18825
+ "SetAttributeBitfieldLiveActor",
18826
+ "Sets bits of the attribute bitfield of a currently loaded actor.\n\nr0: live actor id\nr1: attribute bitfield",
18827
+ None,
18828
+ )
18829
+
18830
+ ResetAttributeBitfieldLiveActor = Symbol(
18831
+ None,
18832
+ None,
18833
+ None,
18834
+ "ResetAttributeBitfieldLiveActor",
18835
+ "Clears bits of the attribute bitfield of a currently loaded actor.\n\nr0: live actor id\nr1: attribute bitfield",
18836
+ None,
18837
+ )
18838
+
18839
+ UnlockActorRoutines = Symbol(
18840
+ None,
18841
+ None,
18842
+ None,
18843
+ "UnlockActorRoutines",
18844
+ "Attempts to unlock all live actor routines of the current script.\n\nr0: lock id\nreturn: True if any script routine was successfully unlocked",
18845
+ None,
18846
+ )
18847
+
18848
+ GetCollidingActorId = Symbol(
18849
+ None,
18850
+ None,
18851
+ None,
18852
+ "GetCollidingActorId",
18853
+ "Returns the first colliding actor given a series of vector coordinates.\n\nr0: live actor id (used only to ignore an actor colliding with itself)\nr1: attribute bitfield to test actors against\nr2: pointer to coord_min\nr3: pointer to coord_max\nreturn: The first colliding actor's id, or -1 if no is collision detected",
18719
18854
  None,
18720
18855
  )
18721
18856
 
@@ -18724,319 +18859,967 @@ class NaItcmOverlay11Functions:
18724
18859
  None,
18725
18860
  None,
18726
18861
  "ChangeActorAnimation",
18727
- "Used by the SetAnimation opcode to change the animation of an actor.\n\nIt's responsible for breaking down the SetAnimation parameter and determining which animation to play and which flags to set.\n\nr0: ?\nr1: SetAnimation parameter",
18862
+ "Used by the SetAnimation opcode to change the animation of an actor.\n\nIt's responsible for breaking down the SetAnimation parameter and determining which animation to play and which flags to set.\n\nr0: live actor\nr1: SetAnimation parameter",
18728
18863
  None,
18729
18864
  )
18730
18865
 
18731
- InitPartnerFollowData = Symbol(
18866
+ SetPositionLiveActor = Symbol(
18732
18867
  None,
18733
18868
  None,
18734
18869
  None,
18735
- "InitPartnerFollowData",
18736
- "Initialize the partner follow data structure, without allocating it (in GROUND_STATE_PTRS)\n\nNo params.",
18870
+ "SetPositionLiveActor",
18871
+ "Sets the position for a currently loaded actor.\n\nr0: live actor\nr1: pointer to a position vector",
18737
18872
  None,
18738
18873
  )
18739
18874
 
18740
- GetDirectionLiveActor = Symbol(
18875
+ GetIdLiveActor = Symbol(
18741
18876
  None,
18742
18877
  None,
18743
18878
  None,
18744
- "GetDirectionLiveActor",
18745
- "Put the direction of the actor in the destination\n\nr0: live actor\nr1: destination address (1 byte)",
18879
+ "GetIdLiveActor",
18880
+ "Returns the ID of a currently loaded actor. This ID can then be used to index GROUND_STATE_PTRS::actors.\n\nr0: live actor\nreturn: id",
18746
18881
  None,
18747
18882
  )
18748
18883
 
18749
- SetDirectionLiveActor = Symbol(
18884
+ GetCollisionBoxLiveActor = Symbol(
18750
18885
  None,
18751
18886
  None,
18752
18887
  None,
18753
- "SetDirectionLiveActor",
18754
- "Store the direction in the actor structure\n-1 input is ignored\nUnsure if this change the animation\n\nr0: live actor\nr1: direction",
18888
+ "GetCollisionBoxLiveActor",
18889
+ "Gets the collision box of a currently loaded actor.\n\nr0: live actor\nr1: [output] collision box buffer",
18755
18890
  None,
18756
18891
  )
18757
18892
 
18758
- CreateTeamInfoBox = Symbol(
18893
+ SetPositionInitialLiveActor = Symbol(
18759
18894
  None,
18760
18895
  None,
18761
18896
  None,
18762
- "CreateTeamInfoBox",
18763
- "Creates a window containing team information (rank and money carried) for the top-level menu in ground mode. Also see struct team_info_box.\n\nThe new window will always default to TEAM_INFO_BOX_DEFAULT_WINDOW_PARAMS.\n\nreturn: window_id",
18897
+ "SetPositionInitialLiveActor",
18898
+ "Sets a currently loaded actor to return to its initial position.\n\nr0: live actor\nr1: pointer to an position vector; if null, actor will return to its initial position",
18764
18899
  None,
18765
18900
  )
18766
18901
 
18767
- CloseTeamInfoBox = Symbol(
18902
+ SetMovementRangeLiveActor = Symbol(
18768
18903
  None,
18769
18904
  None,
18770
18905
  None,
18771
- "CloseTeamInfoBox",
18772
- "Closes a window created with CreateTeamInfoBox.\n\nr0: window_id",
18906
+ "SetMovementRangeLiveActor",
18907
+ "Sets a currently loaded actor's random movement range.\n\nr0: live actor\nr1: pointer to limit_min_pos\nr2: pointer to limit_max_pos",
18773
18908
  None,
18774
18909
  )
18775
18910
 
18776
- IsTeamInfoBoxActive = Symbol(
18911
+ GetCollisionBoxCenterLiveActor = Symbol(
18777
18912
  None,
18778
18913
  None,
18779
18914
  None,
18780
- "IsTeamInfoBoxActive",
18781
- "This is a guess.\n\nChecks if the state of a team info box is not 5.\n\nr0: window_id\nreturn: bool",
18915
+ "GetCollisionBoxCenterLiveActor",
18916
+ "Gets the center of a collision box of a currently loaded actor.\n\nThis simply adds the actor's minimum coordinates by half the size of the actor's collision box.\n\nr0: live actor\nr1: [output] collision box center buffer",
18782
18917
  None,
18783
18918
  )
18784
18919
 
18785
- UpdateTeamInfoBox = Symbol(
18920
+ SetPositionLiveActorVeneer = Symbol(
18786
18921
  None,
18787
18922
  None,
18788
18923
  None,
18789
- "UpdateTeamInfoBox",
18790
- "Window update function for team info boxes.\n\nr0: window pointer",
18924
+ "SetPositionLiveActorVeneer",
18925
+ "Likely a linker-generated veneer for SetPositionLiveActor.\n\nSee https://developer.arm.com/documentation/dui0474/k/image-structure-and-generation/linker-generated-veneers/what-is-a-veneer-\n\nr0: live actor\nr1: pointer to a position vector",
18791
18926
  None,
18792
18927
  )
18793
18928
 
18794
- CreateTopGroundMenu = Symbol(
18929
+ GetHeightLiveActor = Symbol(
18795
18930
  None,
18796
18931
  None,
18797
18932
  None,
18798
- "CreateTopGroundMenu",
18799
- "Creates a parent menu (containing Items, Team, etc.) and two other windows upon pressing X in the overworld.\n\nreturn: always 1",
18933
+ "GetHeightLiveActor",
18934
+ "Gets the two height values of a currently loaded actor.\n\nr0: live actor\nr1: [output] pointer to first height value\nr2: [output] pointer to second height value, which is curiously not referenced by SetHeightLiveActor",
18800
18935
  None,
18801
18936
  )
18802
18937
 
18803
- CloseTopGroundMenu = Symbol(
18938
+ SetHeightLiveActor = Symbol(
18804
18939
  None,
18805
18940
  None,
18806
18941
  None,
18807
- "CloseTopGroundMenu",
18808
- "Closes the three windows created by CreateOverworldMenu.\n\nNo params.",
18942
+ "SetHeightLiveActor",
18943
+ "Sets the height of a currently loaded actor.\n\nr0: live actor\nr1: height",
18809
18944
  None,
18810
18945
  )
18811
18946
 
18812
- UpdateTopGroundMenu = Symbol(
18947
+ GetDirectionLiveActor = Symbol(
18813
18948
  None,
18814
18949
  None,
18815
18950
  None,
18816
- "UpdateTopGroundMenu",
18817
- "Window update function for the top-level ground mode menu.\n\nreturn: status code",
18951
+ "GetDirectionLiveActor",
18952
+ "Gets the direction of a currently loaded actor.\n\nr0: live actor\nr1: [output] pointer to direction",
18818
18953
  None,
18819
18954
  )
18820
18955
 
18821
- IsBagNotEmpty = Symbol(
18956
+ SetDirectionLiveActor = Symbol(
18822
18957
  None,
18823
18958
  None,
18824
18959
  None,
18825
- "IsBagNotEmpty",
18826
- "Checks if the bag has at least one valid item. Notably used in CreateTopGroundMenu to decide if the 'Items' option should be enabled.\n\nreturn: bool",
18960
+ "SetDirectionLiveActor",
18961
+ "Sets the direction of a currently loaded actor. Does nothing if the direction value passed is -1.\n\nr0: live actor\nr1: direction",
18827
18962
  None,
18828
18963
  )
18829
18964
 
18830
- SprintfStatic = Symbol(
18965
+ SetAnimationLiveActor = Symbol(
18831
18966
  None,
18832
18967
  None,
18833
18968
  None,
18834
- "SprintfStatic",
18835
- "Statically defined copy of sprintf(3) in overlay 11. See arm9.yml for more information.\n\nr0: str\nr1: format\n...: variadic\nreturn: number of characters printed, excluding the null-terminator",
18969
+ "SetAnimationLiveActor",
18970
+ "Sets the animation of a currently loaded actor. Leads up to a final ChangeActorAnimation call.\n\nIncludes a check for if live_actor::id is less than 3 and if live_actor::field_0xa is equal to 0x119, which ultimately may perform ((SetAnimation parameter) & 0x1f00 | 0x53).\n\nr0: live actor\nr1: SetAnimation parameter",
18836
18971
  None,
18837
18972
  )
18838
18973
 
18839
- GetExclusiveItemRequirements = Symbol(
18974
+ SetEffectLiveActor = Symbol(
18840
18975
  None,
18841
18976
  None,
18842
18977
  None,
18843
- "GetExclusiveItemRequirements",
18844
- "Used to calculate the items required to get a certain exclusive item in the swap shop.\n\nr0: ?\nr1: ?",
18978
+ "SetEffectLiveActor",
18979
+ "Sets the effect of a currently loaded actor.\n\nr0: live actor\nr1: flag (true if effect id is 0?)\nr2: effect id\nr3: effect position marker",
18845
18980
  None,
18846
18981
  )
18847
18982
 
18848
- HandleControlsTopScreenGround = Symbol(
18983
+ GetAnimationStatusLiveActor = Symbol(
18849
18984
  None,
18850
18985
  None,
18851
18986
  None,
18852
- "HandleControlsTopScreenGround",
18853
- "Handles the controls top screen display in the overworld.\n\nFor some reason the implementation seems considerably jankier in ground mode. In dungeon mode there's this structure for the top screen that has handlers for creating, updating and closing the various top screen layouts in a sort of polymorphic way. Here there's just a separate function for every layout that gets called every frame and seems to have a switch-case to handle everything about it.\n\nNo params.",
18987
+ "GetAnimationStatusLiveActor",
18988
+ "Gets the animation status of a currently loaded actor.\n\nUsed to determine if the animation has finished via script opcodes like WaitAnimation and WaitEndAnimation.\n\nr0: live actor\nreturn: status",
18854
18989
  None,
18855
18990
  )
18856
18991
 
18857
- GetDungeonMapPos = Symbol(
18992
+ GetEffectStatusLiveActor = Symbol(
18858
18993
  None,
18859
18994
  None,
18860
18995
  None,
18861
- "GetDungeonMapPos",
18862
- "Checks if a dungeon should be displayed on the map and the position where it should be displayed if so.\n\nr0: [Output] Buffer where the coordinates of the map marker will be stored. The coordinates are shifted 8 bits to the left, so they are probably fixed-point numbers instead of integers.\nr1: Dungeon ID\nreturn: True if the dungeon should be displayed on the map, false otherwise.",
18996
+ "GetEffectStatusLiveActor",
18997
+ "Gets the effect status of a currently loaded actor.\n\nUsed to determine if an effect has finished via the script opcode WaitEffect.\n\nr0: live actor\nreturn: status",
18863
18998
  None,
18864
18999
  )
18865
19000
 
18866
- WorldMapSetMode = Symbol(
19001
+ GetAttributeBitfieldLiveActor = Symbol(
18867
19002
  None,
18868
19003
  None,
18869
19004
  None,
18870
- "WorldMapSetMode",
18871
- "Function called by the script function 'worldmap_SetMode'\nDefine the mode of the world map, which can among other things be used to decide if the player character should appear on the world map\nThe mode is set even if no world map is set\n\nr0: world map mode",
19005
+ "GetAttributeBitfieldLiveActor",
19006
+ "Gets the attribute bitfield of a currently loaded actor.\n\nr0: live actor\nr1: [output] pointer to attribute bitfield",
18872
19007
  None,
18873
19008
  )
18874
19009
 
18875
- WorldMapSetCamera = Symbol(
19010
+ SetAttributeBitfieldLiveActorWrapper = Symbol(
18876
19011
  None,
18877
19012
  None,
18878
19013
  None,
18879
- "WorldMapSetCamera",
18880
- "Function called with the script function 'worldmap_SetCamera'.\nSet the map marker the world map should try to center on (while still ensuring it doesn't go over the background border)\nHas no effect if no map is currently set\n\nr0: map marker id",
19014
+ "SetAttributeBitfieldLiveActorWrapper",
19015
+ "Sets bits of the attribute bitfield of a currently loaded actor.\n\nIs a wrapper around SetAttributeBitfieldLiveActor, meaning this calls SetAttributeBitfieldLiveActor with a first parameter of live_actor::id.\n\nr0: live actor\nr1: attribute bitfield",
18881
19016
  None,
18882
19017
  )
18883
19018
 
18884
- StatusUpdate = Symbol(
19019
+ ResetAttributeBitfieldLiveActorWrapper = Symbol(
18885
19020
  None,
18886
19021
  None,
18887
19022
  None,
18888
- "StatusUpdate",
18889
- "Implements SPECIAL_PROC_STATUS_UPDATE (see ScriptSpecialProcessCall).\n\nNo params.",
19023
+ "ResetAttributeBitfieldLiveActorWrapper",
19024
+ "Clears bits of the attribute bitfield of a currently loaded actor.\n\nIs a wrapper around ResetAttributeBitfieldLiveActor, meaning this calls ResetAttributeBitfieldLiveActor with a first parameter of live_actor::id.\n\nr0: live actor\nr1: attribute bitfield",
18890
19025
  None,
18891
19026
  )
18892
19027
 
18893
- HandleTeamStatsGround = Symbol(
19028
+ SetBlinkLiveActor = Symbol(
18894
19029
  None,
18895
19030
  None,
18896
19031
  None,
18897
- "HandleTeamStatsGround",
18898
- "Handles the team stats top screen display in the overworld.\n\nFor some reason the implementation seems considerably jankier in ground mode. In dungeon mode there's this structure for the top screen that has handlers for creating, updating and closing the various top screen layouts in a sort of polymorphic way. Here there's just a separate function for every layout that gets called every frame and seems to have a switch-case to handle everything about it.\n\nNo params.",
19032
+ "SetBlinkLiveActor",
19033
+ "Sets the actor to blink in and out of sight at certain intervals.\n\nr0: live actor\nr1: frame interval for blinking in\nr2: frame interval for blinking out",
18899
19034
  None,
18900
19035
  )
18901
19036
 
18902
- ProcessScriptParam = _Deprecated("ProcessScriptParam", ScriptParamToInt)
19037
+ SetPositionOffsetLiveActor = Symbol(
19038
+ None,
19039
+ None,
19040
+ None,
19041
+ "SetPositionOffsetLiveActor",
19042
+ "Offsets a currently loaded actor's position.\n\nr0: live actor\nr1: pointer to an position offset vector",
19043
+ None,
19044
+ )
18903
19045
 
19046
+ InitPartnerFollowData = Symbol(
19047
+ None,
19048
+ None,
19049
+ None,
19050
+ "InitPartnerFollowData",
19051
+ "Initialize the partner follow data structure, without allocating it (in GROUND_STATE_PTRS)\n\nNo params.",
19052
+ None,
19053
+ )
18904
19054
 
18905
- class NaItcmOverlay11Data:
19055
+ DeleteLiveObject = Symbol(
19056
+ None,
19057
+ None,
19058
+ None,
19059
+ "DeleteLiveObject",
19060
+ "Remove the object from the object list (in GROUND_STATE_PTRS)\n\nr0: the index of the object in the live object list",
19061
+ None,
19062
+ )
18906
19063
 
18907
- OVERLAY11_UNKNOWN_TABLE__NA_2316A38 = Symbol(
19064
+ SetAttributeBitfieldLiveObject = Symbol(
18908
19065
  None,
18909
19066
  None,
18910
19067
  None,
18911
- "OVERLAY11_UNKNOWN_TABLE__NA_2316A38",
18912
- "Multiple entries are pointers to the string 'script.c'\n\nNote: unverified, ported from Irdkwia's notes\n\ntype: undefined4[40]",
18913
- "",
19068
+ "SetAttributeBitfieldLiveObject",
19069
+ "Sets bits of the attribute bitfield of a currently loaded object.\n\nr0: live object id\nr1: attribute bitfield",
19070
+ None,
18914
19071
  )
18915
19072
 
18916
- SCRIPT_COMMAND_PARSING_DATA = Symbol(
19073
+ ResetAttributeBitfieldLiveObject = Symbol(
18917
19074
  None,
18918
19075
  None,
18919
19076
  None,
18920
- "SCRIPT_COMMAND_PARSING_DATA",
18921
- "Used by ScriptCommandParsing somehow",
18922
- "undefined[32]",
19077
+ "ResetAttributeBitfieldLiveObject",
19078
+ "Clears bits of the attribute bitfield of a currently loaded object.\n\nr0: live object id\nr1: attribute bitfield",
19079
+ None,
18923
19080
  )
18924
19081
 
18925
- SCRIPT_OP_CODE_NAMES = Symbol(
19082
+ UnlockObjectRoutines = Symbol(
18926
19083
  None,
18927
19084
  None,
18928
19085
  None,
18929
- "SCRIPT_OP_CODE_NAMES",
18930
- "Opcode name strings pointed to by entries in SCRIPT_OP_CODES (script_opcode::name)",
18931
- "char[0]",
19086
+ "UnlockObjectRoutines",
19087
+ "Attempts to unlock all live object routines of the current script.\n\nr0: lock id\nreturn: True if any script routine was successfully unlocked",
19088
+ None,
18932
19089
  )
18933
19090
 
18934
- SCRIPT_OP_CODES = Symbol(
19091
+ GetCollidingObjectId = Symbol(
18935
19092
  None,
18936
19093
  None,
18937
19094
  None,
18938
- "SCRIPT_OP_CODES",
18939
- "Table of opcodes for the script engine. There are 383 8-byte entries.\n\nThese opcodes underpin the various ExplorerScript functions you can call in the SkyTemple SSB debugger.\n\ntype: struct script_opcode_table",
18940
- "struct script_opcode_table",
19095
+ "GetCollidingObjectId",
19096
+ "Returns the first colliding object given a series of vector coordinates.\n\nr0: attribute bitfield to test objects against\nr1: pointer to coord_min\nr2: pointer to coord_max\nreturn: The first colliding object's id, or -1 if no is collision detected",
19097
+ None,
18941
19098
  )
18942
19099
 
18943
- OVERLAY11_DEBUG_STRINGS = Symbol(
19100
+ SetPositionLiveObject = Symbol(
18944
19101
  None,
18945
19102
  None,
18946
19103
  None,
18947
- "OVERLAY11_DEBUG_STRINGS",
18948
- "Strings used with various debug printing functions throughout the overlay",
18949
- "char[0]",
19104
+ "SetPositionLiveObject",
19105
+ "Sets the position for a currently loaded object.\n\nr0: live object\nr1: pointer to a position vector",
19106
+ None,
18950
19107
  )
18951
19108
 
18952
- C_ROUTINE_NAMES = Symbol(
19109
+ GetIdLiveObject = Symbol(
18953
19110
  None,
18954
19111
  None,
18955
19112
  None,
18956
- "C_ROUTINE_NAMES",
18957
- "Common routine name strings pointed to by entries in C_ROUTINES (common_routine::name)",
18958
- "char[0]",
19113
+ "GetIdLiveObject",
19114
+ "Returns the ID of a currently loaded object. This ID can then be used to index GROUND_STATE_PTRS::objects.\n\nr0: live object\nreturn: id",
19115
+ None,
18959
19116
  )
18960
19117
 
18961
- C_ROUTINES = Symbol(
19118
+ GetCollisionBoxLiveObject = Symbol(
18962
19119
  None,
18963
19120
  None,
18964
19121
  None,
18965
- "C_ROUTINES",
18966
- "Common routines used within the unionall.ssb script (the master script). There are 701 8-byte entries.\n\nThese routines underpin the ExplorerScript coroutines you can call in the SkyTemple SSB debugger.\n\ntype: struct common_routine_table",
18967
- "struct common_routine_table",
19122
+ "GetCollisionBoxLiveObject",
19123
+ "Gets the collision box of a currently loaded object.\n\nr0: live object\nr1: [output] collision box buffer",
19124
+ None,
18968
19125
  )
18969
19126
 
18970
- GROUND_WEATHER_TABLE = Symbol(
19127
+ SetPositionInitialLiveObject = Symbol(
18971
19128
  None,
18972
19129
  None,
18973
19130
  None,
18974
- "GROUND_WEATHER_TABLE",
18975
- "Note: unverified, ported from Irdkwia's notes\n\ntype: struct ground_weather_entry[12]",
18976
- "struct ground_weather_entry[12]",
19131
+ "SetPositionInitialLiveObject",
19132
+ "Sets a currently loaded object to return to its initial position.\n\nr0: live object\nr1: pointer to an position vector; if null, object will return to its initial position",
19133
+ None,
18977
19134
  )
18978
19135
 
18979
- GROUND_WAN_FILES_TABLE = Symbol(
19136
+ SetMovementRangeLiveObject = Symbol(
18980
19137
  None,
18981
19138
  None,
18982
19139
  None,
18983
- "GROUND_WAN_FILES_TABLE",
18984
- "Note: unverified, ported from Irdkwia's notes\n\ntype: char[343][12]",
18985
- "char[343][12]",
19140
+ "SetMovementRangeLiveObject",
19141
+ "Sets a currently loaded object's random movement range.\n\nr0: live object\nr1: pointer to limit_min_pos\nr2: pointer to limit_max_pos",
19142
+ None,
18986
19143
  )
18987
19144
 
18988
- OBJECTS = Symbol(
19145
+ GetCollisionBoxCenterLiveObject = Symbol(
18989
19146
  None,
18990
19147
  None,
18991
19148
  None,
18992
- "OBJECTS",
18993
- "Table of objects for the script engine, which can be placed in scenes. There are a version-dependent number of 12-byte entries.\n\ntype: struct script_object[length / 12]",
18994
- "struct script_object[0]",
19149
+ "GetCollisionBoxCenterLiveObject",
19150
+ "Gets the center of a collision box of a currently loaded object.\n\nThis simply adds the object's minimum coordinates by half the size of the object's collision box.\n\nr0: live object\nr1: [output] collision box center buffer",
19151
+ None,
18995
19152
  )
18996
19153
 
18997
- RECRUITMENT_TABLE_LOCATIONS = Symbol(
19154
+ SetPositionLiveObjectVeneer = Symbol(
18998
19155
  None,
18999
19156
  None,
19000
19157
  None,
19001
- "RECRUITMENT_TABLE_LOCATIONS",
19002
- "Table of dungeon IDs corresponding to entries in RECRUITMENT_TABLE_SPECIES.\n\ntype: struct dungeon_id_16[22]",
19003
- "struct dungeon_id_16[22]",
19158
+ "SetPositionLiveObjectVeneer",
19159
+ "Likely a linker-generated veneer for SetPositionLiveObject.\n\nSee https://developer.arm.com/documentation/dui0474/k/image-structure-and-generation/linker-generated-veneers/what-is-a-veneer-\n\nr0: live object\nr1: pointer to a position vector",
19160
+ None,
19004
19161
  )
19005
19162
 
19006
- RECRUITMENT_TABLE_LEVELS = Symbol(
19163
+ GetHeightLiveObject = Symbol(
19007
19164
  None,
19008
19165
  None,
19009
19166
  None,
19010
- "RECRUITMENT_TABLE_LEVELS",
19011
- "Table of levels for recruited Pokémon, corresponding to entries in RECRUITMENT_TABLE_SPECIES.\n\ntype: int16_t[22]",
19012
- "int16_t[22]",
19167
+ "GetHeightLiveObject",
19168
+ "Gets the two height values of a currently loaded object.\n\nr0: live object\nr1: [output] pointer to first height value\nr2: [output] pointer to second height value, which is curiously not referenced by SetHeightLiveObject",
19169
+ None,
19013
19170
  )
19014
19171
 
19015
- RECRUITMENT_TABLE_SPECIES = Symbol(
19172
+ SetHeightLiveObject = Symbol(
19016
19173
  None,
19017
19174
  None,
19018
19175
  None,
19019
- "RECRUITMENT_TABLE_SPECIES",
19020
- "Table of Pokémon recruited at special locations, such as at the ends of certain dungeons (e.g., Dialga or the Seven Treasures legendaries) or during a cutscene (e.g., Cresselia and Manaphy).\n\nInterestingly, this includes both Heatran genders. It also includes Darkrai for some reason?\n\ntype: struct monster_id_16[22]",
19021
- "struct monster_id_16[22]",
19176
+ "SetHeightLiveObject",
19177
+ "Sets the height of a currently loaded object.\n\nr0: live object\nr1: height",
19178
+ None,
19022
19179
  )
19023
19180
 
19024
- LEVEL_TILEMAP_LIST = Symbol(
19181
+ GetDirectionLiveObject = Symbol(
19025
19182
  None,
19026
19183
  None,
19027
19184
  None,
19028
- "LEVEL_TILEMAP_LIST",
19029
- "Irdkwia's notes: FIXED_FLOOR_GROUND_ASSOCIATION\n\ntype: struct level_tilemap_list_entry[81]",
19030
- "struct level_tilemap_list_entry[81]",
19185
+ "GetDirectionLiveObject",
19186
+ "Gets the direction of a currently loaded object.\n\nr0: live object\nr1: [output] pointer to direction",
19187
+ None,
19031
19188
  )
19032
19189
 
19033
- SETANIMATION_TABLE = Symbol(
19190
+ SetDirectionLiveObject = Symbol(
19034
19191
  None,
19035
19192
  None,
19036
19193
  None,
19037
- "SETANIMATION_TABLE",
19038
- "Table that associates the parameter of the SetAnimation scripting opcode to animation data.\n\nThe first entry is unused and has a value of 0xFFFF.",
19039
- "struct animation_data[84]",
19194
+ "SetDirectionLiveObject",
19195
+ "Sets the direction of a currently loaded object. Does nothing if the direction value passed is -1.\n\nr0: live object\nr1: direction",
19196
+ None,
19197
+ )
19198
+
19199
+ SetAnimationLiveObject = Symbol(
19200
+ None,
19201
+ None,
19202
+ None,
19203
+ "SetAnimationLiveObject",
19204
+ "Sets the animation of a currently loaded object.\n\nr0: live object\nr1: SetAnimation parameter",
19205
+ None,
19206
+ )
19207
+
19208
+ SetEffectLiveObject = Symbol(
19209
+ None,
19210
+ None,
19211
+ None,
19212
+ "SetEffectLiveObject",
19213
+ "Sets the effect of a currently loaded object.\n\nr0: live object\nr1: flag (true if effect id is 0?)\nr2: effect id",
19214
+ None,
19215
+ )
19216
+
19217
+ GetAnimationStatusLiveObject = Symbol(
19218
+ None,
19219
+ None,
19220
+ None,
19221
+ "GetAnimationStatusLiveObject",
19222
+ "Gets the animation status of a currently loaded object.\n\nUsed to determine if the animation has finished via script opcodes like WaitAnimation and WaitEndAnimation.\n\nr0: live object\nreturn: status",
19223
+ None,
19224
+ )
19225
+
19226
+ GetEffectStatusLiveObject = Symbol(
19227
+ None,
19228
+ None,
19229
+ None,
19230
+ "GetEffectStatusLiveObject",
19231
+ "Gets the effect status of a currently loaded object.\n\nUsed to determine if an effect has finished via the script opcode WaitEffect.\n\nr0: live object\nreturn: status",
19232
+ None,
19233
+ )
19234
+
19235
+ GetAttributeBitfieldLiveObject = Symbol(
19236
+ None,
19237
+ None,
19238
+ None,
19239
+ "GetAttributeBitfieldLiveObject",
19240
+ "Gets the attribute bitfield of a currently loaded object.\n\nr0: live object\nr1: [output] pointer to attribute bitfield",
19241
+ None,
19242
+ )
19243
+
19244
+ SetAttributeBitfieldLiveObjectWrapper = Symbol(
19245
+ None,
19246
+ None,
19247
+ None,
19248
+ "SetAttributeBitfieldLiveObjectWrapper",
19249
+ "Sets bits of the attribute bitfield of a currently loaded object.\n\nIs a wrapper around SetAttributeBitfieldLiveObject, meaning this calls SetAttributeBitfieldLiveObject with a first parameter of live_object::id.\n\nr0: live object\nr1: attribute bitfield",
19250
+ None,
19251
+ )
19252
+
19253
+ ResetAttributeBitfieldLiveObjectWrapper = Symbol(
19254
+ None,
19255
+ None,
19256
+ None,
19257
+ "ResetAttributeBitfieldLiveObjectWrapper",
19258
+ "Clears bits of the attribute bitfield of a currently loaded object.\n\nIs a wrapper around ResetAttributeBitfieldLiveObject, meaning this calls ResetAttributeBitfieldLiveObject with a first parameter of live_object::id.\n\nr0: live object\nr1: attribute bitfield",
19259
+ None,
19260
+ )
19261
+
19262
+ SetBlinkLiveObject = Symbol(
19263
+ None,
19264
+ None,
19265
+ None,
19266
+ "SetBlinkLiveObject",
19267
+ "Sets the object to blink in and out of sight at certain intervals.\n\nr0: live object\nr1: frame interval for blinking in\nr2: frame interval for blinking out",
19268
+ None,
19269
+ )
19270
+
19271
+ SetPositionOffsetLiveObject = Symbol(
19272
+ None,
19273
+ None,
19274
+ None,
19275
+ "SetPositionOffsetLiveObject",
19276
+ "Offsets a currently loaded object's position.\n\nr0: live object\nr1: pointer to an position offset vector",
19277
+ None,
19278
+ )
19279
+
19280
+ DeleteLivePerformer = Symbol(
19281
+ None,
19282
+ None,
19283
+ None,
19284
+ "DeleteLivePerformer",
19285
+ "Remove the performer from the performer list (in GROUND_STATE_PTRS)\n\nr0: the index of the performer in the live performer list",
19286
+ None,
19287
+ )
19288
+
19289
+ SetAttributeBitfieldLivePerformer = Symbol(
19290
+ None,
19291
+ None,
19292
+ None,
19293
+ "SetAttributeBitfieldLivePerformer",
19294
+ "Sets bits of the attribute bitfield of a currently loaded performer.\n\nr0: live performer id\nr1: attribute bitfield",
19295
+ None,
19296
+ )
19297
+
19298
+ ResetAttributeBitfieldLivePerformer = Symbol(
19299
+ None,
19300
+ None,
19301
+ None,
19302
+ "ResetAttributeBitfieldLivePerformer",
19303
+ "Clears bits of the attribute bitfield of a currently loaded performer.\n\nr0: live performer id\nr1: attribute bitfield",
19304
+ None,
19305
+ )
19306
+
19307
+ UnlockPerformerRoutines = Symbol(
19308
+ None,
19309
+ None,
19310
+ None,
19311
+ "UnlockPerformerRoutines",
19312
+ "Attempts to unlock all live performer routines of the current script.\n\nr0: lock id\nreturn: True if any script routine was successfully unlocked",
19313
+ None,
19314
+ )
19315
+
19316
+ SetPositionLivePerformer = Symbol(
19317
+ None,
19318
+ None,
19319
+ None,
19320
+ "SetPositionLivePerformer",
19321
+ "Sets the position for a currently loaded performer.\n\nr0: live performer\nr1: pointer to a position vector",
19322
+ None,
19323
+ )
19324
+
19325
+ GetIdLivePerformer = Symbol(
19326
+ None,
19327
+ None,
19328
+ None,
19329
+ "GetIdLivePerformer",
19330
+ "Returns the ID of a currently loaded performer. This ID can then be used to index GROUND_STATE_PTRS::performers.\n\nr0: live performer\nreturn: id",
19331
+ None,
19332
+ )
19333
+
19334
+ GetCollisionBoxLivePerformer = Symbol(
19335
+ None,
19336
+ None,
19337
+ None,
19338
+ "GetCollisionBoxLivePerformer",
19339
+ "Gets the collision box of a currently loaded performer.\n\nr0: live performer\nr1: [output] collision box buffer",
19340
+ None,
19341
+ )
19342
+
19343
+ SetPositionInitialLivePerformer = Symbol(
19344
+ None,
19345
+ None,
19346
+ None,
19347
+ "SetPositionInitialLivePerformer",
19348
+ "Sets a currently loaded performer to return to its initial position.\n\nr0: live performer\nr1: pointer to an position vector; if null, performer will return to its initial position",
19349
+ None,
19350
+ )
19351
+
19352
+ SetMovementRangeLivePerformer = Symbol(
19353
+ None,
19354
+ None,
19355
+ None,
19356
+ "SetMovementRangeLivePerformer",
19357
+ "Sets a currently loaded performer's random movement range.\n\nr0: live performer\nr1: pointer to limit_min_pos\nr2: pointer to limit_max_pos",
19358
+ None,
19359
+ )
19360
+
19361
+ GetCollisionBoxCenterLivePerformer = Symbol(
19362
+ None,
19363
+ None,
19364
+ None,
19365
+ "GetCollisionBoxCenterLivePerformer",
19366
+ "Gets the center of a collision box of a currently loaded performer.\n\nThis simply adds the performer's minimum coordinates by half the size of the performer's collision box.\n\nr0: live performer\nr1: [output] collision box center buffer",
19367
+ None,
19368
+ )
19369
+
19370
+ SetPositionLivePerformerVeneer = Symbol(
19371
+ None,
19372
+ None,
19373
+ None,
19374
+ "SetPositionLivePerformerVeneer",
19375
+ "Likely a linker-generated veneer for SetPositionLivePerformer.\n\nSee https://developer.arm.com/documentation/dui0474/k/image-structure-and-generation/linker-generated-veneers/what-is-a-veneer-\n\nr0: live performer\nr1: pointer to a position vector",
19376
+ None,
19377
+ )
19378
+
19379
+ GetHeightLivePerformer = Symbol(
19380
+ None,
19381
+ None,
19382
+ None,
19383
+ "GetHeightLivePerformer",
19384
+ "Gets the two height values of a currently loaded performer.\n\nr0: live performer\nr1: [output] pointer to first height value\nr2: [output] pointer to second height value, which is curiously not referenced by SetHeightLivePerformer",
19385
+ None,
19386
+ )
19387
+
19388
+ SetHeightLivePerformer = Symbol(
19389
+ None,
19390
+ None,
19391
+ None,
19392
+ "SetHeightLivePerformer",
19393
+ "Sets the height of a currently loaded performer.\n\nr0: live performer\nr1: height",
19394
+ None,
19395
+ )
19396
+
19397
+ GetDirectionLivePerformer = Symbol(
19398
+ None,
19399
+ None,
19400
+ None,
19401
+ "GetDirectionLivePerformer",
19402
+ "Gets the direction of a currently loaded performer.\n\nr0: live performer\nr1: [output] pointer to direction",
19403
+ None,
19404
+ )
19405
+
19406
+ SetDirectionLivePerformer = Symbol(
19407
+ None,
19408
+ None,
19409
+ None,
19410
+ "SetDirectionLivePerformer",
19411
+ "Sets the direction of a currently loaded performer. Does nothing if the direction value passed is -1.\n\nr0: live performer\nr1: direction",
19412
+ None,
19413
+ )
19414
+
19415
+ SetAnimationLivePerformer = Symbol(
19416
+ None,
19417
+ None,
19418
+ None,
19419
+ "SetAnimationLivePerformer",
19420
+ "Sets the animation of a currently loaded performer.\n\nr0: live performer\nr1: SetAnimation parameter",
19421
+ None,
19422
+ )
19423
+
19424
+ SetEffectLivePerformer = Symbol(
19425
+ None,
19426
+ None,
19427
+ None,
19428
+ "SetEffectLivePerformer",
19429
+ "Sets the effect of a currently loaded performer.\n\nr0: live performer\nr1: flag (true if effect id is 0?)\nr2: effect id",
19430
+ None,
19431
+ )
19432
+
19433
+ GetAnimationStatusLivePerformer = Symbol(
19434
+ None,
19435
+ None,
19436
+ None,
19437
+ "GetAnimationStatusLivePerformer",
19438
+ "Gets the animation status of a currently loaded performer.\n\nUsed to determine if the animation has finished via script opcodes like WaitAnimation and WaitEndAnimation.\n\nr0: live performer\nreturn: status",
19439
+ None,
19440
+ )
19441
+
19442
+ GetEffectStatusLivePerformer = Symbol(
19443
+ None,
19444
+ None,
19445
+ None,
19446
+ "GetEffectStatusLivePerformer",
19447
+ "Gets the effect status of a currently loaded performer.\n\nUsed to determine if an effect has finished via the script opcode WaitEffect.\n\nr0: live performer\nreturn: status",
19448
+ None,
19449
+ )
19450
+
19451
+ GetAttributeBitfieldLivePerformer = Symbol(
19452
+ None,
19453
+ None,
19454
+ None,
19455
+ "GetAttributeBitfieldLivePerformer",
19456
+ "Gets the attribute bitfield of a currently loaded performer.\n\nr0: live performer\nr1: [output] pointer to attribute bitfield",
19457
+ None,
19458
+ )
19459
+
19460
+ SetAttributeBitfieldLivePerformerWrapper = Symbol(
19461
+ None,
19462
+ None,
19463
+ None,
19464
+ "SetAttributeBitfieldLivePerformerWrapper",
19465
+ "Sets bits of the attribute bitfield of a currently loaded performer.\n\nIs a wrapper around SetAttributeBitfieldLivePerformer, meaning this calls SetAttributeBitfieldLivePerformer with a first parameter of live_performer::id.\n\nr0: live performer\nr1: attribute bitfield",
19466
+ None,
19467
+ )
19468
+
19469
+ ResetAttributeBitfieldLivePerformerWrapper = Symbol(
19470
+ None,
19471
+ None,
19472
+ None,
19473
+ "ResetAttributeBitfieldLivePerformerWrapper",
19474
+ "Clears bits of the attribute bitfield of a currently loaded performer.\n\nIs a wrapper around ResetAttributeBitfieldLivePerformer, meaning this calls ResetAttributeBitfieldLivePerformer with a first parameter of live_performer::id.\n\nr0: live performer\nr1: attribute bitfield",
19475
+ None,
19476
+ )
19477
+
19478
+ SetBlinkLivePerformer = Symbol(
19479
+ None,
19480
+ None,
19481
+ None,
19482
+ "SetBlinkLivePerformer",
19483
+ "Sets the performer to blink in and out of sight at certain intervals.\n\nr0: live performer\nr1: frame interval for blinking in\nr2: frame interval for blinking out",
19484
+ None,
19485
+ )
19486
+
19487
+ SetPositionOffsetLivePerformer = Symbol(
19488
+ None,
19489
+ None,
19490
+ None,
19491
+ "SetPositionOffsetLivePerformer",
19492
+ "Offsets a currently loaded performer's position.\n\nr0: live performer\nr1: pointer to an position offset vector",
19493
+ None,
19494
+ )
19495
+
19496
+ DeleteLiveEvent = Symbol(
19497
+ None,
19498
+ None,
19499
+ None,
19500
+ "DeleteLiveEvent",
19501
+ "Remove the event from the event list (in GROUND_STATE_PTRS)\n\nr0: the index of the event in the live event list",
19502
+ None,
19503
+ )
19504
+
19505
+ GetCollidingEventId = Symbol(
19506
+ None,
19507
+ None,
19508
+ None,
19509
+ "GetCollidingEventId",
19510
+ "Returns the first colliding event given a series of vector coordinates.\n\nr0: attribute bitfield to test events against\nr1: pointer to coord_min\nr2: pointer to coord_max\nreturn: The first colliding event's id, or -1 if no is collision detected",
19511
+ None,
19512
+ )
19513
+
19514
+ CreateTeamInfoBox = Symbol(
19515
+ None,
19516
+ None,
19517
+ None,
19518
+ "CreateTeamInfoBox",
19519
+ "Creates a window containing team information (rank and money carried) for the top-level menu in ground mode. Also see struct team_info_box.\n\nThe new window will always default to TEAM_INFO_BOX_DEFAULT_WINDOW_PARAMS.\n\nreturn: window_id",
19520
+ None,
19521
+ )
19522
+
19523
+ CloseTeamInfoBox = Symbol(
19524
+ None,
19525
+ None,
19526
+ None,
19527
+ "CloseTeamInfoBox",
19528
+ "Closes a window created with CreateTeamInfoBox.\n\nr0: window_id",
19529
+ None,
19530
+ )
19531
+
19532
+ IsTeamInfoBoxActive = Symbol(
19533
+ None,
19534
+ None,
19535
+ None,
19536
+ "IsTeamInfoBoxActive",
19537
+ "This is a guess.\n\nChecks if the state of a team info box is not 5.\n\nr0: window_id\nreturn: bool",
19538
+ None,
19539
+ )
19540
+
19541
+ UpdateTeamInfoBox = Symbol(
19542
+ None,
19543
+ None,
19544
+ None,
19545
+ "UpdateTeamInfoBox",
19546
+ "Window update function for team info boxes.\n\nr0: window pointer",
19547
+ None,
19548
+ )
19549
+
19550
+ CreateTopGroundMenu = Symbol(
19551
+ None,
19552
+ None,
19553
+ None,
19554
+ "CreateTopGroundMenu",
19555
+ "Creates a parent menu (containing Items, Team, etc.) and two other windows upon pressing X in the overworld.\n\nreturn: always 1",
19556
+ None,
19557
+ )
19558
+
19559
+ CloseTopGroundMenu = Symbol(
19560
+ None,
19561
+ None,
19562
+ None,
19563
+ "CloseTopGroundMenu",
19564
+ "Closes the three windows created by CreateOverworldMenu.\n\nNo params.",
19565
+ None,
19566
+ )
19567
+
19568
+ UpdateTopGroundMenu = Symbol(
19569
+ None,
19570
+ None,
19571
+ None,
19572
+ "UpdateTopGroundMenu",
19573
+ "Window update function for the top-level ground mode menu.\n\nreturn: status code",
19574
+ None,
19575
+ )
19576
+
19577
+ IsBagNotEmpty = Symbol(
19578
+ None,
19579
+ None,
19580
+ None,
19581
+ "IsBagNotEmpty",
19582
+ "Checks if the bag has at least one valid item. Notably used in CreateTopGroundMenu to decide if the 'Items' option should be enabled.\n\nreturn: bool",
19583
+ None,
19584
+ )
19585
+
19586
+ SprintfStatic = Symbol(
19587
+ None,
19588
+ None,
19589
+ None,
19590
+ "SprintfStatic",
19591
+ "Statically defined copy of sprintf(3) in overlay 11. See arm9.yml for more information.\n\nr0: str\nr1: format\n...: variadic\nreturn: number of characters printed, excluding the null-terminator",
19592
+ None,
19593
+ )
19594
+
19595
+ GetExclusiveItemRequirements = Symbol(
19596
+ None,
19597
+ None,
19598
+ None,
19599
+ "GetExclusiveItemRequirements",
19600
+ "Used to calculate the items required to get a certain exclusive item in the swap shop.\n\nr0: ?\nr1: ?",
19601
+ None,
19602
+ )
19603
+
19604
+ HandleControlsTopScreenGround = Symbol(
19605
+ None,
19606
+ None,
19607
+ None,
19608
+ "HandleControlsTopScreenGround",
19609
+ "Handles the controls top screen display in the overworld.\n\nFor some reason the implementation seems considerably jankier in ground mode. In dungeon mode there's this structure for the top screen that has handlers for creating, updating and closing the various top screen layouts in a sort of polymorphic way. Here there's just a separate function for every layout that gets called every frame and seems to have a switch-case to handle everything about it.\n\nNo params.",
19610
+ None,
19611
+ )
19612
+
19613
+ GetDungeonMapPos = Symbol(
19614
+ None,
19615
+ None,
19616
+ None,
19617
+ "GetDungeonMapPos",
19618
+ "Checks if a dungeon should be displayed on the map and the position where it should be displayed if so.\n\nr0: [Output] Buffer where the coordinates of the map marker will be stored. The coordinates are shifted 8 bits to the left, so they are probably fixed-point numbers instead of integers.\nr1: Dungeon ID\nreturn: True if the dungeon should be displayed on the map, false otherwise.",
19619
+ None,
19620
+ )
19621
+
19622
+ WorldMapSetMode = Symbol(
19623
+ None,
19624
+ None,
19625
+ None,
19626
+ "WorldMapSetMode",
19627
+ "Function called by the script function 'worldmap_SetMode'\nDefine the mode of the world map, which can among other things be used to decide if the player character should appear on the world map\nThe mode is set even if no world map is set\n\nr0: world map mode",
19628
+ None,
19629
+ )
19630
+
19631
+ WorldMapSetCamera = Symbol(
19632
+ None,
19633
+ None,
19634
+ None,
19635
+ "WorldMapSetCamera",
19636
+ "Function called with the script function 'worldmap_SetCamera'.\nSet the map marker the world map should try to center on (while still ensuring it doesn't go over the background border)\nHas no effect if no map is currently set\n\nr0: map marker id",
19637
+ None,
19638
+ )
19639
+
19640
+ StatusUpdate = Symbol(
19641
+ None,
19642
+ None,
19643
+ None,
19644
+ "StatusUpdate",
19645
+ "Implements SPECIAL_PROC_STATUS_UPDATE (see ScriptSpecialProcessCall).\n\nNo params.",
19646
+ None,
19647
+ )
19648
+
19649
+ HandleTeamStatsGround = Symbol(
19650
+ None,
19651
+ None,
19652
+ None,
19653
+ "HandleTeamStatsGround",
19654
+ "Handles the team stats top screen display in the overworld.\n\nFor some reason the implementation seems considerably jankier in ground mode. In dungeon mode there's this structure for the top screen that has handlers for creating, updating and closing the various top screen layouts in a sort of polymorphic way. Here there's just a separate function for every layout that gets called every frame and seems to have a switch-case to handle everything about it.\n\nNo params.",
19655
+ None,
19656
+ )
19657
+
19658
+ ProcessScriptParam = _Deprecated("ProcessScriptParam", ScriptParamToInt)
19659
+
19660
+
19661
+ class NaItcmOverlay11Data:
19662
+
19663
+ OVERLAY11_UNKNOWN_TABLE__NA_2316A38 = Symbol(
19664
+ None,
19665
+ None,
19666
+ None,
19667
+ "OVERLAY11_UNKNOWN_TABLE__NA_2316A38",
19668
+ "Multiple entries are pointers to the string 'script.c'\n\nNote: unverified, ported from Irdkwia's notes\n\ntype: undefined4[40]",
19669
+ "",
19670
+ )
19671
+
19672
+ SCRIPT_COMMAND_PARSING_DATA = Symbol(
19673
+ None,
19674
+ None,
19675
+ None,
19676
+ "SCRIPT_COMMAND_PARSING_DATA",
19677
+ "Used by ScriptCommandParsing somehow",
19678
+ "undefined[32]",
19679
+ )
19680
+
19681
+ SCRIPT_OP_CODE_NAMES = Symbol(
19682
+ None,
19683
+ None,
19684
+ None,
19685
+ "SCRIPT_OP_CODE_NAMES",
19686
+ "Opcode name strings pointed to by entries in SCRIPT_OP_CODES (script_opcode::name)",
19687
+ "char[0]",
19688
+ )
19689
+
19690
+ SCRIPT_OP_CODES = Symbol(
19691
+ None,
19692
+ None,
19693
+ None,
19694
+ "SCRIPT_OP_CODES",
19695
+ "Table of opcodes for the script engine. There are 383 8-byte entries.\n\nThese opcodes underpin the various ExplorerScript functions you can call in the SkyTemple SSB debugger.\n\ntype: struct script_opcode_table",
19696
+ "struct script_opcode_table",
19697
+ )
19698
+
19699
+ OVERLAY11_DEBUG_STRINGS = Symbol(
19700
+ None,
19701
+ None,
19702
+ None,
19703
+ "OVERLAY11_DEBUG_STRINGS",
19704
+ "Strings used with various debug printing functions throughout the overlay",
19705
+ "char[0]",
19706
+ )
19707
+
19708
+ C_ROUTINE_NAMES = Symbol(
19709
+ None,
19710
+ None,
19711
+ None,
19712
+ "C_ROUTINE_NAMES",
19713
+ "Common routine name strings pointed to by entries in C_ROUTINES (common_routine::name)",
19714
+ "char[0]",
19715
+ )
19716
+
19717
+ C_ROUTINES = Symbol(
19718
+ None,
19719
+ None,
19720
+ None,
19721
+ "C_ROUTINES",
19722
+ "Common routines used within the unionall.ssb script (the master script). There are 701 8-byte entries.\n\nThese routines underpin the ExplorerScript coroutines you can call in the SkyTemple SSB debugger.\n\ntype: struct common_routine_table",
19723
+ "struct common_routine_table",
19724
+ )
19725
+
19726
+ GROUND_WEATHER_TABLE = Symbol(
19727
+ None,
19728
+ None,
19729
+ None,
19730
+ "GROUND_WEATHER_TABLE",
19731
+ "Note: unverified, ported from Irdkwia's notes\n\ntype: struct ground_weather_entry[12]",
19732
+ "struct ground_weather_entry[12]",
19733
+ )
19734
+
19735
+ GROUND_WAN_FILES_TABLE = Symbol(
19736
+ None,
19737
+ None,
19738
+ None,
19739
+ "GROUND_WAN_FILES_TABLE",
19740
+ "Note: unverified, ported from Irdkwia's notes\n\ntype: char[343][12]",
19741
+ "char[343][12]",
19742
+ )
19743
+
19744
+ OBJECTS = Symbol(
19745
+ None,
19746
+ None,
19747
+ None,
19748
+ "OBJECTS",
19749
+ "Table of objects for the script engine, which can be placed in scenes. There are a version-dependent number of 12-byte entries.\n\ntype: struct script_object[length / 12]",
19750
+ "struct script_object[0]",
19751
+ )
19752
+
19753
+ RECRUITMENT_TABLE_LOCATIONS = Symbol(
19754
+ None,
19755
+ None,
19756
+ None,
19757
+ "RECRUITMENT_TABLE_LOCATIONS",
19758
+ "Table of dungeon IDs corresponding to entries in RECRUITMENT_TABLE_SPECIES.\n\ntype: struct dungeon_id_16[22]",
19759
+ "struct dungeon_id_16[22]",
19760
+ )
19761
+
19762
+ RECRUITMENT_TABLE_LEVELS = Symbol(
19763
+ None,
19764
+ None,
19765
+ None,
19766
+ "RECRUITMENT_TABLE_LEVELS",
19767
+ "Table of levels for recruited Pokémon, corresponding to entries in RECRUITMENT_TABLE_SPECIES.\n\ntype: int16_t[22]",
19768
+ "int16_t[22]",
19769
+ )
19770
+
19771
+ RECRUITMENT_TABLE_SPECIES = Symbol(
19772
+ None,
19773
+ None,
19774
+ None,
19775
+ "RECRUITMENT_TABLE_SPECIES",
19776
+ "Table of Pokémon recruited at special locations, such as at the ends of certain dungeons (e.g., Dialga or the Seven Treasures legendaries) or during a cutscene (e.g., Cresselia and Manaphy).\n\nInterestingly, this includes both Heatran genders. It also includes Darkrai for some reason?\n\ntype: struct monster_id_16[22]",
19777
+ "struct monster_id_16[22]",
19778
+ )
19779
+
19780
+ LEVEL_TILEMAP_LIST = Symbol(
19781
+ None,
19782
+ None,
19783
+ None,
19784
+ "LEVEL_TILEMAP_LIST",
19785
+ "Irdkwia's notes: FIXED_FLOOR_GROUND_ASSOCIATION\n\ntype: struct level_tilemap_list_entry[81]",
19786
+ "struct level_tilemap_list_entry[81]",
19787
+ )
19788
+
19789
+ ACTOR_FUNCTION_TABLE = Symbol(
19790
+ None,
19791
+ None,
19792
+ None,
19793
+ "ACTOR_FUNCTION_TABLE",
19794
+ "A function pointer table accessed when performing script opcodes on actors.",
19795
+ "struct ground_entity_function_table",
19796
+ )
19797
+
19798
+ SETANIMATION_TABLE = Symbol(
19799
+ None,
19800
+ None,
19801
+ None,
19802
+ "SETANIMATION_TABLE",
19803
+ "Table that associates the parameter of the SetAnimation scripting opcode to animation data.\n\nThe first entry is unused and has a value of 0xFFFF.",
19804
+ "struct animation_data[84]",
19805
+ )
19806
+
19807
+ OBJECT_FUNCTION_TABLE = Symbol(
19808
+ None,
19809
+ None,
19810
+ None,
19811
+ "OBJECT_FUNCTION_TABLE",
19812
+ "A function pointer table accessed when performing script opcodes on objects.",
19813
+ "struct ground_entity_function_table",
19814
+ )
19815
+
19816
+ PERFORMER_FUNCTION_TABLE = Symbol(
19817
+ None,
19818
+ None,
19819
+ None,
19820
+ "PERFORMER_FUNCTION_TABLE",
19821
+ "A function pointer table accessed when performing script opcodes on performers.",
19822
+ "struct ground_entity_function_table",
19040
19823
  )
19041
19824
 
19042
19825
  TEAM_INFO_BOX_DEFAULT_WINDOW_PARAMS = Symbol(