SkyTemple - User contributions [en]

List of Script Variables

2026-02-15T22:03:08Z

Happylappy:

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [140] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.
{| class="wikitable"
!Number
!Used By
!Where's used
!Notes
|-
|0
|N/A
|N/A
|Presumed Unused.
|-
|1
|Cafe Client
|P01P04A\enter11.ssb
|Used by the Cafe Client for the Gabite Mission, and the 7-Treasures Missions. In both Mission types, it's used to skip the lengthy exposition for the mission if the player declined the job earlier in the day.
|-
|2
|Spoink
|Various
|Used in all of Spoink's talk scripts. Used to remember if Spoink has given the player their helpful exploration tip about enemies not moving unless you do.
|-
|3-22
|Chimecho
|G01P03A
|Used in all of Chimecho's talk scripts. Flag 18 is unused!
|-
|23, 24, 26
|Dugtrio
|Various
|Used in all of Dugtrio's talk scripts. Flag 25 is unused! Likely related to triggering CORO_EVENT_M00_04.
|-
|27, 28
|Pink Celebi
|D23P11A\um19
|Used in both Celebi talk scripts for the player to probe deeper about her not minding that she gets to spend more time with Grovyle.
|-
|29-40
|Croagunk
|G01P04A\enter05.ssb
|Flags 36 and 38 are unused! By mistake, 37 and 39 are used two separate times for Croagunk's dialogue!
|-
|41
|Cresselia
|Various
|Used in all of Cresselia's talk scripts. Used to remember if the player has rejected recruiting her to the team. Intended to only appear in H01P99A.
|-
|42
|N/A
|N/A
|Presumed unused.
|-
|43-47
|Lapras
|D01P01A
|Used in all of Lapras' talk scripts.
|-
|48
|Vigoroth
|T01P02A
|Used for Vigoroth to give a shortened advertisement for the Marowak Dojo. Apparently he's "sponsored".
|-
|49, 50
|Chatot
|Various
|Used in all of Chatot's talk scripts. Used for dialogue relating to the player going to Amp Plains. Intended to only appear in G01P04A.
|-
|51-59
|Electivire
|T01P01A\enter06.ssb
|
|-
|60-62
|Marowak (Main Story)
|T01P03A\enter07.ssb
|
|-
|63-71
|Kangaskhan
|T01P02A\enter10.ssb
|
|-
|72-83
|Green Kecleon
|T01P02A\enter12.ssb
|
|-
|84-95
|Purple Kecleon
|T01P02A\enter11.ssb
|
|-
|96-102
|Xatu
|T01P02A\enter09.ssb
|
|-
|103-109
|Chansey
|T01P01A\enter07.ssb
|
|-
|110-118
|Duskull
|T01P01A\enter05.ssb
|
|-
|119
|Pelipper (Rescue)
|S01P02A\enter02.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Go Rescue" on the main menu.
|-
|120
|Pelipper (Explore)
|S01P02A\enter07.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Standby Adventure" on the main menu.
|-
|121
|Partner
|Various
|Used during the main story (Main 22, before Brine Cave) to remember if the partner has told the hero they want to check back on Sharpedo Bluff for Grovyle. If enabled, this flag will activate related R-button partner dialogue and prevent the player from triggering the same "Let's go check out Sharpedo Bluff!" dialogue in T01P02A if it has already been triggered in T01P01A.
|-
|122
|Shaymin (Guide)
|Various
|Used in all of Shaymin's talk scripts throughout the mountain. Remembers if the player has rejected recruiting them to the team. Likely only intended to appear at the summit?
|-
|123
|Shaymin (Sky Gift)
|D73P11A
|Used to remember if Shaymin has told the player about Sky Gift delivery.
|-
|124
|N/A
|N/A
|Presumed unused.
|-
|125
|Pachirisu
|Various
|Used in all of Pachirisu's talk scripts. Remembers if the player has received a Sky Gift from Pachirisu or not. Likely intended to be used somewhere on the mountain.
|-
|126
|Marowak (Bidoof)
|T01P03A\enter08.ssb
|Used to remember if Bidoof has claimed Marowak's Reviver Seed in the special episode. Reset at the beginning of the episode!
|-
|127
|Kangakshan (Bidoof)
|T01P02A\un0103.ssb
|Used to remember if Bidoof has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|128
|Duskull (Bidoof)
|T01P01A\un0101.ssb
|Used to remember if Bidoof has talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|129
|Green Kecleon (Bidoof)
|T01P02A\un0101.ssb
|Used to remember if Bidoof has talked with Green Kecleon in the episode before. Reset at the beginning of the episode!
|-
|130
|Purple Kecleon (Bidoof)
|T01P02A\un0102.ssb
|Used to remember if Bidoof has talked with Purple Kecleon in the episode before. Reset at the beginning of the episode!
|-
|131
|Wigglytuff (Bidoof)
|G01P05A\un0101.ssb
|Used to remember if Bidoof has talked with Wigglytuff after unlocking Deep Star Cave in the episode before. Runs CORO_EVENT_N00_01 if not.
Reset at the beginning of the episode!
|-
|132
|Bidoof (Sunflora)
|G01P03A\un0401.ssb
|Used to remember if Sunflora has talked with Bidoof in the episode before.
Reset at the beginning of the episode!
|-
|133
|Chimecho (Sunflora)
|G01P03A\un0402.ssb
|Used to remember if Sunflora has talked with Chimecho in the episode before.
Reset at the beginning of the episode!
|-
|134
|Dugtrio (Sunflora)
|H01P99A\un0401.ssb
|Used to remeber if Sunflora has talked with Dugtrio in the episode before.
Reset at the beginning of the episode!
|-
|135
|Kangaskhan (Sunflora)
|T01P02A\un0404.ssb
|Used to remember if Sunflora has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|136
|Green Kecleon (Sunflora)
|T01P02A\un0406.ssb
|Used to remember if Sunflora has talked with Green Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|137
|Purple Kecleon (Sunflora)
|T01P02A\un0405.ssb
|Used to remember if Sunflora has talked with Purple Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|138
|Vigoroth (Sunflora)
|T01P01A\un0404.ssb
|Used to remember if Sunflora was advertised to by Vigoroth in the episode before.
Reset at the beginning of the episode!
|-
|139
|Team Flame (Sunflora)
|G01P03A\un0405.ssb
|Used to remember if Sunflora talked with Bellsprout of Team Flame in the episode before. Reset at the beginning of the episode!
|-
|140
|Duskull (Sunflora)
|T01P01A\un0405.ssb
|Used to remember if Sunflora talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|141+
|N/A
|N/A
|Presumed unused.
|}

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value. Is also used as a general game progression marker by other things, restriction certain mission types, the croagunk swap shop being able to contain a water float, and other things like that.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

If not 215, PROCESS_SPECIAL_DUNGEON_HAD_REQUEST_DONE will assume no missions were completed without checking DUNGEON_ENTER_INDEX.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used (Or mission cleared and left mid-dungeon)
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
When called by LoadScriptVariableValue(), will always return 1. Seems unused outside of this.

=== 0x3b - UNIT_SUM ===
In a switch case, will return the number of pokemon in the active team. Cannot be written to, only read. Skytemple's Variable reader will mistakenly read this as zero, as the script variable slot itself is unused, and the number of team members is a hardcoded return from LoadScriptVariable.

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by Wigglytuff to determine the color of the aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between acting scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used exclusively by the debug town. Unused in the context of vanilla EoS.

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Opcodes

2026-02-06T21:51:00Z

Happylappy: World Map Mode documentation

The scripting engine used in Explorers of Sky has different opcodes. [[ExplorerScript]] translates most of them literally, preserving the same parameters and functionality. However, some opcodes are translated to [[ExplorerScript]] constructs, such as if statements.

This article documents the different opcodes, their purpose and parameters. The purpose of unkX parameters is unknown.

== What is an opcode? ==
An opcode is an instruction to the machine (it tells the machine to 'do' something). In modern programming, it would be most similar to a [https://en.wikipedia.org/wiki/Function_(computer_programming) function]. For a more technical description, see [https://en.wikipedia.org/wiki/Opcode here].

== Types of parameters ==
* uint: An unsigned integer (a number without decimals). It cannot be negative. It is possible that in the game's code, there are only signed integers and no unsigned integers, but not enough research has been done on the matter. For the most part, it shouldn't matter.
* sint: A signed integer (a number without decimals). It can be either positive or negative.
* bitfield: A bitfield is uint where each bits (0 or 1) are treated independantly. They are used to store multiple binary (boolean) values efficiently. Opcodes that use it usually come in the <code>Set</code> and <code>Reset</code> variant. The <code>Set</code> variant define to true the values which are 1 in the input bitfield (while leaving the others untouched), and <code>Reset</code> define to false the values which are 1 in the input bitfield (while also leaving the others untouched).
* String: Text (i.e dialogue). There should always be a quotation mark (") at the beginning and end.
* ConstString: Same as String.
* Routine: Any of the 701 coroutines from [[Unionall]]. Always begins with "CORO_"
* Entity: An actor, performer. (not an object!)
* Object: An object in a scene. (not an actor or perfomer!)
* Level: Any level from the [[Script Engine|Level List]]. Will always begin with "LEVEL_".
* Bgm: Any music in the game. Will always begin with "BGM_". (example: BGM_CRAGGY_COAST)
* PositionMark: A position. Will be written as "Position<'MarkName', x, y>". Once a position mark is written in a script, SkyTemple will show an option to place it visually in the scene.
* Face: A portrait expression. Will always begin with "FACE_". (examples: FACE_NORMAL, FACE_HAPPY, FACE_PAIN)
* FaceMode: A portrait position. Will always begin with "FACE_MODE_".
* Direction: A direction for an entity to move in or turn to. Will always begin with "DIR_". (examples: DIR_UP, DIR_RIGHT)
* ProcessSpecial: One of the games special processes. Can be referred to by its number, or name.
* Effect: A graphical effect.
* GameVar: Any of the game's [[List of Script Variables|Script Variables]]. Will always begin with "$".

== Relevant Opcodes ==
These opcodes can be directly called from ExplorerScript.

=== 0x0 - Null ===
Does nothing.

No parameters.
=== 0x1 - back_ChangeGround ===
Sets the Map Background from a Level without changing the chunks from the currently loaded Map Background. Entities such as actors, objects, and performers will not be deleted when this opcode is executed.

This has very few uses in the game—a notable use is how Wigglytuff's Chamber has its door open, as seen via LEVEL_G01P04A and LEVEL_G01P04A2.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x2 - back_SetBackEffect ===
Performs various effects related to the currently loaded Animation Palettes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x3 - back_SetBackScrollOffset ===
Shifts the background by a certain number of pixels, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level is hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level is hardcoded.
|}

=== 0x4 - back_SetBackScrollSpeed ===
Continuously scrolls the background at a certain speed, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint16
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint16
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x5 - back_SetBanner ===
Displays broken text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x6 - back_SetBanner2 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is typically used for chapter introductions, which includes chapter text and a subtitle displayed over a Map Background. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|-
|2
|uint
|unk1
|Currently unknown. Typically, the game uses 0 for this parameter, but it seems to have no effect.
|-
|3
|uint
|x
|The pixel position the camera will center the Map Background on its X-axis.
|-
|4
|uint
|y
|The pixel position the camera will center the Map Background on its Y-axis.
|-
|5
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|6
|String
|title
|The title of the chapter, e.g., "A Storm At Sea" for Chapter 1.
|}
=== 0x7 - back_SetEffect ===
Performs various effects related to the current Map Background's layers across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x8 - back_SetDungeonBanner ===
Displays a specific string using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. The text chosen is defined in Dungeons tab as a dungeon's <code>back_SetDungeonBanner</code> string. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|The ID of a dungeon, as listed in the Dungeons tab of SkyTemple.
|-
|2
|uint
|unk1
|Currently unknown. Does not seem to affect much.
|}
=== 0x9 - back_SetGround ===
Sets the Map Background from a Level. Upon using this opcode, the variable <code>$GROUND_MAP</code> will be updated to match the ID of the chosen Level. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0xa - back_SetSpecialEpisodeBanner ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is used for Special Episodes 1-3. This opcode plays a short animation of a green line shooting across the screen, followed by text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xb - back_SetSpecialEpisodeBanner2 ===
Displays text using the <code>FONT/banner_c.bin:FONT/b_pal_r.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 4. This opcode features an elaborate animation featuring hearts and sparkles, along with text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xc - back_SetSpecialEpisodeBanner3 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 5. This opcode features no animation, but the end result is similar to the opcode <code>back_SetSpecialEpisodeBanner</code>. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xd - back_SetTitleBanner ===
Displays user-defined text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|y
|The Y-axis pixel position of the title.
|-
|2
|String
|title
|The title displayed on the Touch Screen.
|}
=== 0xe - back_SetWeather ===
Displays a weather effect that overlays the current Map Background.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}
=== 0xf - back_SetWeatherEffect ===
Currently unknown. The only values this opcode accepts seems to be 1, 2, and 3. Value 3 was previously used in S02P01A/m00a01a.ssb in Time/Darkness, for its iteration of the personality test. In Sky, its only use is in V00P02/m01a04a.ssb, which is a leftover test script used by the developers to test the visuals of the Time/Darkness iteration of the aura test.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}

=== 0x10 - back_SetWeatherScrollOffset ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x11 - back_SetWeatherScrollSpeed ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x12 - back2_SetBackEffect ===
The same as <code>back_SetBackEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect_id
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x13 - back2_SetBackScrollOffset ===
The same as <code>back_SetBackScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}

=== 0x14 - back2_SetBackScrollSpeed ===
The same as <code>back_SetBackScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x15 - back2_SetData ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x16 - back2_SetEffect ===
The same as <code>back_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x17 - back2_SetGround ===
Mostly the same as <code>back_SetGround</code>, but for the Top Screen. This opcode only works if <code>back2_SetMode(4);</code> is used prior to this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x18 - back2_SetMode ===
Determines a hardcoded status of the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|A value of 0 is no mode. A negative value seems to set the Top Screen to the overworld's current Top Screen setting.

# Fades out the Top Screen.
# Team Stats.
# The Map Background S01P01A with the hero idling on a World Map Marker.
# Allows for the Top Screen to display a Map Background from a Level using the <code>back2_SetGround</code> opcode.
# Splits the Map Background used in the Level defined by <code>back_SetGround</code> equally between the Top and Touch Screen.
#Splits the Map Background used in the Level defined by <code>back_SetGround</code> between the Top and Touch Screen.
|}
=== 0x19 - back2_SetSpecialActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0x1a - back2_SetWeather ===
The same as <code>back_SetWeather</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}

=== 0x1b - back2_SetWeatherEffect ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x1c - back2_SetWeatherScrollOffset ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1d - back2_SetWeatherScrollSpeed ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1e - bgm_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x1f - bgm_Play ===
Instantly plays a BGM on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x20 - bgm_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x21 - bgm_Stop ===
Instantly stops the BGM that is currently playing on the first BGM track.

No parameters.
=== 0x22 - bgm_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x23 - bgm2_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x24 - bgm2_Play ===
Instantly plays a BGM on the second BGM track.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x25 - bgm2_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x26 - bgm2_Stop ===
Instantly stops the BGM that is currently playing on the second BGM track.

No parameters.
=== 0x27 - bgm2_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x38 - CallCommon ===
Jumps to the specified Unionall Coroutine, runs its code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the Coroutine). This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub).

If used in the context of an actor/object/performer, this should not be used in with-statements.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x39 - camera_Move2Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3a - camera_Move2MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3b - camera_Move2Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3c - camera_Move2PositionMark ===
Moves the camera to one or more Position Marks without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x3d - camera_Move2PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x3e - camera_Move3Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x3f - camera_Move3MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x40 - camera_Move3Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x41 - camera_Move3PositionMark ===
Moves the camera to one or more Position Marks in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x42 - camera_Move3PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x43 - camera_MoveDefault ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x44 - camera_MoveMyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x45 - camera_MoveMyself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x46 - camera_MovePositionMark ===
Moves the camera to one or more Position Marks while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x47 - camera_MovePositionMark ===
Moves the camera to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x48 - camera_SetDefault ===
Instantly sets the camera to a Type 1 actor (e.g., ACTOR_PLAYER).

No parameters.
=== 0x49 - camera_SetEffect ===
Continuously shakes the camera at specified intensities. Entities will be affected by the camera shaking, but not textboxes and portraits. The camera will continue to shake even if it is moved using another opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x4a - camera_SetMyPosition ===
Instantly sets the camera toward a specific entity's position (i.e., an actor, object, or performer).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4b - camera_SetMyself ===
Instantly sets the camera to a specific entity (i.e., an actor, object, or performer). Once performed, the camera will now follow the entity wherever it moves.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4c - camera_SetPositionMark ===
Instantly sets the camera to a Position Mark.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x4d - camera2_Move2Default ===
The same as <code>camera_Move2Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4e - camera2_Move2MyPosition ===
The same as <code>camera_Move2MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4f - camera2_Move2Myself ===
The same as <code>camera_Move2Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x50 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x51 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x52 - camera2_Move3Default ===
The same as <code>camera_Move3Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x53 - camera2_Move3MyPosition ===
The same as <code>camera_Move3MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x54 - camera2_Move3Myself ===
The same as <code>camera_Move3Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x55 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x56 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x57 - camera2_MoveDefault ===
The same as <code>camera_MoveDefault</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x58 - camera2_MoveMyPosition ===
The same as <code>camera_MoveMyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x59 - camera2_MoveMyself ===
The same as <code>camera_MoveMyself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x5a - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x5b - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x5c - camera2_SetDefault ===
The same as <code>camera_SetDefault</code>, but for the Top Screen.

No parameters.
=== 0x5d - camera2_SetEffect ===
The same as <code>camera_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x5e - camera2_SetMyPosition ===
The same as <code>camera_SetMyPosition</code>, but for the Top Screen.

No parameters.
=== 0x5f - camera2_SetMyself ===
The same as <code>camera_SetMyself</code>, but for the Top Screen.

No parameters.
=== 0x60 - camera2_SetPositionMark ===
The same as <code>camera_SetPositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x61 - CancelCut ===
Reverses the effects of the opcode <code>CancelRecoverCommon</code>, i.e., disallows the game from reloading Unionall at a Coroutine by pressing the Start button.

No parameters.
=== 0x62 - CancelRecoverCommon ===
Allows reloading Unionall at a specified Coroutine by pressing the Start button. This can be done in a cutscene and the overworld.

Once the Start button is pressed, the game will stop the current script, fade out the entire screen, and reload Unionall and begin running code at the specified Coroutine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x6a - debug_Assert ===
Does nothing in the final game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x6b - debug_Print ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6c - debug_PrintFlag ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with the value of the specified script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. Indexed variables are not encouraged to use, since the Debug Log will only read from the first index.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6d - debug_PrintScenario ===
If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with two indices of the specified script variable.

This opcode's Debug Log implementation currently seems broken, as it prints the first index of the specified variable twice.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. A two-indexed variable (e.g., <code>$SCENARIO_MAIN</code>) is encouraged to use.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6f - Destroy ===
Instantly removes an active entity (i.e., an actor, object, or performer) from memory.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.

=== 0x71 - EndAnimation ===
Stops an actor or object's looping animation once it reaches the end of its animation frames.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x72 - ExecuteActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x73 - ExecuteCommon ===
Jumps to a Unionall Coroutine, runs its code, and returns to the line in which this opcode was called. This opcode should be called if the specified Coroutine ends with <code>hold;</code>. Typically, the base game uses this command with Coroutines whose names end with "FUNC_SERIES".

This opcode does not have a parameter for an entity, as it must be used in a with-statement.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|-
|2
|uint
|unk1
|Unknown.
|}
=== 0x81 - Flash ===
Zeroes-out the return address used by the <code>Return</code> opcode. This opcode is not used in the base game.

No parameters.
=== 0x83 - item_GetVariable ===
Saves the value in a specific item slot (set by <code>item_Set</code>) to a script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the indexed variables. Non-indexed values causes the IndexError.
|}
=== 0x84 - item_Set ===
Sets an item into an item slot, which can be used by other various <code>item_</code> opcodes.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

Item slots 0-3 are safe to use, but item slots 4 and beyond will begin to overwrite other memory!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|item_id
|The ID of the item, where all are listed in the Items tab of SkyTemple.
|-
|3
|uint
|item_stack
|The stack count of an item, if it belongs to a Thrown category. Treasure Boxes will also use this as the item earned when opening the box at Xatu's Appraisal.
|}
=== 0x85 - item_SetTableData ===
Sets a random item from predefined tables into an item slot, which can be used by other various <code>item_</code> opcodes. This opcode is used mainly in Spinda's Cafe, for redeeming a random Recycle Shop prize and for receiving items from Treasure Town NPCs after giving them Sky Gifts.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|table_ID
|Some item tables related to Spinda's Cafe.
|}
The table IDs themselves are as follows. Values above 15 are currently unknown and untested.
{| class="wikitable"
!#
!Description
!#
!Description
|-
|0
|Sky Gift Item Pool
|8
|Silver Ticket Win Pool
|-
|1
|Numel "Give" Item Pool
|9
|Silver Ticket Big Win Pool
|-
|2
|Numel "Recieve" Item Pool
|10
|Gold Ticket Loss Pool
|-
|3
|Happiny Lost Item Pool
|11
|Gold Ticket Win Pool
|-
|4
|Prize Ticket Loss Pool
|12
|Gold Ticket Big Win Pool
|-
|5
|Prize Ticket Win Pool
|13
|Prism Ticket Loss Pool
|-
|6
|Prize Ticket Big Win Pool
|14
|Prism Ticket Win Pool
|-
|7
|Silver Ticket Loss Pool
|15
|Prism Ticket Big Win Pool
|}

=== 0x86 - item_SetVariable ===
Saves the value of a script variable to an item slot. Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the 115 possible script variables.
|}
=== 0x88 - JumpCommon ===
Jumps to the specified Unionall Coroutine and runs its code, without returning to the line in which this opcode was first used. This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub), but is mostly used by the base game in Unionall.

If attempting to execute a Unionall Coroutine from inside an Enter, Acting, or Sub script to play Acting scripts, use <code>supervision_ExecuteCommon</code> instead.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x8a - LoadPosition ===
Sets various attributes of an entity (i.e., an actor, object, or performer) to the values of all indexed <code>$POSITION_</code> script variables. These include changing the entity's X and Y coordinates, height, and direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0x8b - Lock ===
Suspends the current routine until the opcode <code>Unlock</code> is called with the same ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x8c - main_EnterAdventure ===
Performs various functions related to entering a dungeon using the crossroads menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|Most modes are not known, but:

* 32767 opens the dungeon selection menu.
* 251 stops the current script to reload Unionall starting from the Coroutine CORO_MOVE_WORLD_MAP.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x8d - main_EnterDungeon ===
Attempts to exit ground mode and begins dungeon mode at a specific dungeon.

If attempting to run this opcode before selecting any option from the Top Menu, the game will not enter any dungeon and instead attempt to load a DEMO Unionall coroutine or the Top Menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|dungeon_id
|The dungeon ID to enter, which are all listed in the Dungeons tab of SkyTemple. A value of -1 actually enters dungeon mode—it is insufficient to use this opcode a single time to enter a specific dungeon.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8e - main_EnterGround ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: Set to 0.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8f - main_EnterGroundMulti ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: This opcode's ''level_id_link'' parameter.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id_enter
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|-
|3
|Level
|level_id_link
|An entry in the Level List. Used to update <code>$GROUND_ENTER_LINK</code>.
|}
=== 0x90 - main_EnterRescueUser ===
Exits ground mode and begins dungeon mode while taking an SOS Mail. Dungeon selection seems to be determined by the SOS Mail chosen via <code>message_Menu(MENU_S_O_S_MAIL_PICKER);</code>.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x91 - main_EnterTraining ===
Performs various functions related to entering a dungeon using Marowak Dojo.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens the generic dojo selection menu
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x92 - main_EnterTraining2 ===
Performs various functions related to entering a dungeon using Marowak Dojo's Final Maze.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens a dojo selection menu that only involves Final Maze.
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x93 - main_SetGround ===
Updates the following variables' values to be this opcode's ''level_id'' parameter:

* <code>$GROUND_ENTER</code>
* <code>$GROUND_GETOUT</code>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List.
|}
=== 0x94 - me_Play ===
Instantly plays a special [[sound effect]] that can seamlessly interrupt any BGM tracks that are currently playing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|me_id
|A sound effect defined in SOUND/ME of the ROM.
|}
=== 0x95 - me_Stop ===
Instantly stops the currently-playing special [[sound effect]] called with <code>me_Play</code>.

No parameters.
=== 0x96 - message_Close ===
Suspends the current routine and allows for closing an active textbox (and portrait, if active) set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

By pressing the A Button, B Button, or tapping the textbox via the Touch Screen. Once the textbox is closed, the current routine resumes.

No parameters.
=== 0x97 - message_CloseEnforce ===
Instantly closes an active textbox (and portrait, if active) once the game finishes displaying a string set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

No parameters.
=== 0x98 - message_Explanation ===
Displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine.

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x99 - message_FacePositionOffset ===
Offsets the active portrait in pixels by multiples of 8.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|The offset to shift the portrait box across the X-axis.
|-
|2
|sint
|y
|The offset to shift the portrait box across the Y-axis.
|}
=== 0x9a - message_ImitationSound ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9b - message_KeyWait ===
If an active textbox has finished displaying its string and was created by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

This opcode suspends the current routine until the A Button, B Button or textbox is pressed (via the Touch Screen). Once done so, the textbox will not close, but the current routine will resume.

No parameters.
=== 0x9c - message_Mail ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9d - message_Menu ===
Executes various hardcoded "menu" functionalities given a certain ID. Some IDs result in an actual menu, while others simply perform a silent task.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Menu
|menu_id
|The ID of a menu, the list of which can be seen by typing <code>MENU_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x9e - message_Monologue ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9f - message_Narration ===
Fades in the screen and instantly displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine. Once the routine is resumed (by pressing the A Button, B Button, or text via the Touch Screen), the screen will fade out, including the string.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade in/out the Touch Screen.
|-
|2
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa0 - message_Notice ===
Instantly displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa1 - message_EmptyActor ===
Disallows a portrait from appearing alongside a textbox, along with disallowing a name to appear in the textbox if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa2 - message_ResetActor ===
Disallows a portrait from appearing alongside a textbox, along with setting a speech bubble (the text tag [M:T1]) to the start of next script string if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa3 - message_SetActor ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xa4 - message_SetFace ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa5 - message_SetFaceEmpty ===
Displays a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa6 - message_SetFaceOnly ===
Sets a speech bubble (the text tag [M:T1]) to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa7 - message_SetFacePosition ===
Re-positions an actor's portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa8 - message_SetWaitMode ===
Makes strings displayed with a <code>message_</code> opcode auto-scroll. For both parameters, a value of -1 means the auto-scroll will stop.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|duration0
|Sets the frame count for a textbox auto-advancing, once the end of the string has been displayed and the following opcode is <code>message_KeyWait();</code>.
|-
|2
|sint
|duration1
|Sets the frame count for text tags such as [K] auto-advancing.
|}
=== 0xa9 - message_SpecialTalk ===
Displays a random Text String based off of the actor ACTOR_TALK_SUB's Talk Group.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|category
|A category of Text String.

* 0 seems to use Text Strings while not in a dungeon (e.g., teammates waiting at Spinda's Cafe).
* 1 seems to be use Text Strings while mid-dungeon (e.g., teammates at Amp Plains).
|}
=== 0xae - message_Talk ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xaf - Move2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb0 - Move2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without restricting the angles used.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb1 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0xb2 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xb3 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xb4 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xb5 - Move2PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xb6 - Move3Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb7 - Move3PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor in a rapid, strange motion.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb8 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xb9 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xba - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xbb - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xbc - Move3PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xbd - MoveDirection ===
Offsets an entity (i.e., an actor, object, or performer) by a certain number of pixels based on a given direction. Movement is performed while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|offset
|The pixel offset to shift the entity relative to the entity's direction.
|-
|3
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xbe - MoveHeight ===
Moves an entity (i.e., an actor, object, or performer) to a certain pixel height, displacing it from its shadow. When used, the entity's animation and direction will not change.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|height
|The pixel height to set the entity relative to their shadow.
|}
=== 0xbf - MovePosition ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xc0 - MovePositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xc1 - MovePositionLivesTime ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the actor or after a certain number of frames have passed—whichever comes first.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc2 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xc3 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xc4 - MovePositionMarkTime ===
Moves an entity (i.e., an actor, object, or performer) to an Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the Position Mark or after a certain number of frames have passed—whichever comes first.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc5 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xc6 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xc7 - MoveSpecial ===
Currently unknown. Seems to move an entity (i.e., an actor, object, or performer) based on some hardcoded behaviors.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Determines the kind of action.

# Spin and move in a circular motion.
# Spin and move in a circular motion.
# Currently unknown.
# Currently unknown.
# Currently unknown. Seems to be the most commonly-used value, as a part of the Unionall Coroutine CORO_LIVES_REPLY_NOMRAL.
|-
|2
|uint
|unk1
|Currently unknown. Seems to affect how far the entity will move?
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0xc8 - MoveTurn ===
Moves an entity (i.e., an actor, object, or performer) based on a certain pattern. Unlike other <code>Move</code> opcodes, this opcode will make the entity interact with the currently loaded Map Background's collision (i.e., the entity stops when hitting a wall).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|distance
|How far the entity will move. Higher values result in greater distance being covered.
|-
|2
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.

This parameter also seems to affect the distance traveled.
|-
|3
|uint
|pattern
|A hardcoded pattern to move in.

# Moves in a circle clockwise.
# Moves in a circle counterclockwise.
# Moves in a square clockwise.
# Moves in a square counterclockwise.
# Zig-zags back and forth.

Values 6 and above seem to be variations of random movement.
|}
=== 0xca - PauseEffect ===
Instantly pauses the current graphical effect of an entity (i.e., an actor, object, or performer). The effect will freeze mid-frame.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xcc - ProcessSpecial ===
Executes one of the game's Special Processes. The return value of a Special Process can be checked by encasing this opcode in a <code>switch</code> statement. A negative return value is not acceptable and will cause the game to suspend indefinitely.

This opcode cannot be used in targeted routines.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ProcessSpecial
|process_id
|One of the game's Special Processes.
|-
|2
|sint
|process_param1
|The first parameter used by the Special Process.
|-
|3
|sint
|process_param2
|The first parameter used by the Special Process.
|}
=== 0xcd - PursueTurnLives ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xce - PursueTurnLives2 ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xcf - ResetAttribute ===
Currently unknown. Seems to get ignored when parsed in the scripting engine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0xd0 - ResetFunctionAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "function" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|function_bitfield
|Most bits' purposes are unknown. Bit 1 appears to be the bit used for allowing an entity to follow a Type 1 actor, like the actor ACTOR_ATTENDANT1 in the overworld.
|}
=== 0xd1 - ResetHitAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "hit" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|hit_bitfield
|Most bits' purposes are unknown.

* 2: Entity collision.
* 6: Talk Script upon collision.
* 7: Talk Script upon pressing the A Button near the entity.
|}
=== 0xd2 - ResetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0xd3 - ResetReplyAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "reply" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|reply_bitfield
|Most bits' purposes are unknown.

* 1: Talk Script upon collision.
* 2: Talk Script upon pressing the A Button near the entity.
* 6: Underlay below entities.
* 7: Overlay above entities.
|}
=== 0xd4 - ResumeEffect ===
Resumes the current graphical effect of an entity (i.e., an actor, object, or performer) that has been paused with <code>PauseEffect</code> prior to using this opcode.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xd6 - SavePosition ===
Saves various attributes of an entity (i.e., an actor, object, or performer) to the following script variables:

* <code>$POSITION_X</code>: The pixel position of the entity on the X-axis multiplied by 256.
* <code>$POSITION_Y</code>: The pixel position of the entity on the Y-axis multiplied by 256.
* <code>$POSITION_HEIGHT</code>: The pixel height (i.e., displacement of the entity from their shadow) of the entity multiplied by 256.
* <code>$POSITION_DIRECTION</code>: The direction the entity is facing.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0xd7 - screen_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd8 - screen_FadeChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd9 - screen_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xda - screen_FadeInAll ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdb - screen_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdc - screen_FadeOutAll ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdd - screen_FlushChange ===
Does nothing.
{| class="wikitable"
|+Parameters
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}

=== 0xde - screen_FlushIn ===
Changes the color of the screen from a specific state (given by the opcode's parameters, which affect the Touch Screen instantly) to its default state across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xdf - screen_FlushOut ===
Changes the color of the screen across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xe0 - screen_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe1 - screen_WhiteChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe2 - screen_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOut</code>, use <code>screen_FadeIn</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe3 - screen_WhiteInAll ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOutAll</code>, use <code>screen_FadeInAll</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe4 - screen_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe5 - screen_WhiteOutAll ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe6 - screen2_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xe7 - screen2_FadeChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xe8 - screen2_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xe9 - screen2_FadeInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xea - screen2_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xeb - screen2_FadeOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xec - screen2_FlushChange ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}
=== 0xed - screen2_FlushIn ===
The same as <code>screen_FlushIn</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xee - screen2_FlushOut ===
The same as <code>screen_FlushOut</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xef - screen2_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xf0 - screen2_WhiteChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xf1 - screen2_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen2_WhiteOut</code>, use <code>screen2_FadeIn</code> to restore the Top Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf2 - screen2_WhiteInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf3 - screen2_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xf4 - screen2_WhiteOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf5 - se_ChangePan ===
Changes the panning of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's panning.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xf6 - se_ChangeVolume ===
Changes the volume of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's volume.
|-
|3
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xf7 - se_FadeOut ===
Fades out the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to fade out and silence a given SE.
|}
=== 0xf8 - se_Play ===
Instantly plays a [[sound effect]].

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xf9 - se_PlayFull ===
Instantly plays a [[sound effect]] at a specified volume and panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfa - se_PlayPan ===
Instantly plays a [[sound effect]] at a specified panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfb - se_PlayVolume ===
Instantly plays a [[sound effect]] at a specified volume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xfc - se_Stop ===
Instantly stops a specified sound effect.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xfd - SetAnimation ===
Plays a sprite's animation, optionally changing its speed and animation flags.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|id
|Animation table index. Converted to an [[Animation ID]] for the current sprite using the [https://docs.google.com/spreadsheets/d/11xHv80Def5mtF60ZsfI1lF1eNX0dBE2It837Q08AlRk/htmlview SetAnimation table].
|}
=== 0xfe - SetAttribute ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|}
=== 0xff - SetBlink ===
Sets a specific entity (i.e., an actor, object, or performer) to continuously flicker in and out of view at a certain interval.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|visible_interval
|The number of frames to wait for while the entity is visible.
|-
|2
|uint
|invisible_interval
|The number of frames to wait for while the entity is invisible.
|}
=== 0x100 - SetDirection ===
Instantly sets a specific entity (i.e., an actor, object, or performer) to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x101 - SetDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x102 - SetEffect ===
Plays back an [[List of Effect Animations|effect animation]] assigned to an actor or performer.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|The ID of a given effect.
|-
|2
|uint
|position_marker_id?
|Set to one of the following character sprite offsets:
0: Head 1: Right Hand 2: Left Hand 3: Center 4: No offset (bottom of sprite)
|}

=== 0x103 - SetFunctionAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x104 - SetHeight ===
Moves an actor "vertically" by distancing it from its shadow.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|number of pixels to move up or down by.
|}
=== 0x105 - SetHitAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x106 - SetMoveRange ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|-
|5
|uint
|unk4
|
|-
|6
|uint
|unk5
|
|}
=== 0x107 - SetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 1.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0x108 - SetPosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|x
|
|-
|2
|uint
|y
|
|}
=== 0x109 - SetPositionInitial ===
<TO DO: Opcode description>

No parameters.
=== 0x10a - SetPositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x10b - SetPositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x10c - SetPositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10d - SetPositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10e - SetReplyAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x10f - SetupOutputAttributeAndAnimation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x110 - Slide2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}

=== 0x111 - Slide2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|actor_id
|The ID of the actor to move the entity to.
|}

=== 0x112 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x113 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_mark
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x114 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x115 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x116 - Slide2PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x117 - Slide3Position ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x118 - Slide3PositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|actor_id
|
|}
=== 0x119 - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|PositionMark
|pos_marker
|This parameter may be repeated multiple times
|}
=== 0x11a - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x11b - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x11c - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11d - Slide3PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11e - SlideHeight ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x11f - SlidePosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x120 - SlidePositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x121 - SlidePositionLivesTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x122 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x123 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x124 - SlidePositionMarkTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|}
=== 0x125 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
|This parameter may be repeated multiple times
|}
=== 0x126 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x127 - sound_FadeOut ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x128 - sound_Stop ===
<TO DO: Opcode description>

No parameters.
=== 0x129 - StopAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x12a - supervision_Acting ===
Loads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12b - supervision_ActingInvisible ===
Loads a sector of the Acting scene. Actors and objects in this sector will be invisible.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12c - supervision_ExecuteActing ===
Loads a specified Acting script from the specified level from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|Map LEVEL the script should be located in.
|-
|2
|ConstString
|script_id
|Name of the script itself, only the first 8 characters are read.
|-
|3
|uint
|script_sector
|The "sector" of the script, and the value <code>switch(sector())</code> will return in def 0. Often used to determine whether a cutscene should be played as a flashback or not.
|}

=== 0x12d - supervision_ExecuteActingSub ===
Loads a specified Acting script from the specified level from within Unionall.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|Map LEVEL the script should be located in.
|-
|2
|ConstString
|script_id
|Name of the script itself, only the first 8 characters are read.
|-
|3
|uint
|script_sector
|The "sector" of the script, and the value <code>switch(sector())</code> will return in def 0. Often used to determine whether a cutscene should be played as a flashback or not.
|}

=== 0x12e - supervision_ExecuteCommon ===
Loads a specified Unionall coroutine from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|
|}

=== 0x12f - supervision_ExecuteEnter ===
Loads an Enter script from the specified level.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|level_id
|An entry in the Level list.
|}

=== 0x130 - supervision_ExecuteStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x131 - supervision_ExecuteStationCommon ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x132 - supervision_ExecuteStationCommonSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x133 - supervision_ExecuteStationSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x134 - supervision_ExecuteExport ===
Loads a specified Acting scene of the level S00P01A

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|script_id
|
|}

=== 0x135 - supervision_ExecuteExportSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|const
|
|}
=== 0x136 - supervision_LoadStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|}
=== 0x137 - supervision_Remove ===
Unloads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x138 - supervision_RemoveActing ===
Unloads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x139 - supervision_RemoveCommon ===
Unloads a sector of the Enter scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x13a - supervision_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x13b - supervision_Station ===
Loads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13c - supervision_StationCommon ===
Loads a sector of the Enter scene.

Can be used to call sectors of an enter scene within acting scenes!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13d - supervision_Suspend ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|unk0
|
|}
=== 0x13e - supervision2_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14c - Turn2Direction ===
Makes an actor rotate to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Direction
|direction
|The direction that the actor will turn to face.
|}

=== 0x14d - Turn2DirectionLives ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Entity
|actor_id
|The target actor that the actor will turn to face.
|}

=== 0x14e - Turn2DirectionLives2 ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|actor_id
|ID of the target actor from Level List that the actor will turn to face.
|}

=== 0x14f - Turn2DirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|-
|4
|uint
|unk6
|
|-
|5
|uint
|unk7
|
|}
=== 0x150 - Turn2DirectionTurn ===
Makes an actor turn at a certain angle.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|angle
|1: 45 degrees left, 2: 45 degrees right, 3: 90 degrees right, 4: 90 degrees left, 5: 180 degrees
|}

=== 0x151 - Turn3 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|unk3
|
|}
=== 0x152 - TurnDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x153 - TurnDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x154 - TurnDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x155 - TurnDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x156 - Unlock ===
Resumes the routine that was suspended when <code>Lock</code> was called with the specified ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x157 - Wait ===
Pauses the routine for a set number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames that the routine will wait for before resuming.
|}

=== 0x158 - WaitAnimation ===
Pauses the routine until the specified actor has finished its animation. After the actor finishes its animation, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x159 - WaitBackEffect ===
Pauses the current routine until [[List of Opcodes#0x2 - back SetBackEffect|back_SetBackEffect]] is called.

No parameters.
=== 0x15a - WaitBack2Effect ===
Pauses the current routine until [[List of Opcodes#0x12 - back2 SetBackEffect|back2_SetBackEffect]] is called.

No parameters.

=== 0x15b - WaitBgm ===
Pauses the current routine until the specified BGM on the first BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15c - WaitBgm2 ===
Pauses the current routine until the specified BGM on the second BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15d - WaitBgmSignal ===
Pauses the routine until a DSE event with ID 0xF6 on the current BGM track is triggered. This can be used to sync certain parts of the scene to the background music.

No parameters.
=== 0x15e - WaitEffect ===
Pauses the routine until the effect on the specified actor/peformer has ended. After the effect ends, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x15f - WaitEndAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x160 - WaitExecuteLives ===
Pauses the routine until the specified actor has finished its action (Move2Position, Slide2Position, etc.). After the actor finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|The actor that the routine will wait for.
|}

=== 0x161 - WaitExecuteObject ===
Pauses the current routine until the specified object has finished its action (Move2Position, Slide2Position, etc.). After the object finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|The ID of the object that the routine will wait for.
|}

=== 0x162 - WaitExecutePerformer ===
Pauses the current routine until the specified performer has finished its current action (Move2Position, Slide2Position, etc.) After the performer has finished its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|The ID of the performer that the routine will wait for.
|}

=== 0x163 - WaitFadeIn ===
Pauses the current routine and waits for the screen to fade in. After the screen fades in, the routine will resume.

No parameters.

=== 0x164 - WaitLockLives ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified actor's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Entity
|actor
|
|}

=== 0x165 - WaitLockObject ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified object's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Object
|object
|
|}

=== 0x166 - WaitLockPerformer ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified performer's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|uint
|performer
|
|}

=== 0x167 - WaitLockSupervision ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in <code>def 0</code>. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|}

=== 0x168 - WaitMe ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x169 - WaitMoveCamera ===
<TO DO: Opcode description>

No parameters.
=== 0x16a - WaitMoveCamera2 ===
<TO DO: Opcode description>

No parameters.
=== 0x16b - WaitRandom ===
Pauses the routine for a random number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration_min
|Minimum number of frames that the routine will wait for before resuming.
|-
|2
|uint
|duration_max
|Maximum number of frames that the routine will wait for before resuming.
|}

=== 0x16c - WaitScreenFade ===
Waits until screen_FadeIn finishes executing.

No parameters.
=== 0x16d - WaitScreenFadeAll ===
Waits until screen_FadeInAll finishes executing.

No parameters.
=== 0x16e - WaitScreen2Fade ===
Waits until screen2_FadeIn finishes executing.

No parameters.
=== 0x16f - WaitSe ===
Pauses the current routine until the specified sound effect has ended. After the sound effect ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|The ID of the sound to wait for the end of before resuming the routine.
|}

=== 0x170 - WaitSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x171 - WaitSubScreen ===
<TO DO: Opcode description>

No parameters.
=== 0x172 - WaitSubSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x173 - worldmap_BlinkMark ===
Shows a blinking world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x174 - worldmap_ChangeLevel ===
Causes the clouds parting animation on the world map, presumably hardcoded by vanilla use-case.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_level
|Level to transition the world map state to.
|}
=== 0x175 - worldmap_DeleteArrow ===
Remove the yellow arrow from the world map.

No parameters.

=== 0x176 - worldmap_MoveCamera ===
Moves the camera to the specified world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|The world map id to move the camera to.
|}

=== 0x177 - worldmap_OffMessage ===
Removes a textbox with the world map marker's name from the Top Screen

No parameters.

=== 0x178 - worldmap_SetArrow ===
Shows an arrow pointing to a specified world map marker

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x179 - worldmap_SetCamera ===
Centers the world map camera on a specific world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|The world map id to set the camera to.
|}
=== 0x17a - worldmap_SetLevel ===
Sets the current world map state. Additionally updates $WORLD_MAP_LEVEL

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_level
|Level to assign the world map state to.
|}
=== 0x17b - worldmap_SetMark ===
Enables a yellow dot for the specified world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|The world map id to enable the yellow dot for.
|}
=== 0x17c - worldmap_SetMessage ===
<TO DO: Opcode description>

Seemingly unused in vanilla.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x17d - worldmap_SetMessagePlace ===
Shows a textbox on the Top Screen with the specified world map marker's name.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x17e - worldmap_SetMode ===
Sets the "mode" of the world map, to align with a particular purpose.

Mode 1 seems to be for handling travel to a dungeon or area.

Mode 2 is only used by debug scripts.

Mode 3 is for handling moving clouds.

Mode 4 is for cutscene use, or for showing where things are on a map.

All other modes are unused.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_mode
|
|}

== Other Opcodes ==
These opcodes cannot be directly called from ExplorerScript, since they are represented as higher-level constructs.

=== 0x28 - Branch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x29 - BranchBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2a - BranchDebug ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2b - BranchEdit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2c - BranchExecuteSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2d - BranchPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2e - BranchScenarioNow ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x2f - BranchScenarioNowAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x30 - BranchScenarioNowBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x31 - BranchScenarioAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x32 - BranchScenarioBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x33 - BranchSum ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x34 - BranchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|uint
|value
|
|-
|4
|uint
|jump_address
|
|}
=== 0x35 - BranchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|GameVar
|cmp_var
|
|-
|4
|uint
|jump_address
|
|}
=== 0x36 - BranchVariation ===
Used for demo cutscenes.

Jumps to the specified address if the first parameter is 0. On the demo version of the game, jumps if the first parameter is 3.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|Unknown. Always 3.
|-
|2
|uint
|jump_address
|Address to jump to.
|}
=== 0x37 - Call ===
Jumps to the specified address, runs code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the routine this opcode calls). Only one call can be stored at a time!

Use within macros is ill-advised, as using <code>return;</code> within a macro will just end the macro!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|The address to call, e.g., <code>call @label_0;</code> if <code>§label_0;</code> is defined in the script.
|}
=== 0x63 - Case ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|uint
|jump_address
|
|}
=== 0x64 - CaseMenu ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|choice
|
|-
|2
|uint
|jump_address
|
|}
=== 0x65 - CaseMenu2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint?
|choice?
|
|-
|2
|uint
|jump_address
|
|}
=== 0x66 - CaseScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x67 - CaseText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|String
|display
|
|}
=== 0x68 - CaseValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x69 - CaseVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|GameVar
|var
|
|-
|3
|uint
|jump_address
|
|}
=== 0x6e - DefaultText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x70 - End ===
<TO DO: Opcode description>

No parameters.
=== 0x74 - flag_CalcBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|value
|
|}
=== 0x75 - flag_CalcValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|uint
|value
|
|}
=== 0x76 - flag_CalcVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|GameVar
|var_to_set_from
|
|}
=== 0x77 - flag_Clear ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x78 - flag_Initial ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x79 - flag_Set ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|}
=== 0x7a - flag_ResetDungeonResult ===
<TO DO: Opcode description>

No parameters.
=== 0x7b - flag_ResetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x7c - flag_SetAdventureLog ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x7d - flag_SetDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|-
|2
|DungeonMode
|dungen_mode
|
|}
=== 0x7e - flag_SetDungeonResult ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x7f - flag_SetPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|}
=== 0x80 - flag_SetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|scenario_value
|
|-
|3
|uint
|level_value
|
|}
=== 0x82 - Hold ===
Will stall a script forever.

No parameters.
=== 0x87 - Jump ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|
|}
=== 0x89 - lives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|
|}
=== 0xaa - message_SwitchMenu ===
Enclose within a switch case, and generates a dialogue prompt with the options present in subsequent "case menu("text"):"

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|}
=== 0xab - message_SwitchMenu2 ===
Same as message_SwitchMenu, but it also takes an argument for a bitfield, and will only display dialogue options for which the corresponding bit is enabled (set to 1).

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|-
|3
|uint
|unk2
|Bitfield $VAR
|}
=== 0xac - message_SwitchMonologue ===
Structured similarly to a switch statement. Typically uses <code>$HERO_TALK_KIND</code> as an argument, and uses multiple cases to display certain dialogue strings.

<code>case 4:</code> used when the player is male or genderless

<code>case 5:</code> used when the player is female

<code>default:</code> used when <code>$HERO_TALK_KIND</code>'s Talk Group has a value other than 4 or 5

This opcode supports displaying a portrait. No sound effect is used when text is scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xad - message_SwitchTalk ===
Same as _SwitchMonologue, but typically uses <code>$PARTNER_TALK_KIND</code> as an argument, and the cases used vary.

Of the vanilla game partner options:

<code>case 1:</code> used if Squirtle, Tododile, Chimchar, Meowth, or Munchlax

<code>case 2:</code> used for all other male partners

<code>case 3:</code> used for all female partners

<code>default:</code> used when <code>$PARTNER_TALK_KIND</code>'s Talk Group has a value other than 1, 2, or 3

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xc9 - object ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|
|}
=== 0xcb - performer ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|
|}
=== 0xd5 - Return ===
If run from within a macro, ends the macro.

If run after the "call" opcode was used, will return to the address of the call opcode.

If used within a script, ends the script.

No parameters.
=== 0x13f - Switch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x140 - SwitchDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x141 - SwitchDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x142 - SwitchDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x143 - SwitchDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x144 - SwitchDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|}
=== 0x145 - SwitchLives ===
If inside a Switch Case, take the case equal to the species ID of the specified Actor!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0x146 - SwitchRandom ===
To be used in a switch statement. Will switch to a case of a random number below the specified integer.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|max_value
|Largest random output, plus 1
|}
=== 0x147 - SwitchScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x148 - SwitchScenarioLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x149 - SwitchSector ===
<TO DO: Opcode description>

No parameters.
=== 0x14a - SwitchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14b - SwitchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Opcodes

2026-02-06T21:49:12Z

Happylappy: More World Map Opcode stuff

The scripting engine used in Explorers of Sky has different opcodes. [[ExplorerScript]] translates most of them literally, preserving the same parameters and functionality. However, some opcodes are translated to [[ExplorerScript]] constructs, such as if statements.

This article documents the different opcodes, their purpose and parameters. The purpose of unkX parameters is unknown.

== What is an opcode? ==
An opcode is an instruction to the machine (it tells the machine to 'do' something). In modern programming, it would be most similar to a [https://en.wikipedia.org/wiki/Function_(computer_programming) function]. For a more technical description, see [https://en.wikipedia.org/wiki/Opcode here].

== Types of parameters ==
* uint: An unsigned integer (a number without decimals). It cannot be negative. It is possible that in the game's code, there are only signed integers and no unsigned integers, but not enough research has been done on the matter. For the most part, it shouldn't matter.
* sint: A signed integer (a number without decimals). It can be either positive or negative.
* bitfield: A bitfield is uint where each bits (0 or 1) are treated independantly. They are used to store multiple binary (boolean) values efficiently. Opcodes that use it usually come in the <code>Set</code> and <code>Reset</code> variant. The <code>Set</code> variant define to true the values which are 1 in the input bitfield (while leaving the others untouched), and <code>Reset</code> define to false the values which are 1 in the input bitfield (while also leaving the others untouched).
* String: Text (i.e dialogue). There should always be a quotation mark (") at the beginning and end.
* ConstString: Same as String.
* Routine: Any of the 701 coroutines from [[Unionall]]. Always begins with "CORO_"
* Entity: An actor, performer. (not an object!)
* Object: An object in a scene. (not an actor or perfomer!)
* Level: Any level from the [[Script Engine|Level List]]. Will always begin with "LEVEL_".
* Bgm: Any music in the game. Will always begin with "BGM_". (example: BGM_CRAGGY_COAST)
* PositionMark: A position. Will be written as "Position<'MarkName', x, y>". Once a position mark is written in a script, SkyTemple will show an option to place it visually in the scene.
* Face: A portrait expression. Will always begin with "FACE_". (examples: FACE_NORMAL, FACE_HAPPY, FACE_PAIN)
* FaceMode: A portrait position. Will always begin with "FACE_MODE_".
* Direction: A direction for an entity to move in or turn to. Will always begin with "DIR_". (examples: DIR_UP, DIR_RIGHT)
* ProcessSpecial: One of the games special processes. Can be referred to by its number, or name.
* Effect: A graphical effect.
* GameVar: Any of the game's [[List of Script Variables|Script Variables]]. Will always begin with "$".

== Relevant Opcodes ==
These opcodes can be directly called from ExplorerScript.

=== 0x0 - Null ===
Does nothing.

No parameters.
=== 0x1 - back_ChangeGround ===
Sets the Map Background from a Level without changing the chunks from the currently loaded Map Background. Entities such as actors, objects, and performers will not be deleted when this opcode is executed.

This has very few uses in the game—a notable use is how Wigglytuff's Chamber has its door open, as seen via LEVEL_G01P04A and LEVEL_G01P04A2.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x2 - back_SetBackEffect ===
Performs various effects related to the currently loaded Animation Palettes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x3 - back_SetBackScrollOffset ===
Shifts the background by a certain number of pixels, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level is hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level is hardcoded.
|}

=== 0x4 - back_SetBackScrollSpeed ===
Continuously scrolls the background at a certain speed, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint16
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint16
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x5 - back_SetBanner ===
Displays broken text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x6 - back_SetBanner2 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is typically used for chapter introductions, which includes chapter text and a subtitle displayed over a Map Background. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|-
|2
|uint
|unk1
|Currently unknown. Typically, the game uses 0 for this parameter, but it seems to have no effect.
|-
|3
|uint
|x
|The pixel position the camera will center the Map Background on its X-axis.
|-
|4
|uint
|y
|The pixel position the camera will center the Map Background on its Y-axis.
|-
|5
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|6
|String
|title
|The title of the chapter, e.g., "A Storm At Sea" for Chapter 1.
|}
=== 0x7 - back_SetEffect ===
Performs various effects related to the current Map Background's layers across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x8 - back_SetDungeonBanner ===
Displays a specific string using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. The text chosen is defined in Dungeons tab as a dungeon's <code>back_SetDungeonBanner</code> string. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|The ID of a dungeon, as listed in the Dungeons tab of SkyTemple.
|-
|2
|uint
|unk1
|Currently unknown. Does not seem to affect much.
|}
=== 0x9 - back_SetGround ===
Sets the Map Background from a Level. Upon using this opcode, the variable <code>$GROUND_MAP</code> will be updated to match the ID of the chosen Level. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0xa - back_SetSpecialEpisodeBanner ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is used for Special Episodes 1-3. This opcode plays a short animation of a green line shooting across the screen, followed by text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xb - back_SetSpecialEpisodeBanner2 ===
Displays text using the <code>FONT/banner_c.bin:FONT/b_pal_r.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 4. This opcode features an elaborate animation featuring hearts and sparkles, along with text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xc - back_SetSpecialEpisodeBanner3 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 5. This opcode features no animation, but the end result is similar to the opcode <code>back_SetSpecialEpisodeBanner</code>. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xd - back_SetTitleBanner ===
Displays user-defined text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|y
|The Y-axis pixel position of the title.
|-
|2
|String
|title
|The title displayed on the Touch Screen.
|}
=== 0xe - back_SetWeather ===
Displays a weather effect that overlays the current Map Background.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}
=== 0xf - back_SetWeatherEffect ===
Currently unknown. The only values this opcode accepts seems to be 1, 2, and 3. Value 3 was previously used in S02P01A/m00a01a.ssb in Time/Darkness, for its iteration of the personality test. In Sky, its only use is in V00P02/m01a04a.ssb, which is a leftover test script used by the developers to test the visuals of the Time/Darkness iteration of the aura test.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}

=== 0x10 - back_SetWeatherScrollOffset ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x11 - back_SetWeatherScrollSpeed ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x12 - back2_SetBackEffect ===
The same as <code>back_SetBackEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect_id
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x13 - back2_SetBackScrollOffset ===
The same as <code>back_SetBackScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}

=== 0x14 - back2_SetBackScrollSpeed ===
The same as <code>back_SetBackScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x15 - back2_SetData ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x16 - back2_SetEffect ===
The same as <code>back_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x17 - back2_SetGround ===
Mostly the same as <code>back_SetGround</code>, but for the Top Screen. This opcode only works if <code>back2_SetMode(4);</code> is used prior to this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x18 - back2_SetMode ===
Determines a hardcoded status of the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|A value of 0 is no mode. A negative value seems to set the Top Screen to the overworld's current Top Screen setting.

# Fades out the Top Screen.
# Team Stats.
# The Map Background S01P01A with the hero idling on a World Map Marker.
# Allows for the Top Screen to display a Map Background from a Level using the <code>back2_SetGround</code> opcode.
# Splits the Map Background used in the Level defined by <code>back_SetGround</code> equally between the Top and Touch Screen.
#Splits the Map Background used in the Level defined by <code>back_SetGround</code> between the Top and Touch Screen.
|}
=== 0x19 - back2_SetSpecialActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0x1a - back2_SetWeather ===
The same as <code>back_SetWeather</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}

=== 0x1b - back2_SetWeatherEffect ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x1c - back2_SetWeatherScrollOffset ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1d - back2_SetWeatherScrollSpeed ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1e - bgm_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x1f - bgm_Play ===
Instantly plays a BGM on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x20 - bgm_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x21 - bgm_Stop ===
Instantly stops the BGM that is currently playing on the first BGM track.

No parameters.
=== 0x22 - bgm_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x23 - bgm2_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x24 - bgm2_Play ===
Instantly plays a BGM on the second BGM track.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x25 - bgm2_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x26 - bgm2_Stop ===
Instantly stops the BGM that is currently playing on the second BGM track.

No parameters.
=== 0x27 - bgm2_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x38 - CallCommon ===
Jumps to the specified Unionall Coroutine, runs its code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the Coroutine). This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub).

If used in the context of an actor/object/performer, this should not be used in with-statements.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x39 - camera_Move2Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3a - camera_Move2MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3b - camera_Move2Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3c - camera_Move2PositionMark ===
Moves the camera to one or more Position Marks without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x3d - camera_Move2PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x3e - camera_Move3Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x3f - camera_Move3MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x40 - camera_Move3Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x41 - camera_Move3PositionMark ===
Moves the camera to one or more Position Marks in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x42 - camera_Move3PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x43 - camera_MoveDefault ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x44 - camera_MoveMyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x45 - camera_MoveMyself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x46 - camera_MovePositionMark ===
Moves the camera to one or more Position Marks while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x47 - camera_MovePositionMark ===
Moves the camera to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x48 - camera_SetDefault ===
Instantly sets the camera to a Type 1 actor (e.g., ACTOR_PLAYER).

No parameters.
=== 0x49 - camera_SetEffect ===
Continuously shakes the camera at specified intensities. Entities will be affected by the camera shaking, but not textboxes and portraits. The camera will continue to shake even if it is moved using another opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x4a - camera_SetMyPosition ===
Instantly sets the camera toward a specific entity's position (i.e., an actor, object, or performer).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4b - camera_SetMyself ===
Instantly sets the camera to a specific entity (i.e., an actor, object, or performer). Once performed, the camera will now follow the entity wherever it moves.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4c - camera_SetPositionMark ===
Instantly sets the camera to a Position Mark.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x4d - camera2_Move2Default ===
The same as <code>camera_Move2Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4e - camera2_Move2MyPosition ===
The same as <code>camera_Move2MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4f - camera2_Move2Myself ===
The same as <code>camera_Move2Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x50 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x51 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x52 - camera2_Move3Default ===
The same as <code>camera_Move3Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x53 - camera2_Move3MyPosition ===
The same as <code>camera_Move3MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x54 - camera2_Move3Myself ===
The same as <code>camera_Move3Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x55 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x56 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x57 - camera2_MoveDefault ===
The same as <code>camera_MoveDefault</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x58 - camera2_MoveMyPosition ===
The same as <code>camera_MoveMyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x59 - camera2_MoveMyself ===
The same as <code>camera_MoveMyself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x5a - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x5b - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x5c - camera2_SetDefault ===
The same as <code>camera_SetDefault</code>, but for the Top Screen.

No parameters.
=== 0x5d - camera2_SetEffect ===
The same as <code>camera_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x5e - camera2_SetMyPosition ===
The same as <code>camera_SetMyPosition</code>, but for the Top Screen.

No parameters.
=== 0x5f - camera2_SetMyself ===
The same as <code>camera_SetMyself</code>, but for the Top Screen.

No parameters.
=== 0x60 - camera2_SetPositionMark ===
The same as <code>camera_SetPositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x61 - CancelCut ===
Reverses the effects of the opcode <code>CancelRecoverCommon</code>, i.e., disallows the game from reloading Unionall at a Coroutine by pressing the Start button.

No parameters.
=== 0x62 - CancelRecoverCommon ===
Allows reloading Unionall at a specified Coroutine by pressing the Start button. This can be done in a cutscene and the overworld.

Once the Start button is pressed, the game will stop the current script, fade out the entire screen, and reload Unionall and begin running code at the specified Coroutine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x6a - debug_Assert ===
Does nothing in the final game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x6b - debug_Print ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6c - debug_PrintFlag ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with the value of the specified script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. Indexed variables are not encouraged to use, since the Debug Log will only read from the first index.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6d - debug_PrintScenario ===
If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with two indices of the specified script variable.

This opcode's Debug Log implementation currently seems broken, as it prints the first index of the specified variable twice.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. A two-indexed variable (e.g., <code>$SCENARIO_MAIN</code>) is encouraged to use.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6f - Destroy ===
Instantly removes an active entity (i.e., an actor, object, or performer) from memory.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.

=== 0x71 - EndAnimation ===
Stops an actor or object's looping animation once it reaches the end of its animation frames.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x72 - ExecuteActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x73 - ExecuteCommon ===
Jumps to a Unionall Coroutine, runs its code, and returns to the line in which this opcode was called. This opcode should be called if the specified Coroutine ends with <code>hold;</code>. Typically, the base game uses this command with Coroutines whose names end with "FUNC_SERIES".

This opcode does not have a parameter for an entity, as it must be used in a with-statement.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|-
|2
|uint
|unk1
|Unknown.
|}
=== 0x81 - Flash ===
Zeroes-out the return address used by the <code>Return</code> opcode. This opcode is not used in the base game.

No parameters.
=== 0x83 - item_GetVariable ===
Saves the value in a specific item slot (set by <code>item_Set</code>) to a script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the indexed variables. Non-indexed values causes the IndexError.
|}
=== 0x84 - item_Set ===
Sets an item into an item slot, which can be used by other various <code>item_</code> opcodes.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

Item slots 0-3 are safe to use, but item slots 4 and beyond will begin to overwrite other memory!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|item_id
|The ID of the item, where all are listed in the Items tab of SkyTemple.
|-
|3
|uint
|item_stack
|The stack count of an item, if it belongs to a Thrown category. Treasure Boxes will also use this as the item earned when opening the box at Xatu's Appraisal.
|}
=== 0x85 - item_SetTableData ===
Sets a random item from predefined tables into an item slot, which can be used by other various <code>item_</code> opcodes. This opcode is used mainly in Spinda's Cafe, for redeeming a random Recycle Shop prize and for receiving items from Treasure Town NPCs after giving them Sky Gifts.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|table_ID
|Some item tables related to Spinda's Cafe.
|}
The table IDs themselves are as follows. Values above 15 are currently unknown and untested.
{| class="wikitable"
!#
!Description
!#
!Description
|-
|0
|Sky Gift Item Pool
|8
|Silver Ticket Win Pool
|-
|1
|Numel "Give" Item Pool
|9
|Silver Ticket Big Win Pool
|-
|2
|Numel "Recieve" Item Pool
|10
|Gold Ticket Loss Pool
|-
|3
|Happiny Lost Item Pool
|11
|Gold Ticket Win Pool
|-
|4
|Prize Ticket Loss Pool
|12
|Gold Ticket Big Win Pool
|-
|5
|Prize Ticket Win Pool
|13
|Prism Ticket Loss Pool
|-
|6
|Prize Ticket Big Win Pool
|14
|Prism Ticket Win Pool
|-
|7
|Silver Ticket Loss Pool
|15
|Prism Ticket Big Win Pool
|}

=== 0x86 - item_SetVariable ===
Saves the value of a script variable to an item slot. Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the 115 possible script variables.
|}
=== 0x88 - JumpCommon ===
Jumps to the specified Unionall Coroutine and runs its code, without returning to the line in which this opcode was first used. This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub), but is mostly used by the base game in Unionall.

If attempting to execute a Unionall Coroutine from inside an Enter, Acting, or Sub script to play Acting scripts, use <code>supervision_ExecuteCommon</code> instead.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x8a - LoadPosition ===
Sets various attributes of an entity (i.e., an actor, object, or performer) to the values of all indexed <code>$POSITION_</code> script variables. These include changing the entity's X and Y coordinates, height, and direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0x8b - Lock ===
Suspends the current routine until the opcode <code>Unlock</code> is called with the same ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x8c - main_EnterAdventure ===
Performs various functions related to entering a dungeon using the crossroads menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|Most modes are not known, but:

* 32767 opens the dungeon selection menu.
* 251 stops the current script to reload Unionall starting from the Coroutine CORO_MOVE_WORLD_MAP.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x8d - main_EnterDungeon ===
Attempts to exit ground mode and begins dungeon mode at a specific dungeon.

If attempting to run this opcode before selecting any option from the Top Menu, the game will not enter any dungeon and instead attempt to load a DEMO Unionall coroutine or the Top Menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|dungeon_id
|The dungeon ID to enter, which are all listed in the Dungeons tab of SkyTemple. A value of -1 actually enters dungeon mode—it is insufficient to use this opcode a single time to enter a specific dungeon.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8e - main_EnterGround ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: Set to 0.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8f - main_EnterGroundMulti ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: This opcode's ''level_id_link'' parameter.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id_enter
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|-
|3
|Level
|level_id_link
|An entry in the Level List. Used to update <code>$GROUND_ENTER_LINK</code>.
|}
=== 0x90 - main_EnterRescueUser ===
Exits ground mode and begins dungeon mode while taking an SOS Mail. Dungeon selection seems to be determined by the SOS Mail chosen via <code>message_Menu(MENU_S_O_S_MAIL_PICKER);</code>.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x91 - main_EnterTraining ===
Performs various functions related to entering a dungeon using Marowak Dojo.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens the generic dojo selection menu
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x92 - main_EnterTraining2 ===
Performs various functions related to entering a dungeon using Marowak Dojo's Final Maze.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens a dojo selection menu that only involves Final Maze.
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x93 - main_SetGround ===
Updates the following variables' values to be this opcode's ''level_id'' parameter:

* <code>$GROUND_ENTER</code>
* <code>$GROUND_GETOUT</code>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List.
|}
=== 0x94 - me_Play ===
Instantly plays a special [[sound effect]] that can seamlessly interrupt any BGM tracks that are currently playing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|me_id
|A sound effect defined in SOUND/ME of the ROM.
|}
=== 0x95 - me_Stop ===
Instantly stops the currently-playing special [[sound effect]] called with <code>me_Play</code>.

No parameters.
=== 0x96 - message_Close ===
Suspends the current routine and allows for closing an active textbox (and portrait, if active) set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

By pressing the A Button, B Button, or tapping the textbox via the Touch Screen. Once the textbox is closed, the current routine resumes.

No parameters.
=== 0x97 - message_CloseEnforce ===
Instantly closes an active textbox (and portrait, if active) once the game finishes displaying a string set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

No parameters.
=== 0x98 - message_Explanation ===
Displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine.

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x99 - message_FacePositionOffset ===
Offsets the active portrait in pixels by multiples of 8.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|The offset to shift the portrait box across the X-axis.
|-
|2
|sint
|y
|The offset to shift the portrait box across the Y-axis.
|}
=== 0x9a - message_ImitationSound ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9b - message_KeyWait ===
If an active textbox has finished displaying its string and was created by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

This opcode suspends the current routine until the A Button, B Button or textbox is pressed (via the Touch Screen). Once done so, the textbox will not close, but the current routine will resume.

No parameters.
=== 0x9c - message_Mail ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9d - message_Menu ===
Executes various hardcoded "menu" functionalities given a certain ID. Some IDs result in an actual menu, while others simply perform a silent task.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Menu
|menu_id
|The ID of a menu, the list of which can be seen by typing <code>MENU_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x9e - message_Monologue ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9f - message_Narration ===
Fades in the screen and instantly displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine. Once the routine is resumed (by pressing the A Button, B Button, or text via the Touch Screen), the screen will fade out, including the string.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade in/out the Touch Screen.
|-
|2
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa0 - message_Notice ===
Instantly displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa1 - message_EmptyActor ===
Disallows a portrait from appearing alongside a textbox, along with disallowing a name to appear in the textbox if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa2 - message_ResetActor ===
Disallows a portrait from appearing alongside a textbox, along with setting a speech bubble (the text tag [M:T1]) to the start of next script string if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa3 - message_SetActor ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xa4 - message_SetFace ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa5 - message_SetFaceEmpty ===
Displays a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa6 - message_SetFaceOnly ===
Sets a speech bubble (the text tag [M:T1]) to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa7 - message_SetFacePosition ===
Re-positions an actor's portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa8 - message_SetWaitMode ===
Makes strings displayed with a <code>message_</code> opcode auto-scroll. For both parameters, a value of -1 means the auto-scroll will stop.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|duration0
|Sets the frame count for a textbox auto-advancing, once the end of the string has been displayed and the following opcode is <code>message_KeyWait();</code>.
|-
|2
|sint
|duration1
|Sets the frame count for text tags such as [K] auto-advancing.
|}
=== 0xa9 - message_SpecialTalk ===
Displays a random Text String based off of the actor ACTOR_TALK_SUB's Talk Group.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|category
|A category of Text String.

* 0 seems to use Text Strings while not in a dungeon (e.g., teammates waiting at Spinda's Cafe).
* 1 seems to be use Text Strings while mid-dungeon (e.g., teammates at Amp Plains).
|}
=== 0xae - message_Talk ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xaf - Move2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb0 - Move2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without restricting the angles used.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb1 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0xb2 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xb3 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xb4 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xb5 - Move2PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xb6 - Move3Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb7 - Move3PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor in a rapid, strange motion.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb8 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xb9 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xba - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xbb - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xbc - Move3PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xbd - MoveDirection ===
Offsets an entity (i.e., an actor, object, or performer) by a certain number of pixels based on a given direction. Movement is performed while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|offset
|The pixel offset to shift the entity relative to the entity's direction.
|-
|3
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xbe - MoveHeight ===
Moves an entity (i.e., an actor, object, or performer) to a certain pixel height, displacing it from its shadow. When used, the entity's animation and direction will not change.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|height
|The pixel height to set the entity relative to their shadow.
|}
=== 0xbf - MovePosition ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xc0 - MovePositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xc1 - MovePositionLivesTime ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the actor or after a certain number of frames have passed—whichever comes first.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc2 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xc3 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xc4 - MovePositionMarkTime ===
Moves an entity (i.e., an actor, object, or performer) to an Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the Position Mark or after a certain number of frames have passed—whichever comes first.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc5 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xc6 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xc7 - MoveSpecial ===
Currently unknown. Seems to move an entity (i.e., an actor, object, or performer) based on some hardcoded behaviors.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Determines the kind of action.

# Spin and move in a circular motion.
# Spin and move in a circular motion.
# Currently unknown.
# Currently unknown.
# Currently unknown. Seems to be the most commonly-used value, as a part of the Unionall Coroutine CORO_LIVES_REPLY_NOMRAL.
|-
|2
|uint
|unk1
|Currently unknown. Seems to affect how far the entity will move?
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0xc8 - MoveTurn ===
Moves an entity (i.e., an actor, object, or performer) based on a certain pattern. Unlike other <code>Move</code> opcodes, this opcode will make the entity interact with the currently loaded Map Background's collision (i.e., the entity stops when hitting a wall).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|distance
|How far the entity will move. Higher values result in greater distance being covered.
|-
|2
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.

This parameter also seems to affect the distance traveled.
|-
|3
|uint
|pattern
|A hardcoded pattern to move in.

# Moves in a circle clockwise.
# Moves in a circle counterclockwise.
# Moves in a square clockwise.
# Moves in a square counterclockwise.
# Zig-zags back and forth.

Values 6 and above seem to be variations of random movement.
|}
=== 0xca - PauseEffect ===
Instantly pauses the current graphical effect of an entity (i.e., an actor, object, or performer). The effect will freeze mid-frame.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xcc - ProcessSpecial ===
Executes one of the game's Special Processes. The return value of a Special Process can be checked by encasing this opcode in a <code>switch</code> statement. A negative return value is not acceptable and will cause the game to suspend indefinitely.

This opcode cannot be used in targeted routines.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ProcessSpecial
|process_id
|One of the game's Special Processes.
|-
|2
|sint
|process_param1
|The first parameter used by the Special Process.
|-
|3
|sint
|process_param2
|The first parameter used by the Special Process.
|}
=== 0xcd - PursueTurnLives ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xce - PursueTurnLives2 ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xcf - ResetAttribute ===
Currently unknown. Seems to get ignored when parsed in the scripting engine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0xd0 - ResetFunctionAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "function" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|function_bitfield
|Most bits' purposes are unknown. Bit 1 appears to be the bit used for allowing an entity to follow a Type 1 actor, like the actor ACTOR_ATTENDANT1 in the overworld.
|}
=== 0xd1 - ResetHitAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "hit" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|hit_bitfield
|Most bits' purposes are unknown.

* 2: Entity collision.
* 6: Talk Script upon collision.
* 7: Talk Script upon pressing the A Button near the entity.
|}
=== 0xd2 - ResetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0xd3 - ResetReplyAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "reply" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|reply_bitfield
|Most bits' purposes are unknown.

* 1: Talk Script upon collision.
* 2: Talk Script upon pressing the A Button near the entity.
* 6: Underlay below entities.
* 7: Overlay above entities.
|}
=== 0xd4 - ResumeEffect ===
Resumes the current graphical effect of an entity (i.e., an actor, object, or performer) that has been paused with <code>PauseEffect</code> prior to using this opcode.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xd6 - SavePosition ===
Saves various attributes of an entity (i.e., an actor, object, or performer) to the following script variables:

* <code>$POSITION_X</code>: The pixel position of the entity on the X-axis multiplied by 256.
* <code>$POSITION_Y</code>: The pixel position of the entity on the Y-axis multiplied by 256.
* <code>$POSITION_HEIGHT</code>: The pixel height (i.e., displacement of the entity from their shadow) of the entity multiplied by 256.
* <code>$POSITION_DIRECTION</code>: The direction the entity is facing.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0xd7 - screen_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd8 - screen_FadeChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd9 - screen_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xda - screen_FadeInAll ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdb - screen_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdc - screen_FadeOutAll ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdd - screen_FlushChange ===
Does nothing.
{| class="wikitable"
|+Parameters
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}

=== 0xde - screen_FlushIn ===
Changes the color of the screen from a specific state (given by the opcode's parameters, which affect the Touch Screen instantly) to its default state across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xdf - screen_FlushOut ===
Changes the color of the screen across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xe0 - screen_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe1 - screen_WhiteChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe2 - screen_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOut</code>, use <code>screen_FadeIn</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe3 - screen_WhiteInAll ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOutAll</code>, use <code>screen_FadeInAll</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe4 - screen_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe5 - screen_WhiteOutAll ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe6 - screen2_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xe7 - screen2_FadeChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xe8 - screen2_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xe9 - screen2_FadeInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xea - screen2_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xeb - screen2_FadeOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xec - screen2_FlushChange ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}
=== 0xed - screen2_FlushIn ===
The same as <code>screen_FlushIn</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xee - screen2_FlushOut ===
The same as <code>screen_FlushOut</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xef - screen2_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xf0 - screen2_WhiteChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xf1 - screen2_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen2_WhiteOut</code>, use <code>screen2_FadeIn</code> to restore the Top Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf2 - screen2_WhiteInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf3 - screen2_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xf4 - screen2_WhiteOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf5 - se_ChangePan ===
Changes the panning of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's panning.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xf6 - se_ChangeVolume ===
Changes the volume of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's volume.
|-
|3
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xf7 - se_FadeOut ===
Fades out the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to fade out and silence a given SE.
|}
=== 0xf8 - se_Play ===
Instantly plays a [[sound effect]].

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xf9 - se_PlayFull ===
Instantly plays a [[sound effect]] at a specified volume and panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfa - se_PlayPan ===
Instantly plays a [[sound effect]] at a specified panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfb - se_PlayVolume ===
Instantly plays a [[sound effect]] at a specified volume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xfc - se_Stop ===
Instantly stops a specified sound effect.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xfd - SetAnimation ===
Plays a sprite's animation, optionally changing its speed and animation flags.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|id
|Animation table index. Converted to an [[Animation ID]] for the current sprite using the [https://docs.google.com/spreadsheets/d/11xHv80Def5mtF60ZsfI1lF1eNX0dBE2It837Q08AlRk/htmlview SetAnimation table].
|}
=== 0xfe - SetAttribute ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|}
=== 0xff - SetBlink ===
Sets a specific entity (i.e., an actor, object, or performer) to continuously flicker in and out of view at a certain interval.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|visible_interval
|The number of frames to wait for while the entity is visible.
|-
|2
|uint
|invisible_interval
|The number of frames to wait for while the entity is invisible.
|}
=== 0x100 - SetDirection ===
Instantly sets a specific entity (i.e., an actor, object, or performer) to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x101 - SetDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x102 - SetEffect ===
Plays back an [[List of Effect Animations|effect animation]] assigned to an actor or performer.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|The ID of a given effect.
|-
|2
|uint
|position_marker_id?
|Set to one of the following character sprite offsets:
0: Head 1: Right Hand 2: Left Hand 3: Center 4: No offset (bottom of sprite)
|}

=== 0x103 - SetFunctionAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x104 - SetHeight ===
Moves an actor "vertically" by distancing it from its shadow.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|number of pixels to move up or down by.
|}
=== 0x105 - SetHitAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x106 - SetMoveRange ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|-
|5
|uint
|unk4
|
|-
|6
|uint
|unk5
|
|}
=== 0x107 - SetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 1.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0x108 - SetPosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|x
|
|-
|2
|uint
|y
|
|}
=== 0x109 - SetPositionInitial ===
<TO DO: Opcode description>

No parameters.
=== 0x10a - SetPositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x10b - SetPositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x10c - SetPositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10d - SetPositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10e - SetReplyAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x10f - SetupOutputAttributeAndAnimation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x110 - Slide2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}

=== 0x111 - Slide2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|actor_id
|The ID of the actor to move the entity to.
|}

=== 0x112 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x113 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_mark
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x114 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x115 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x116 - Slide2PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x117 - Slide3Position ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x118 - Slide3PositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|actor_id
|
|}
=== 0x119 - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|PositionMark
|pos_marker
|This parameter may be repeated multiple times
|}
=== 0x11a - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x11b - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x11c - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11d - Slide3PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11e - SlideHeight ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x11f - SlidePosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x120 - SlidePositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x121 - SlidePositionLivesTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x122 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x123 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x124 - SlidePositionMarkTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|}
=== 0x125 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
|This parameter may be repeated multiple times
|}
=== 0x126 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x127 - sound_FadeOut ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x128 - sound_Stop ===
<TO DO: Opcode description>

No parameters.
=== 0x129 - StopAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x12a - supervision_Acting ===
Loads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12b - supervision_ActingInvisible ===
Loads a sector of the Acting scene. Actors and objects in this sector will be invisible.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12c - supervision_ExecuteActing ===
Loads a specified Acting script from the specified level from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|Map LEVEL the script should be located in.
|-
|2
|ConstString
|script_id
|Name of the script itself, only the first 8 characters are read.
|-
|3
|uint
|script_sector
|The "sector" of the script, and the value <code>switch(sector())</code> will return in def 0. Often used to determine whether a cutscene should be played as a flashback or not.
|}

=== 0x12d - supervision_ExecuteActingSub ===
Loads a specified Acting script from the specified level from within Unionall.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|Map LEVEL the script should be located in.
|-
|2
|ConstString
|script_id
|Name of the script itself, only the first 8 characters are read.
|-
|3
|uint
|script_sector
|The "sector" of the script, and the value <code>switch(sector())</code> will return in def 0. Often used to determine whether a cutscene should be played as a flashback or not.
|}

=== 0x12e - supervision_ExecuteCommon ===
Loads a specified Unionall coroutine from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|
|}

=== 0x12f - supervision_ExecuteEnter ===
Loads an Enter script from the specified level.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|level_id
|An entry in the Level list.
|}

=== 0x130 - supervision_ExecuteStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x131 - supervision_ExecuteStationCommon ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x132 - supervision_ExecuteStationCommonSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x133 - supervision_ExecuteStationSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x134 - supervision_ExecuteExport ===
Loads a specified Acting scene of the level S00P01A

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|script_id
|
|}

=== 0x135 - supervision_ExecuteExportSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|const
|
|}
=== 0x136 - supervision_LoadStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|}
=== 0x137 - supervision_Remove ===
Unloads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x138 - supervision_RemoveActing ===
Unloads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x139 - supervision_RemoveCommon ===
Unloads a sector of the Enter scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x13a - supervision_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x13b - supervision_Station ===
Loads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13c - supervision_StationCommon ===
Loads a sector of the Enter scene.

Can be used to call sectors of an enter scene within acting scenes!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13d - supervision_Suspend ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|unk0
|
|}
=== 0x13e - supervision2_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14c - Turn2Direction ===
Makes an actor rotate to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Direction
|direction
|The direction that the actor will turn to face.
|}

=== 0x14d - Turn2DirectionLives ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Entity
|actor_id
|The target actor that the actor will turn to face.
|}

=== 0x14e - Turn2DirectionLives2 ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|actor_id
|ID of the target actor from Level List that the actor will turn to face.
|}

=== 0x14f - Turn2DirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|-
|4
|uint
|unk6
|
|-
|5
|uint
|unk7
|
|}
=== 0x150 - Turn2DirectionTurn ===
Makes an actor turn at a certain angle.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|angle
|1: 45 degrees left, 2: 45 degrees right, 3: 90 degrees right, 4: 90 degrees left, 5: 180 degrees
|}

=== 0x151 - Turn3 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|unk3
|
|}
=== 0x152 - TurnDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x153 - TurnDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x154 - TurnDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x155 - TurnDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x156 - Unlock ===
Resumes the routine that was suspended when <code>Lock</code> was called with the specified ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x157 - Wait ===
Pauses the routine for a set number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames that the routine will wait for before resuming.
|}

=== 0x158 - WaitAnimation ===
Pauses the routine until the specified actor has finished its animation. After the actor finishes its animation, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x159 - WaitBackEffect ===
Pauses the current routine until [[List of Opcodes#0x2 - back SetBackEffect|back_SetBackEffect]] is called.

No parameters.
=== 0x15a - WaitBack2Effect ===
Pauses the current routine until [[List of Opcodes#0x12 - back2 SetBackEffect|back2_SetBackEffect]] is called.

No parameters.

=== 0x15b - WaitBgm ===
Pauses the current routine until the specified BGM on the first BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15c - WaitBgm2 ===
Pauses the current routine until the specified BGM on the second BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15d - WaitBgmSignal ===
Pauses the routine until a DSE event with ID 0xF6 on the current BGM track is triggered. This can be used to sync certain parts of the scene to the background music.

No parameters.
=== 0x15e - WaitEffect ===
Pauses the routine until the effect on the specified actor/peformer has ended. After the effect ends, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x15f - WaitEndAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x160 - WaitExecuteLives ===
Pauses the routine until the specified actor has finished its action (Move2Position, Slide2Position, etc.). After the actor finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|The actor that the routine will wait for.
|}

=== 0x161 - WaitExecuteObject ===
Pauses the current routine until the specified object has finished its action (Move2Position, Slide2Position, etc.). After the object finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|The ID of the object that the routine will wait for.
|}

=== 0x162 - WaitExecutePerformer ===
Pauses the current routine until the specified performer has finished its current action (Move2Position, Slide2Position, etc.) After the performer has finished its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|The ID of the performer that the routine will wait for.
|}

=== 0x163 - WaitFadeIn ===
Pauses the current routine and waits for the screen to fade in. After the screen fades in, the routine will resume.

No parameters.

=== 0x164 - WaitLockLives ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified actor's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Entity
|actor
|
|}

=== 0x165 - WaitLockObject ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified object's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Object
|object
|
|}

=== 0x166 - WaitLockPerformer ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified performer's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|uint
|performer
|
|}

=== 0x167 - WaitLockSupervision ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in <code>def 0</code>. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|}

=== 0x168 - WaitMe ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x169 - WaitMoveCamera ===
<TO DO: Opcode description>

No parameters.
=== 0x16a - WaitMoveCamera2 ===
<TO DO: Opcode description>

No parameters.
=== 0x16b - WaitRandom ===
Pauses the routine for a random number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration_min
|Minimum number of frames that the routine will wait for before resuming.
|-
|2
|uint
|duration_max
|Maximum number of frames that the routine will wait for before resuming.
|}

=== 0x16c - WaitScreenFade ===
Waits until screen_FadeIn finishes executing.

No parameters.
=== 0x16d - WaitScreenFadeAll ===
Waits until screen_FadeInAll finishes executing.

No parameters.
=== 0x16e - WaitScreen2Fade ===
Waits until screen2_FadeIn finishes executing.

No parameters.
=== 0x16f - WaitSe ===
Pauses the current routine until the specified sound effect has ended. After the sound effect ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|The ID of the sound to wait for the end of before resuming the routine.
|}

=== 0x170 - WaitSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x171 - WaitSubScreen ===
<TO DO: Opcode description>

No parameters.
=== 0x172 - WaitSubSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x173 - worldmap_BlinkMark ===
Shows a blinking world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x174 - worldmap_ChangeLevel ===
Causes the clouds parting animation on the world map, presumably hardcoded by vanilla use-case.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_level
|Level to transition the world map state to.
|}
=== 0x175 - worldmap_DeleteArrow ===
Remove the yellow arrow from the world map.

No parameters.

=== 0x176 - worldmap_MoveCamera ===
Moves the camera to the specified world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|The world map id to move the camera to.
|}

=== 0x177 - worldmap_OffMessage ===
Removes a textbox with the world map marker's name from the Top Screen

No parameters.

=== 0x178 - worldmap_SetArrow ===
Shows an arrow pointing to a specified world map marker

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x179 - worldmap_SetCamera ===
Centers the world map camera on a specific world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|The world map id to set the camera to.
|}
=== 0x17a - worldmap_SetLevel ===
Sets the current world map state. Additionally updates $WORLD_MAP_LEVEL

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_level
|Level to assign the world map state to.
|}
=== 0x17b - worldmap_SetMark ===
Enables a yellow dot for the specified world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|The world map id to enable the yellow dot for.
|}
=== 0x17c - worldmap_SetMessage ===
<TO DO: Opcode description>

Seemingly unused in vanilla.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x17d - worldmap_SetMessagePlace ===
Shows a textbox on the Top Screen with the specified world map marker's name.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x17e - worldmap_SetMode ===
Sets the "mode" of the world map, to align with a particular purpose.

Mode 1 seems to be for handling travel to a dungeon or area.

Mode 3 is for handling moving clouds.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_mode
|
|}

== Other Opcodes ==
These opcodes cannot be directly called from ExplorerScript, since they are represented as higher-level constructs.

=== 0x28 - Branch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x29 - BranchBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2a - BranchDebug ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2b - BranchEdit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2c - BranchExecuteSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2d - BranchPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2e - BranchScenarioNow ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x2f - BranchScenarioNowAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x30 - BranchScenarioNowBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x31 - BranchScenarioAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x32 - BranchScenarioBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x33 - BranchSum ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x34 - BranchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|uint
|value
|
|-
|4
|uint
|jump_address
|
|}
=== 0x35 - BranchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|GameVar
|cmp_var
|
|-
|4
|uint
|jump_address
|
|}
=== 0x36 - BranchVariation ===
Used for demo cutscenes.

Jumps to the specified address if the first parameter is 0. On the demo version of the game, jumps if the first parameter is 3.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|Unknown. Always 3.
|-
|2
|uint
|jump_address
|Address to jump to.
|}
=== 0x37 - Call ===
Jumps to the specified address, runs code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the routine this opcode calls). Only one call can be stored at a time!

Use within macros is ill-advised, as using <code>return;</code> within a macro will just end the macro!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|The address to call, e.g., <code>call @label_0;</code> if <code>§label_0;</code> is defined in the script.
|}
=== 0x63 - Case ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|uint
|jump_address
|
|}
=== 0x64 - CaseMenu ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|choice
|
|-
|2
|uint
|jump_address
|
|}
=== 0x65 - CaseMenu2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint?
|choice?
|
|-
|2
|uint
|jump_address
|
|}
=== 0x66 - CaseScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x67 - CaseText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|String
|display
|
|}
=== 0x68 - CaseValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x69 - CaseVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|GameVar
|var
|
|-
|3
|uint
|jump_address
|
|}
=== 0x6e - DefaultText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x70 - End ===
<TO DO: Opcode description>

No parameters.
=== 0x74 - flag_CalcBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|value
|
|}
=== 0x75 - flag_CalcValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|uint
|value
|
|}
=== 0x76 - flag_CalcVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|GameVar
|var_to_set_from
|
|}
=== 0x77 - flag_Clear ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x78 - flag_Initial ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x79 - flag_Set ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|}
=== 0x7a - flag_ResetDungeonResult ===
<TO DO: Opcode description>

No parameters.
=== 0x7b - flag_ResetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x7c - flag_SetAdventureLog ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x7d - flag_SetDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|-
|2
|DungeonMode
|dungen_mode
|
|}
=== 0x7e - flag_SetDungeonResult ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x7f - flag_SetPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|}
=== 0x80 - flag_SetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|scenario_value
|
|-
|3
|uint
|level_value
|
|}
=== 0x82 - Hold ===
Will stall a script forever.

No parameters.
=== 0x87 - Jump ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|
|}
=== 0x89 - lives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|
|}
=== 0xaa - message_SwitchMenu ===
Enclose within a switch case, and generates a dialogue prompt with the options present in subsequent "case menu("text"):"

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|}
=== 0xab - message_SwitchMenu2 ===
Same as message_SwitchMenu, but it also takes an argument for a bitfield, and will only display dialogue options for which the corresponding bit is enabled (set to 1).

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|-
|3
|uint
|unk2
|Bitfield $VAR
|}
=== 0xac - message_SwitchMonologue ===
Structured similarly to a switch statement. Typically uses <code>$HERO_TALK_KIND</code> as an argument, and uses multiple cases to display certain dialogue strings.

<code>case 4:</code> used when the player is male or genderless

<code>case 5:</code> used when the player is female

<code>default:</code> used when <code>$HERO_TALK_KIND</code>'s Talk Group has a value other than 4 or 5

This opcode supports displaying a portrait. No sound effect is used when text is scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xad - message_SwitchTalk ===
Same as _SwitchMonologue, but typically uses <code>$PARTNER_TALK_KIND</code> as an argument, and the cases used vary.

Of the vanilla game partner options:

<code>case 1:</code> used if Squirtle, Tododile, Chimchar, Meowth, or Munchlax

<code>case 2:</code> used for all other male partners

<code>case 3:</code> used for all female partners

<code>default:</code> used when <code>$PARTNER_TALK_KIND</code>'s Talk Group has a value other than 1, 2, or 3

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xc9 - object ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|
|}
=== 0xcb - performer ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|
|}
=== 0xd5 - Return ===
If run from within a macro, ends the macro.

If run after the "call" opcode was used, will return to the address of the call opcode.

If used within a script, ends the script.

No parameters.
=== 0x13f - Switch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x140 - SwitchDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x141 - SwitchDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x142 - SwitchDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x143 - SwitchDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x144 - SwitchDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|}
=== 0x145 - SwitchLives ===
If inside a Switch Case, take the case equal to the species ID of the specified Actor!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0x146 - SwitchRandom ===
To be used in a switch statement. Will switch to a case of a random number below the specified integer.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|max_value
|Largest random output, plus 1
|}
=== 0x147 - SwitchScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x148 - SwitchScenarioLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x149 - SwitchSector ===
<TO DO: Opcode description>

No parameters.
=== 0x14a - SwitchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14b - SwitchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Opcodes

2026-02-06T21:32:40Z

Happylappy: World Map Opcode edits

The scripting engine used in Explorers of Sky has different opcodes. [[ExplorerScript]] translates most of them literally, preserving the same parameters and functionality. However, some opcodes are translated to [[ExplorerScript]] constructs, such as if statements.

This article documents the different opcodes, their purpose and parameters. The purpose of unkX parameters is unknown.

== What is an opcode? ==
An opcode is an instruction to the machine (it tells the machine to 'do' something). In modern programming, it would be most similar to a [https://en.wikipedia.org/wiki/Function_(computer_programming) function]. For a more technical description, see [https://en.wikipedia.org/wiki/Opcode here].

== Types of parameters ==
* uint: An unsigned integer (a number without decimals). It cannot be negative. It is possible that in the game's code, there are only signed integers and no unsigned integers, but not enough research has been done on the matter. For the most part, it shouldn't matter.
* sint: A signed integer (a number without decimals). It can be either positive or negative.
* bitfield: A bitfield is uint where each bits (0 or 1) are treated independantly. They are used to store multiple binary (boolean) values efficiently. Opcodes that use it usually come in the <code>Set</code> and <code>Reset</code> variant. The <code>Set</code> variant define to true the values which are 1 in the input bitfield (while leaving the others untouched), and <code>Reset</code> define to false the values which are 1 in the input bitfield (while also leaving the others untouched).
* String: Text (i.e dialogue). There should always be a quotation mark (") at the beginning and end.
* ConstString: Same as String.
* Routine: Any of the 701 coroutines from [[Unionall]]. Always begins with "CORO_"
* Entity: An actor, performer. (not an object!)
* Object: An object in a scene. (not an actor or perfomer!)
* Level: Any level from the [[Script Engine|Level List]]. Will always begin with "LEVEL_".
* Bgm: Any music in the game. Will always begin with "BGM_". (example: BGM_CRAGGY_COAST)
* PositionMark: A position. Will be written as "Position<'MarkName', x, y>". Once a position mark is written in a script, SkyTemple will show an option to place it visually in the scene.
* Face: A portrait expression. Will always begin with "FACE_". (examples: FACE_NORMAL, FACE_HAPPY, FACE_PAIN)
* FaceMode: A portrait position. Will always begin with "FACE_MODE_".
* Direction: A direction for an entity to move in or turn to. Will always begin with "DIR_". (examples: DIR_UP, DIR_RIGHT)
* ProcessSpecial: One of the games special processes. Can be referred to by its number, or name.
* Effect: A graphical effect.
* GameVar: Any of the game's [[List of Script Variables|Script Variables]]. Will always begin with "$".

== Relevant Opcodes ==
These opcodes can be directly called from ExplorerScript.

=== 0x0 - Null ===
Does nothing.

No parameters.
=== 0x1 - back_ChangeGround ===
Sets the Map Background from a Level without changing the chunks from the currently loaded Map Background. Entities such as actors, objects, and performers will not be deleted when this opcode is executed.

This has very few uses in the game—a notable use is how Wigglytuff's Chamber has its door open, as seen via LEVEL_G01P04A and LEVEL_G01P04A2.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x2 - back_SetBackEffect ===
Performs various effects related to the currently loaded Animation Palettes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x3 - back_SetBackScrollOffset ===
Shifts the background by a certain number of pixels, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level is hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level is hardcoded.
|}

=== 0x4 - back_SetBackScrollSpeed ===
Continuously scrolls the background at a certain speed, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint16
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint16
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x5 - back_SetBanner ===
Displays broken text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x6 - back_SetBanner2 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is typically used for chapter introductions, which includes chapter text and a subtitle displayed over a Map Background. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|-
|2
|uint
|unk1
|Currently unknown. Typically, the game uses 0 for this parameter, but it seems to have no effect.
|-
|3
|uint
|x
|The pixel position the camera will center the Map Background on its X-axis.
|-
|4
|uint
|y
|The pixel position the camera will center the Map Background on its Y-axis.
|-
|5
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|6
|String
|title
|The title of the chapter, e.g., "A Storm At Sea" for Chapter 1.
|}
=== 0x7 - back_SetEffect ===
Performs various effects related to the current Map Background's layers across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x8 - back_SetDungeonBanner ===
Displays a specific string using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. The text chosen is defined in Dungeons tab as a dungeon's <code>back_SetDungeonBanner</code> string. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|The ID of a dungeon, as listed in the Dungeons tab of SkyTemple.
|-
|2
|uint
|unk1
|Currently unknown. Does not seem to affect much.
|}
=== 0x9 - back_SetGround ===
Sets the Map Background from a Level. Upon using this opcode, the variable <code>$GROUND_MAP</code> will be updated to match the ID of the chosen Level. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0xa - back_SetSpecialEpisodeBanner ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is used for Special Episodes 1-3. This opcode plays a short animation of a green line shooting across the screen, followed by text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xb - back_SetSpecialEpisodeBanner2 ===
Displays text using the <code>FONT/banner_c.bin:FONT/b_pal_r.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 4. This opcode features an elaborate animation featuring hearts and sparkles, along with text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xc - back_SetSpecialEpisodeBanner3 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 5. This opcode features no animation, but the end result is similar to the opcode <code>back_SetSpecialEpisodeBanner</code>. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xd - back_SetTitleBanner ===
Displays user-defined text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|y
|The Y-axis pixel position of the title.
|-
|2
|String
|title
|The title displayed on the Touch Screen.
|}
=== 0xe - back_SetWeather ===
Displays a weather effect that overlays the current Map Background.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}
=== 0xf - back_SetWeatherEffect ===
Currently unknown. The only values this opcode accepts seems to be 1, 2, and 3. Value 3 was previously used in S02P01A/m00a01a.ssb in Time/Darkness, for its iteration of the personality test. In Sky, its only use is in V00P02/m01a04a.ssb, which is a leftover test script used by the developers to test the visuals of the Time/Darkness iteration of the aura test.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}

=== 0x10 - back_SetWeatherScrollOffset ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x11 - back_SetWeatherScrollSpeed ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x12 - back2_SetBackEffect ===
The same as <code>back_SetBackEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect_id
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x13 - back2_SetBackScrollOffset ===
The same as <code>back_SetBackScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}

=== 0x14 - back2_SetBackScrollSpeed ===
The same as <code>back_SetBackScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x15 - back2_SetData ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x16 - back2_SetEffect ===
The same as <code>back_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x17 - back2_SetGround ===
Mostly the same as <code>back_SetGround</code>, but for the Top Screen. This opcode only works if <code>back2_SetMode(4);</code> is used prior to this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x18 - back2_SetMode ===
Determines a hardcoded status of the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|A value of 0 is no mode. A negative value seems to set the Top Screen to the overworld's current Top Screen setting.

# Fades out the Top Screen.
# Team Stats.
# The Map Background S01P01A with the hero idling on a World Map Marker.
# Allows for the Top Screen to display a Map Background from a Level using the <code>back2_SetGround</code> opcode.
# Splits the Map Background used in the Level defined by <code>back_SetGround</code> equally between the Top and Touch Screen.
#Splits the Map Background used in the Level defined by <code>back_SetGround</code> between the Top and Touch Screen.
|}
=== 0x19 - back2_SetSpecialActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0x1a - back2_SetWeather ===
The same as <code>back_SetWeather</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}

=== 0x1b - back2_SetWeatherEffect ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x1c - back2_SetWeatherScrollOffset ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1d - back2_SetWeatherScrollSpeed ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1e - bgm_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x1f - bgm_Play ===
Instantly plays a BGM on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x20 - bgm_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x21 - bgm_Stop ===
Instantly stops the BGM that is currently playing on the first BGM track.

No parameters.
=== 0x22 - bgm_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x23 - bgm2_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x24 - bgm2_Play ===
Instantly plays a BGM on the second BGM track.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x25 - bgm2_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x26 - bgm2_Stop ===
Instantly stops the BGM that is currently playing on the second BGM track.

No parameters.
=== 0x27 - bgm2_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x38 - CallCommon ===
Jumps to the specified Unionall Coroutine, runs its code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the Coroutine). This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub).

If used in the context of an actor/object/performer, this should not be used in with-statements.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x39 - camera_Move2Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3a - camera_Move2MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3b - camera_Move2Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3c - camera_Move2PositionMark ===
Moves the camera to one or more Position Marks without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x3d - camera_Move2PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x3e - camera_Move3Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x3f - camera_Move3MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x40 - camera_Move3Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x41 - camera_Move3PositionMark ===
Moves the camera to one or more Position Marks in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x42 - camera_Move3PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x43 - camera_MoveDefault ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x44 - camera_MoveMyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x45 - camera_MoveMyself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x46 - camera_MovePositionMark ===
Moves the camera to one or more Position Marks while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x47 - camera_MovePositionMark ===
Moves the camera to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x48 - camera_SetDefault ===
Instantly sets the camera to a Type 1 actor (e.g., ACTOR_PLAYER).

No parameters.
=== 0x49 - camera_SetEffect ===
Continuously shakes the camera at specified intensities. Entities will be affected by the camera shaking, but not textboxes and portraits. The camera will continue to shake even if it is moved using another opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x4a - camera_SetMyPosition ===
Instantly sets the camera toward a specific entity's position (i.e., an actor, object, or performer).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4b - camera_SetMyself ===
Instantly sets the camera to a specific entity (i.e., an actor, object, or performer). Once performed, the camera will now follow the entity wherever it moves.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4c - camera_SetPositionMark ===
Instantly sets the camera to a Position Mark.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x4d - camera2_Move2Default ===
The same as <code>camera_Move2Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4e - camera2_Move2MyPosition ===
The same as <code>camera_Move2MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4f - camera2_Move2Myself ===
The same as <code>camera_Move2Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x50 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x51 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x52 - camera2_Move3Default ===
The same as <code>camera_Move3Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x53 - camera2_Move3MyPosition ===
The same as <code>camera_Move3MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x54 - camera2_Move3Myself ===
The same as <code>camera_Move3Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x55 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x56 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x57 - camera2_MoveDefault ===
The same as <code>camera_MoveDefault</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x58 - camera2_MoveMyPosition ===
The same as <code>camera_MoveMyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x59 - camera2_MoveMyself ===
The same as <code>camera_MoveMyself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x5a - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x5b - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x5c - camera2_SetDefault ===
The same as <code>camera_SetDefault</code>, but for the Top Screen.

No parameters.
=== 0x5d - camera2_SetEffect ===
The same as <code>camera_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x5e - camera2_SetMyPosition ===
The same as <code>camera_SetMyPosition</code>, but for the Top Screen.

No parameters.
=== 0x5f - camera2_SetMyself ===
The same as <code>camera_SetMyself</code>, but for the Top Screen.

No parameters.
=== 0x60 - camera2_SetPositionMark ===
The same as <code>camera_SetPositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x61 - CancelCut ===
Reverses the effects of the opcode <code>CancelRecoverCommon</code>, i.e., disallows the game from reloading Unionall at a Coroutine by pressing the Start button.

No parameters.
=== 0x62 - CancelRecoverCommon ===
Allows reloading Unionall at a specified Coroutine by pressing the Start button. This can be done in a cutscene and the overworld.

Once the Start button is pressed, the game will stop the current script, fade out the entire screen, and reload Unionall and begin running code at the specified Coroutine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x6a - debug_Assert ===
Does nothing in the final game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x6b - debug_Print ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6c - debug_PrintFlag ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with the value of the specified script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. Indexed variables are not encouraged to use, since the Debug Log will only read from the first index.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6d - debug_PrintScenario ===
If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with two indices of the specified script variable.

This opcode's Debug Log implementation currently seems broken, as it prints the first index of the specified variable twice.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. A two-indexed variable (e.g., <code>$SCENARIO_MAIN</code>) is encouraged to use.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6f - Destroy ===
Instantly removes an active entity (i.e., an actor, object, or performer) from memory.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.

=== 0x71 - EndAnimation ===
Stops an actor or object's looping animation once it reaches the end of its animation frames.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x72 - ExecuteActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x73 - ExecuteCommon ===
Jumps to a Unionall Coroutine, runs its code, and returns to the line in which this opcode was called. This opcode should be called if the specified Coroutine ends with <code>hold;</code>. Typically, the base game uses this command with Coroutines whose names end with "FUNC_SERIES".

This opcode does not have a parameter for an entity, as it must be used in a with-statement.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|-
|2
|uint
|unk1
|Unknown.
|}
=== 0x81 - Flash ===
Zeroes-out the return address used by the <code>Return</code> opcode. This opcode is not used in the base game.

No parameters.
=== 0x83 - item_GetVariable ===
Saves the value in a specific item slot (set by <code>item_Set</code>) to a script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the indexed variables. Non-indexed values causes the IndexError.
|}
=== 0x84 - item_Set ===
Sets an item into an item slot, which can be used by other various <code>item_</code> opcodes.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

Item slots 0-3 are safe to use, but item slots 4 and beyond will begin to overwrite other memory!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|item_id
|The ID of the item, where all are listed in the Items tab of SkyTemple.
|-
|3
|uint
|item_stack
|The stack count of an item, if it belongs to a Thrown category. Treasure Boxes will also use this as the item earned when opening the box at Xatu's Appraisal.
|}
=== 0x85 - item_SetTableData ===
Sets a random item from predefined tables into an item slot, which can be used by other various <code>item_</code> opcodes. This opcode is used mainly in Spinda's Cafe, for redeeming a random Recycle Shop prize and for receiving items from Treasure Town NPCs after giving them Sky Gifts.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|table_ID
|Some item tables related to Spinda's Cafe.
|}
The table IDs themselves are as follows. Values above 15 are currently unknown and untested.
{| class="wikitable"
!#
!Description
!#
!Description
|-
|0
|Sky Gift Item Pool
|8
|Silver Ticket Win Pool
|-
|1
|Numel "Give" Item Pool
|9
|Silver Ticket Big Win Pool
|-
|2
|Numel "Recieve" Item Pool
|10
|Gold Ticket Loss Pool
|-
|3
|Happiny Lost Item Pool
|11
|Gold Ticket Win Pool
|-
|4
|Prize Ticket Loss Pool
|12
|Gold Ticket Big Win Pool
|-
|5
|Prize Ticket Win Pool
|13
|Prism Ticket Loss Pool
|-
|6
|Prize Ticket Big Win Pool
|14
|Prism Ticket Win Pool
|-
|7
|Silver Ticket Loss Pool
|15
|Prism Ticket Big Win Pool
|}

=== 0x86 - item_SetVariable ===
Saves the value of a script variable to an item slot. Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the 115 possible script variables.
|}
=== 0x88 - JumpCommon ===
Jumps to the specified Unionall Coroutine and runs its code, without returning to the line in which this opcode was first used. This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub), but is mostly used by the base game in Unionall.

If attempting to execute a Unionall Coroutine from inside an Enter, Acting, or Sub script to play Acting scripts, use <code>supervision_ExecuteCommon</code> instead.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x8a - LoadPosition ===
Sets various attributes of an entity (i.e., an actor, object, or performer) to the values of all indexed <code>$POSITION_</code> script variables. These include changing the entity's X and Y coordinates, height, and direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0x8b - Lock ===
Suspends the current routine until the opcode <code>Unlock</code> is called with the same ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x8c - main_EnterAdventure ===
Performs various functions related to entering a dungeon using the crossroads menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|Most modes are not known, but:

* 32767 opens the dungeon selection menu.
* 251 stops the current script to reload Unionall starting from the Coroutine CORO_MOVE_WORLD_MAP.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x8d - main_EnterDungeon ===
Attempts to exit ground mode and begins dungeon mode at a specific dungeon.

If attempting to run this opcode before selecting any option from the Top Menu, the game will not enter any dungeon and instead attempt to load a DEMO Unionall coroutine or the Top Menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|dungeon_id
|The dungeon ID to enter, which are all listed in the Dungeons tab of SkyTemple. A value of -1 actually enters dungeon mode—it is insufficient to use this opcode a single time to enter a specific dungeon.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8e - main_EnterGround ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: Set to 0.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8f - main_EnterGroundMulti ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: This opcode's ''level_id_link'' parameter.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id_enter
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|-
|3
|Level
|level_id_link
|An entry in the Level List. Used to update <code>$GROUND_ENTER_LINK</code>.
|}
=== 0x90 - main_EnterRescueUser ===
Exits ground mode and begins dungeon mode while taking an SOS Mail. Dungeon selection seems to be determined by the SOS Mail chosen via <code>message_Menu(MENU_S_O_S_MAIL_PICKER);</code>.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x91 - main_EnterTraining ===
Performs various functions related to entering a dungeon using Marowak Dojo.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens the generic dojo selection menu
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x92 - main_EnterTraining2 ===
Performs various functions related to entering a dungeon using Marowak Dojo's Final Maze.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens a dojo selection menu that only involves Final Maze.
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x93 - main_SetGround ===
Updates the following variables' values to be this opcode's ''level_id'' parameter:

* <code>$GROUND_ENTER</code>
* <code>$GROUND_GETOUT</code>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List.
|}
=== 0x94 - me_Play ===
Instantly plays a special [[sound effect]] that can seamlessly interrupt any BGM tracks that are currently playing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|me_id
|A sound effect defined in SOUND/ME of the ROM.
|}
=== 0x95 - me_Stop ===
Instantly stops the currently-playing special [[sound effect]] called with <code>me_Play</code>.

No parameters.
=== 0x96 - message_Close ===
Suspends the current routine and allows for closing an active textbox (and portrait, if active) set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

By pressing the A Button, B Button, or tapping the textbox via the Touch Screen. Once the textbox is closed, the current routine resumes.

No parameters.
=== 0x97 - message_CloseEnforce ===
Instantly closes an active textbox (and portrait, if active) once the game finishes displaying a string set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

No parameters.
=== 0x98 - message_Explanation ===
Displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine.

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x99 - message_FacePositionOffset ===
Offsets the active portrait in pixels by multiples of 8.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|The offset to shift the portrait box across the X-axis.
|-
|2
|sint
|y
|The offset to shift the portrait box across the Y-axis.
|}
=== 0x9a - message_ImitationSound ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9b - message_KeyWait ===
If an active textbox has finished displaying its string and was created by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

This opcode suspends the current routine until the A Button, B Button or textbox is pressed (via the Touch Screen). Once done so, the textbox will not close, but the current routine will resume.

No parameters.
=== 0x9c - message_Mail ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9d - message_Menu ===
Executes various hardcoded "menu" functionalities given a certain ID. Some IDs result in an actual menu, while others simply perform a silent task.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Menu
|menu_id
|The ID of a menu, the list of which can be seen by typing <code>MENU_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x9e - message_Monologue ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9f - message_Narration ===
Fades in the screen and instantly displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine. Once the routine is resumed (by pressing the A Button, B Button, or text via the Touch Screen), the screen will fade out, including the string.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade in/out the Touch Screen.
|-
|2
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa0 - message_Notice ===
Instantly displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa1 - message_EmptyActor ===
Disallows a portrait from appearing alongside a textbox, along with disallowing a name to appear in the textbox if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa2 - message_ResetActor ===
Disallows a portrait from appearing alongside a textbox, along with setting a speech bubble (the text tag [M:T1]) to the start of next script string if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa3 - message_SetActor ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xa4 - message_SetFace ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa5 - message_SetFaceEmpty ===
Displays a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa6 - message_SetFaceOnly ===
Sets a speech bubble (the text tag [M:T1]) to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa7 - message_SetFacePosition ===
Re-positions an actor's portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa8 - message_SetWaitMode ===
Makes strings displayed with a <code>message_</code> opcode auto-scroll. For both parameters, a value of -1 means the auto-scroll will stop.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|duration0
|Sets the frame count for a textbox auto-advancing, once the end of the string has been displayed and the following opcode is <code>message_KeyWait();</code>.
|-
|2
|sint
|duration1
|Sets the frame count for text tags such as [K] auto-advancing.
|}
=== 0xa9 - message_SpecialTalk ===
Displays a random Text String based off of the actor ACTOR_TALK_SUB's Talk Group.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|category
|A category of Text String.

* 0 seems to use Text Strings while not in a dungeon (e.g., teammates waiting at Spinda's Cafe).
* 1 seems to be use Text Strings while mid-dungeon (e.g., teammates at Amp Plains).
|}
=== 0xae - message_Talk ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xaf - Move2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb0 - Move2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without restricting the angles used.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb1 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0xb2 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xb3 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xb4 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xb5 - Move2PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xb6 - Move3Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb7 - Move3PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor in a rapid, strange motion.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb8 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xb9 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xba - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xbb - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xbc - Move3PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xbd - MoveDirection ===
Offsets an entity (i.e., an actor, object, or performer) by a certain number of pixels based on a given direction. Movement is performed while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|offset
|The pixel offset to shift the entity relative to the entity's direction.
|-
|3
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xbe - MoveHeight ===
Moves an entity (i.e., an actor, object, or performer) to a certain pixel height, displacing it from its shadow. When used, the entity's animation and direction will not change.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|height
|The pixel height to set the entity relative to their shadow.
|}
=== 0xbf - MovePosition ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xc0 - MovePositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xc1 - MovePositionLivesTime ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the actor or after a certain number of frames have passed—whichever comes first.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc2 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xc3 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xc4 - MovePositionMarkTime ===
Moves an entity (i.e., an actor, object, or performer) to an Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the Position Mark or after a certain number of frames have passed—whichever comes first.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc5 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xc6 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xc7 - MoveSpecial ===
Currently unknown. Seems to move an entity (i.e., an actor, object, or performer) based on some hardcoded behaviors.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Determines the kind of action.

# Spin and move in a circular motion.
# Spin and move in a circular motion.
# Currently unknown.
# Currently unknown.
# Currently unknown. Seems to be the most commonly-used value, as a part of the Unionall Coroutine CORO_LIVES_REPLY_NOMRAL.
|-
|2
|uint
|unk1
|Currently unknown. Seems to affect how far the entity will move?
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0xc8 - MoveTurn ===
Moves an entity (i.e., an actor, object, or performer) based on a certain pattern. Unlike other <code>Move</code> opcodes, this opcode will make the entity interact with the currently loaded Map Background's collision (i.e., the entity stops when hitting a wall).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|distance
|How far the entity will move. Higher values result in greater distance being covered.
|-
|2
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.

This parameter also seems to affect the distance traveled.
|-
|3
|uint
|pattern
|A hardcoded pattern to move in.

# Moves in a circle clockwise.
# Moves in a circle counterclockwise.
# Moves in a square clockwise.
# Moves in a square counterclockwise.
# Zig-zags back and forth.

Values 6 and above seem to be variations of random movement.
|}
=== 0xca - PauseEffect ===
Instantly pauses the current graphical effect of an entity (i.e., an actor, object, or performer). The effect will freeze mid-frame.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xcc - ProcessSpecial ===
Executes one of the game's Special Processes. The return value of a Special Process can be checked by encasing this opcode in a <code>switch</code> statement. A negative return value is not acceptable and will cause the game to suspend indefinitely.

This opcode cannot be used in targeted routines.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ProcessSpecial
|process_id
|One of the game's Special Processes.
|-
|2
|sint
|process_param1
|The first parameter used by the Special Process.
|-
|3
|sint
|process_param2
|The first parameter used by the Special Process.
|}
=== 0xcd - PursueTurnLives ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xce - PursueTurnLives2 ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xcf - ResetAttribute ===
Currently unknown. Seems to get ignored when parsed in the scripting engine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0xd0 - ResetFunctionAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "function" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|function_bitfield
|Most bits' purposes are unknown. Bit 1 appears to be the bit used for allowing an entity to follow a Type 1 actor, like the actor ACTOR_ATTENDANT1 in the overworld.
|}
=== 0xd1 - ResetHitAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "hit" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|hit_bitfield
|Most bits' purposes are unknown.

* 2: Entity collision.
* 6: Talk Script upon collision.
* 7: Talk Script upon pressing the A Button near the entity.
|}
=== 0xd2 - ResetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0xd3 - ResetReplyAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "reply" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|reply_bitfield
|Most bits' purposes are unknown.

* 1: Talk Script upon collision.
* 2: Talk Script upon pressing the A Button near the entity.
* 6: Underlay below entities.
* 7: Overlay above entities.
|}
=== 0xd4 - ResumeEffect ===
Resumes the current graphical effect of an entity (i.e., an actor, object, or performer) that has been paused with <code>PauseEffect</code> prior to using this opcode.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xd6 - SavePosition ===
Saves various attributes of an entity (i.e., an actor, object, or performer) to the following script variables:

* <code>$POSITION_X</code>: The pixel position of the entity on the X-axis multiplied by 256.
* <code>$POSITION_Y</code>: The pixel position of the entity on the Y-axis multiplied by 256.
* <code>$POSITION_HEIGHT</code>: The pixel height (i.e., displacement of the entity from their shadow) of the entity multiplied by 256.
* <code>$POSITION_DIRECTION</code>: The direction the entity is facing.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0xd7 - screen_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd8 - screen_FadeChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd9 - screen_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xda - screen_FadeInAll ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdb - screen_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdc - screen_FadeOutAll ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdd - screen_FlushChange ===
Does nothing.
{| class="wikitable"
|+Parameters
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}

=== 0xde - screen_FlushIn ===
Changes the color of the screen from a specific state (given by the opcode's parameters, which affect the Touch Screen instantly) to its default state across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xdf - screen_FlushOut ===
Changes the color of the screen across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xe0 - screen_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe1 - screen_WhiteChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe2 - screen_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOut</code>, use <code>screen_FadeIn</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe3 - screen_WhiteInAll ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOutAll</code>, use <code>screen_FadeInAll</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe4 - screen_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe5 - screen_WhiteOutAll ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe6 - screen2_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xe7 - screen2_FadeChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xe8 - screen2_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xe9 - screen2_FadeInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xea - screen2_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xeb - screen2_FadeOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xec - screen2_FlushChange ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}
=== 0xed - screen2_FlushIn ===
The same as <code>screen_FlushIn</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xee - screen2_FlushOut ===
The same as <code>screen_FlushOut</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xef - screen2_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xf0 - screen2_WhiteChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xf1 - screen2_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen2_WhiteOut</code>, use <code>screen2_FadeIn</code> to restore the Top Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf2 - screen2_WhiteInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf3 - screen2_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xf4 - screen2_WhiteOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf5 - se_ChangePan ===
Changes the panning of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's panning.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xf6 - se_ChangeVolume ===
Changes the volume of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's volume.
|-
|3
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xf7 - se_FadeOut ===
Fades out the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to fade out and silence a given SE.
|}
=== 0xf8 - se_Play ===
Instantly plays a [[sound effect]].

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xf9 - se_PlayFull ===
Instantly plays a [[sound effect]] at a specified volume and panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfa - se_PlayPan ===
Instantly plays a [[sound effect]] at a specified panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfb - se_PlayVolume ===
Instantly plays a [[sound effect]] at a specified volume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xfc - se_Stop ===
Instantly stops a specified sound effect.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xfd - SetAnimation ===
Plays a sprite's animation, optionally changing its speed and animation flags.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|id
|Animation table index. Converted to an [[Animation ID]] for the current sprite using the [https://docs.google.com/spreadsheets/d/11xHv80Def5mtF60ZsfI1lF1eNX0dBE2It837Q08AlRk/htmlview SetAnimation table].
|}
=== 0xfe - SetAttribute ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|}
=== 0xff - SetBlink ===
Sets a specific entity (i.e., an actor, object, or performer) to continuously flicker in and out of view at a certain interval.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|visible_interval
|The number of frames to wait for while the entity is visible.
|-
|2
|uint
|invisible_interval
|The number of frames to wait for while the entity is invisible.
|}
=== 0x100 - SetDirection ===
Instantly sets a specific entity (i.e., an actor, object, or performer) to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x101 - SetDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x102 - SetEffect ===
Plays back an [[List of Effect Animations|effect animation]] assigned to an actor or performer.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|The ID of a given effect.
|-
|2
|uint
|position_marker_id?
|Set to one of the following character sprite offsets:
0: Head 1: Right Hand 2: Left Hand 3: Center 4: No offset (bottom of sprite)
|}

=== 0x103 - SetFunctionAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x104 - SetHeight ===
Moves an actor "vertically" by distancing it from its shadow.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|number of pixels to move up or down by.
|}
=== 0x105 - SetHitAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x106 - SetMoveRange ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|-
|5
|uint
|unk4
|
|-
|6
|uint
|unk5
|
|}
=== 0x107 - SetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 1.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0x108 - SetPosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|x
|
|-
|2
|uint
|y
|
|}
=== 0x109 - SetPositionInitial ===
<TO DO: Opcode description>

No parameters.
=== 0x10a - SetPositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x10b - SetPositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x10c - SetPositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10d - SetPositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10e - SetReplyAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x10f - SetupOutputAttributeAndAnimation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x110 - Slide2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}

=== 0x111 - Slide2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|actor_id
|The ID of the actor to move the entity to.
|}

=== 0x112 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x113 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_mark
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x114 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x115 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x116 - Slide2PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x117 - Slide3Position ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x118 - Slide3PositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|actor_id
|
|}
=== 0x119 - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|PositionMark
|pos_marker
|This parameter may be repeated multiple times
|}
=== 0x11a - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x11b - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x11c - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11d - Slide3PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11e - SlideHeight ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x11f - SlidePosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x120 - SlidePositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x121 - SlidePositionLivesTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x122 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x123 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x124 - SlidePositionMarkTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|}
=== 0x125 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
|This parameter may be repeated multiple times
|}
=== 0x126 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x127 - sound_FadeOut ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x128 - sound_Stop ===
<TO DO: Opcode description>

No parameters.
=== 0x129 - StopAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x12a - supervision_Acting ===
Loads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12b - supervision_ActingInvisible ===
Loads a sector of the Acting scene. Actors and objects in this sector will be invisible.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12c - supervision_ExecuteActing ===
Loads a specified Acting script from the specified level from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|Map LEVEL the script should be located in.
|-
|2
|ConstString
|script_id
|Name of the script itself, only the first 8 characters are read.
|-
|3
|uint
|script_sector
|The "sector" of the script, and the value <code>switch(sector())</code> will return in def 0. Often used to determine whether a cutscene should be played as a flashback or not.
|}

=== 0x12d - supervision_ExecuteActingSub ===
Loads a specified Acting script from the specified level from within Unionall.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|Map LEVEL the script should be located in.
|-
|2
|ConstString
|script_id
|Name of the script itself, only the first 8 characters are read.
|-
|3
|uint
|script_sector
|The "sector" of the script, and the value <code>switch(sector())</code> will return in def 0. Often used to determine whether a cutscene should be played as a flashback or not.
|}

=== 0x12e - supervision_ExecuteCommon ===
Loads a specified Unionall coroutine from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|
|}

=== 0x12f - supervision_ExecuteEnter ===
Loads an Enter script from the specified level.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|level_id
|An entry in the Level list.
|}

=== 0x130 - supervision_ExecuteStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x131 - supervision_ExecuteStationCommon ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x132 - supervision_ExecuteStationCommonSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x133 - supervision_ExecuteStationSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x134 - supervision_ExecuteExport ===
Loads a specified Acting scene of the level S00P01A

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|script_id
|
|}

=== 0x135 - supervision_ExecuteExportSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|const
|
|}
=== 0x136 - supervision_LoadStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|}
=== 0x137 - supervision_Remove ===
Unloads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x138 - supervision_RemoveActing ===
Unloads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x139 - supervision_RemoveCommon ===
Unloads a sector of the Enter scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x13a - supervision_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x13b - supervision_Station ===
Loads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13c - supervision_StationCommon ===
Loads a sector of the Enter scene.

Can be used to call sectors of an enter scene within acting scenes!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13d - supervision_Suspend ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|unk0
|
|}
=== 0x13e - supervision2_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14c - Turn2Direction ===
Makes an actor rotate to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Direction
|direction
|The direction that the actor will turn to face.
|}

=== 0x14d - Turn2DirectionLives ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Entity
|actor_id
|The target actor that the actor will turn to face.
|}

=== 0x14e - Turn2DirectionLives2 ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|actor_id
|ID of the target actor from Level List that the actor will turn to face.
|}

=== 0x14f - Turn2DirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|-
|4
|uint
|unk6
|
|-
|5
|uint
|unk7
|
|}
=== 0x150 - Turn2DirectionTurn ===
Makes an actor turn at a certain angle.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|angle
|1: 45 degrees left, 2: 45 degrees right, 3: 90 degrees right, 4: 90 degrees left, 5: 180 degrees
|}

=== 0x151 - Turn3 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|unk3
|
|}
=== 0x152 - TurnDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x153 - TurnDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x154 - TurnDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x155 - TurnDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x156 - Unlock ===
Resumes the routine that was suspended when <code>Lock</code> was called with the specified ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x157 - Wait ===
Pauses the routine for a set number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames that the routine will wait for before resuming.
|}

=== 0x158 - WaitAnimation ===
Pauses the routine until the specified actor has finished its animation. After the actor finishes its animation, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x159 - WaitBackEffect ===
Pauses the current routine until [[List of Opcodes#0x2 - back SetBackEffect|back_SetBackEffect]] is called.

No parameters.
=== 0x15a - WaitBack2Effect ===
Pauses the current routine until [[List of Opcodes#0x12 - back2 SetBackEffect|back2_SetBackEffect]] is called.

No parameters.

=== 0x15b - WaitBgm ===
Pauses the current routine until the specified BGM on the first BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15c - WaitBgm2 ===
Pauses the current routine until the specified BGM on the second BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15d - WaitBgmSignal ===
Pauses the routine until a DSE event with ID 0xF6 on the current BGM track is triggered. This can be used to sync certain parts of the scene to the background music.

No parameters.
=== 0x15e - WaitEffect ===
Pauses the routine until the effect on the specified actor/peformer has ended. After the effect ends, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x15f - WaitEndAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x160 - WaitExecuteLives ===
Pauses the routine until the specified actor has finished its action (Move2Position, Slide2Position, etc.). After the actor finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|The actor that the routine will wait for.
|}

=== 0x161 - WaitExecuteObject ===
Pauses the current routine until the specified object has finished its action (Move2Position, Slide2Position, etc.). After the object finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|The ID of the object that the routine will wait for.
|}

=== 0x162 - WaitExecutePerformer ===
Pauses the current routine until the specified performer has finished its current action (Move2Position, Slide2Position, etc.) After the performer has finished its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|The ID of the performer that the routine will wait for.
|}

=== 0x163 - WaitFadeIn ===
Pauses the current routine and waits for the screen to fade in. After the screen fades in, the routine will resume.

No parameters.

=== 0x164 - WaitLockLives ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified actor's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Entity
|actor
|
|}

=== 0x165 - WaitLockObject ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified object's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Object
|object
|
|}

=== 0x166 - WaitLockPerformer ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified performer's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|uint
|performer
|
|}

=== 0x167 - WaitLockSupervision ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in <code>def 0</code>. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|}

=== 0x168 - WaitMe ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x169 - WaitMoveCamera ===
<TO DO: Opcode description>

No parameters.
=== 0x16a - WaitMoveCamera2 ===
<TO DO: Opcode description>

No parameters.
=== 0x16b - WaitRandom ===
Pauses the routine for a random number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration_min
|Minimum number of frames that the routine will wait for before resuming.
|-
|2
|uint
|duration_max
|Maximum number of frames that the routine will wait for before resuming.
|}

=== 0x16c - WaitScreenFade ===
Waits until screen_FadeIn finishes executing.

No parameters.
=== 0x16d - WaitScreenFadeAll ===
Waits until screen_FadeInAll finishes executing.

No parameters.
=== 0x16e - WaitScreen2Fade ===
Waits until screen2_FadeIn finishes executing.

No parameters.
=== 0x16f - WaitSe ===
Pauses the current routine until the specified sound effect has ended. After the sound effect ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|The ID of the sound to wait for the end of before resuming the routine.
|}

=== 0x170 - WaitSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x171 - WaitSubScreen ===
<TO DO: Opcode description>

No parameters.
=== 0x172 - WaitSubSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x173 - worldmap_BlinkMark ===
Shows a blinking world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x174 - worldmap_ChangeLevel ===
Causes the clouds parting animation on the world map, presumably hardcoded by vanilla use-case.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_level
|Level to transition the world map state to.
|}
=== 0x175 - worldmap_DeleteArrow ===
Remove the yellow arrow from the world map.

No parameters.

=== 0x176 - worldmap_MoveCamera ===
Moves the camera to the specified world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x177 - worldmap_OffMessage ===
Removes a textbox with the world map marker's name from the Top Screen

No parameters.

=== 0x178 - worldmap_SetArrow ===
Shows an arrow pointing to a specified world map marker

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x179 - worldmap_SetCamera ===
Centers the world map camera on a specific world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|The world map id to center the camera on.
|}
=== 0x17a - worldmap_SetLevel ===
Sets the current world map state. Additionally updates $WORLD_MAP_LEVEL

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_level
|Level to assign the world map state to.
|}
=== 0x17b - worldmap_SetMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x17c - worldmap_SetMessage ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x17d - worldmap_SetMessagePlace ===
Shows a textbox on the Top Screen with the specified world map marker's name.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x17e - worldmap_SetMode ===
Sets the "mode" of the world map, to align with a particular purpose. Mode 3 is for handling moving clouds.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_mode
|
|}

== Other Opcodes ==
These opcodes cannot be directly called from ExplorerScript, since they are represented as higher-level constructs.

=== 0x28 - Branch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x29 - BranchBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2a - BranchDebug ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2b - BranchEdit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2c - BranchExecuteSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2d - BranchPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2e - BranchScenarioNow ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x2f - BranchScenarioNowAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x30 - BranchScenarioNowBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x31 - BranchScenarioAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x32 - BranchScenarioBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x33 - BranchSum ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x34 - BranchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|uint
|value
|
|-
|4
|uint
|jump_address
|
|}
=== 0x35 - BranchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|GameVar
|cmp_var
|
|-
|4
|uint
|jump_address
|
|}
=== 0x36 - BranchVariation ===
Used for demo cutscenes.

Jumps to the specified address if the first parameter is 0. On the demo version of the game, jumps if the first parameter is 3.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|Unknown. Always 3.
|-
|2
|uint
|jump_address
|Address to jump to.
|}
=== 0x37 - Call ===
Jumps to the specified address, runs code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the routine this opcode calls). Only one call can be stored at a time!

Use within macros is ill-advised, as using <code>return;</code> within a macro will just end the macro!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|The address to call, e.g., <code>call @label_0;</code> if <code>§label_0;</code> is defined in the script.
|}
=== 0x63 - Case ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|uint
|jump_address
|
|}
=== 0x64 - CaseMenu ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|choice
|
|-
|2
|uint
|jump_address
|
|}
=== 0x65 - CaseMenu2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint?
|choice?
|
|-
|2
|uint
|jump_address
|
|}
=== 0x66 - CaseScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x67 - CaseText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|String
|display
|
|}
=== 0x68 - CaseValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x69 - CaseVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|GameVar
|var
|
|-
|3
|uint
|jump_address
|
|}
=== 0x6e - DefaultText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x70 - End ===
<TO DO: Opcode description>

No parameters.
=== 0x74 - flag_CalcBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|value
|
|}
=== 0x75 - flag_CalcValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|uint
|value
|
|}
=== 0x76 - flag_CalcVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|GameVar
|var_to_set_from
|
|}
=== 0x77 - flag_Clear ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x78 - flag_Initial ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x79 - flag_Set ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|}
=== 0x7a - flag_ResetDungeonResult ===
<TO DO: Opcode description>

No parameters.
=== 0x7b - flag_ResetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x7c - flag_SetAdventureLog ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x7d - flag_SetDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|-
|2
|DungeonMode
|dungen_mode
|
|}
=== 0x7e - flag_SetDungeonResult ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x7f - flag_SetPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|}
=== 0x80 - flag_SetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|scenario_value
|
|-
|3
|uint
|level_value
|
|}
=== 0x82 - Hold ===
Will stall a script forever.

No parameters.
=== 0x87 - Jump ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|
|}
=== 0x89 - lives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|
|}
=== 0xaa - message_SwitchMenu ===
Enclose within a switch case, and generates a dialogue prompt with the options present in subsequent "case menu("text"):"

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|}
=== 0xab - message_SwitchMenu2 ===
Same as message_SwitchMenu, but it also takes an argument for a bitfield, and will only display dialogue options for which the corresponding bit is enabled (set to 1).

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|-
|3
|uint
|unk2
|Bitfield $VAR
|}
=== 0xac - message_SwitchMonologue ===
Structured similarly to a switch statement. Typically uses <code>$HERO_TALK_KIND</code> as an argument, and uses multiple cases to display certain dialogue strings.

<code>case 4:</code> used when the player is male or genderless

<code>case 5:</code> used when the player is female

<code>default:</code> used when <code>$HERO_TALK_KIND</code>'s Talk Group has a value other than 4 or 5

This opcode supports displaying a portrait. No sound effect is used when text is scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xad - message_SwitchTalk ===
Same as _SwitchMonologue, but typically uses <code>$PARTNER_TALK_KIND</code> as an argument, and the cases used vary.

Of the vanilla game partner options:

<code>case 1:</code> used if Squirtle, Tododile, Chimchar, Meowth, or Munchlax

<code>case 2:</code> used for all other male partners

<code>case 3:</code> used for all female partners

<code>default:</code> used when <code>$PARTNER_TALK_KIND</code>'s Talk Group has a value other than 1, 2, or 3

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xc9 - object ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|
|}
=== 0xcb - performer ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|
|}
=== 0xd5 - Return ===
If run from within a macro, ends the macro.

If run after the "call" opcode was used, will return to the address of the call opcode.

If used within a script, ends the script.

No parameters.
=== 0x13f - Switch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x140 - SwitchDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x141 - SwitchDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x142 - SwitchDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x143 - SwitchDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x144 - SwitchDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|}
=== 0x145 - SwitchLives ===
If inside a Switch Case, take the case equal to the species ID of the specified Actor!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0x146 - SwitchRandom ===
To be used in a switch statement. Will switch to a case of a random number below the specified integer.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|max_value
|Largest random output, plus 1
|}
=== 0x147 - SwitchScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x148 - SwitchScenarioLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x149 - SwitchSector ===
<TO DO: Opcode description>

No parameters.
=== 0x14a - SwitchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14b - SwitchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
{{NavScriptTerms}}
[[Category:Documentation]]

Scenario Main Values

2026-02-01T21:32:19Z

Happylappy: Document Postgame $SCENARIO_MAIN.

{{Stub}}

The following table is a work-in-progress list of the scenario main (<code>$SCENARIO_MAIN</code>) values used by the vanilla game. These values help the game know where you are in the story and what events have (or have not) been triggered. They are also used to determine things that change based on story progression, such as which NPCs spawn in Treasure Town or the dialogue said by the partner if you turn to talk to them in the overworld.

The format used by the game for defining this variable is <code>$SCENARIO_MAIN = scn[1, 0];</code> where the two numbers in the brackets change depending on story progression.

For scripts that check for specific $SCENARIO_MAIN values using if-statements (such as to determine what partner dialogue should be played at that point in the story), you will usually see the value mentioned in a format like the following, which is taken from one of the partner's overworld dialogue scripts: <code>if ( scn($SCENARIO_MAIN) >= [26, 5] )</code> . In this example, the game is checking to see if the current $SCENARIO_MAIN value is ''greater than or equal to'' <code>[26, 5]</code> and, if that is indeed the case, then the partner's overworld dialogue will be some variation of "We're so close... There's no way we can give up now, [hero]!"

Because some scripts have identical names, the column for the script locations of each $SCENARIO_MAIN value will also include the name of the map folder they are found in. For example, the $SCENARIO_MAIN value that gets triggered following the Project P cutscene can be triggered by four seprate enter scripts that have identical names (''enter01.ssb'' and ''enter02.ssb'', respectively), so the corresponding map folder names are also included to help users know which enter scripts to look for.
{| class="wikitable center"
|+
!Scenario Main (Values)
!Game Chapter
!Description
!Script location of the value
!Other notes
!Other scripts that mention this value
!Debug Menu (that uses this value)
|-
|<code>$SCENARIO_MAIN = '''scn[1, 0];'''</code>
|
|Immediately BEFORE the personality quiz
|Found in '''unionall''' under
<code>EVENT_DIVIDE_OPENING</code>

''~ line 900''
|Contained within the larger <code>EVENT_DIVIDE</code>
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[2, 0];'''</code>
|
|Immediately AFTER the personality quiz
|Found in '''unionall''' under
<code>EVENT_M00A_01</code>

''~ line 2261''
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[2, 1];'''</code>
|
|
|Found in '''unionall''' under
<code>EVENT_DIVIDE_FIRST</code>

''~ line 967''
|'''''happylappy''''' writes that this is in a switch case in <code>EVENT_DIVIDE</code> over $SCENARIO_MAIN
''“Basically, if it’s [X, 0], make it [X, 1]… for these chapters only”''

(also applies to scn[3, 1];)
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[2, 2];'''</code>
!'''Chapter 1'''
|Partner’s Relic Fragment was just stolen on the beach
|'''D01P11B'''
<code>m01a0208.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[2, 3];'''</code>
|Ch. 1
|Pre-fight in Beach Cave
|'''D01P41A'''
<code>m01a0401.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[3, 0];'''</code>
|
|Visual of the Rainbow Stoneship along with ''“The Pokémon Company and CHUNSOFT presents”'' before the game title appears
|'''S11P02C'''
<code>t01p0801.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2150''
|'''Main 2'''
|-
|<code>$SCENARIO_MAIN = '''scn[3, 1];'''</code>
!'''Chapter 2'''
|About to enter Wigglytuff’s Guild for the first time with the partner
|'''G01P01B'''
<code>m02a0101.ssb</code>
|This value appears in the script mentioned by the previous cell, EVENT_DIVIDE, the debug script, and also in a switch case in EVENT_DIVIDE_FIRST (exact locations can be found in the next cell)
Same note from '''''happylappy''''' as [2, 1] where ''“Basically, if it’s [X, 0], make it [X, 1]… for these chapters only”''
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1599''

&

''~ line 393''
----Found in '''unionall.ssb'''

<code>EVENT_DIVIDE</code>

''~ line 750''
----Found in '''unionall.ssb'''

<code>EVENT_DIVIDE_FIRST</code>

''~ line 983''
|(under “Others”)
'''M2 The First Job'''

----(under “Dialogue Check”)

'''TALK-M02-01'''
|-
|<code>$SCENARIO_MAIN = '''scn[3, 2];'''</code>
|Ch. 2
|Chatot has you follow him since it’s your first day (about to learn about the Job Bulletin Board)
|'''G01P04A'''
<code>m02a0301.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[3, 3];'''</code>
|Ch. 2
|Entering Drenched Bluff for Spoink’s mission
|'''D02P11A'''
<code>m02a0401.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[3, 4];'''</code>
|Ch. 2
|Enter Drenched Bluff for Spoink’s mission ''(if you failed previously)''
|'''D02P11A'''
<code>m02a0701.ssb</code>
|This one is found in a case menu
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[3, 5];'''</code>
|Ch. 2
|Enter Drenched Bluff for Spoink’s mission ''(if you failed previously)''
|'''D02P11A'''
<code>m02a0701.ssb</code>
|This one is in a case menu, same scene as above
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[3, 6];'''</code>
|Ch. 2
|You find Spoink’s missing pearl at the end of Drenched Bluff
|'''D02P31A'''
<code>m02a0801.ssb</code>
|This one is in a case menu, probably relating to the '''demo version'''
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[3, 7];'''</code>
|Ch. 2
|You find Spoink’s missing pearl at the end of Drenched Bluff
|'''D02P31A'''
<code>m02a0801.ssb</code>
|This one is in a case menu, probably relating to the '''demo version'''
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[4, 0];'''</code>
|Ch. 2
|Going to bed after your first successful job mission (also the end of chapter 2)
|'''G01P07C'''
<code>m02a1003.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1896''

''&''

''~ line 1607''

''&''

''~ line 401''
|'''Main 3'''
----(under “Others”)

'''M3 Outlaw Notice Board'''
----(under “Dialogue Check”)

'''TALK-M03-01B'''
|-
|<code>$SCENARIO_MAIN = '''scn[4, 1];'''</code>
!Chapter 3
|Chatot notices you wandering the day after your first mission (about to learn about the Outlaw Notice Board)
|'''G01P04A'''
<code>m03a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1615''

''&''

''~ line 406''
|(under “Others”)
'''Not That Way'''
----(under “Dialogue Check”)

'''TALK-M03-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[4, 2];'''</code>
|Ch. 3
|Meeting Marill and Azurill for the first time at Kecleon Market
|'''T01P02A'''
<code>m03a0301.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1623''

''&''

''~ line 411''
|(under “Others”)
'''M3 Drowzee'''
----(under “Dialogue Check”)

'''TALK-M03-03'''
|-
|<code>$SCENARIO_MAIN = '''scn[4, 3];'''</code>
|Ch. 3
|Meeting Drowzee for the first time
|'''T01P01A'''
<code>m03a0401.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1631''

''&''

''~ line 416''
|(under “Others”)
'''M3 Truth'''
----(under “Dialogue Check”)

'''TALK-M03-04'''
|-
|<code>$SCENARIO_MAIN = '''scn[4, 4];'''</code>
|Ch. 3
|Bidoof is about to help you pick your first outlaw job
|'''G01P03A'''
<code>m03a0502.ssb</code>
|
|'''D01P11A'''
<code>dus08.ssb</code>
|
|-
|<code>$SCENARIO_MAIN = '''scn[4, 5];'''</code>
|Ch. 3
|About to enter Mt. Bristle to save Azurill from Drowzee
|'''D03P11A'''
<code>m03a0601.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 421''
|(under “Dialogue Check”)
'''TALK-M03-06'''
|-
|<code>$SCENARIO_MAIN = '''scn[4, 6];'''</code>
|Ch. 3
|Drowzee reveals that it was all a trick to Azurill (pre-boss fight)
|'''D03P41A'''
<code>m03a0801.ssb</code>
|For whatever reason, this particular variable appears twice in the same script (at the start of the scene and then right after the boss fight screen wipe effect)
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[4, 7];'''</code>
|Ch. 3
|Drowzee is defeated and you rescue Azurill
|'''D03P41A'''
<code>m03a1001.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 426''
|(under “Dialogue Check”)
'''TALK-M03-08'''
|-
|<code>$SCENARIO_MAIN = '''scn[5, 0];'''</code>
|
|Requires you to do '''3+ missions''' and <code>scn[4, 7];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2283''
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2160''
|'''Main 4'''
|-
|<code>$SCENARIO_MAIN = '''scn[5, 1];'''</code>
!Chapter 4
|Loudred calls you over to do sentry duty for the first time
|'''G01P04A'''
<code>m04a0101.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[5, 2];'''</code>
|Ch. 4
|Triggers as the hero and partner are crawling to the sentry post
|'''G01P04A'''
<code>m04a0106.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[5, 3];'''</code>
|Ch. 4
|You have just completed sentry duty for the first time, and are about to hear your results
|'''G01P04A'''
<code>m04a0201.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[5, 4];'''</code>
|Ch. 4
|Triggers just after you receive the results if you failed sentry duty
|'''G01P04A'''
m04a0201.ssb
|Only triggers if you failed sentry duty
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[5, 5];'''</code>
|Ch. 4
|Triggers after you’ve seen the cutscene where your team and Loudred go without dinner, which only happens if you failed sentry duty
|Found in '''unionall''' under
<code>EVENT_M04_02_03</code>

''~ line 3242''
|''Only triggers if <code>scn[5, 4];</code>''

Appears in a switch case
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 431''
|(under “Dialogue Check”)

'''TALK-M04-03'''
|-
|<code>$SCENARIO_MAIN = '''scn[5, 6];'''</code>
|Ch. 4
|Requires you to do '''2+ missions''' and <code>scn[5, 5];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2314''
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[5, 7];'''</code>
|Ch. 4
|Requires you to '''“do 0+ missions”''' and <code>scn[5, 6];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2325''
|'''''happylappy''''' suspects that this, and others like it, are just counting the number of days that pass
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[5, 8];'''</code>
|Ch. 4
|Requires you to '''“do 0+ missions”''' and <code>scn[5, 7];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2336''
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[6, 0];'''</code>
!Chapter 5
|Requires you to '''“do 0+ missions”''' and<code>scn[5, 8];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2347''
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2165''
|'''Main 5'''
|-
|<code>$SCENARIO_MAIN = '''scn[6, 1];'''</code>
|Ch. 5
|Morning address where Chatot announces that Treeshroud Forest’s Time Gear has been stolen
|'''G01P04A'''
<code>m05a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 436''
|(under “Dialogue Check”)
'''TALK-M05-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[6, 2];'''</code>
|Ch. 5
|Triggers after you tell Chatot you understand the details of your mission to investigate Waterfall Cave
|'''G01P04A'''
<code>m05a0203.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[6, 3];'''</code>
|Ch. 5
|Chimecho Assembly opens
|'''G01P03A'''
<code>m00p0101.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[6, 4];'''</code>
|Ch. 5
|The hero and partner discover the stairs to Spinda’s shop for the first time (“opening soon!”)
|'''P01P01A'''
<code>s30a0101.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[6, 5];'''</code>
|Ch. 5
|Triggers when you enter Waterfall Cave for the first time
|'''D04P12A'''
<code>m05a0304.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 441''
|(under “Dialogue Check”)
'''TALK-M05-04'''
|-
|<code>$SCENARIO_MAIN = '''scn[6, 6];'''</code>
|Ch. 5
|Reaching the bottom of Waterfall Cave
|'''D04P31A'''
<code>m05a0601.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[7, 0];'''</code>
|Ch. 5
|After dinner, Wigglytuff tells your team about the upcoming expedition
|'''G01P05C'''
<code>m05a0911.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2170''
|'''Main 6'''
|-
|<code>$SCENARIO_MAIN = '''scn[7, 1];'''</code>
!Chapter 6
|During the morning address, Chatot talks to everyone about the expedition
|'''G01P04A'''
<code>m06a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 446''
|(under “Dialogue Check”)
'''TALK-M06-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[7, 2];'''</code>
|Ch. 6
|About to encounter Koffing and Zubat at the job boards
|'''G01P03A'''
<code>m06a0201.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 451''
|(under “Dialogue Check”)
'''TALK-M06-03'''
|-
|<code>$SCENARIO_MAIN = '''scn[7, 3];'''</code>
|Ch. 6
|Opening cutscene for Spinda’s Café
|'''P01P01A'''
<code>s30a0201.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 456''
|(under “Dialogue Check”)
'''TALK-M06-035'''
|-
|<code>$SCENARIO_MAIN = '''scn[7, 4];'''</code>
|Ch. 6
|Loudred calls the hero and partner over for sentry duty (again)
|'''G01P04A'''
<code>m06a0401.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[7, 5];'''</code>
|Ch. 6
|Diglett has something else he has to do, and needs your team to do sentry duty again
|'''G01P04A'''
<code>m06a0401.ssb</code>

&

<code>m06a0403.ssb</code>
|Triggers twice for whatever reason. The first time is at the start of the scene where Diglett asks for your help again, and the second time is after you confirm to Loudred that you understand what you need to do (i.e. right before the sentry duty minigame starts)
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[7, 6];'''</code>
|Ch. 6
|Chatot has just announced that Team Skull will be living at the guild until the expedition
|'''G01P04A'''
<code>m06a0501.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 461''
|(under “Dialogue Check”)
'''TALK-M06-05'''
|-
|<code>$SCENARIO_MAIN = '''scn[8, 0];'''</code>
|Ch. 6
|Requires <code>scn[7, 6];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2431''
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2175''
|'''Main 7'''
|-
|<code>$SCENARIO_MAIN = '''scn[8, 1];'''</code>
|Ch. 6
|Chatot asks your team to go find Perfect Apples at Apple Woods
|'''G01P04A'''
<code>m07a0301.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 466''
|(under “Dialogue Check”)
'''TALK-M07-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[8, 2];'''</code>
|Ch. 6
|Entering Apple Woods for the first time
|'''D05P11A'''
<code>m07a0601.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 471''
|(under “Dialogue Check”)
'''TALK-M07-04'''
|-
|<code>$SCENARIO_MAIN = '''scn[8, 3];'''</code>
|Ch, 6
|Reaching the end of Apple Woods and encountering Team Skull
|'''D05P31A'''
<code>m07a0701.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[8, 4];'''</code>
|Ch. 6
|The other guild apprentices sneak in some food for the hero and partner
|'''G01P07A'''
<code>m07a1302.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 476''
|(under “Dialogue Check”)
'''TALK-M07-06'''
|-
|<code>$SCENARIO_MAIN = '''scn[8, 5];'''</code>
|Ch. 6
|Project P is introduced to the player for the first time upon entering the crossroads
|'''P01P01A'''
<code>s30a0301.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 481''
|(under “Dialogue Check”)
'''TALK-M07-065'''
|-
|<code>$SCENARIO_MAIN = '''scn[8, 6];'''</code>
|Ch. 6
|Seems to be triggered upon re-entering the crossroads after having seen the Project P cutscene (i.e., having <code>scn[8, 5];</code>)
|'''G01P01A'''
<code>enter02.ssb</code>
----'''P01P02A'''

<code>enter02.ssb</code>
----'''P01P04A'''

<code>enter01.ssb</code>
----'''T01P01A'''

<code>enter01.ssb</code>
|This value can be triggered by four different enter scripts that all connect to the crossroads
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 488''
|(under “Dialogue Check”)
'''TALK-M07-067'''
|-
|<code>$SCENARIO_MAIN = '''scn[8, 7];'''</code>
|Ch. 6
|Requires you to do '''1+ missions''' and <code>scn[8, 6];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2358''
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 493''
|(under “Dialogue Check”)
'''TALK-M07-08'''
|-
|<code>$SCENARIO_MAIN = '''scn[8, 8];'''</code>
|Ch. 6
|Requires you to do '''sentry duty''' and have<code>scn[8, 7];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2370''
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[8, 9];'''</code>
|Ch. 6
|Requires you to “'''do 0+ missions”''' and <code>scn[8, 8];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2381''
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[9, 0];'''</code>
|Ch. 6
|Requires you to '''“do 0+ missions”''' and <code>scn[8, 9];</code>
|Found in '''unionall''' under
<code>EVENT_HA_YU_KI</code>

''~ line 2392''
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2180''
|'''Main 8'''
|-
|<code>$SCENARIO_MAIN = '''scn[9, 1];'''</code>
|Ch. 6
|Announcement of the expedition members during the morning address
|'''G01P04A'''
<code>m08a0301.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1639''

''&''

''~ line 1646''

''&''

''~ line 498''
|(under “Others”)
'''M8 Ready for the Expedition?'''
----(under “Others”)

'''M8 First Time to Craggy Coast'''
----(under “Dialogue Check”)

'''TALK-M08-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[9, 2];'''</code>
!Chapter 7
|Triggered once you enter Craggy Coast
|'''D06P11A'''
<code>m08a0603.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1653''
|(under “Others”)
'''M8 Craggy Coast Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[9, 3];'''</code>
|Ch. 7
|This is triggered after exiting the Side Path dungeon
|'''D06P11A'''
<code>m08a0701.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[9, 4];'''</code>
|Ch. 7
|Arriving at Mt. Horn
|'''D07P11A'''
<code>m08a1001.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1660''
|(under “Others”)
'''M8 First Time to Mt. Horn'''
|-
|<code>$SCENARIO_MAIN = '''scn[9, 5];'''</code>
|Ch. 7
|Triggered once you enter Mt. Horn (or Rock Path)
|'''D07P11A'''
<code>m08b1301.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1667''
|(under “Others”)
'''M8 Mt. Horn Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[9, 6];'''</code>
|Ch. 7
|This is triggered after exiting Rock Path
|'''D07P11A'''
<code>m08a1101.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[10, 0];'''</code>
|Ch. 7
|Requires that you clear Dungeon 10 (Mt. Horn)
|Found in '''unionall''' under
<code>GETOUT_SCENARIO_DUNEGON</code>

''~ line 8864''
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2185''
|'''Main 9'''
|-
|<code>$SCENARIO_MAIN = '''scn[10, 1];'''</code>
!Chapter 8
|Arriving at the Foggy Forest base camp
|'''D08P11A'''
<code>m09a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1674''
|(under “Others”)
'''M9 First Time to Foggy Forest'''
|-
|<code>$SCENARIO_MAIN = '''scn[10, 2];'''</code>
|Ch. 8
|This is triggered after the partner picks up the Drought Stone when you choose the Foggy Forest route
|'''D08P11A'''
<code>m09a0201.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1681''
|(under “Others”)
'''M9 Foggy Forest Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[10, 3];'''</code>
|Ch. 8
|Triggered upon exiting Forest Path and ending up back at base camp
|'''D08P11A'''
<code>m09a0301.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[11, 0];'''</code>
|Ch. 8
|Triggers right after the scene with Team Skull getting into position to attack Wigglytuff (<code>m09a0701.ssb</code>) ends
|Found in '''unionall''' under
<code>EVENT_M09_06_07</code>

''~ line 3656''
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2190''
|'''Main 10'''
|-
|<code>$SCENARIO_MAIN = '''scn[11, 1];'''</code>
!Chapter 9
|Arriving at Steam Cave
|'''D09P11A'''

<code>m10a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1688''
|(under “Others”)
'''M10 First Time to Steam Cave'''
|-
|<code>$SCENARIO_MAIN = '''scn[11, 2];'''</code>
|Ch. 9
|Team Skull attacks Wigglytuff
|'''P03P02A'''
<code>m10a0301.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1695''
|(under “Others”)
'''M10 Steam Cave Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[11, 3];'''</code>
|Ch. 9
|Arriving at Upper Steam Cave
|'''D10P21A'''
<code>m10a0501.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1702''
|(under “Others”)
'''M10 First Time to Steam Cave-2'''
|-
|<code>$SCENARIO_MAIN = '''scn[11, 4];'''</code>
|Ch. 9
|Hero tells the partner they think they’ve been to Fogbound Lake before
|'''D10P21A'''
<code>m10a0701.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1709''
|(under “Others”)
'''M10 Steam Cave-2 Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[11, 5];'''</code>
|Ch. 9
|Hero and partner prepare to fight Groudon
|'''D10P41A'''
<code>m10a0905.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[12, 0];'''</code>
|Ch. 9
|The guild promises Uxie that they’ll keep Fogbound Lake a secre
|'''P04P01C'''
<code>m10a1213.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2195''
|'''Main 11'''
|-
|<code>$SCENARIO_MAIN = '''scn[12, 1];'''</code>
!Chapter 10
|Dusknoir arrives at the guild
|'''G01P04A'''
<code>m11a0201.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 503''
|(under “Dialogue Check”)
'''TALK-M11-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[12, 2];'''</code>
|Ch. 10
|Identical to the usual scene of the partner saying goodnight to the hero, except this time there’s a scenario flag
|'''G01P07C'''
<code>m11a0301.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[12, 3];'''</code>
|Ch. 10
|Chatot sends you on an errand to Kecleon Market to see if they have any plans to stock Perfect Apples
|'''G01P04A'''
<code>m11a0401.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1716''

''&''

''~ line 508''
|(under “Others”)
'''M11 Marill Bros. Lost Item'''
----(under “Dialogue Check”)

'''TALK-M11-04'''
|-
|<code>$SCENARIO_MAIN = '''scn[12, 4];'''</code>
|Ch. 10
|Your team is talking to Dusknoir by Kecleon Market as Marill and Azurill rush by to find their lost item
|'''T01P02A'''
<code>m11a0501.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 513''
|(under “Dialogue Check”)
'''TALK-M11-05'''
|-
|<code>$SCENARIO_MAIN = '''scn[13, 0];'''</code>
|Ch. 10
|Grovyle tells Uxie he will be taking the third Time Gear
|'''V03P12A'''
<code>m11a0707.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2200''
|'''Main 12'''
|-
|<code>$SCENARIO_MAIN = '''scn[13, 1];'''</code>
|Ch. 10
|After the morning cheer, Loudred tells the partner and hero that they have visitors
|'''G01P04A'''
<code>m12a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 518''
|(under “Dialogue Check”)
'''TALK-M12-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[13, 2];'''</code>
|Ch. 10
|Entering Amp Plains
|'''D11P11A'''
<code>m12a0201.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1723''

''&''

''~ line 523''
|(under “Others”)
'''M12 First Time to Amp Clearing-2'''
----(under “Dialogue Check”)

'''TALK-M12-04'''
|-
|<code>$SCENARIO_MAIN = '''scn[13, 3];'''</code>
|Ch. 10
|Entering Far Amp Plains from the rest stop
|'''D12P21A'''
<code>m12a0601.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1730''
|(under “Others”)
'''M12 Amp Clearing-2 Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[13, 4];'''</code>
|Ch. 10
|Boss fight against the Manectric tribe (first attempt)
|'''D12P41A'''
<code>m12a0801.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[14, 0];'''</code>
|Ch. 10
|Bidoof comes to find your team on the beach with Dusknoir, saying everyone is needed back at the guild
|'''T01P02A'''
<code>m12a1201.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2205''
|'''Main 13'''
|-
|<code>$SCENARIO_MAIN = '''scn[14, 1];'''</code>
!Chapter 11
|Back at the guild, you learn Grovyle is the one who’s been stealing all the Time Gears
|'''G01P03A'''
<code>m13a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1737''

''&''

''~ line 528''
|(under “Others”)
'''M13 Capturing Grovyle is First'''
----(under “Dialogue Check”)

'''TALK-M13-01'''
|-
|<code>$SCENARIO_MAIN = '''scn[14, 2];'''</code>
|Ch. 11
|Everyone is assigned locations to search for Time Gears
|'''G01P03A'''
<code>m13a0301.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1744''

''&''

''~ line 533''
|(under “Others”)
'''M13 First Time to Northern Desert'''
----(under “Dialogue Check”)

'''TALK-M13-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[14, 3];'''</code>
|Ch. 11
|Seems to trigger during morning cheers the next day if you did NOT go to Northern Desert (i.e., if you completed another job instead of heading directly to Northern Desert to advance the plot)
|'''G01P07A'''
<code>enter01.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[14, 4];'''</code>
|Ch. 11
|Entering Northern Desert
|'''D13P11A'''
<code>m13a0401.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 538''
|(under “Dialogue Check”)
'''TALK-M13-04'''
|-
|<code>$SCENARIO_MAIN = '''scn[14, 5];'''</code>
|Ch. 11
|Hero and partner make it through the Northern Desert and decide the quicksand pits are a dead end
|'''D14P11A'''
<code>m13a0701.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[14, 6];'''</code>
|Ch. 11
|Hero thinks they should go back to the quicksand pits
|'''G01P04A'''
<code>m13a0903.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2210''

''&''

''~ line 543''
|'''Main 14'''
----(under “Dialogue Check”)

'''TALK-M13-06'''
|-
|<code>$SCENARIO_MAIN = '''scn[15, 1];'''</code>
|Ch. 11
|Back at the quicksand pits, the hero sensibly decides that jumping into the quicksand is the best course of action
|'''D14P11A'''
<code>m14a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 548''
|(under “Dialogue Check”)
'''TALK-M14-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[15, 2];'''</code>
|Ch. 11
|Entering Quicksand Pit from the rest stop
|'''D15P21A'''
<code>m14a0501.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1752''
|(under “Others”)
'''M14 Quicksand Cave-2 Retry'''
|-
|<code>$SCENARIO_MAIN = '''scn[15, 3];'''</code>
|Ch. 11
|The hero and partner discover the Underground Lake, but are then challenged by Mesprit
|'''D15P41A'''
<code>m14a0601.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[15, 4];'''</code>
!Chapter 12
|Based on the hero’s vision, the guild decides to set out for Crystal Cave
|'''G01P04A'''
<code>m14a0905.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 553''
|(under “Dialogue Check”)
'''TALK-M14-05'''
|-
|<code>$SCENARIO_MAIN = '''scn[15, 99];'''</code>
|
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1055''
|I never saw this getting used in regular gameplay, but when you set this value using the debug menu you’ll find yourself at the Hot Spring with Torkoal missing and half of the NPCs having the wrong character’s dialogue
|
|(under “Others”)
'''Hot Spring Check'''
|-
|<code>$SCENARIO_MAIN = '''scn[16, 0];'''</code>
|Ch. 12
|Seems to trigger during morning cheers the next day if you did NOT go to Crystal Cave (i.e., if you completed another job instead of heading directly to Crystal Cave to advance the plot)
|'''G01P07A'''
<code>enter01.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2216''

''&''

''~ line 558''
|'''Main 15'''
----(under “Dialogue Check”)

'''TALK-M15-01'''
|-
|<code>$SCENARIO_MAIN = '''scn[16, 1];'''</code>
|Ch. 12
|Entering Crystal Cave
|'''D16P11A'''
<code>m15a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1759''
|(under “Others”)
'''M15 Solve This!'''
|-
|<code>$SCENARIO_MAIN = '''scn[16, 2];'''</code>
|Ch. 12
|Your team finds the puzzle with the three colored crystals at the end of Crystal Cave
|'''D16P31A'''
<code>m15a0401.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 563''
|(under “Dialogue Check”)
'''TALK-M15-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[17, 0];'''</code>
|Ch. 12
|Hero and partner explain what happened at Crystal Lake to the guild, then Magnemite tells everyone to come to Treasure Town
|'''G01P04A'''
<code>m15b1201.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2222''
|'''Main 16'''
|-
|<code>$SCENARIO_MAIN = '''scn[17, 1];'''</code>
!Chapter 13
|Chapter 13 title card
(“Dusknoir’s Secret”)
|'''P01P01A'''
<code>m16a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1769''

''&''

''~ line 568''
|(under “Others”)
'''M16 Restrain Ourselves and Go Back'''
----(under “Dialogue Check”)

'''TALK-M16-01'''
|-
|<code>$SCENARIO_MAIN = '''scn[17, 2];'''</code>
|Ch. 13
|Before going to bed, the partner reflects back on what Dusknoir had revealed to everyone
|'''G01P07C'''
<code>m16a0302.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[17, 3];'''</code>
|Ch. 13
|Having heard no news about Grovyle’s capture, Chatot tells everyone to go about their regular work
|'''G01P04A'''

<code>m16a0401.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 573''
|(under “Dialogue Check”)
'''TALK-M16-03'''
|-
|<code>$SCENARIO_MAIN = '''scn[17, 4];'''</code>
|Ch. 13
|Before bed, the partner and hero wonder about the world of the future and if Grovyle has been captured yet ''(this is likely the night before you go to the future)''
|'''G01P07C'''
<code>m16a0502.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[18, 0];'''</code>
|Ch. 13
|Triggers immediately after you finish traveling through the Dimensional Hole into the future
|'''V16P02A'''
<code>m16a0702.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2227''
|'''Main 17'''
|-
|<code>$SCENARIO_MAIN = '''scn[18, 1];'''</code>
!Chapter 14
|Waking up in the future
|'''V17P03A'''
<code>m17a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1777''

''&''

''~ line 578''
|(under “Others”)
'''M17 Check the Doors'''
----(under “Dialogue Check”)

'''TALK-M17-01'''
|-
|<code>$SCENARIO_MAIN = '''scn[18, 2];'''</code>
|Ch. 14
|The hero unsuccessfully tries to open the jail cell doors in the future
|'''P05P02A'''
<code>m170201.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1781''

''&''

''~ line 1784''

''&''

''~ line 583''
|(under “Others”)
'''M17 To the Stockade'''
----(under “Others”)

'''M17 First Time to Chasm Cave'''
----(under “Dialogue Check”)

'''TALK-M17-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[18, 3];'''</code>
|Ch. 14
|Grovyle decides to keep moving and leaves, meanwhile the partner struggles with the truth
|'''D18P11A'''
<code>m17a0504.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1798''
|(under “Others”)
'''M17 Chasm Cave Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[18, 4];'''</code>
|Ch. 14
|Triggers if you fail Chasm Cave
|'''D18P11A'''
<code>m17a0701.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[19, 0];'''</code>
|Ch. 14
|
|Found in '''unionall''' under
<code>GETOUT_SCENARIO_DUNEGON</code>

''~ line 8965''
|Seemingly gets skipped over upon clearing Chasm Cave, so I don’t know what specifically triggers this
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2232''

''&''

''~ line 1805''
|'''Main 18'''
----(under “Others”)

'''M18 First Time to Dark Hill'''
|-
|<code>$SCENARIO_MAIN = '''scn[19, 1];'''</code>
|Ch. 14
|Triggers once you complete Chasm Cave (you are about to try and use the Dimensional Scream on the frozen waterfall)
|'''D19P11A'''
<code>m18a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1812''

''&''

''~ line 1819''
|(under “Others”)
'''M18 Dark Hill Exploration'''
----(under “Others”)

'''M18 First Time to Sealed Ruin'''
|-
|<code>$SCENARIO_MAIN = '''scn[19, 2];'''</code>
|Ch. 14
|Triggers after you complete Dark Hill, before the partner sees the lights from the stockade
|'''P06P01A'''
<code>m18a0401.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1826''

''&''

''~ line 1833''
|(under “Others”)
'''M18 Sealed Ruin Exploration'''
----(under “Others”)

'''M18 First Time to Sealed Ruin-2'''
|-
|<code>$SCENARIO_MAIN = '''scn[19, 3];'''</code>
|Ch. 14
|Entering Sealed Pit Ruin (for the first time)
|'''D21P21A'''
<code>m18b0901.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1840''
|(under “Others”)
'''M19 Sealed Ruin-2 Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[19, 4];'''</code>
|Ch. 14
|Triggers before your first attempt at the Spiritomb boss fight
|'''D21P41A'''
<code>m18b1101.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[20, 0];'''</code>
!Chapter 15
|Triggers after Grovyle has explained the truth about the future and your team decides to follow him so they can get home
|'''P07P01A'''
<code>m18b1401.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2237''
|'''Main 19'''
|-
|<code>$SCENARIO_MAIN = '''scn[20, 1];'''</code>
|Ch. 15
|Visual of the paralyzed future
|'''V17P03A'''
<code>m19a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1847''

''&''

''~ line 588''
|(under “Others”)
'''M19 First Time to Dusk Forest'''
----(under “Dialogue Check”)

'''TALK-M19-01'''
|-
|<code>$SCENARIO_MAIN = '''scn[20, 2];'''</code>
|Ch. 15
|Entering Dusk Forest
|'''D22P11A'''
<code>m19a0301.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1854''

''&''

''~ line 1861''
|(under “Others”)
'''M19 Dusk Forest Exploration'''
----(under “Others”)

'''M19 First Time to Deep Dusk Forest'''
|-
|<code>$SCENARIO_MAIN = '''scn[20, 3];'''</code>
|Ch. 15
|While heading to the entrance to Deep Dusk Forest, Celebi explains the Passage of Time
|'''D23P11A'''
<code>m19b0701.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1868''
|(under “Others”)
'''M19 Deep Dusk Forest Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[20, 4];'''</code>
|Ch. 15
|Triggers if you fail Deep Dusk Forest
|'''D23P11A'''
<code>m19b0901.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[21, 0];'''</code>
|Ch. 15
|Traveling through the Passage of Time
|'''V16P02A'''
<code>m19b1014.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2242''
|'''Main 20'''
|-
|<code>$SCENARIO_MAIN = '''scn[21, 1];'''</code>
!Chapter 16
|After the chapter title card (“A New Dawn”), the hero, partner, and Grovyle all wake up on the beach back in the past
|'''D01P11A'''
<code>m20a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1875''

''&''

''~ line 593''
|(under “Others”)
'''M20 First Time to Treeshroud Forest'''
----(under “Dialogue Check”)

'''TALK-M20-01'''
|-
|<code>$SCENARIO_MAIN = '''scn[21, 2];'''</code>
|Ch. 16
|Triggers once you say “Yes” to if you’re ready to enter Treeshroud Forest
|'''D24P11A'''
<code>m20a0501.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1882''
|(under “Others”)
'''M20 Treeshroud Forest Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[22, 0];'''</code>
|Ch. 16
|The hero and partner agree to go back to the guild for help
|'''D01P11A'''
<code>m20a0901.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2247''
|'''Main 21'''
|-
|<code>$SCENARIO_MAIN = '''scn[22, 1];'''</code>
!Chapter 17
|Hero and partner return to Wigglytuff’s Guild
|'''G01P01B'''
<code>m21a0101.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[22, 2];'''</code>
|Ch. 17
|Chatot gives everyone their orders (your team is supposed to go visit Torkoal)
|'''G01P04A'''
<code>m21a0410.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1889''

''&''

''~ line 598''
|(under “Others”)
'''M21 The Wise, Old Torkoal'''
----(under “Dialogue Check”)

'''TALK-M21-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[22, 3];'''</code>
|Ch. 17
|Morning briefing (if you didn’t go to the Hot Spring the previous day)
|'''G01P04A'''
<code>m21a0520.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 603''
|(under “Dialogue Check”)
'''TALK-M21-04'''
|-
|<code>$SCENARIO_MAIN = '''scn[23, 0];'''</code>
|Ch. 17
|Before bed, the partner reflects on the meeting with Torkoal and wonders how Grovyle is doing
|'''G01P07C'''
<code>m21a0802.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2252''
|'''Main 22'''
|-
|<code>$SCENARIO_MAIN = '''scn[23, 1];'''</code>
|Ch. 17
|Torkoal appears at the sentry gate
|'''G01P04A'''
<code>m22a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 608''
|(under “Dialogue Check”)
'''TALK-M22-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[23, 2];'''</code>
|Ch. 17
|Torkoal is leaving the guild when he gets ambushed by Team Skull
|'''P01P01A'''
<code>m22a0302.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1896''

''&''

''~ line 1903''

''&''

''~ line 613''
|(under “Others”)
'''M22 Dungeon Stop'''
----(under “Others”)

'''M22 Let’s Stop by Sharpedo Bluff!'''
----(under “Dialogue Check”)

'''TALK-M22-03'''
|-
|<code>$SCENARIO_MAIN = '''scn[23, 3];'''</code>
|Ch. 17
|Before entering the Sharpedo Bluff hideout, the partner wonders if Grovyle is back
|'''H01P99A'''
<code>m22a0601.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1910''

''&''

''~ line 1917''

''&''

''~ line 618''
|(under “Others”)
'''M22 Re-read Letter'''
----(under “Others”)

'''M22 Let’s Swing by the Beach'''
----(under “Dialogue Check”)

'''TALK-M22-04'''
|-
|<code>$SCENARIO_MAIN = '''scn[24, 0];'''</code>
!Chapter 18
|Lapras talks to Wigglytuff
|'''P10P01A'''

<code>m22a1004.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1924''

''&''

''~ line 2257''
|(under “Others”)
'''M23 First Time to Brine Cave'''
----

'''Main 23'''

|-
|<code>$SCENARIO_MAIN = '''scn[24, 1];'''</code>
|Ch. 18
|Wigglytuff has not yet returned, but Chatot plans to leave for Brine Cave as scheduled anyway
|'''G01P04A'''
<code>m23a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1931''

''&''

''~ line 1938''

''&''

''~ line 623''
|(under “Others”)
'''M23 Brine Cave Exploration'''
----(under “Others”)

'''M23 First Time to Brine Cave-2'''
----(under “Dialogue Check”)

'''TALK-M23-02'''
|-
|<code>$SCENARIO_MAIN = '''scn[24, 2];'''</code>
|Ch. 18
|At the Lower Brine Cave midpoint, Team Skull steals the Relic Fragment from the partner and Chatot runs after them
|'''D26P21A'''
<code>m23a0501.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1945''
|(under “Others”)
'''M23 Brine Cave-2 Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[24, 3];'''</code>
|Ch. 18
|The hero and partner find Team Skull knocked out and Skuntank returns the Relic Fragment
|'''D26P31A'''
<code>m23a0701.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[25, 0];'''</code>
|Ch. 18
|Triggers at the end of the scene where the hero, partner, and Grovyle meet Lapras
|'''P11P01A'''
<code>m23a1008.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2262''
|'''Main 24'''
|-
|<code>$SCENARIO_MAIN = '''scn[25, 1];'''</code>
!Chapter 19
|Chapter 19 title card
(“To the Hidden Land”)
|'''G01P01C'''
<code>m24a0102.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1952''

''&''

''~ line 628''
|(under “Others”)
'''M24 First Time to the Hidden Land'''
----(under “Dialogue Check”)

'''TALK-M24-01'''
|-
|<code>$SCENARIO_MAIN = '''scn[25, 2];'''</code>
|Ch. 19
|Triggers upon entering the Hidden Land
|'''D27P11A'''
<code>m24a0401.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1959''

''&''

''~ line 1966''
|(under “Others”)
'''M24 The Hidden Land Exploration'''
----(under “Others”)

'''M24 First Time to the Hidden Land-2'''
|-
|<code>$SCENARIO_MAIN = '''scn[25, 3];'''</code>
|Ch. 19
|Triggers upon saying “Yes” to entering the Hidden Highland
|'''D28P21A'''
<code>m24a0601.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1973''
|(under “Others”)
'''M24 The Hidden Land-2 Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[25, 4];'''</code>
|Ch. 19
|Triggers upon entering the Old Ruins
|'''D28P32A'''
<code>m24a0802.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[26, 0];'''</code>
|Ch. 19
|
|Found in '''unionall''' under
<code>GETOUT_SCENARIO_DUNEGON</code>

''~ line 9031''
|Seemingly gets skipped over after defeating Dusknoir, so I don’t know what specifically triggers this
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2269''
|'''Main 25'''
|-
|<code>$SCENARIO_MAIN = '''scn[26, 1];'''</code>
|Ch. 19
|Triggers right after defeating Dusknoir
|'''D28P44A'''
<code>m25a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1980''
|(under “Others”)
'''M25 First Time to Temporal Towe'''
|-
|<code>$SCENARIO_MAIN = '''scn[26, 2];'''</code>
!Chapter 20
|Arriving at the entrance to Temporal Tower
|'''D29P11A'''
<code>m25a0501.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 1987''
|(under “Others”)
'''M25 Temporal Tower Exploration'''
|-
|<code>$SCENARIO_MAIN = '''scn[26, 3];'''</code>
|Ch. 20
|Triggers when you interact with the entrance to Temporal Tower (regardless of if you say you’re ready to go in or not)
|'''D29P11A'''

<code>m25a0601.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[26, 4];'''</code>
|Ch. 20
|Arriving at the Temporal Tower midpoint
|'''D30P21A'''
<code>m25a0801.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[26, 5];'''</code>
|Ch. 20
|Entering Temporal Spire
|'''D3021A'''
<code>m25a0901.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[26, 6];'''</code>
|Ch. 20
|Reaching Temporal Pinnacle
|'''D30P41A'''
<code>m25a1101.ssb</code>
|
|
|
|-
|<code>$SCENARIO_MAIN = '''scn[27, 0];'''</code>
|Ch. 20
|Immediately after defeating Primal Dialga
|'''D30P41A'''
<code>m26a0101.ssb</code>
|
|'''S02P01A''' (debug)
<code>m00a01a.ssb</code>

''~ line 2276''
----Found in '''unionall''' under

<code>GETOUT_SCENARIO_DUNEGON</code>

''~ line 9055''
|'''Main 26'''
|-
|$SCENARIO_MAIN = scn[29, 0];
|Postgame
|End Screen Displayed
|m26a0806.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 1];
|Postgame
|Graduation first announcement
|s01p0101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 2];
|Postgame
|Encounter Teddiursa and Ursaring
|s01p0201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 3];
|Postgame
|Entered Mystifying Forest
|s01p0301.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 4];
|Postgame
|Beat Mystifying Forest
|s01p0601.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 5];
|Postgame
|Graduating from the guild
|s01p1101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 6];
|Postgame
|1 Mission Cleared
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 7];
|Postgame
|1 Mission Cleared on a separate day
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 8];
|Postgame
|Cafe Describe Shaymin Village
|s31a0101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 9];
|Postgame
|Left the Cafe
|P01P04A enter01.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 10];
|Postgame
|First Time at Shaymin Village
|s31a0201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 11];
|Postgame
|Returned to Shaymin Village
|s31a0301.ssb AND s31a0401.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 12];
|Postgame
|First Time at 1st Station Clearing
|s31a0601.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 13];
|Postgame
|Return to 1st Station Clearing
|s31a0701.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 14];
|Postgame
|First Time at 2nd Station Clearing
|s31a0901.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 15];
|Postgame
|Return to 2nd Station Clearing
|s31a1001.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 16];
|Postgame
|First Time at 3rd Station Clearing
|s31a1201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 17];
|Postgame
|Return to 3rd Station Clearing
|s31a1301.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 18];
|Postgame
|First Time at 4th Station Clearing
|s31a1501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 19];
|Postgame
|Return to 4th Station Clearing
|s31a1601.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 20];
|Postgame
|First time at 5th Station Clearing
|s31a1901.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 21];
|Postgame
|Returned to 5th Station Clearing
|s31a3801.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 22];
|Postgame
|First time at 6th Station Pass
|s31a2101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 23];
|Postgame
|Returned to 6th Station Clearing
|s31a2201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 24];
|Postgame
|First Time at 7th Station Clearing
|s31a2401.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 25];
|Postgame
|Return to 7th Station Clearing
|s31a2501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 26];
|Postgame
|First Time at 8th Station Clearing
|s31a2801.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 27];
|Postgame
|Return to 8th Station Clearing
|s31a2901.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 28];
|Postgame
|First Time at 9th Station Pass
|s31a3101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 29];
|Postgame
|Return to 9th Station Clearing
|s31a3201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 30];
|Postgame
|Lost to Grimer!
|s31a3401.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 31];
|Postgame
|Grimer Defeated!
|s31a3701.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 32];
|Postgame
|1 day passes.
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 33];
|Postgame
|Blizzard Island Unlocked
|s02p0101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 34];
|
|
|
|Globally Unused?
|
|
|-
|$SCENARIO_MAIN = scn[29, 35];
|Postgame
|Crevice Cave Opens
|s02p0201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 36];
|Postgame
|
|
|Seemingly unused outside of quiz debug?
|m00a01a.ssb
|"S2 Crevice Cave Exploration & Return"
|-
|$SCENARIO_MAIN = scn[29, 37];
|Postgame
|About to Fight Froslass
|s02p0501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 38];
|Postgame
|Scizor is ABOUT to give Secret Rank
|s02p0702.ssb
|This is set at the beginning of s02p0702?
|
|
|-
|$SCENARIO_MAIN = scn[29, 39];
|Postgame
|Scizor Gives Secret Rank
|s02p0702.ssb
|This is set at the end of s02p0702?
|
|
|-
|$SCENARIO_MAIN = scn[29, 40];
|Postgame
|1 mission complete!
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 41];
|Postgame
|Surround Sea Unlocked
|s03p0101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 42];
|Postgame
|Manaphy hatched.
|s03p0301.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 43];
|Postgame
|Failed to find Blue Gummi #1
|s03p0401.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 44];
|Postgame
|Fed Blue Gummi #1
|s03p0501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 45];
|Postgame
|Failed to find Blue Gummi #2
|s03p0601.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 46];
|Postgame
|Manaphy is following?
|s03p0701.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 47];
|Postgame
|Playing with Manaphy on beach
|s03p0901.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 48];
|Postgame
|Chatot helps find Manaphy
|s03p1001.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 49];
|Postgame
|Manaphy faints on beach
|s03p1301.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 50];
|Postgame
|One day passes
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 51];
|Postgame
|About to fight Gyarados
|s03p1501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 52];
|Postgame
|Phione Dew Obtained!
|s03p1701.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 53];
|Postgame
|One day passes.
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 54];
|Postgame
|2 missions complete!
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 55];
|Postgame
|Team Charm Arrives!
|s04p0101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 56];
|Postgame
|One day passes.
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 57];
|Postgame
|Entered Ice Aegis Cave Hub
|s04p0201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 58];
|Postgame
|Beat Ice Aegis Cave
|s04p0301.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 59];
|Postgame
|About to fight Regice
|s04p0501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 60];
|Postgame
|Defeated Regice?
|s04p0701.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 61];
|Postgame
|Completing Rock Aegis Cave for the first time
|s04p0901.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 62];
|Postgame
|About to fight Regirock
|s04p1001.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 63];
|Postgame
|
|
|Seemingly unused outside of quiz debug?
|m00a01a.ssb
|"S4 Stone Marker 3"
|-
|$SCENARIO_MAIN = scn[29, 64];
|Postgame
|About to fight Registeel
|s04p1301.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 65];
|Postgame
|Registeel Defeated, Team Charm Saved
|s04p1401.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 66];
|Postgame
|About to fight Regigigas
|s04p1601.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 67];
|Postgame
|Aegis Cave Complete!
|s04p1902.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 68];
|Postgame
|1 Mission Cleared
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 69];
|Postgame
|Hero/Partner wonder why they can't evolve
|s20p0101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 70];
|Postgame
|"Cresselia" enters the hero's dream
|s20p0201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 71];
|Postgame
|"Cresselia" enters the hero's dream again
|s20p0301.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 72];
|Postgame
|Azurill is trapped in a nightmare
|s20p0501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 73];
|Postgame
|One day passes?
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 74];
|Postgame
|About to enter Mt. Trevail
|s20p0601.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 75];
|Postgame
|Nightmare Unlocked
|s20p0701.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 76];
|Postgame
|Nightmare entered
|s20p0902.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 77];
|Postgame
|Nightmare is complete
|s20p1101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 78];
|Postgame
|The guild begins investigating distortions of space
|s21p0101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 79];
|Postgame
|Hero convinces partner that disappearing isn't the answer
|s21p0201.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 80];
|Postgame
|Asked Lapras about distortion of space
|s21p0301.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 81];
|Postgame
|Palkia Kidnaps you
|s21p0601.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 82];
|Postgame
|Failing Spacial Rift
|s21p0801.ssb AND s21p1401.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 83];
|Postgame
|Beat Spacial Rift
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 84];
|Postgame
|Entered Deep Spacial Rift
|unionall.ssb AND s21p0901.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 85];
|Postgame
|Beat Deep Spacial Rift
|s21p1101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 86];
|Postgame
|Beat Spacial Rift Bottom
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 87];
|Postgame
|Dark Crater is Unlocked
|s22p0401.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 88];
|Postgame
|Entered Dark Crater
|s22p0501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 89];
|Postgame
|Beat Dark Crater
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 90];
|Postgame
|Entered Deep Dark Crater
|s22p0901.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 91];
|Postgame
|Entered Dark Crater Pit
|s22p1101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 92];
|Postgame
|Darkrai Defeated
|s22p1501.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 93];
|Postgame
|3 Missions Cleared Since Darkrai's Defeat
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 94];
|Postgame
|Chatot Says Manaphy Returned
|s23p0101.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 95];
|Postgame
|Manaphy Recruited!
|s23p0103.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 96];
|Postgame
|2 Days to Marine Resort Unlock
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 97];
|Postgame
|1 Day to Marine Resort Unlock
|unionall.ssb
|
|
|
|-
|$SCENARIO_MAIN = scn[29, 98];
|Postgame
|Marine Resort Unlocked
|s11p0101.ssb
|
|
|
|}
[[Category:Documentation]]

List of Script Variables

2026-01-18T07:56:47Z

Happylappy: /* 0x5c - EVENT_LOCAL */

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [140] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.
{| class="wikitable"
!Number
!Used By
!Where's used
!Notes
|-
|0
|N/A
|N/A
|Presumed Unused.
|-
|1
|Cafe Client
|P01P04A\enter11.ssb
|Used by the Cafe Client for the Gabite Mission, and the 7-Treasures Missions. In both Mission types, it's used to skip the lengthy exposition for the mission if the player declined the job earlier in the day.
|-
|2
|Spoink
|Various
|Used in all of Spoink's talk scripts. Used to remember if Spoink has given the player their helpful exploration tip about enemies not moving unless you do.
|-
|3-22
|Chimecho
|G01P03A
|Used in all of Chimecho's talk scripts. Flag 18 is unused!
|-
|23, 24, 26
|Dugtrio
|Various
|Used in all of Dugtrio's talk scripts. Flag 25 is unused! Likely related to triggering CORO_EVENT_M00_04.
|-
|27, 28
|Pink Celebi
|D23P11A\um19
|Used in both Celebi talk scripts for the player to probe deeper about her not minding that she gets to spend more time with grovyle.
|-
|29-40
|Croagunk
|G01P04A\enter05.ssb
|Flags 36 and 38 are unused! By mistake, 37 and 39 are used two separate times for Croagunk's dialogue!
|-
|41
|Cresselia
|Various
|Used in all of Cresselia's talk scripts. Used to remember if the player has rejected recruiting her to the team. Intended to only appear in H01P99A.
|-
|42
|N/A
|N/A
|Presumed unused.
|-
|43-47
|Lapras
|D01P01A
|Used in all of Lapras' talk scripts.
|-
|48
|Vigoroth
|T01P02A
|Used for Vigoroth to give a shortened advertisement for the Marowak Dojo. Apparently he's "sponsored".
|-
|49, 50
|Chatot
|Various
|Used in all of Chatot's talk scripts. Used for dialogue relating to the player going to Amp Plains. Intended to only appear in G01P04A.
|-
|51-59
|Electivire
|T01P01A\enter06.ssb
|
|-
|60-62
|Marowak (Main Story)
|T01P03A\enter07.ssb
|
|-
|63-71
|Kangaskhan
|T01P02A\enter10.ssb
|
|-
|72-83
|Green Kecleon
|T01P02A\enter12.ssb
|
|-
|84-95
|Purple Kecleon
|T01P02A\enter11.ssb
|
|-
|96-102
|Xatu
|T01P02A\enter09.ssb
|
|-
|103-109
|Chansey
|T01P01A\enter07.ssb
|
|-
|110-118
|Duskull
|T01P01A\enter05.ssb
|
|-
|119
|Pelipper (Rescue)
|S01P02A\enter02.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Go Rescue" on the main menu.
|-
|120
|Pelipper (Explore)
|S01P02A\enter07.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Standby Adventure" on the main menu.
|-
|121
|Partner
|Various
|Somewhat unclear. Seems to be some kind of game progress, possibly whether or not the partner has (through some means) told the hero that they want to check back on Sharpedo Bluff for Grovyle. Spawns a trigger in T02P02A if enabled.
|-
|122
|Shaymin (Guide)
|Various
|Used in all of Shaymin's talk scripts throughout the mountain. Remembers if the player has rejected recruiting them to the team. Likely only intended to appear at the summit?
|-
|123
|Shaymin (Sky Gift)
|D73P11A
|Used to remember if Shaymin has told the player about Sky Gift delivery.
|-
|124
|N/A
|N/A
|Presumed unused.
|-
|125
|Pachirisu
|Various
|Used in all of Pachirisu's talk scripts. Remembers if the player has received a Sky Gift from Pachirisu or not. Likely intended to be used somewhere on the mountain.
|-
|126
|Marowak (Bidoof)
|T01P03A\enter08.ssb
|Used to remember if Bidoof has claimed Marowak's Reviver Seed in the special episode. Reset at the beginning of the episode!
|-
|127
|Kangakshan (Bidoof)
|T01P02A\un0103.ssb
|Used to remember if Bidoof has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|128
|Duskull (Bidoof)
|T01P01A\un0101.ssb
|Used to remember if Bidoof has talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|129
|Green Kecleon (Bidoof)
|T01P02A\un0101.ssb
|Used to remember if Bidoof has talked with Green Kecleon in the episode before. Reset at the beginning of the episode!
|-
|130
|Purple Kecleon (Bidoof)
|T01P02A\un0102.ssb
|Used to remember if Bidoof has talked with Purple Kecleon in the episode before. Reset at the beginning of the episode!
|-
|131
|Wigglytuff (Bidoof)
|G01P05A\un0101.ssb
|Used to remember if Bidoof has talked with Wigglytuff after unlocking Deep Star Cave in the episode before. Runs CORO_EVENT_N00_01 if not.
Reset at the beginning of the episode!
|-
|132
|Bidoof (Sunflora)
|G01P03A\un0401.ssb
|Used to remember if Sunflora has talked with Bidoof in the episode before.
Reset at the beginning of the episode!
|-
|133
|Chimecho (Sunflora)
|G01P03A\un0402.ssb
|Used to remember if Sunflora has talked with Chimecho in the episode before.
Reset at the beginning of the episode!
|-
|134
|Dugtrio (Sunflora)
|H01P99A\un0401.ssb
|Used to remeber if Sunflora has talked with Dugtrio in the episode before.
Reset at the beginning of the episode!
|-
|135
|Kangaskhan (Sunflora)
|T01P02A\un0404.ssb
|Used to remember if Sunflora has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|136
|Green Kecleon (Sunflora)
|T01P02A\un0406.ssb
|Used to remember if Sunflora has talked with Green Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|137
|Purple Kecleon (Sunflora)
|T01P02A\un0405.ssb
|Used to remember if Sunflora has talked with Purple Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|138
|Vigoroth (Sunflora)
|T01P01A\un0404.ssb
|Used to remember if Sunflora was advertised to by Vigoroth in the episode before.
Reset at the beginning of the episode!
|-
|139
|Team Flame (Sunflora)
|G01P03A\un0405.ssb
|Used to remember if Sunflora talked with Bellsprout of Team Flame in the episode before. Reset at the beginning of the episode!
|-
|140
|Duskull (Sunflora)
|T01P01A\un0405.ssb
|Used to remember if Sunflora talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|141+
|N/A
|N/A
|Presumed unused.
|}

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value. Is also used as a general game progression marker by other things, restriction certain mission types, the croagunk swap shop being able to contain a water float, and other things like that.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
When called by LoadScriptVariableValue(), will always return 1. Seems unused outside of this.

=== 0x3b - UNIT_SUM ===
In a switch case, will return the number of pokemon in the active team. Cannot be written to, only read. Skytemple's Variable reader will mistakenly read this as zero, as the script variable slot itself is unused, and the number of team members is a hardcoded return from LoadScriptVariable.

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between acting scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used exclusively by the debug town. Unused in the context of vanilla EoS.

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2026-01-18T07:40:45Z

Happylappy: UNIT_SUM is the number of members on the active team!!!

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [140] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.
{| class="wikitable"
!Number
!Used By
!Where's used
!Notes
|-
|0
|N/A
|N/A
|Presumed Unused.
|-
|1
|Cafe Client
|P01P04A\enter11.ssb
|Used by the Cafe Client for the Gabite Mission, and the 7-Treasures Missions. In both Mission types, it's used to skip the lengthy exposition for the mission if the player declined the job earlier in the day.
|-
|2
|Spoink
|Various
|Used in all of Spoink's talk scripts. Used to remember if Spoink has given the player their helpful exploration tip about enemies not moving unless you do.
|-
|3-22
|Chimecho
|G01P03A
|Used in all of Chimecho's talk scripts. Flag 18 is unused!
|-
|23, 24, 26
|Dugtrio
|Various
|Used in all of Dugtrio's talk scripts. Flag 25 is unused! Likely related to triggering CORO_EVENT_M00_04.
|-
|27, 28
|Pink Celebi
|D23P11A\um19
|Used in both Celebi talk scripts for the player to probe deeper about her not minding that she gets to spend more time with grovyle.
|-
|29-40
|Croagunk
|G01P04A\enter05.ssb
|Flags 36 and 38 are unused! By mistake, 37 and 39 are used two separate times for Croagunk's dialogue!
|-
|41
|Cresselia
|Various
|Used in all of Cresselia's talk scripts. Used to remember if the player has rejected recruiting her to the team. Intended to only appear in H01P99A.
|-
|42
|N/A
|N/A
|Presumed unused.
|-
|43-47
|Lapras
|D01P01A
|Used in all of Lapras' talk scripts.
|-
|48
|Vigoroth
|T01P02A
|Used for Vigoroth to give a shortened advertisement for the Marowak Dojo. Apparently he's "sponsored".
|-
|49, 50
|Chatot
|Various
|Used in all of Chatot's talk scripts. Used for dialogue relating to the player going to Amp Plains. Intended to only appear in G01P04A.
|-
|51-59
|Electivire
|T01P01A\enter06.ssb
|
|-
|60-62
|Marowak (Main Story)
|T01P03A\enter07.ssb
|
|-
|63-71
|Kangaskhan
|T01P02A\enter10.ssb
|
|-
|72-83
|Green Kecleon
|T01P02A\enter12.ssb
|
|-
|84-95
|Purple Kecleon
|T01P02A\enter11.ssb
|
|-
|96-102
|Xatu
|T01P02A\enter09.ssb
|
|-
|103-109
|Chansey
|T01P01A\enter07.ssb
|
|-
|110-118
|Duskull
|T01P01A\enter05.ssb
|
|-
|119
|Pelipper (Rescue)
|S01P02A\enter02.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Go Rescue" on the main menu.
|-
|120
|Pelipper (Explore)
|S01P02A\enter07.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Standby Adventure" on the main menu.
|-
|121
|Partner
|Various
|Somewhat unclear. Seems to be some kind of game progress, possibly whether or not the partner has (through some means) told the hero that they want to check back on Sharpedo Bluff for Grovyle. Spawns a trigger in T02P02A if enabled.
|-
|122
|Shaymin (Guide)
|Various
|Used in all of Shaymin's talk scripts throughout the mountain. Remembers if the player has rejected recruiting them to the team. Likely only intended to appear at the summit?
|-
|123
|Shaymin (Sky Gift)
|D73P11A
|Used to remember if Shaymin has told the player about Sky Gift delivery.
|-
|124
|N/A
|N/A
|Presumed unused.
|-
|125
|Pachirisu
|Various
|Used in all of Pachirisu's talk scripts. Remembers if the player has received a Sky Gift from Pachirisu or not. Likely intended to be used somewhere on the mountain.
|-
|126
|Marowak (Bidoof)
|T01P03A\enter08.ssb
|Used to remember if Bidoof has claimed Marowak's Reviver Seed in the special episode. Reset at the beginning of the episode!
|-
|127
|Kangakshan (Bidoof)
|T01P02A\un0103.ssb
|Used to remember if Bidoof has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|128
|Duskull (Bidoof)
|T01P01A\un0101.ssb
|Used to remember if Bidoof has talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|129
|Green Kecleon (Bidoof)
|T01P02A\un0101.ssb
|Used to remember if Bidoof has talked with Green Kecleon in the episode before. Reset at the beginning of the episode!
|-
|130
|Purple Kecleon (Bidoof)
|T01P02A\un0102.ssb
|Used to remember if Bidoof has talked with Purple Kecleon in the episode before. Reset at the beginning of the episode!
|-
|131
|Wigglytuff (Bidoof)
|G01P05A\un0101.ssb
|Used to remember if Bidoof has talked with Wigglytuff after unlocking Deep Star Cave in the episode before. Runs CORO_EVENT_N00_01 if not.
Reset at the beginning of the episode!
|-
|132
|Bidoof (Sunflora)
|G01P03A\un0401.ssb
|Used to remember if Sunflora has talked with Bidoof in the episode before.
Reset at the beginning of the episode!
|-
|133
|Chimecho (Sunflora)
|G01P03A\un0402.ssb
|Used to remember if Sunflora has talked with Chimecho in the episode before.
Reset at the beginning of the episode!
|-
|134
|Dugtrio (Sunflora)
|H01P99A\un0401.ssb
|Used to remeber if Sunflora has talked with Dugtrio in the episode before.
Reset at the beginning of the episode!
|-
|135
|Kangaskhan (Sunflora)
|T01P02A\un0404.ssb
|Used to remember if Sunflora has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|136
|Green Kecleon (Sunflora)
|T01P02A\un0406.ssb
|Used to remember if Sunflora has talked with Green Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|137
|Purple Kecleon (Sunflora)
|T01P02A\un0405.ssb
|Used to remember if Sunflora has talked with Purple Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|138
|Vigoroth (Sunflora)
|T01P01A\un0404.ssb
|Used to remember if Sunflora was advertised to by Vigoroth in the episode before.
Reset at the beginning of the episode!
|-
|139
|Team Flame (Sunflora)
|G01P03A\un0405.ssb
|Used to remember if Sunflora talked with Bellsprout of Team Flame in the episode before. Reset at the beginning of the episode!
|-
|140
|Duskull (Sunflora)
|T01P01A\un0405.ssb
|Used to remember if Sunflora talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|141+
|N/A
|N/A
|Presumed unused.
|}

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value. Is also used as a general game progression marker by other things, restriction certain mission types, the croagunk swap shop being able to contain a water float, and other things like that.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
When called by LoadScriptVariableValue(), will always return 1. Seems unused outside of this.

=== 0x3b - UNIT_SUM ===
In a switch case, will return the number of pokemon in the active team. Cannot be written to, only read. Skytemple's Variable reader will mistakenly read this as zero, as the script variable slot itself is unused, and the number of team members is a hardcoded return from LoadScriptVariable.

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used exclusively by the debug town. Unused in the context of vanilla EoS.

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2026-01-18T06:56:06Z

Happylappy: /* 0x64 - ITEM_BACKUP */

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [140] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.
{| class="wikitable"
!Number
!Used By
!Where's used
!Notes
|-
|0
|N/A
|N/A
|Presumed Unused.
|-
|1
|Cafe Client
|P01P04A\enter11.ssb
|Used by the Cafe Client for the Gabite Mission, and the 7-Treasures Missions. In both Mission types, it's used to skip the lengthy exposition for the mission if the player declined the job earlier in the day.
|-
|2
|Spoink
|Various
|Used in all of Spoink's talk scripts. Used to remember if Spoink has given the player their helpful exploration tip about enemies not moving unless you do.
|-
|3-22
|Chimecho
|G01P03A
|Used in all of Chimecho's talk scripts. Flag 18 is unused!
|-
|23, 24, 26
|Dugtrio
|Various
|Used in all of Dugtrio's talk scripts. Flag 25 is unused! Likely related to triggering CORO_EVENT_M00_04.
|-
|27, 28
|Pink Celebi
|D23P11A\um19
|Used in both Celebi talk scripts for the player to probe deeper about her not minding that she gets to spend more time with grovyle.
|-
|29-40
|Croagunk
|G01P04A\enter05.ssb
|Flags 36 and 38 are unused! By mistake, 37 and 39 are used two separate times for Croagunk's dialogue!
|-
|41
|Cresselia
|Various
|Used in all of Cresselia's talk scripts. Used to remember if the player has rejected recruiting her to the team. Intended to only appear in H01P99A.
|-
|42
|N/A
|N/A
|Presumed unused.
|-
|43-47
|Lapras
|D01P01A
|Used in all of Lapras' talk scripts.
|-
|48
|Vigoroth
|T01P02A
|Used for Vigoroth to give a shortened advertisement for the Marowak Dojo. Apparently he's "sponsored".
|-
|49, 50
|Chatot
|Various
|Used in all of Chatot's talk scripts. Used for dialogue relating to the player going to Amp Plains. Intended to only appear in G01P04A.
|-
|51-59
|Electivire
|T01P01A\enter06.ssb
|
|-
|60-62
|Marowak (Main Story)
|T01P03A\enter07.ssb
|
|-
|63-71
|Kangaskhan
|T01P02A\enter10.ssb
|
|-
|72-83
|Green Kecleon
|T01P02A\enter12.ssb
|
|-
|84-95
|Purple Kecleon
|T01P02A\enter11.ssb
|
|-
|96-102
|Xatu
|T01P02A\enter09.ssb
|
|-
|103-109
|Chansey
|T01P01A\enter07.ssb
|
|-
|110-118
|Duskull
|T01P01A\enter05.ssb
|
|-
|119
|Pelipper (Rescue)
|S01P02A\enter02.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Go Rescue" on the main menu.
|-
|120
|Pelipper (Explore)
|S01P02A\enter07.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Standby Adventure" on the main menu.
|-
|121
|Partner
|Various
|Somewhat unclear. Seems to be some kind of game progress, possibly whether or not the partner has (through some means) told the hero that they want to check back on Sharpedo Bluff for Grovyle. Spawns a trigger in T02P02A if enabled.
|-
|122
|Shaymin (Guide)
|Various
|Used in all of Shaymin's talk scripts throughout the mountain. Remembers if the player has rejected recruiting them to the team. Likely only intended to appear at the summit?
|-
|123
|Shaymin (Sky Gift)
|D73P11A
|Used to remember if Shaymin has told the player about Sky Gift delivery.
|-
|124
|N/A
|N/A
|Presumed unused.
|-
|125
|Pachirisu
|Various
|Used in all of Pachirisu's talk scripts. Remembers if the player has received a Sky Gift from Pachirisu or not. Likely intended to be used somewhere on the mountain.
|-
|126
|Marowak (Bidoof)
|T01P03A\enter08.ssb
|Used to remember if Bidoof has claimed Marowak's Reviver Seed in the special episode. Reset at the beginning of the episode!
|-
|127
|Kangakshan (Bidoof)
|T01P02A\un0103.ssb
|Used to remember if Bidoof has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|128
|Duskull (Bidoof)
|T01P01A\un0101.ssb
|Used to remember if Bidoof has talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|129
|Green Kecleon (Bidoof)
|T01P02A\un0101.ssb
|Used to remember if Bidoof has talked with Green Kecleon in the episode before. Reset at the beginning of the episode!
|-
|130
|Purple Kecleon (Bidoof)
|T01P02A\un0102.ssb
|Used to remember if Bidoof has talked with Purple Kecleon in the episode before. Reset at the beginning of the episode!
|-
|131
|Wigglytuff (Bidoof)
|G01P05A\un0101.ssb
|Used to remember if Bidoof has talked with Wigglytuff after unlocking Deep Star Cave in the episode before. Runs CORO_EVENT_N00_01 if not.
Reset at the beginning of the episode!
|-
|132
|Bidoof (Sunflora)
|G01P03A\un0401.ssb
|Used to remember if Sunflora has talked with Bidoof in the episode before.
Reset at the beginning of the episode!
|-
|133
|Chimecho (Sunflora)
|G01P03A\un0402.ssb
|Used to remember if Sunflora has talked with Chimecho in the episode before.
Reset at the beginning of the episode!
|-
|134
|Dugtrio (Sunflora)
|H01P99A\un0401.ssb
|Used to remeber if Sunflora has talked with Dugtrio in the episode before.
Reset at the beginning of the episode!
|-
|135
|Kangaskhan (Sunflora)
|T01P02A\un0404.ssb
|Used to remember if Sunflora has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|136
|Green Kecleon (Sunflora)
|T01P02A\un0406.ssb
|Used to remember if Sunflora has talked with Green Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|137
|Purple Kecleon (Sunflora)
|T01P02A\un0405.ssb
|Used to remember if Sunflora has talked with Purple Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|138
|Vigoroth (Sunflora)
|T01P01A\un0404.ssb
|Used to remember if Sunflora was advertised to by Vigoroth in the episode before.
Reset at the beginning of the episode!
|-
|139
|Team Flame (Sunflora)
|G01P03A\un0405.ssb
|Used to remember if Sunflora talked with Bellsprout of Team Flame in the episode before. Reset at the beginning of the episode!
|-
|140
|Duskull (Sunflora)
|T01P01A\un0405.ssb
|Used to remember if Sunflora talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|141+
|N/A
|N/A
|Presumed unused.
|}

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value. Is also used as a general game progression marker by other things, restriction certain mission types, the croagunk swap shop being able to contain a water float, and other things like that.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used exclusively by the debug town. Unused in the context of vanilla EoS.

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2026-01-18T06:53:26Z

Happylappy: /* 0x55 - WORLD_MAP_MARK_LIST_NORMAL */

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [140] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.
{| class="wikitable"
!Number
!Used By
!Where's used
!Notes
|-
|0
|N/A
|N/A
|Presumed Unused.
|-
|1
|Cafe Client
|P01P04A\enter11.ssb
|Used by the Cafe Client for the Gabite Mission, and the 7-Treasures Missions. In both Mission types, it's used to skip the lengthy exposition for the mission if the player declined the job earlier in the day.
|-
|2
|Spoink
|Various
|Used in all of Spoink's talk scripts. Used to remember if Spoink has given the player their helpful exploration tip about enemies not moving unless you do.
|-
|3-22
|Chimecho
|G01P03A
|Used in all of Chimecho's talk scripts. Flag 18 is unused!
|-
|23, 24, 26
|Dugtrio
|Various
|Used in all of Dugtrio's talk scripts. Flag 25 is unused! Likely related to triggering CORO_EVENT_M00_04.
|-
|27, 28
|Pink Celebi
|D23P11A\um19
|Used in both Celebi talk scripts for the player to probe deeper about her not minding that she gets to spend more time with grovyle.
|-
|29-40
|Croagunk
|G01P04A\enter05.ssb
|Flags 36 and 38 are unused! By mistake, 37 and 39 are used two separate times for Croagunk's dialogue!
|-
|41
|Cresselia
|Various
|Used in all of Cresselia's talk scripts. Used to remember if the player has rejected recruiting her to the team. Intended to only appear in H01P99A.
|-
|42
|N/A
|N/A
|Presumed unused.
|-
|43-47
|Lapras
|D01P01A
|Used in all of Lapras' talk scripts.
|-
|48
|Vigoroth
|T01P02A
|Used for Vigoroth to give a shortened advertisement for the Marowak Dojo. Apparently he's "sponsored".
|-
|49, 50
|Chatot
|Various
|Used in all of Chatot's talk scripts. Used for dialogue relating to the player going to Amp Plains. Intended to only appear in G01P04A.
|-
|51-59
|Electivire
|T01P01A\enter06.ssb
|
|-
|60-62
|Marowak (Main Story)
|T01P03A\enter07.ssb
|
|-
|63-71
|Kangaskhan
|T01P02A\enter10.ssb
|
|-
|72-83
|Green Kecleon
|T01P02A\enter12.ssb
|
|-
|84-95
|Purple Kecleon
|T01P02A\enter11.ssb
|
|-
|96-102
|Xatu
|T01P02A\enter09.ssb
|
|-
|103-109
|Chansey
|T01P01A\enter07.ssb
|
|-
|110-118
|Duskull
|T01P01A\enter05.ssb
|
|-
|119
|Pelipper (Rescue)
|S01P02A\enter02.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Go Rescue" on the main menu.
|-
|120
|Pelipper (Explore)
|S01P02A\enter07.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Standby Adventure" on the main menu.
|-
|121
|Partner
|Various
|Somewhat unclear. Seems to be some kind of game progress, possibly whether or not the partner has (through some means) told the hero that they want to check back on Sharpedo Bluff for Grovyle. Spawns a trigger in T02P02A if enabled.
|-
|122
|Shaymin (Guide)
|Various
|Used in all of Shaymin's talk scripts throughout the mountain. Remembers if the player has rejected recruiting them to the team. Likely only intended to appear at the summit?
|-
|123
|Shaymin (Sky Gift)
|D73P11A
|Used to remember if Shaymin has told the player about Sky Gift delivery.
|-
|124
|N/A
|N/A
|Presumed unused.
|-
|125
|Pachirisu
|Various
|Used in all of Pachirisu's talk scripts. Remembers if the player has received a Sky Gift from Pachirisu or not. Likely intended to be used somewhere on the mountain.
|-
|126
|Marowak (Bidoof)
|T01P03A\enter08.ssb
|Used to remember if Bidoof has claimed Marowak's Reviver Seed in the special episode. Reset at the beginning of the episode!
|-
|127
|Kangakshan (Bidoof)
|T01P02A\un0103.ssb
|Used to remember if Bidoof has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|128
|Duskull (Bidoof)
|T01P01A\un0101.ssb
|Used to remember if Bidoof has talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|129
|Green Kecleon (Bidoof)
|T01P02A\un0101.ssb
|Used to remember if Bidoof has talked with Green Kecleon in the episode before. Reset at the beginning of the episode!
|-
|130
|Purple Kecleon (Bidoof)
|T01P02A\un0102.ssb
|Used to remember if Bidoof has talked with Purple Kecleon in the episode before. Reset at the beginning of the episode!
|-
|131
|Wigglytuff (Bidoof)
|G01P05A\un0101.ssb
|Used to remember if Bidoof has talked with Wigglytuff after unlocking Deep Star Cave in the episode before. Runs CORO_EVENT_N00_01 if not.
Reset at the beginning of the episode!
|-
|132
|Bidoof (Sunflora)
|G01P03A\un0401.ssb
|Used to remember if Sunflora has talked with Bidoof in the episode before.
Reset at the beginning of the episode!
|-
|133
|Chimecho (Sunflora)
|G01P03A\un0402.ssb
|Used to remember if Sunflora has talked with Chimecho in the episode before.
Reset at the beginning of the episode!
|-
|134
|Dugtrio (Sunflora)
|H01P99A\un0401.ssb
|Used to remeber if Sunflora has talked with Dugtrio in the episode before.
Reset at the beginning of the episode!
|-
|135
|Kangaskhan (Sunflora)
|T01P02A\un0404.ssb
|Used to remember if Sunflora has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|136
|Green Kecleon (Sunflora)
|T01P02A\un0406.ssb
|Used to remember if Sunflora has talked with Green Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|137
|Purple Kecleon (Sunflora)
|T01P02A\un0405.ssb
|Used to remember if Sunflora has talked with Purple Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|138
|Vigoroth (Sunflora)
|T01P01A\un0404.ssb
|Used to remember if Sunflora was advertised to by Vigoroth in the episode before.
Reset at the beginning of the episode!
|-
|139
|Team Flame (Sunflora)
|G01P03A\un0405.ssb
|Used to remember if Sunflora talked with Bellsprout of Team Flame in the episode before. Reset at the beginning of the episode!
|-
|140
|Duskull (Sunflora)
|T01P01A\un0405.ssb
|Used to remember if Sunflora talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|141+
|N/A
|N/A
|Presumed unused.
|}

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value. Is also used as a general game progression marker by other things, restriction certain mission types, the croagunk swap shop being able to contain a water float, and other things like that.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Is adequately sized for the number of World Map Markers. Presumed Unused.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used somewhere in Sky Peak

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2026-01-18T06:46:12Z

Happylappy: /* 0x13 - SCENARIO_BALANCE_FLAG */

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [140] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.
{| class="wikitable"
!Number
!Used By
!Where's used
!Notes
|-
|0
|N/A
|N/A
|Presumed Unused.
|-
|1
|Cafe Client
|P01P04A\enter11.ssb
|Used by the Cafe Client for the Gabite Mission, and the 7-Treasures Missions. In both Mission types, it's used to skip the lengthy exposition for the mission if the player declined the job earlier in the day.
|-
|2
|Spoink
|Various
|Used in all of Spoink's talk scripts. Used to remember if Spoink has given the player their helpful exploration tip about enemies not moving unless you do.
|-
|3-22
|Chimecho
|G01P03A
|Used in all of Chimecho's talk scripts. Flag 18 is unused!
|-
|23, 24, 26
|Dugtrio
|Various
|Used in all of Dugtrio's talk scripts. Flag 25 is unused! Likely related to triggering CORO_EVENT_M00_04.
|-
|27, 28
|Pink Celebi
|D23P11A\um19
|Used in both Celebi talk scripts for the player to probe deeper about her not minding that she gets to spend more time with grovyle.
|-
|29-40
|Croagunk
|G01P04A\enter05.ssb
|Flags 36 and 38 are unused! By mistake, 37 and 39 are used two separate times for Croagunk's dialogue!
|-
|41
|Cresselia
|Various
|Used in all of Cresselia's talk scripts. Used to remember if the player has rejected recruiting her to the team. Intended to only appear in H01P99A.
|-
|42
|N/A
|N/A
|Presumed unused.
|-
|43-47
|Lapras
|D01P01A
|Used in all of Lapras' talk scripts.
|-
|48
|Vigoroth
|T01P02A
|Used for Vigoroth to give a shortened advertisement for the Marowak Dojo. Apparently he's "sponsored".
|-
|49, 50
|Chatot
|Various
|Used in all of Chatot's talk scripts. Used for dialogue relating to the player going to Amp Plains. Intended to only appear in G01P04A.
|-
|51-59
|Electivire
|T01P01A\enter06.ssb
|
|-
|60-62
|Marowak (Main Story)
|T01P03A\enter07.ssb
|
|-
|63-71
|Kangaskhan
|T01P02A\enter10.ssb
|
|-
|72-83
|Green Kecleon
|T01P02A\enter12.ssb
|
|-
|84-95
|Purple Kecleon
|T01P02A\enter11.ssb
|
|-
|96-102
|Xatu
|T01P02A\enter09.ssb
|
|-
|103-109
|Chansey
|T01P01A\enter07.ssb
|
|-
|110-118
|Duskull
|T01P01A\enter05.ssb
|
|-
|119
|Pelipper (Rescue)
|S01P02A\enter02.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Go Rescue" on the main menu.
|-
|120
|Pelipper (Explore)
|S01P02A\enter07.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Standby Adventure" on the main menu.
|-
|121
|Partner
|Various
|Somewhat unclear. Seems to be some kind of game progress, possibly whether or not the partner has (through some means) told the hero that they want to check back on Sharpedo Bluff for Grovyle. Spawns a trigger in T02P02A if enabled.
|-
|122
|Shaymin (Guide)
|Various
|Used in all of Shaymin's talk scripts throughout the mountain. Remembers if the player has rejected recruiting them to the team. Likely only intended to appear at the summit?
|-
|123
|Shaymin (Sky Gift)
|D73P11A
|Used to remember if Shaymin has told the player about Sky Gift delivery.
|-
|124
|N/A
|N/A
|Presumed unused.
|-
|125
|Pachirisu
|Various
|Used in all of Pachirisu's talk scripts. Remembers if the player has received a Sky Gift from Pachirisu or not. Likely intended to be used somewhere on the mountain.
|-
|126
|Marowak (Bidoof)
|T01P03A\enter08.ssb
|Used to remember if Bidoof has claimed Marowak's Reviver Seed in the special episode. Reset at the beginning of the episode!
|-
|127
|Kangakshan (Bidoof)
|T01P02A\un0103.ssb
|Used to remember if Bidoof has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|128
|Duskull (Bidoof)
|T01P01A\un0101.ssb
|Used to remember if Bidoof has talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|129
|Green Kecleon (Bidoof)
|T01P02A\un0101.ssb
|Used to remember if Bidoof has talked with Green Kecleon in the episode before. Reset at the beginning of the episode!
|-
|130
|Purple Kecleon (Bidoof)
|T01P02A\un0102.ssb
|Used to remember if Bidoof has talked with Purple Kecleon in the episode before. Reset at the beginning of the episode!
|-
|131
|Wigglytuff (Bidoof)
|G01P05A\un0101.ssb
|Used to remember if Bidoof has talked with Wigglytuff after unlocking Deep Star Cave in the episode before. Runs CORO_EVENT_N00_01 if not.
Reset at the beginning of the episode!
|-
|132
|Bidoof (Sunflora)
|G01P03A\un0401.ssb
|Used to remember if Sunflora has talked with Bidoof in the episode before.
Reset at the beginning of the episode!
|-
|133
|Chimecho (Sunflora)
|G01P03A\un0402.ssb
|Used to remember if Sunflora has talked with Chimecho in the episode before.
Reset at the beginning of the episode!
|-
|134
|Dugtrio (Sunflora)
|H01P99A\un0401.ssb
|Used to remeber if Sunflora has talked with Dugtrio in the episode before.
Reset at the beginning of the episode!
|-
|135
|Kangaskhan (Sunflora)
|T01P02A\un0404.ssb
|Used to remember if Sunflora has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|136
|Green Kecleon (Sunflora)
|T01P02A\un0406.ssb
|Used to remember if Sunflora has talked with Green Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|137
|Purple Kecleon (Sunflora)
|T01P02A\un0405.ssb
|Used to remember if Sunflora has talked with Purple Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|138
|Vigoroth (Sunflora)
|T01P01A\un0404.ssb
|Used to remember if Sunflora was advertised to by Vigoroth in the episode before.
Reset at the beginning of the episode!
|-
|139
|Team Flame (Sunflora)
|G01P03A\un0405.ssb
|Used to remember if Sunflora talked with Bellsprout of Team Flame in the episode before. Reset at the beginning of the episode!
|-
|140
|Duskull (Sunflora)
|T01P01A\un0405.ssb
|Used to remember if Sunflora talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|141+
|N/A
|N/A
|Presumed unused.
|}

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value. Is also used as a general game progression marker by other things, restriction certain mission types, the croagunk swap shop being able to contain a water float, and other things like that.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Use unknown.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Use unknown.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used somewhere in Sky Peak

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2026-01-18T06:39:11Z

Happylappy: Edit description of talk flags to not say [200] are in use. This is likely incorrect, as 141+ seem to be fully unused as well.

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [140] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.
{| class="wikitable"
!Number
!Used By
!Where's used
!Notes
|-
|0
|N/A
|N/A
|Presumed Unused.
|-
|1
|Cafe Client
|P01P04A\enter11.ssb
|Used by the Cafe Client for the Gabite Mission, and the 7-Treasures Missions. In both Mission types, it's used to skip the lengthy exposition for the mission if the player declined the job earlier in the day.
|-
|2
|Spoink
|Various
|Used in all of Spoink's talk scripts. Used to remember if Spoink has given the player their helpful exploration tip about enemies not moving unless you do.
|-
|3-22
|Chimecho
|G01P03A
|Used in all of Chimecho's talk scripts. Flag 18 is unused!
|-
|23, 24, 26
|Dugtrio
|Various
|Used in all of Dugtrio's talk scripts. Flag 25 is unused! Likely related to triggering CORO_EVENT_M00_04.
|-
|27, 28
|Pink Celebi
|D23P11A\um19
|Used in both Celebi talk scripts for the player to probe deeper about her not minding that she gets to spend more time with grovyle.
|-
|29-40
|Croagunk
|G01P04A\enter05.ssb
|Flags 36 and 38 are unused! By mistake, 37 and 39 are used two separate times for Croagunk's dialogue!
|-
|41
|Cresselia
|Various
|Used in all of Cresselia's talk scripts. Used to remember if the player has rejected recruiting her to the team. Intended to only appear in H01P99A.
|-
|42
|N/A
|N/A
|Presumed unused.
|-
|43-47
|Lapras
|D01P01A
|Used in all of Lapras' talk scripts.
|-
|48
|Vigoroth
|T01P02A
|Used for Vigoroth to give a shortened advertisement for the Marowak Dojo. Apparently he's "sponsored".
|-
|49, 50
|Chatot
|Various
|Used in all of Chatot's talk scripts. Used for dialogue relating to the player going to Amp Plains. Intended to only appear in G01P04A.
|-
|51-59
|Electivire
|T01P01A\enter06.ssb
|
|-
|60-62
|Marowak (Main Story)
|T01P03A\enter07.ssb
|
|-
|63-71
|Kangaskhan
|T01P02A\enter10.ssb
|
|-
|72-83
|Green Kecleon
|T01P02A\enter12.ssb
|
|-
|84-95
|Purple Kecleon
|T01P02A\enter11.ssb
|
|-
|96-102
|Xatu
|T01P02A\enter09.ssb
|
|-
|103-109
|Chansey
|T01P01A\enter07.ssb
|
|-
|110-118
|Duskull
|T01P01A\enter05.ssb
|
|-
|119
|Pelipper (Rescue)
|S01P02A\enter02.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Go Rescue" on the main menu.
|-
|120
|Pelipper (Explore)
|S01P02A\enter07.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Standby Adventure" on the main menu.
|-
|121
|Partner
|Various
|Somewhat unclear. Seems to be some kind of game progress, possibly whether or not the partner has (through some means) told the hero that they want to check back on Sharpedo Bluff for Grovyle. Spawns a trigger in T02P02A if enabled.
|-
|122
|Shaymin (Guide)
|Various
|Used in all of Shaymin's talk scripts throughout the mountain. Remembers if the player has rejected recruiting them to the team. Likely only intended to appear at the summit?
|-
|123
|Shaymin (Sky Gift)
|D73P11A
|Used to remember if Shaymin has told the player about Sky Gift delivery.
|-
|124
|N/A
|N/A
|Presumed unused.
|-
|125
|Pachirisu
|Various
|Used in all of Pachirisu's talk scripts. Remembers if the player has received a Sky Gift from Pachirisu or not. Likely intended to be used somewhere on the mountain.
|-
|126
|Marowak (Bidoof)
|T01P03A\enter08.ssb
|Used to remember if Bidoof has claimed Marowak's Reviver Seed in the special episode. Reset at the beginning of the episode!
|-
|127
|Kangakshan (Bidoof)
|T01P02A\un0103.ssb
|Used to remember if Bidoof has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|128
|Duskull (Bidoof)
|T01P01A\un0101.ssb
|Used to remember if Bidoof has talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|129
|Green Kecleon (Bidoof)
|T01P02A\un0101.ssb
|Used to remember if Bidoof has talked with Green Kecleon in the episode before. Reset at the beginning of the episode!
|-
|130
|Purple Kecleon (Bidoof)
|T01P02A\un0102.ssb
|Used to remember if Bidoof has talked with Purple Kecleon in the episode before. Reset at the beginning of the episode!
|-
|131
|Wigglytuff (Bidoof)
|G01P05A\un0101.ssb
|Used to remember if Bidoof has talked with Wigglytuff after unlocking Deep Star Cave in the episode before. Runs CORO_EVENT_N00_01 if not.
Reset at the beginning of the episode!
|-
|132
|Bidoof (Sunflora)
|G01P03A\un0401.ssb
|Used to remember if Sunflora has talked with Bidoof in the episode before.
Reset at the beginning of the episode!
|-
|133
|Chimecho (Sunflora)
|G01P03A\un0402.ssb
|Used to remember if Sunflora has talked with Chimecho in the episode before.
Reset at the beginning of the episode!
|-
|134
|Dugtrio (Sunflora)
|H01P99A\un0401.ssb
|Used to remeber if Sunflora has talked with Dugtrio in the episode before.
Reset at the beginning of the episode!
|-
|135
|Kangaskhan (Sunflora)
|T01P02A\un0404.ssb
|Used to remember if Sunflora has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|136
|Green Kecleon (Sunflora)
|T01P02A\un0406.ssb
|Used to remember if Sunflora has talked with Green Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|137
|Purple Kecleon (Sunflora)
|T01P02A\un0405.ssb
|Used to remember if Sunflora has talked with Purple Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|138
|Vigoroth (Sunflora)
|T01P01A\un0404.ssb
|Used to remember if Sunflora was advertised to by Vigoroth in the episode before.
Reset at the beginning of the episode!
|-
|139
|Team Flame (Sunflora)
|G01P03A\un0405.ssb
|Used to remember if Sunflora talked with Bellsprout of Team Flame in the episode before. Reset at the beginning of the episode!
|-
|140
|Duskull (Sunflora)
|T01P01A\un0405.ssb
|Used to remember if Sunflora talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|141+
|N/A
|N/A
|Presumed unused.
|}

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Use unknown.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Use unknown.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used somewhere in Sky Peak

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2026-01-18T06:38:29Z

Happylappy: Documented every known $SCENARIO_TALK_BIT_FLAG.

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [200] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.
{| class="wikitable"
!Number
!Used By
!Where's used
!Notes
|-
|0
|N/A
|N/A
|Presumed Unused.
|-
|1
|Cafe Client
|P01P04A\enter11.ssb
|Used by the Cafe Client for the Gabite Mission, and the 7-Treasures Missions. In both Mission types, it's used to skip the lengthy exposition for the mission if the player declined the job earlier in the day.
|-
|2
|Spoink
|Various
|Used in all of Spoink's talk scripts. Used to remember if Spoink has given the player their helpful exploration tip about enemies not moving unless you do.
|-
|3-22
|Chimecho
|G01P03A
|Used in all of Chimecho's talk scripts. Flag 18 is unused!
|-
|23, 24, 26
|Dugtrio
|Various
|Used in all of Dugtrio's talk scripts. Flag 25 is unused! Likely related to triggering CORO_EVENT_M00_04.
|-
|27, 28
|Pink Celebi
|D23P11A\um19
|Used in both Celebi talk scripts for the player to probe deeper about her not minding that she gets to spend more time with grovyle.
|-
|29-40
|Croagunk
|G01P04A\enter05.ssb
|Flags 36 and 38 are unused! By mistake, 37 and 39 are used two separate times for Croagunk's dialogue!
|-
|41
|Cresselia
|Various
|Used in all of Cresselia's talk scripts. Used to remember if the player has rejected recruiting her to the team. Intended to only appear in H01P99A.
|-
|42
|N/A
|N/A
|Presumed unused.
|-
|43-47
|Lapras
|D01P01A
|Used in all of Lapras' talk scripts.
|-
|48
|Vigoroth
|T01P02A
|Used for Vigoroth to give a shortened advertisement for the Marowak Dojo. Apparently he's "sponsored".
|-
|49, 50
|Chatot
|Various
|Used in all of Chatot's talk scripts. Used for dialogue relating to the player going to Amp Plains. Intended to only appear in G01P04A.
|-
|51-59
|Electivire
|T01P01A\enter06.ssb
|
|-
|60-62
|Marowak (Main Story)
|T01P03A\enter07.ssb
|
|-
|63-71
|Kangaskhan
|T01P02A\enter10.ssb
|
|-
|72-83
|Green Kecleon
|T01P02A\enter12.ssb
|
|-
|84-95
|Purple Kecleon
|T01P02A\enter11.ssb
|
|-
|96-102
|Xatu
|T01P02A\enter09.ssb
|
|-
|103-109
|Chansey
|T01P01A\enter07.ssb
|
|-
|110-118
|Duskull
|T01P01A\enter05.ssb
|
|-
|119
|Pelipper (Rescue)
|S01P02A\enter02.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Go Rescue" on the main menu.
|-
|120
|Pelipper (Explore)
|S01P02A\enter07.ssb
|Used to remember if the player has ever been "welcomed" to Pelipper Island before after selecting "Standby Adventure" on the main menu.
|-
|121
|Partner
|Various
|Somewhat unclear. Seems to be some kind of game progress, possibly whether or not the partner has (through some means) told the hero that they want to check back on Sharpedo Bluff for Grovyle. Spawns a trigger in T02P02A if enabled.
|-
|122
|Shaymin (Guide)
|Various
|Used in all of Shaymin's talk scripts throughout the mountain. Remembers if the player has rejected recruiting them to the team. Likely only intended to appear at the summit?
|-
|123
|Shaymin (Sky Gift)
|D73P11A
|Used to remember if Shaymin has told the player about Sky Gift delivery.
|-
|124
|N/A
|N/A
|Presumed unused.
|-
|125
|Pachirisu
|Various
|Used in all of Pachirisu's talk scripts. Remembers if the player has received a Sky Gift from Pachirisu or not. Likely intended to be used somewhere on the mountain.
|-
|126
|Marowak (Bidoof)
|T01P03A\enter08.ssb
|Used to remember if Bidoof has claimed Marowak's Reviver Seed in the special episode. Reset at the beginning of the episode!
|-
|127
|Kangakshan (Bidoof)
|T01P02A\un0103.ssb
|Used to remember if Bidoof has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|128
|Duskull (Bidoof)
|T01P01A\un0101.ssb
|Used to remember if Bidoof has talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|129
|Green Kecleon (Bidoof)
|T01P02A\un0101.ssb
|Used to remember if Bidoof has talked with Green Kecleon in the episode before. Reset at the beginning of the episode!
|-
|130
|Purple Kecleon (Bidoof)
|T01P02A\un0102.ssb
|Used to remember if Bidoof has talked with Purple Kecleon in the episode before. Reset at the beginning of the episode!
|-
|131
|Wigglytuff (Bidoof)
|G01P05A\un0101.ssb
|Used to remember if Bidoof has talked with Wigglytuff after unlocking Deep Star Cave in the episode before. Runs CORO_EVENT_N00_01 if not.
Reset at the beginning of the episode!
|-
|132
|Bidoof (Sunflora)
|G01P03A\un0401.ssb
|Used to remember if Sunflora has talked with Bidoof in the episode before.
Reset at the beginning of the episode!
|-
|133
|Chimecho (Sunflora)
|G01P03A\un0402.ssb
|Used to remember if Sunflora has talked with Chimecho in the episode before.
Reset at the beginning of the episode!
|-
|134
|Dugtrio (Sunflora)
|H01P99A\un0401.ssb
|Used to remeber if Sunflora has talked with Dugtrio in the episode before.
Reset at the beginning of the episode!
|-
|135
|Kangaskhan (Sunflora)
|T01P02A\un0404.ssb
|Used to remember if Sunflora has talked with Kangaskhan in the episode before.
Reset at the beginning of the episode!
|-
|136
|Green Kecleon (Sunflora)
|T01P02A\un0406.ssb
|Used to remember if Sunflora has talked with Green Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|137
|Purple Kecleon (Sunflora)
|T01P02A\un0405.ssb
|Used to remember if Sunflora has talked with Purple Kecleon in the episode before.
Reset at the beginning of the episode!
|-
|138
|Vigoroth (Sunflora)
|T01P01A\un0404.ssb
|Used to remember if Sunflora was advertised to by Vigoroth in the episode before.
Reset at the beginning of the episode!
|-
|139
|Team Flame (Sunflora)
|G01P03A\un0405.ssb
|Used to remember if Sunflora talked with Bellsprout of Team Flame in the episode before. Reset at the beginning of the episode!
|-
|140
|Duskull (Sunflora)
|T01P01A\un0405.ssb
|Used to remember if Sunflora talked with Duskull in the episode before.
Reset at the beginning of the episode!
|-
|141+
|N/A
|N/A
|Presumed unused.
|}

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Use unknown.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Use unknown.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used somewhere in Sky Peak

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

Performance Progress Flags

2026-01-17T21:55:38Z

Happylappy:

These flags are contained in the PERFORMANCE_PROGRESS_LIST [[List of Script Variables|variable]]. They are used to keep track of certain achievements and unlocks as the story progresses. Each flag is represented with a single bit, and therefore can only be true or false.
{| class="wikitable"
!ID
!Internal name
!Description
!Other comments
|-
|1
|Team name
|Controls if your team name is shown or just ???? in the menu
|
|-
|2
|Treasure Bag
|Bag is bigger than the "One-Item-Inventory"
|
|-
|3
|Random Mission
|Must be enabled for random missions to generate
|Might have to do with being able to receive Wonder Mail S
|-
|4
|Friend Rescue
|
|
|-
|5
|Friends
|Pokémon show up in "Potential Recruits"
|
|-
|6
|Evolution
|
|
|-
|7
|Formation Change
|Whether leader can be switched in dungeons. If 0, you get kicked out of the dungeon when your partner faints.
Also allows adding and removing the starters from the active team on Chimeco Assembly.
|
|-
|8
|Move Alone / Training
|
|The list of internal names has an extra element that does not correspond to a flag somewhere around here. So the name for this flag could be either of those.
|-
|9
|Post ending
|Allows Pokémon that can't appear in missions during the story to appear in missions
|
|-
|10
|Scenario Completion
|Player and partner can evolve
|
|-
|11
|Dojo clear
|
|
|-
|12
|Defeat Drowzee
|Clear mark: Drowzee apprehended
|
|-
|13
|Defeat fake Groudon
|Clear mark: Mirage Groudon defeated
|
|-
|14
|Defeat Luxray
|Clear mark: Manectric's clan defeated
|
|-
|15
|Cleared Future World
|Clear mark: Escaped from the future
|
|-
|16
|Defeat Dusknoir
|Clear mark: Dusknoir defeated
|
|-
|17
|Defeat Dialga
|Clear mark: Temporal Tower saved
|
|-
|18
|Defeat Darkrai
|Clear mark: Darkrai banished
|
|-
|19
|Defeat Regigigas
|Clear mark: Regigigas defeated
|
|-
|20
|Guild Graduation
|Clear mark: Graduated from Wigglytuff's Guild
|Enables the Make Leader option in Chimeco assembly
|-
|21
|Collect 7 Treasures
|Clear mark: Seven Treasures all obtained
|
|-
|22
|Scizor ev. clear
|Clear mark: Met Scizor. Also grants Secret Rank.
|
|-
|23
|Get Manaphy
|
|
|-
|24
|Manaphy ev. clear
|Clear mark: Manaphy arc completed
|
|-
|25
|Go separately from Chatot
|Makes the Chatot guest slot for Brine Cave not appear even if the dungeon isn't cleared
|
|-
|26
|Climbed Sky Peak
|Clear mark: Climbed Sky Peak. Also unlocks Sky Jukebox.
|Allows using a Gracidea to change Shaymin to Sky forme.
|-
|27
|Identify Waterfall
|Changes "Secret Waterfall" to "Waterfall Cave"
|
|-
|28
|Identify Quicksand
|
|
|-
|29
|
|The list of recruitable Pokémon is available from the menu
|Believed to enable recruitment as a mission reward.
Enabled upon unlocking chimecho assembly (m00p0101).
|-
|30
|
|
|Believed to enable eggs as a mission reward.
Enabled upon returning from the expedition (m11a0101).
|-
|31
|
|
|Last flag that gets set when starting a new game with the "All complete" option. The rest might be unused.
Seems to be related to the Croagunk Swap Shop?

Believed to enable exclusive items as a mission reward.

Enabled upon unlocking the swap shop (m00p0201).
|-
|32
|
|Unused?
|
|-
|33
|
|Unused?
|
|-
|34
|
|Unused?
|
|-
|35
|
|Unused?
|
|-
|36
|
|Unused?
|
|-
|37
|
|Unused?
|
|-
|38
|
|Unused?
|
|-
|39
|
|Unused?
|
|-
|40
|
|Unused?
|
|-
|41
|
|Unused?
|
|-
|42
|
|Unused?
|
|-
|43
|
|Unused?
|
|-
|44
|
|Unused?
|
|-
|45
|
|Unused?
|
|-
|46
|
|Unused?
|
|-
|47
|
|Unused?
|
|-
|48
|
|Unused?
|
|-
|49
|
|Unused?
|
|-
|50
|
|Unused?
|
|-
|51
|
|Unused?
|
|-
|52
|
|Unused?
|
|-
|53
|
|Unused?
|
|-
|54
|
|Unused?
|
|-
|55
|
|Unused?
|
|-
|56
|
|Unused?
|
|-
|57
|
|Unused?
|
|-
|58
|
|Unused?
|
|-
|59
|
|Unused?
|
|-
|60
|
|Unused?
|
|-
|61
|
|Unused?
|
|-
|62
|
|Unused?
|
|-
|63
|
|Unused?
|
|}
{{NavScriptTerms}}
[[Category:Documentation]]

Performance Progress Flags

2025-10-02T19:03:35Z

Happylappy: Added Likely uses for [29], [30], and [31]

These flags are contained in the PERFORMANCE_PROGRESS_LIST [[List of Script Variables|variable]]. They are used to keep track of certain achievements and unlocks as the story progresses. Each flag is represented with a single bit, and therefore can only be true or false.
{| class="wikitable"
!ID
!Internal name
!Description
!Other comments
|-
|1
|Team name
|Controls if your team name is shown or just ???? in the menu
|
|-
|2
|Treasure Bag
|Bag is bigger than the "One-Item-Inventory"
|
|-
|3
|Random Mission
|Must be enabled for random missions to generate
|Might have to do with being able to receive Wonder Mail S
|-
|4
|Friend Rescue
|
|
|-
|5
|Friends
|Pokémon show up in "Potential Recruits"
|
|-
|6
|Evolution
|
|
|-
|7
|Formation Change
|Whether leader can be switched in dungeons. If 0, you get kicked out of the dungeon when your partner faints.
Also allows adding and removing the starters from the active team on Chimeco Assembly.
|
|-
|8
|Move Alone / Training
|
|The list of internal names has an extra element that does not correspond to a flag somewhere around here. So the name for this flag could be either of those.
|-
|9
|Post ending
|Allows Pokémon that can't appear in missions during the story to appear in missions
|
|-
|10
|Scenario Completion
|Player and partner can evolve
|
|-
|11
|Dojo clear
|
|
|-
|12
|Defeat Drowzee
|Clear mark: Drowzee apprehended
|
|-
|13
|Defeat fake Groudon
|Clear mark: Mirage Groudon defeated
|
|-
|14
|Defeat Luxray
|Clear mark: Manectric's clan defeated
|
|-
|15
|Cleared Future World
|Clear mark: Escaped from the future
|
|-
|16
|Defeat Dusknoir
|Clear mark: Dusknoir defeated
|
|-
|17
|Defeat Dialga
|Clear mark: Temporal Tower saved
|
|-
|18
|Defeat Darkrai
|Clear mark: Darkrai banished
|
|-
|19
|Defeat Regigigas
|Clear mark: Regigigas defeated
|
|-
|20
|Guild Graduation
|Clear mark: Graduated from Wigglytuff's Guild
|Enables the Make Leader option in Chimeco assembly
|-
|21
|Collect 7 Treasures
|Clear mark: Seven Treasures all obtained
|
|-
|22
|Scizor ev. clear
|Clear mark: Met Scizor. Also grants Secret Rank.
|
|-
|23
|Get Manaphy
|
|
|-
|24
|Manaphy ev. clear
|Clear mark: Manaphy arc completed
|
|-
|25
|Go separately from Chatot
|Makes the Chatot guest slot for Brine Cave not appear even if the dungeon isn't cleared
|
|-
|26
|Climbed Sky Peak
|Clear mark: Climbed Sky Peak. Also unlocks Sky Jukebox.
|Allows using a Gracidea to change Shaymin to Sky forme.
|-
|27
|Identify Waterfall
|Changes "Secret Waterfall" to "Waterfall Cave"
|
|-
|28
|Identify Quicksand
|
|
|-
|29
|
|The list of recruitable Pokémon is available from the menu
|Believed to enable recruitment as a mission reward.
Enabled upon unlocking chimecho assembly (m00p0101).
|-
|30
|
|
|Believed to enable eggs as a mission reward.
Enabled upon returning from the expedition (m11a0101).
|-
|31
|
|
|Last flag that gets set when starting a new game with the "All complete" option. The rest might be unused.
Seems to be related to the Croagunk Swap Shop?

Believed to enable exclusive items as a mission reward.

Enabled upon unlocking the swap shop (m00p0101).
|-
|32
|
|Unused?
|
|-
|33
|
|Unused?
|
|-
|34
|
|Unused?
|
|-
|35
|
|Unused?
|
|-
|36
|
|Unused?
|
|-
|37
|
|Unused?
|
|-
|38
|
|Unused?
|
|-
|39
|
|Unused?
|
|-
|40
|
|Unused?
|
|-
|41
|
|Unused?
|
|-
|42
|
|Unused?
|
|-
|43
|
|Unused?
|
|-
|44
|
|Unused?
|
|-
|45
|
|Unused?
|
|-
|46
|
|Unused?
|
|-
|47
|
|Unused?
|
|-
|48
|
|Unused?
|
|-
|49
|
|Unused?
|
|-
|50
|
|Unused?
|
|-
|51
|
|Unused?
|
|-
|52
|
|Unused?
|
|-
|53
|
|Unused?
|
|-
|54
|
|Unused?
|
|-
|55
|
|Unused?
|
|-
|56
|
|Unused?
|
|-
|57
|
|Unused?
|
|-
|58
|
|Unused?
|
|-
|59
|
|Unused?
|
|-
|60
|
|Unused?
|
|-
|61
|
|Unused?
|
|-
|62
|
|Unused?
|
|-
|63
|
|Unused?
|
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2025-09-01T17:43:33Z

Happylappy: /* 0x6e - TEAM_RANK_EVENT_LEVEL */

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [200] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Use unknown.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Use unknown.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used somewhere in Sky Peak

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Updated by message_Menu(76) to the current guild rank. In vanilla, this only seems to happen on clearing a mission.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2025-09-01T17:22:41Z

Happylappy: /* 0x70 - NOTE_MODIFY_FLAG */

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN. For the page detailing what these values mean, please see the [[Scenario Main Values]] article.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [200] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Use unknown.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Use unknown.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used somewhere in Sky Peak

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Has some correlation with guild rank? Unsure, I don't trust this variable.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===
If true, the player will be forced to save on leaving Pelipper island. Likely indicative of whether a rescue has been attempted?

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Special Processes

2025-08-18T02:20:34Z

Happylappy:

Here is the list of all special processes in the game. These are called by using <code>ProcessSpecial(PROCESS_SPECIAL_Name, Argument1, Argument2);</code>
{| class="wikitable"
|+
!ID
!Name
!Comment
|-
|1
|RETURN_DUNGEON
|
|-
|2
|INIT_MAIN_TEAM_AFTER_QUIZ
|Assigns the starter Pokemon, bow color, and much more from the personality quiz. Needs to run before most cutscenes involving the starters will actually function.
|-
|3-4
|Unknown
|
|-
|5
|NEXT_DAY
|Changes the contents of Job and Outlaw boards, Updates Kecleon Shops, Updates Croagunk, Updates Spinda Cafe, and likely more. Calls <code>GroundMainNextDay</code>, which does the above.
|-
|6
|Unknown
|
|-
|7
|DUNGEON_HAD_REQUEST_DONE
|True if the player finished a mission in the dungeon.
|-
|8-9
|Unknown
|
|-
|10
|GET_SOS_MAIL_COUNT
|
|-
|11
|GET_SOS_MAIL_RETRIES_LEFT
|Used by Pelipper to determine how many rescue attempts are left on a specific rescue.
|-
|12
|INIT_RANDOM_NPC_JOBS
|
|-
|13
|GET_RANDOM_NPC_JOB_TYPE
|
|-
|14
|GET_RANDOM_NPC_JOB_SUB_TYPE
|
|-
|15
|GET_RANDOM_NPC_STILL_AVAILABLE
|
|-
|16
|ACCEPT_RANDOM__NPC_JOB
|
|-
|17
|Unknown
|Just returns 0.
|-
|18
|Unknown
|
|-
|19
|KEY_WAIT_PRESS
|
|-
|20
|KEY_WAIT_INIT
|
|-
|21
|KEY_WAIT_CHECK
|
|-
|22-23
|Unknown
|
|-
|24
|Unknown
|Allows to skip a demo if the save file exist
|-
|25
|JUMP_TO_TITLE_SCREEN
|
|-
|26
|Unknown
|
|-
|27
|RETURN_TO_TITLE_SCREEN
|Exits ground mode and returns to the title screen.
|-
|28
|IS_RECRUITABLE_IN_TEAM
|
|-
|29
|GET_RECRUITABLE_CURRENT_LEvEL
|
|-
|30
|RECRUITABLE_CAN_ADD
|
|-
|31
|ADD_RECRUITABLE_TO_TEAM
|
|-
|32
|COUNT_ITEM_IN_BAG
|Counts how many of a specific item ID are in the bag
|-
|33
|COUNT_TABLE_ITEM_IN_BAG
|Counts how many of a specific set_Item item slot are in the bag
|-
|34
|COUNT_ITEM_TYPE_IN_STORAGE
|Counts how many of a specific item ID are in storage
|-
|35
|Unknown
|Counts how many of a specific set_Item item slot are in storage
|-
|36
|ADD_ITEM_TO_BAG
|Adds one instance of an item ID to the bag. Results may vary for stackable items.
|-
|37
|ADD_TABLE_ITEM_TO_BAG
|Adds one instance of a specific set_Item slot to the bag. Results may vary for stackable items.
|-
|38
|Unknown
|Adds one instance of a specific item ID to storage. Results may vary for stackable items.
|-
|39
|ADD_TABLE_ITEM_TO_STORAGE
|Adds one instance of a specific set_Item slot to storage. Results may vary for stackable items.
|-
|40
|REMOVE_ITEMS_TYPE_IN_BAG
|Removes one instance of an item ID from the bag. Results may vary for stackable items.
|-
|41
|REMOVE_TABLE_ITEMS_TYPE_IN_BAG
|Removes one instance of a set_Item slot from the bag. Results may vary for stackable items.
|-
|42
|Unknown
|Removes one instance of an item ID from storage. Results may vary for stackable items.
|-
|43
|Unknown
|Removes one instance of a set_Item slot from storage. Results may vary for stackable items.
|-
|44
|PREPARE_MENU_ACCEPT_TEAM_MEMBER
|Sets a team member for menu 65 to ask the player whether accept them or not
|-
|45
|GET_HERO_KIND
|
|-
|46
|GET_PARTNER_KIND
|
|-
|47
|IS_TEAM_SETUP_HERO_AND_PARTNER_ONLY
|Returns 1 if hero is a leader
|-
|48
|IS_TEAM_SETUP_PARTNER_AND_HERO_ONLY
|Returns 1 if partner is a leader
|-
|49
|IS_TEAM_SETUP_CONTAINS_PARTNER_AND_HERO
|Returns 1 if the hero and partner are in the team.
|-
|50
|IS_TEAM_SETUP_SOLO
|Returns 1 if there is only 1 pokemon in the team.
|-
|51
|SET_TEAM_SETUP_HERO_AND_PARTNER_ONLY
|Sets the active party to hero leader, partner in slot 2.
|-
|52
|IS_TEAM_SETUP_HERO_ONLY
|Sets the active party to hero only.
|-
|53
|Unknown
|
|-
|54
|STATUS_UPDATE
|Effect is unknown
|-
|55
|Unknown
|
|-
|56
|IS_BAG_FULL
|1 if the bag is full, 0 otherwise.
|-
|57
|Unknown
|Seems to be IS_STORAGE_FULL. 1 if storage is full, 0 otherwise.
|-
|58-59
|Unknown
|
|-
|60
|SEND_SKY_GIFT_TO_GUILDMASTER
|Seems to send a sky gift to the guildmaster.
|-
|61-62
|Unknown
|
|}

List of Special Processes

2025-08-18T02:19:17Z

Happylappy: Describe Some Special Processes

Here is the list of all special processes in the game. These are called by using <code>ProcessSpecial(PROCESS_SPECIAL_Name, Argument1, Argument2);</code>
{| class="wikitable"
|+
!ID
!Name
!Comment
|-
|1
|RETURN_DUNGEON
|
|-
|2
|INIT_MAIN_TEAM_AFTER_QUIZ
|Assigns the starter Pokemon, bow color, and much more from the personality quiz. Needs to run before most cutscenes involving the starters will actually function.
|-
|3-4
|Unknown
|
|-
|5
|NEXT_DAY
|Changes the contents of Job and Outlaw boards.
|-
|6
|Unknown
|
|-
|7
|DUNGEON_HAD_REQUEST_DONE
|True if the player finished a mission in the dungeon.
|-
|8-9
|Unknown
|
|-
|10
|GET_SOS_MAIL_COUNT
|
|-
|11
|GET_SOS_MAIL_RETRIES_LEFT
|Used by Pelipper to determine how many rescue attempts are left on a specific rescue.
|-
|12
|INIT_RANDOM_NPC_JOBS
|
|-
|13
|GET_RANDOM_NPC_JOB_TYPE
|
|-
|14
|GET_RANDOM_NPC_JOB_SUB_TYPE
|
|-
|15
|GET_RANDOM_NPC_STILL_AVAILABLE
|
|-
|16
|ACCEPT_RANDOM__NPC_JOB
|
|-
|17
|Unknown
|Just returns 0.
|-
|18
|Unknown
|
|-
|19
|KEY_WAIT_PRESS
|
|-
|20
|KEY_WAIT_INIT
|
|-
|21
|KEY_WAIT_CHECK
|
|-
|22-23
|Unknown
|
|-
|24
|Unknown
|Allows to skip a demo if the save file exist
|-
|25
|JUMP_TO_TITLE_SCREEN
|
|-
|26
|Unknown
|
|-
|27
|RETURN_TO_TITLE_SCREEN
|Exits ground mode and returns to the title screen.
|-
|28
|IS_RECRUITABLE_IN_TEAM
|
|-
|29
|GET_RECRUITABLE_CURRENT_LEvEL
|
|-
|30
|RECRUITABLE_CAN_ADD
|
|-
|31
|ADD_RECRUITABLE_TO_TEAM
|
|-
|32
|COUNT_ITEM_IN_BAG
|Counts how many of a specific item ID are in the bag
|-
|33
|COUNT_TABLE_ITEM_IN_BAG
|Counts how many of a specific set_Item item slot are in the bag
|-
|34
|COUNT_ITEM_TYPE_IN_STORAGE
|Counts how many of a specific item ID are in storage
|-
|35
|Unknown
|Counts how many of a specific set_Item item slot are in storage
|-
|36
|ADD_ITEM_TO_BAG
|Adds one instance of an item ID to the bag. Results may vary for stackable items.
|-
|37
|ADD_TABLE_ITEM_TO_BAG
|Adds one instance of a specific set_Item slot to the bag. Results may vary for stackable items.
|-
|38
|Unknown
|Adds one instance of a specific item ID to storage. Results may vary for stackable items.
|-
|39
|ADD_TABLE_ITEM_TO_STORAGE
|Adds one instance of a specific set_Item slot to storage. Results may vary for stackable items.
|-
|40
|REMOVE_ITEMS_TYPE_IN_BAG
|Removes one instance of an item ID from the bag. Results may vary for stackable items.
|-
|41
|REMOVE_TABLE_ITEMS_TYPE_IN_BAG
|Removes one instance of a set_Item slot from the bag. Results may vary for stackable items.
|-
|42
|Unknown
|Removes one instance of an item ID from storage. Results may vary for stackable items.
|-
|43
|Unknown
|Removes one instance of a set_Item slot from storage. Results may vary for stackable items.
|-
|44
|PREPARE_MENU_ACCEPT_TEAM_MEMBER
|Sets a team member for menu 65 to ask the player whether accept them or not
|-
|45
|GET_HERO_KIND
|
|-
|46
|GET_PARTNER_KIND
|
|-
|47
|IS_TEAM_SETUP_HERO_AND_PARTNER_ONLY
|Returns 1 if hero is a leader
|-
|48
|IS_TEAM_SETUP_PARTNER_AND_HERO_ONLY
|Returns 1 if partner is a leader
|-
|49
|IS_TEAM_SETUP_CONTAINS_PARTNER_AND_HERO
|Returns 1 if the hero and partner are in the team.
|-
|50
|IS_TEAM_SETUP_SOLO
|Returns 1 if there is only 1 pokemon in the team.
|-
|51
|SET_TEAM_SETUP_HERO_AND_PARTNER_ONLY
|Sets the active party to hero leader, partner in slot 2.
|-
|52
|IS_TEAM_SETUP_HERO_ONLY
|Sets the active party to hero only.
|-
|53
|Unknown
|
|-
|54
|STATUS_UPDATE
|Effect is unknown
|-
|55
|Unknown
|
|-
|56
|IS_BAG_FULL
|1 if the bag is full, 0 otherwise.
|-
|57
|Unknown
|Seems to be IS_STORAGE_FULL. 1 if storage is full, 0 otherwise.
|-
|58-59
|Unknown
|
|-
|60
|SEND_SKY_GIFT_TO_GUILDMASTER
|Seems to send a sky gift to the guildmaster.
|-
|61-62
|Unknown
|
|}

List of Script Variables

2025-08-12T02:50:44Z

Happylappy: /* 0x2 - SCENARIO_SELECT */

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

During mission rewards, the second index is used to track the index of the mission being processed in the job list.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [200] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Use unknown.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Use unknown.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used somewhere in Sky Peak

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Has some correlation with guild rank? Unsure, I don't trust this variable.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

List of Script Variables

2025-08-12T02:10:34Z

Happylappy: /* 0x68 - REQUEST_THANKS_RESULT_KIND */

This page lists all the variables available on the scripting engine. They can be read or written to from scripts.

Some variables store a single value, whereas others can store multiple bitflags.

== List of variables ==

=== 0x0 - VERSION ===
Seems to be used to keep track of save file versions. It's stored in the save file when the game is saved. When loading a save file, if the version value in it doesn't match the value of this variable, the save file is deleted.

=== 0x1 - CONDITION ===
Completely unused. Purpose unknown...

=== 0x2 - SCENARIO_SELECT ===
Two indexed values determined via the Top Menu. These are referenced by Unionall for general control flow.

To be a bit more specific, the first coroutine run after the Top Menu is EVENT_DIVIDE, which checks for these indexed values. In doing so, the game knows when to load scripts from maingame, a Special Episode, or Rescue mode.

=== 0x3 - SCENARIO_MAIN ===
Stores game progress. The first value correlates with the MAIN value (mostly aligns with the story chapter), while the second is generally used to track progress within that MAIN.

=== 0x4 - SCENARIO_SIDE ===
Like SCENARIO_MAIN, but for special episode progress.

=== 0x5 - SCENARIO_SUB1 ===

=== 0x6 - SCENARIO_SUB2 ===

=== 0x7 - SCENARIO_SUB3 ===

=== 0x8 - SCENARIO_SUB4 ===

=== 0x9 - SCENARIO_SUB5 ===

=== 0xa - SCENARIO_SUB6 ===

=== 0xb - SCENARIO_SUB7 ===

=== 0xc - SCENARIO_SUB8 ===
As far as is currently known, SCENARIO_SUB1 through SCENARIO_SUB8 are completely unused by the base-game! Perhaps they were intended to store side-quest progress of some sort?

=== 0xd - SIDE02_TALK ===
Three bit flags that keeps track of the neighbors Igglybuff talked to in Special Episode 2

=== 0xe - SIDE06_ROOM ===
Three bit flags that keeps track of the Limestone Cavern paths Team Charm visited in Special Episode 4

=== 0xf - SIDE08_BOSS2ND ===
True if the player lose against Sableyes in Barren Valley Clearing in Special Episode 5

=== 0x10 - SIDE01_BOSS2ND ===
True if Snover has betrayed bidoof in Special Episode 1. Used to determine whether Snover will be an ally in Star Cave or not.

=== 0x11 - SCENARIO_MAIN_BIT_FLAG ===
Has many purposes, sometimes have hardcoded or technical effects, but not always.
{| class="wikitable"
|+
!Number
!Where's used
|-
|0
|Unused.
|-
|1
|Gets set to 1 right after waking up in the guild. Used for the game to determine when partner dialogue should be changed to just "Good morning, [hero]...".
|-
|2
|Unused.
|-
|3
|Will end the current day if EVENT_DIVIDE is run.
|-
|4
|Similar to 3. Seems to be related to missions
|-
|5
|Gets set to 1 if the player decides to go the wrong way during an expedition.
|-
|6, 7, 8
|Used to remember how the game was saved last.
|-
|9
|Used in G01P04A/um07. When it's not set, the game spawns triggers. Upon walkng to them, Croagunk calls hero and partner to tell that the Croagunk Swap Shop is now opened.
|-
|10
|Gets set to 1 when it's a day to do jobs.
|-
|11
|Gets set to 1 when it's a day to do sentry duty.
|-
|12, 13
|Marowak Dojo First Entry/ Final Maze Opening
|-
|14-23
|Used in Marowak's Dojo. If none of them are set, the player finished all the dojo dungeons.
|-
|24
|Gets set when the player finishes all dojo dungeons. Used to only show a cutscene about the full dojo completion once.
|-
|25
|Gets set to 0 before the check whether it's set to 1 or not during a cutscene after finishing the Final Maze.
|-
|26, 27
|Unused
|-
|28
|Gets set to 1 when the player finishes Final Maze. Used to give another cutscene if the Final Maze gets finished again.
|-
|29
|Gets set to 1 if the player decides to go back to the previous location(or back to the town) from the checkpoint.
|-
|30
|Seems to be used in TITLE_TEST to distinguish between Time and Darkness.
|-
|31
|Gets set to 1 when the player presses Go Rescue for the first time.
|-
|32
|Gets set to 1 when the player presses Standby Adventure for the first time.
|-
|33-39
|Used after collecting one of the seven treasures. If none of them are set, the game gives a Seven Treasures collection checkmark.
|-
|40
|Gets set if the player interacts with anything on the Pelipper Island. If set, the game will save upon leaving the island.
|-
|41
|Gets set to 1 when Chimecho tells hero and partner that they're now able to change team leader. Used to only show this cutscene once.
|-
|42
|Gets set to 1 when the partner says good morning to hero in Sharpedo Bluff, while $SCENARIO_MAIN is 29, 92. Used to only show this cutscene once, as it's called in coroutine EVENT_DIVIDE_AFTER, that is called really often.
|-
|43-45
|Aegis Cave's ice, rock and steel puzzles completion.
|-
|46
|Gets set to 1 if the player Drifblim's Gondola. Used to show a cutscene where Drifblim thanks hero and partner for using his service.
|-
|47
|Gets set to 1 when player talks with Ampharos about Sneasel's Sky Gift.
|-
|48
|Gets set to 1 when the player gets Sneasel's gift.
|-
|49
|Gets set to 1 when the player leaves the station clearing after getting Sneasel's gift.
|-
|50-60
|Sky Gift had been sent to Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk and partner respectively.
|-
|61
|Gets set to 1 when the player gives an item to Happiny.
|-
|62-73
|Wigglytuff, Chatot, Diglett, Dugtrio, Sunflora, Loudred, Corphish, Chimecho, Bidoof, Croagunk, partner and Happiny respectively sent a Sky Gift to hero.
|-
|74-77
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station Clearing respectively. Happiny will always spawn on the 1st station if ITEM_BACKUP_GET = ITEM_BACKUP_TAKE.
|-
|78-81
|Used to decide whether Numel will appear on the 1st/3rd/5th/7th Station Clearing respectively.
|-
|82
|Gets set to 1 if the player already swapped items with Numel in the current attempt to climb to Sky Peak Summit.
|-
|83-87
|Used to decide whether Happiny will appear on the 1st/3rd/5th/7th Station/Summit Clearing respectively.
|-
|88
|Gets set to 1 when the player claims Jumpluff's gift.
|-
|89
|Used to decide whether Delibird should appear on the 9th Station Clearing. The chance of it being set is 50% each climbing attempt.
|-
|90
|Gets set to 1 when the player claims Delibird's gift.
|-
|91
|Gets set to 1 if the player gives an item to Heracross.
|-
|92
|Used to decide if a bottle should appear on the beach. The chance of it being set is 10%
|-
|93
|Used to decide if a client should appear in the cafe. The chance of it being set is 80%
|-
|94
|Gets set to 1 if the player receives a Gracidea.
|-
|95
|Gets set to 1 when Ursaring says that hero and partner can evolve.
|-
|96
|Gets set to 1 when Krabby says that bottles can appear on the beach.
|-
|97
|Gets set to 1 when Chimecho asks hero if recruits can stay at the cafe.
|-
|98
|Gets set to 1 in m00a01a. Doesn't seem to be used anywhere else.
|-
|99-127
|Unused.
|}

=== 0x12 - SCENARIO_TALK_BIT_FLAG ===
Up through [200] are in use, and they primarily exist to remember if the player has already talked with an NPC (therefore playing modified or shorter dialogue the second time around). For example, every merchant in treasure town comments on the player's accomplishments (like defeating Darkrai) the first time you talk to them. Whether that conversation has happened yet is tracked with SCENARIO_TALK_BIT_FLAG.

=== 0x13 - SCENARIO_BALANCE_FLAG ===
Starts at 0 and gets increased as the player completes certain story events. Controls bag size, Wynaut/Spinda dungeon unlocks, and the spawn threshold value of pokémon, which restricts spawning of some species until this variable reaches a certain value.

==== Value changes ====
This table lists the exact story spots where the value of the flag is increased.
{| class="wikitable"
|+
!Flag value
!Story chapter
!Story event
!Scene
!Script
|-
|0
|1
|Start of a new game
| -
| -
|-
|1
|3
|End of chapter
|V03P12A
|m03a1314.ssb
|-
|2
|6
|Expedition members are announced
|G01P04A
|m08a0301.ssb
|-
|3
|9
|End of chapter
|P04P01C
|m10a1213.ssb
|-
|4
|13
|End of chapter
|V16P02A
|m16a0702.ssb
|-
|5
|15
|End of chapter
|V19P06A
|m19b1014.ssb
|-
|6
|Post-game 1
|After graduating and moving to Sharpedo Bluff
|H02P99A
|s01p1103.ssb
|-
|7
|Game complete
|The Ursarings tell Hero and Partner they can evolve
(After unlocking Marine Resort)
|T01P01A
|m00p1401.ssb
|}

==== Bag size ====
This table lists the maximum bag size depending on the current value of <code>SCENARIO_BALANCE_FLAG</code>.
{| class="wikitable"
|+
!Flag value
!Bag size
|-
|0
|16
|-
|1
|24
|-
|2
|32
|-
|3
|40
|-
|4
|40
|-
|5
|40
|-
|6
|48
|-
|7
|48
|}
Values higher than 7 will read garbage data and cause crashes.

If <code>PERFORMANCE_PROGRESS_LIST[2]</code> is 0, the bag will only have 1 slot, regardless of the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x14 - SCENARIO_BALANCE_DEBUG ===
If >= 0, overrides the value of <code>SCENARIO_BALANCE_FLAG</code>.

=== 0x15 - CRYSTAL_COLOR_01 ===
Used to keep track of the current color of the first crystal during the Crystal Cave puzzle.

=== 0x16 - CRYSTAL_COLOR_02 ===
Used to keep track of the current color of the second crystal during the Crystal Cave puzzle.

=== 0x17 - CRYSTAL_COLOR_03 ===
Used to keep track of the current color of the third crystal during the Crystal Cave puzzle.

Outside of this puzzle, these 3 variables are completely unused by the base game!

=== 0x18 - COMPULSORY_SAVE_POINT ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in the main story.

=== 0x19 - COMPULSORY_SAVE_POINT_SIDE ===
Used in cutscene saves for the game to know the coroutine it needs to jump to after reloading a save. Only used in special episode.

=== 0x1a - SCENARIO_SELECT_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused!

=== 0x1b - SCENARIO_MAIN_BIT_FLAG_BACKUP ===
A carbon copy of SCENARIO_SELECT used while the game is saving to ensure that data is never lost by interrupting the save.

Is otherwise unused, and is a huge list of flags that can be used locally, or in places the player is unable to save!

=== 0x1c - GROUND_ENTER ===
The map ID the player is currently in the enter scene for.

=== 0x1d - GROUND_ENTER_LINK ===
Set to zero by EVENT_FORMATION. Purpose Unknown.

=== 0x1e - GROUND_GETOUT ===
The map ID of the enter scene the player was on before the current one. Usually used to decide where the player should enter from on the next map.

=== 0x1f - GROUND_MAP ===
The map ID of the map currently rendered. Usually this is identical to GROUND_ENTER, unless the map that was loaded changes (Such as P01P01A changing to P01P03A when the cafe is unlocked).

=== 0x20 - GROUND_PLACE ===
Determines the index for the map marker on the top-screen world map.

=== 0x21 - GROUND_ENTER_BACKUP ===
A carbon copy of GROUND_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x22 - GROUND_ENTER_LINK_BACKUP ===
A carbon copy of GROUND_ENTER_LINK used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x23 - GROUND_GETOUT_BACKUP ===
A carbon copy of GROUND_GETOUT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x24 - GROUND_MAP_BACKUP ===
A carbon copy of GROUND_MAP used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x25 - GROUND_PLACE_BACKUP ===
A carbon copy of GROUND_PLACE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x26 - DUNGEON_SELECT ===
The dungeon ID selected by the crossroads. Possibly reused elsewhere.

=== 0x27 - DUNGEON_ENTER ===
Stores the dungeon ID the player enters, but only in DMODE_OPEN or DMODE_CLOSED. Otherwise, may be set to 214 or 215.

DUNGEON_ENTER_INDEX is a more reliable tracker of the dungeon ID.

=== 0x28 - DUNGEON_ENTER_MODE ===
Seems to be the DMODE of the dungeon being entered.

=== 0x29 - DUNGEON_ENTER_INDEX ===
Is written on selecting a dungeon from the crossroads (and probably elsewhere). Generally used by the base game to remember the dungeon ID that the player is about to enter or has just exited.

=== 0x2a - DUNGEON_ENTER_FREQUENCY ===
A running total of how many times the player has entered any dungeon.

=== 0x2b - DUNGEON_RESULT ===
Stores how the dungeon was exited. Typically GROUND_START_MODE also stores this information, though that has other uses in ground mode.
{| class="wikitable"
!Value
!Meaning
|-
|8
|Dungeon was cleared
|-
|9
|Escape Orb Used
|-
|Other
|Defeated in Dungeon
|}

=== 0x2c - GROUND_START_MODE ===
The "mode" the game is in when it enters Ground Mode. Uses the same values as DUNGEON_RESULT when exiting a dungeon, but other values appear to be present. coroutine EVENT_FORMATION assigns it to 3, for unknown reasons.

=== 0x2d - DUNGEON_ENTER_BACKUP ===
A carbon copy of DUNGEON_ENTER used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2e - DUNGEON_ENTER_MODE_BACKUP ===
A carbon copy of DUNGEON_ENTER_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x2f - DUNGEON_ENTER_INDEX_BACKUP ===
A carbon copy of DUNGEON_ENTER_INDEX used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x30 - DUNGEON_ENTER_FREQUENCY_BACKUP ===
A carbon copy of DUNGEON_ENTER_FREQUENCY used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x31 - DUNGEON_RESULT_BACKUP ===
A carbon copy of DUNGEON_RESULT used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x32 - GROUND_START_MODE_BACKUP ===
A carbon copy of DUNGEON_START_MODE used while the game is saving to ensure that data is never lost by interrupting the save.

As far as we know, is otherwise unused!

=== 0x33 - REQUEST_CLEAR_COUNT ===
Stores the number of jobs the player has completed at certain points in the story to determine when the next story event will occur. Will never increment above 100 in the base game.

=== 0x34 - PLAYER_KIND ===
Determines what actor's species should replace ACTOR_PLAYER when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Species of Chimecho Assembly entry 0
|The Hero
|Treasure Town
|-
|1
|Species of Chimecho Assembly entry 1
|The Partner
|
|-
|2
|Nothing
|N/A
|N/A
|-
|3
|Species of current party leader
|N/A
|
|-
|4
|ACTOR_ATTENDANT_BIPPA
|Bidoof
|Special Episode 1
|-
|5
|ACTOR_ATTENDANT_PUPURIN
|Igglybuff
|Special Episode 2
|-
|6
|ACTOR_ATTENDANT_KIMAWARI
|Sunflora
|Special Episode 3
|-
|7
|ACTOR_ATTENDANT_FUTURE
|Grovyle
|Special Episode 5
|-
|8
|ACTOR_ATTENDANT_CHARMS
|Lopunny
|Special Episode 4
|-
|9+
|Nothing
|N/A
|N/A
|}

=== 0x35 - ATTENDANT1_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT1 (and possibly other related actors) when displayed:
{| class="wikitable"
!Value
!Actor to Pull Species From
!Base-Game Species
!Use Case
|-
|0
|Nothing
|N/A
|N/A
|-
|1
|Species of Chimecho Assembly entry 0
|The Hero
|
|-
|2
|Species of Chimecho Assembly entry 1
|The Partner
|Treasure Town
|-
|3
|Nothing
|N/A
|N/A
|-
|4
|Species of current party leader
|N/A
|
|-
|5-9
|Nothing
|N/A
|N/A
|-
|10
|ACTOR_ATTENDANT_MANAFI
|Manaphy
|
|}

=== 0x36 - ATTENDANT2_KIND ===
Determines what actor's species should replace ACTOR_ATTENDANT2 when displayed.

Will be "Nothing" unless it is 10, in which case Manaphy will slowly follow ATTENDANT1_KIND

=== 0x37 - PLAYER_KIND_BACKUP ===
A carbon copy of PLAYER_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x38 - ATTENDANT1_KIND_BACKUP ===
A carbon copy of ATTENDANT1_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x39 - ATTENDANT2_KIND_BACKUP ===
A carbon copy of ATTENDANT2_KIND used while the game is saving to ensure that data is never lost by interrupting the save.
As far as we know, is otherwise unused!

=== 0x3a - FRIEND_SUM ===
Unknown

=== 0x3b - UNIT_SUM ===
Unknown

=== 0x3c - CARRY_GOLD ===
Stores the current amount of money carried by the player.

=== 0x3d - BANK_GOLD ===
Stores the current amount of money stored in Duskull's bank.

=== 0x3e - HERO_FIRST_KIND ===
The species ID of the initial hero starter.

=== 0x3f - HERO_FIRST_NAME ===
The stored name of the initial hero starter, as a 10 character array of ASCII values.

=== 0x40 - PARTNER_FIRST_KIND ===
The species ID of the initial partner starter.

=== 0x41 - PARTNER_FIRST_NAME ===
The stored name of the initial partner starter, as a 10 character array of ASCII values.

=== 0x42 - HERO_TALK_KIND ===
Determines which of kind of dialogue the hero will use. In base game, only 4 and 5 are used for HERO_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Hero Species
!Use Case
|-
|4
|Male Pokemon
|Masculine Pronouns
|-
|5
|Female/Genderless Pokemon
|Feminine Pronouns
|}

=== 0x43 - PARTNER_TALK_KIND ===
Determines which of kind of dialogue the partner will use. In base game, only 1, 2, and 3 are used for PARTNER_TALK_KIND, but with something like StarterMenuTool (or QuizMenuTool) these can be assigned to more custom values.
{| class="wikitable"
!Value
!Partner Species
!Use Case
!Example Dialogue Use
|-
|1
|Squirtle, Totodile, Chimchar, Meowth or Munchlax
|More "bold" dialogue-wise
|No more wimping out. I have to be brave today.
|-
|2
|All other Male Species
|Less "bold" dialogue-wise
|This is it. I have to steel my courage today.
|-
|3
|All female Species
|Least "bold" dialogue-wise
|This is it. Today I’m going to be brave.
|}

=== 0x44 - RANDOM_REQUEST_NPC03_KIND ===
Determines the species of ACTOR_RANDOM_REQUEST_NPC03, or the Spinda Cafe client Pokémon. It is either a random Pokémon, Magnemite, or Togetic, depending on the mission.

=== 0x45 - CONFIG_COLOR_KIND ===
The aura bow color determined by the personality quiz at the beginning of the game. Only ever used by wigglytuff to determine the color of aura bow given to the player.

=== 0x46 - ROM_VARIATION ===
Unknown, but hardcoded to zero.

=== 0x47 - LANGUAGE_TYPE ===
Stores the language from DS Firmware.
{| class="wikitable"
!Value
!Language
|-
|0
|Japanese
|-
|1
|English
|-
|2
|French
|-
|3
|German
|-
|4
|Italian
|-
|5
|Spanish
|}

=== 0x48 - GAME_MODE ===
Keeps track of the current game mode.
{| class="wikitable"
|+
!ID
!Mode
|-
|0
|Top menu
|-
|1
|
|-
|2
|Normal play, including overworld and dungeons
|-
|3
|Special episode
|-
|4
|Rescue
|-
|5
|
|}
There might be more valid values.

=== 0x49 - EXECUTE_SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active. The base-game prefers this variable over SPECIAL_EPISODE_TYPE, though it is unknown if they differ at all.

=== 0x4a - SPECIAL_EPISODE_TYPE ===
Tracks which Special Episode is currently active, just like EXECUTE_SPECIAL_EPISODE_TYPE.

=== 0x4b - SPECIAL_EPISODE_OPEN ===
Keeps track of what Special Episodes are unlocked.

The following is the list of scripts where the Special Episodes are unlocked in the base-game:

- SPECIAL_EPISODE_OPEN[0] (Bidoof's Wish): V03P12A - m03a1314

- SPECIAL_EPISODE_OPEN[1] (Igglybuff the Prodigy): P04P01C - m10a1213

- SPECIAL_EPISODE_OPEN[2] (Today's Oh My Gosh): G01P04A - m16a0105

- SPECIAL_EPISODE_OPEN[3] (Here Comes Team Charm!): D01P11A - m20a0101

- SPECIAL_EPISODE_OPEN[4] (In the Future of Darkness): H02P99A - s01p1103

=== 0x4c - SPECIAL_EPISODE_OPEN_OLD ===
Keeps track of what Special Episodes were started. Used to show an exclamation mark if the episode is opened but wasn't started.

=== 0x4d - SPECIAL_EPISODE_CONQUEST ===
Keeps track of what Special Episodes did the player finished. Also unlocks the Special Episode's respective Clear Icons.

Note: This specific script variable is not in any script. It is actually triggered by an '''adventure_log''' command.

The following is the list of the '''adventure_log''' that triggers this Script Variable and its location for each Special Episode:

- SPECIAL_EPISODE_CONQUEST[0] (Bidoof's Wish): Triggered by '''adventure_log''' = 1000; in S04P01A - n03a3103

- SPECIAL_EPISODE_CONQUEST[1] (Igglybuff the Prodigy): Triggered by '''adventure_log''' = 1001; in S04P01A - n03a1704

- SPECIAL_EPISODE_CONQUEST[2] (Today's Oh My Gosh): Triggered by '''adventure_log''' = 1002; in S04P01A - n04a2606

- SPECIAL_EPISODE_CONQUEST[3] (Here Comes Team Charm!): Triggered by '''adventure_log''' = 1003; in S04P01A - n06a3909

- SPECIAL_EPISODE_CONQUEST[4] (In the Future of Darkness): Triggered by '''adventure_log''' = 1004; in S04P01A - n09a2212

=== 0x4e - PERFORMANCE_PROGRESS_LIST ===
List of flags used to keep track of unlocked features and achievements. See [[Performance Progress Flags]] for the full list.

=== 0x4f - DUNGEON_OPEN_LIST ===
List of unlocked dungeons. One bit per dungeon ID. If true, and the dungeon isn't on some blacklist, you can enter this dungeon from the crossroads/dojo/igglybuff's house/pelipper standby adventure.

Setting a dungeon to DMODE_OPEN or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

=== 0x50 - DUNGEON_ENTER_LIST ===
Large bitfield sized for storing dungeon-specific data. This is checked at [NA]0x204CEE0, but never assigned. Presumed Unused

=== 0x51 - DUNGEON_ARRIVE_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x52 - DUNGEON_CONQUEST_LIST ===
List of completed dungeons. One bit per dungeon ID. Automatically set on clearing any dungeon.

In many cases, this bitfield renders other flags or variables redundant in a vanilla setting, especially certain $PERFORMANCE_PROGRESS_LIST flags that are always enabled after clearing certain dungeons for the first time.

=== 0x53 - DUNGEON_PRESENT_LIST ===
Large bitfield sized for storing dungeon-specific data. Presumed Unused

=== 0x54 - DUNGEON_REQUEST_LIST ===
List of dungeons that no longer have story progression. On completing a dungeon with this bit enabled, the player will enter [INSERT THE RIGHT COROUTINE HERE] in unionall.

Setting a dungeon to DMODE_REQUEST or DMODE_OPEN_AND_REQUEST enables the matching bit in this field!

Contrary to the name, this field alone is insufficient for missions to show up on the job board! Only dungeon in DMODE_OPEN_AND_REQUEST can have missions, and other (hardcoded) conditions must be met.

=== 0x55 - WORLD_MAP_MARK_LIST_NORMAL ===
Use unknown.

=== 0x56 - WORLD_MAP_MARK_LIST_SPECIAL ===
Use unknown.

=== 0x57 - WORLD_MAP_LEVEL ===
Seems to be used to track the area covered by clouds on the world map.

=== 0x58 - POSITION_X ===
Stores the X-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x59 - POSITION_Y ===
Stores the Y-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5a - POSITION_HEIGHT ===
Stores the Z-coordinate of an entity when the LoadPosition() opcode is run on it.

=== 0x5b - POSITION_DIRECTION ===
Stores the direction an entity is facing when the LoadPosition() opcode is run on it.

=== 0x5c - EVENT_LOCAL ===
Used as scratch paper by the base game, and is reset between scripts.

=== 0x5d - DUNGEON_EVENT_LOCAL ===
Used as scratch paper by the base game (possibly while within dungeons?), and is reset between scripts.

=== 0x5e - STATION_ITEM_STATIC ===
Use unknown.

=== 0x5f - STATION_ITEM_TEMP ===
Use unknown.

=== 0x60 - DELIVER_ITEM_STATIC ===
Use unknown.

=== 0x61 - DELIVER_ITEM_TEMP ===
Use unknown.

=== 0x62 - BIT_FUWARANTE_LOCAL ===
Keeps track of the Sky Peak stations the player visited. Used in the script for Drifblim's Gondola.

=== 0x63 - LOTTERY_RESULT ===
Used to track what result should occur during the Recycle Shop Prize Ticket Lottery. Has no other use.

=== 0x64 - ITEM_BACKUP ===
Unlikely to be a backup flag. Conveniently sized for item_GetVariable to extract the item ID and metadata.

Used somewhere in Sky Peak

=== 0x65 - ITEM_BACKUP_KUREKURE ===
Happiny requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x66 - ITEM_BACKUP_TAKE ===
Numel requests the item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x67 - ITEM_BACKUP_GET ===
Numel gives this item stored in this variable if found on Sky Peak. Pulled from an item table each day.

=== 0x68 - REQUEST_THANKS_RESULT_KIND ===
Stores the mission type of the mission being processed during mission rewards.

=== 0x69 - REQUEST_THANKS_RESULT_VARIATION ===
Stores the mission subtype of the mission being processed during mission rewards.

=== 0x6a - SUB30_TREASURE_DISCOVER ===
If set to true, Wynaut tells hero and partner that a treasure was found.

=== 0x6b - SUB30_SPOT_DISCOVER ===
If set to true, Wynaut tells hero and partner that a new unexplored area was discovered.

=== 0x6c - RECYCLE_COUNT ===
Stores the number of recycles the player has done. Is only updated by the base-game at the end of each day.

=== 0x6d - SUB30_SPOT_LEVEL ===
Keeps track of what dungeon was discovered by Project P.

=== 0x6e - TEAM_RANK_EVENT_LEVEL ===
Has some correlation with guild rank? Unsure, I don't trust this variable.

=== 0x6f - PLAY_OLD_GAME ===
True if the player answered yes to the question on the personality quiz that asks if you played Explorers of Time or Darkness. Increases the recruit rate of certain pokémon if you haven't recruited them yet.

=== 0x70 - NOTE_MODIFY_FLAG ===

=== 0x71 - SUB30_PROJECTP ===
If true, the player has viewed the Project P cutscene, and the recycle shop is capable of being upgraded.

=== 0x72 - SUM ===
Seems to be a marker of the end of "normal" script variables.

=== 0x400 - LOCAL0 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL0 in def 0 is distinct from $LOCAL0 in def 1!

=== 0x401 - LOCAL1 ===
Unknown if used in vanilla, is reset on entering a new script like $EVENT_LOCAL.

NOTE: Is unique for every routine in a script! $LOCAL1 indef 0 is distinct from $LOCAL1 in def 1!

=== 0x402 - LOCAL2 ===
Broken, do not use unless you know what you are doing!

=== 0x403 - LOCAL3 ===
Broken, do not use unless you know what you are doing!

== Variable Lengths ==
Not all variables can store the same sized values! Some were allocated to be different sizes than others. Besides the standard sizes, there are 2 unusual variable sizes worth mentioning. "special" variable sizes are not stored in the same place as every other variable, and instead read some other value, such as the number of money the player currently has, or the current language of the ROM. "None" size is only used by the "SUM" variable, and has no allocated space at all. Below are a list of variables, their sizes, and how many there are:
{| class="wikitable"
|'''Variable'''
|'''Size'''
|'''Count'''
|-
|VERSION
|int32
|0x1 (1)
|-
|CONDITION
|int32
|0x1 (1)
|-
|SCENARIO_SELECT
|uint8
|0x2 (2)
|-
|SCENARIO_MAIN
|uint8
|0x2 (2)
|-
|SCENARIO_SIDE
|uint8
|0x2 (2)
|-
|SCENARIO_SUB1
|uint8
|0x2 (2)
|-
|SCENARIO_SUB2
|uint8
|0x2 (2)
|-
|SCENARIO_SUB3
|uint8
|0x2 (2)
|-
|SCENARIO_SUB4
|uint8
|0x2 (2)
|-
|SCENARIO_SUB5
|uint8
|0x2 (2)
|-
|SCENARIO_SUB6
|uint8
|0x2 (2)
|-
|SCENARIO_SUB7
|uint8
|0x2 (2)
|-
|SCENARIO_SUB8
|uint8
|0x2 (2)
|-
|SIDE02_TALK
|bit
|0x3 (3)
|-
|SIDE06_ROOM
|bit
|0x3 (3)
|-
|SIDE08_BOSS2ND
|bit
|0x1 (1)
|-
|SIDE01_BOSS2ND
|bit
|0x1 (1)
|-
|SCENARIO_MAIN_BIT_FLAG
|bit
|0x80 (128)
|-
|SCENARIO_TALK_BIT_FLAG
|bit
|0x100 (256)
|-
|SCENARIO_BALANCE_FLAG
|int8
|0x1 (1)
|-
|SCENARIO_BALANCE_DEBUG
|int8
|0x1 (1)
|-
|CRYSTAL_COLOR_01
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_02
|uint8
|0x1 (1)
|-
|CRYSTAL_COLOR_03
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT
|uint8
|0x1 (1)
|-
|COMPULSORY_SAVE_POINT_SIDE
|uint8
|0x1 (1)
|-
|SCENARIO_SELECT_BACKUP
|uint8
|0x8 (8)
|-
|SCENARIO_MAIN_BIT_FLAG_BACKUP
|bit
|0x200 (512)
|-
|GROUND_ENTER
|int16
|0x1 (1)
|-
|GROUND_ENTER_LINK
|uint8
|0x1 (1)
|-
|GROUND_GETOUT
|int16
|0x1 (1)
|-
|GROUND_MAP
|int16
|0x1 (1)
|-
|GROUND_PLACE
|int16
|0x1 (1)
|-
|GROUND_ENTER_BACKUP
|int16
|0x5 (5)
|-
|GROUND_ENTER_LINK_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_GETOUT_BACKUP
|int16
|0x5 (5)
|-
|GROUND_MAP_BACKUP
|int16
|0x5 (5)
|-
|GROUND_PLACE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_SELECT
|int16
|0x1 (1)
|-
|DUNGEON_ENTER
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_MODE
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_INDEX
|int16
|0x1 (1)
|-
|DUNGEON_ENTER_FREQUENCY
|uint16
|0x1 (1)
|-
|DUNGEON_RESULT
|uint8
|0x1 (1)
|-
|GROUND_START_MODE
|uint8
|0x1 (1)
|-
|DUNGEON_ENTER_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_MODE_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_INDEX_BACKUP
|int16
|0x5 (5)
|-
|DUNGEON_ENTER_FREQUENCY_BACKUP
|uint16
|0x5 (5)
|-
|DUNGEON_RESULT_BACKUP
|uint8
|0x5 (5)
|-
|GROUND_START_MODE_BACKUP
|uint8
|0x5 (5)
|-
|REQUEST_CLEAR_COUNT
|uint8
|0x1 (1)
|-
|PLAYER_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT1_KIND
|uint8
|0x1 (1)
|-
|ATTENDANT2_KIND
|uint8
|0x1 (1)
|-
|PLAYER_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT1_KIND_BACKUP
|uint8
|0x5 (5)
|-
|ATTENDANT2_KIND_BACKUP
|uint8
|0x5 (5)
|-
|FRIEND_SUM
|special
|0x1 (1)
|-
|UNIT_SUM
|special
|0x1 (1)
|-
|CARRY_GOLD
|special
|0x1 (1)
|-
|BANK_GOLD
|special
|0x1 (1)
|-
|HERO_FIRST_KIND
|int16
|0x1 (1)
|-
|HERO_FIRST_NAME
|string
|0xA (10)
|-
|PARTNER_FIRST_KIND
|int16
|0x1 (1)
|-
|PARTNER_FIRST_NAME
|string
|0xA (10)
|-
|HERO_TALK_KIND
|int8
|0x1 (1)
|-
|PARTNER_TALK_KIND
|int8
|0x1 (1)
|-
|RANDOM_REQUEST_NPC03_KIND
|int16
|0x1 (1)
|-
|CONFIG_COLOR_KIND
|int8
|0x1 (1)
|-
|ROM_VARIATION
|int8
|0x1 (1)
|-
|LANGUAGE_TYPE
|special
|0x1 (1)
|-
|GAME_MODE
|special
|0x1 (1)
|-
|EXECUTE_SPECIAL_EPISODE_TYPE
|special
|0x1 (1)
|-
|SPECIAL_EPISODE_TYPE
|int8
|0x1 (1)
|-
|SPECIAL_EPISODE_OPEN
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_OPEN_OLD
|bit
|0x8 (8)
|-
|SPECIAL_EPISODE_CONQUEST
|bit
|0x8 (8)
|-
|PERFORMANCE_PROGRESS_LIST
|bit
|0x40 (64)
|-
|DUNGEON_OPEN_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ENTER_LIST
|bit
|0x100 (256)
|-
|DUNGEON_ARRIVE_LIST
|bit
|0x100 (256)
|-
|DUNGEON_CONQUEST_LIST
|bit
|0x100 (256)
|-
|DUNGEON_PRESENT_LIST
|bit
|0x100 (256)
|-
|DUNGEON_REQUEST_LIST
|bit
|0x100 (256)
|-
|WORLD_MAP_MARK_LIST_NORMAL
|bit
|0x140 (320)
|-
|WORLD_MAP_MARK_LIST_SPECIAL
|bit
|0x140 (320)
|-
|WORLD_MAP_LEVEL
|uint8
|0x1 (1)
|-
|POSITION_X
|uint32
|0x3 (3)
|-
|POSITION_Y
|uint32
|0x3 (3)
|-
|POSITION_HEIGHT
|uint32
|0x3 (3)
|-
|POSITION_DIRECTION
|int8
|0x3 (3)
|-
|EVENT_LOCAL
|int16
|0x1 (1)
|-
|DUNGEON_EVENT_LOCAL
|int16
|0x1 (1)
|-
|STATION_ITEM_STATIC
|bit
|0x20 (32)
|-
|STATION_ITEM_TEMP
|bit
|0x20 (32)
|-
|DELIVER_ITEM_STATIC
|bit
|0x10 (16)
|-
|DELIVER_ITEM_TEMP
|bit
|0x10 (16)
|-
|BIT_FUWARANTE_LOCAL
|bit
|0x5 (5)
|-
|LOTTERY_RESULT
|uint8
|0x1 (1)
|-
|ITEM_BACKUP
|int16
|0x2 (2)
|-
|ITEM_BACKUP_KUREKURE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_TAKE
|int16
|0x2 (2)
|-
|ITEM_BACKUP_GET
|int16
|0x2 (2)
|-
|REQUEST_THANKS_RESULT_KIND
|int16
|0x1 (1)
|-
|REQUEST_THANKS_RESULT_VARIATION
|int16
|0x1 (1)
|-
|SUB30_TREASURE_DISCOVER
|bit
|0x1 (1)
|-
|SUB30_SPOT_DISCOVER
|bit
|0x1 (1)
|-
|RECYCLE_COUNT
|uint32
|0x1 (1)
|-
|SUB30_SPOT_LEVEL
|uint8
|0x1 (1)
|-
|TEAM_RANK_EVENT_LEVEL
|uint8
|0x1 (1)
|-
|PLAY_OLD_GAME
|uint8
|0x1 (1)
|-
|NOTE_MODIFY_FLAG
|special
|0x1 (1)
|-
|SUB30_PROJECTP
|bit
|0x1 (1)
|-
|SUM
|none
|0x0 (0)
|-
|LOCAL0
|int16
|0x1 (1)
|-
|LOCAL1
|int16
|0x1 (1)
|-
|LOCAL2
|int16
|0x1 (1)
|-
|LOCAL3
|int16
|0x1 (1)
|}
{{NavScriptTerms}}
[[Category:Documentation]]

QuizMenuTool Tutorial

2025-08-11T19:46:31Z

Happylappy: I thiiiink I removed the unfinished part?

This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting is helpful for this task, but not strictly required. These topics will be covered at the end for the sake of completion, but only to the extent that they are needed for QuizMenuTool.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according to a custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
! rowspan="2" |Answer Text
! colspan="2" |Pool 1
! colspan="2" |Pool 2
! colspan="2" |Pool 3
! colspan="2" |Pool 4
|-
!ID
!Points
!ID
!Points
!ID
!Points
!ID
!Points
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===
Next, is the process of actually creating the QMT script files. For simplicity, this guide will demonstrate the process on LEVEL_S02P01A, the same location in the script files as the original quiz. If you plan on putting the QMT script files elsewhere, ensure this is properly accounted for in Full Script Compression. Navigate to Script Scenes->S02P01A. If you are using a MegaScript, create ONE new acting scene. Otherwise, create four of them, each with the name in FullScriptCompression.
[[File:ImportingQMTScriptFiles1.png|alt=Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.|center|thumb|600x600px|Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.]]
The newly created scenes should appear in the Acting (ssa) folder. Navigate to the first one created, and double-click on "[script-name].ssb".
[[File:ImportingQMTScriptFiles2.png|alt=In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.|center|thumb|600x600px|In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.]]

From there, simply paste from the respective part of the sheet, and attempt to save the script.
[[File:ImportingQMTScriptFiles3.png|center|thumb|600x600px|You can also navigate between script files with the search bar on the left!]]

Repeat the process of pasting in the remaining scripts. Finally, the script that contains the aura bow segment of the quiz (script #2 or the megascript) needs additional work done to the .ssa file. Navigate to S02P01A->M00A01A, and click the Export Button (square with an up arrow in it).
[[File:Export Quiz .ssa.png|alt=Visual for exporting the .ssa for M00A01A for QuizMenuTool|center|thumb|600x600px|The Export Button is up top!]]
Then just import this file into the script containing the Aura Bow segment, as shown below:
[[File:Aura Bow SSA import.png|center|thumb|600x600px|The Export Button is right next to the Import button!]]
After that, save the ROM. The quiz is nearly ready, all that's left is setting up unionall...

=== Editing Unionall ===
Unionall is a big file, but there's only a very specific part that needs to be edited. Open Unionall by using the search bar in the Script Engine Debugger, then do CTRL + F (Command + F for Mac, you should know your equivalent if you use Linux) to find coroutine inside unionall.
[[File:Unionall coro EVENT M00A 01.png|center|thumb|600x600px|Be sure you search for EXACTLY "coro EVENT_M00A_01". This should be the only match!]]
Once you find it, select the entire coroutine, and replace it with the unionall final output. the result should look something like this:
[[File:QMT coro EVENT M00A 01.png|center|thumb|600x600px|Modified Unionall Coroutine, should look roughly like this after pasting.]]
With that, save unionall, and the quiz is ready for testing!

== Troubleshooting ==
if you run into any of these issues, or the fix doesn't work, reach out to happylappy for questions in the SkyTemple discord!

=== The Game Crashed before the first script loaded! ===
Do your script names and locations match between unionall (or the sheet if it's making the unionall coro), and your script file names? If not, that would cause a crash.

=== The Game Crashed When a SP tried to run! ===
Have you used the correct SP IDs and regions? Might be worth importing them again, just in case.

=== The Game Crashed/Glitched out between scripts! ===
That is... concerning. See, script files are capable of overwriting other things in RAM if they're too big (which is why QMT usually splits into 4 separate scripts). Quizzes with an obscene number of questions or starters may still overwrite something important in RAM anyway, which would need to be handled on a case-by-case basis.

=== One of my scripts won't save! ===
That's concerning, but could be the result of leaving a question or starter unfinished? Depends heavily on the error message.

== Other Resources ==

=== QMT Script Variable Map ===
Below is a table of every script variable used by QuizMenuTool, and what their use-case is for each script. Any variable absent from the table is unused by QMT directly. Variable usage can perhaps be optimized somewhat, but this map functions properly.
{| class="wikitable"
!Script Variable Name
!Index
!Script #1
!Script #2
!Script #3
!Script #4
|-
|$SCENARIO_SUB1
|0
|Backup of Pre-Quiz $PLAYER_KIND
| colspan="3" rowspan="1" |Winning # of Points Backup
|-
|$SCENARIO_SUB2
|0
|Backup of 0th index of Pre-Quiz $PLAYER_KIND_BACKUP
| colspan="3" rowspan="1" |Winning Pool ID Backup
|-
|$SCENARIO_SUB3
|0
|Backup of Pre-Quiz $ATTENDANT1_KIND
| -
|# of times hero gen. failed
| -
|-
|$SCENARIO_SUB4
|0
|Backup of 0th index of Pre-Quiz $ATTENDANT1_KIND_BACKUP
| -
| -
| -
|-
|$BIT_FUWARANTE_LOCAL
|All
| colspan="4" rowspan="1" |FUWARANTE blacklist flags
|-
|$LOCAL0
| -
|Max # of points.
| colspan="3" rowspan="1" |Winning # of Points / (Aura Bow Color Backup)
|-
|$LOCAL1
| -
|# Questions Asked / Winning Pool ID
| colspan="3" rowspan="1" |Winning Pool ID
|-
|$SCENARIO_TALK_BIT_FLAG
|Varies
| colspan="4" rowspan="1" |Question Has Been Asked?
|-
|$SCENARIO_MAIN
|0
| colspan="4" rowspan="1" |# of tied pools (-1 if not checking ties)
|-
|$SCENARIO_SIDE
|0
| colspan="4" rowspan="1" |# of pts to add to tied pool
|-
|$RECYCLE_COUNT
| -
| colspan="4" rowspan="1" |Post-Tie Max # of Pts.
|-
|$CONFIG_COLOR_KIND
| -
| -
| colspan="3" rowspan="1" |Aura Bow Color
|-
|$HERO_TALK_KIND
| -
| -
| -
| colspan="2" rowspan="1" |Hero Talk Group
|-
|$PARTNER_TALK_KIND
| -
| -
| -
| -
|Partner Talk Group
|-
|$VERSION
| -
| colspan="3" rowspan="1" |Pool 0 Pts.
|Reset to 1
|-
|$CRYSTAL_COLOR_01
| -
| colspan="3" rowspan="1" |Pool 1 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_02
| -
| colspan="3" rowspan="1" |Pool 2 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_03
| -
| colspan="3" rowspan="1" |Pool 3 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT
| -
| colspan="3" rowspan="1" |Pool 4 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT_SIDE
| -
| colspan="3" rowspan="1" |Pool 5 Pts.
|Reset to 0
|-
|$SCENARIO_SELECT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 6 Pts.
|Reset to 0
|-
|$GROUND_ENTER
| -
| colspan="3" rowspan="1" |Pool 7 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK
| -
| colspan="3" rowspan="1" |Pool 8 Pts.
|Reset to 0
|-
|$GROUND_GETOUT
| -
| colspan="3" rowspan="1" |Pool 9 Pts.
|Reset to 0
|-
|$GROUND_MAP
| -
| colspan="3" rowspan="1" |Pool 10 Pts.
|Reset to 0
|-
|$GROUND_PLACE
| -
| colspan="3" rowspan="1" |Pool 11 Pts.
|Reset to 0
|-
|$GROUND_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 12 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK_BACKUP
|0
| colspan="3" rowspan="1" |Pool 13 Pts.
|Reset to 0
|-
|$GROUND_GETOUT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 14 Pts.
|Reset to 0
|-
|$GROUND_MAP_BACKUP
|0
| colspan="3" rowspan="1" |Pool 15 Pts.
|Reset to 0
|-
|$GROUND_PLACE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 16 Pts.
|Reset to 0
|-
|$DUNGEON_SELECT
| -
| colspan="3" rowspan="1" |Pool 17 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER
| -
| colspan="3" rowspan="1" |Pool 18 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE
| -
| colspan="3" rowspan="1" |Pool 19 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX
| -
| colspan="3" rowspan="1" |Pool 20 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT
| -
| colspan="3" rowspan="1" |Pool 21 Pts.
|Reset to 0
|-
|$GROUND_START_MODE
| -
| colspan="3" rowspan="1" |Pool 22 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 23 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 24 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX_BACKUP
|0
| colspan="3" rowspan="1" |Pool 25 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 26 Pts.
|Reset to 0
|-
|$GROUND_START_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 27 Pts.
|Reset to 0
|-
|$REQUEST_CLEAR_COUNT
| -
| colspan="3" rowspan="1" |Pool 28 Pts.
|Reset to 0
|-
|$PLAYER_KIND
| -
|Pool 29 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND
| -
|Pool 30 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND
| -
| colspan="3" rowspan="1" |Pool 31 Pts.
|Reset to 0
|-
|$PLAYER_KIND_BACKUP
|0
|Pool 32 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND_BACKUP
|0
|Pool 33 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND_BACKUP
|0
| colspan="3" rowspan="1" |Pool 34 Pts.
|Reset to 0
|-
|$HERO_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 35 Pts.
|Reset to 0
|-
|$PARTNER_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 36 Pts.
|Reset to 0
|-
|$RANDOM_REQUEST_NPC03_KIND
| -
| colspan="3" rowspan="1" |Pool 37 Pts.
|Reset to 0
|-
|$WORLD_MAP_LEVEL
| -
| colspan="3" rowspan="1" |Pool 38 Pts.
|Reset to 0
|-
|$EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 39 Pts.
|Reset to 0
|-
|$DUNGEON_EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 40 Pts.
|Reset to 0
|-
|$LOTTERY_RESULT
| -
| colspan="3" rowspan="1" |Pool 41 Pts.
|Reset to 0
|-
|$ITEM_BACKUP
|0
| colspan="3" rowspan="1" |Pool 42 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_KUREKURE
|0
| colspan="3" rowspan="1" |Pool 43 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_TAKE
|0
| colspan="3" rowspan="1" |Pool 44 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_GET
|0
| colspan="3" rowspan="1" |Pool 45 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_KIND
| -
| colspan="3" rowspan="1" |Pool 46 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_VARIATION
| -
| colspan="3" rowspan="1" |Pool 47 Pts.
|Reset to 0
|-
|$SUB30_SPOT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 48 Pts.
|Reset to 0
|-
|$TEAM_RANK_EVENT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 49 Pts.
|Reset to 0
|-
|$PLAY_OLD_GAME
| -
| colspan="3" rowspan="1" |Pool 50 Pts.
|Reset to 0
|}

QuizMenuTool Tutorial

2025-08-11T00:04:54Z

Happylappy: /* About Question Templates */

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting is helpful for this task, but not strictly required. These topics will be covered at the end for the sake of completion, but only to the extent that they are needed for QuizMenuTool.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according to a custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
! rowspan="2" |Answer Text
! colspan="2" |Pool 1
! colspan="2" |Pool 2
! colspan="2" |Pool 3
! colspan="2" |Pool 4
|-
!ID
!Points
!ID
!Points
!ID
!Points
!ID
!Points
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===
Next, is the process of actually creating the QMT script files. For simplicity, this guide will demonstrate the process on LEVEL_S02P01A, the same location in the script files as the original quiz. If you plan on putting the QMT script files elsewhere, ensure this is properly accounted for in Full Script Compression. Navigate to Script Scenes->S02P01A. If you are using a MegaScript, create ONE new acting scene. Otherwise, create four of them, each with the name in FullScriptCompression.
[[File:ImportingQMTScriptFiles1.png|alt=Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.|center|thumb|600x600px|Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.]]
The newly created scenes should appear in the Acting (ssa) folder. Navigate to the first one created, and double-click on "[script-name].ssb".
[[File:ImportingQMTScriptFiles2.png|alt=In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.|center|thumb|600x600px|In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.]]

From there, simply paste from the respective part of the sheet, and attempt to save the script.
[[File:ImportingQMTScriptFiles3.png|center|thumb|600x600px|You can also navigate between script files with the search bar on the left!]]

Repeat the process of pasting in the remaining scripts. Finally, the script that contains the aura bow segment of the quiz (script #2 or the megascript) needs additional work done to the .ssa file. Navigate to S02P01A->M00A01A, and click the Export Button (square with an up arrow in it).
[[File:Export Quiz .ssa.png|alt=Visual for exporting the .ssa for M00A01A for QuizMenuTool|center|thumb|600x600px|The Export Button is up top!]]
Then just import this file into the script containing the Aura Bow segment, as shown below:
[[File:Aura Bow SSA import.png|center|thumb|600x600px|The Export Button is right next to the Import button!]]
After that, save the ROM. The quiz is nearly ready, all that's left is setting up unionall...

=== Editing Unionall ===
Unionall is a big file, but there's only a very specific part that needs to be edited. Open Unionall by using the search bar in the Script Engine Debugger, then do CTRL + F (Command + F for Mac, you should know your equivalent if you use Linux) to find coroutine inside unionall.
[[File:Unionall coro EVENT M00A 01.png|center|thumb|600x600px|Be sure you search for EXACTLY "coro EVENT_M00A_01". This should be the only match!]]
Once you find it, select the entire coroutine, and replace it with the unionall final output. the result should look something like this:
[[File:QMT coro EVENT M00A 01.png|center|thumb|600x600px|Modified Unionall Coroutine, should look roughly like this after pasting.]]
With that, save unionall, and the quiz is ready for testing!

== Troubleshooting ==
if you run into any of these issues, or the fix doesn't work, reach out to happylappy for questions in the SkyTemple discord!

=== The Game Crashed before the first script loaded! ===
Do your script names and locations match between unionall (or the sheet if it's making the unionall coro), and your script file names? If not, that would cause a crash.

=== The Game Crashed When a SP tried to run! ===
Have you used the correct SP IDs and regions? Might be worth importing them again, just in case.

=== The Game Crashed/Glitched out between scripts! ===
That is... concerning. See, script files are capable of overwriting other things in RAM if they're too big (which is why QMT usually splits into 4 separate scripts). Quizzes with an obscene number of questions or starters may still overwrite something important in RAM anyway, which would need to be handled on a case-by-case basis.

=== One of my scripts won't save! ===
That's concerning, but could be the result of leaving a question or starter unfinished? Depends heavily on the error message.

== Other Resources ==

=== QMT Script Variable Map ===
Below is a table of every script variable used by QuizMenuTool, and what their use-case is for each script. Any variable absent from the table is unused by QMT directly. Variable usage can perhaps be optimized somewhat, but this map functions properly.
{| class="wikitable"
!Script Variable Name
!Index
!Script #1
!Script #2
!Script #3
!Script #4
|-
|$SCENARIO_SUB1
|0
|Backup of Pre-Quiz $PLAYER_KIND
| colspan="3" rowspan="1" |Winning # of Points Backup
|-
|$SCENARIO_SUB2
|0
|Backup of 0th index of Pre-Quiz $PLAYER_KIND_BACKUP
| colspan="3" rowspan="1" |Winning Pool ID Backup
|-
|$SCENARIO_SUB3
|0
|Backup of Pre-Quiz $ATTENDANT1_KIND
| -
|# of times hero gen. failed
| -
|-
|$SCENARIO_SUB4
|0
|Backup of 0th index of Pre-Quiz $ATTENDANT1_KIND_BACKUP
| -
| -
| -
|-
|$BIT_FUWARANTE_LOCAL
|All
| colspan="4" rowspan="1" |FUWARANTE blacklist flags
|-
|$LOCAL0
| -
|Max # of points.
| colspan="3" rowspan="1" |Winning # of Points / (Aura Bow Color Backup)
|-
|$LOCAL1
| -
|# Questions Asked / Winning Pool ID
| colspan="3" rowspan="1" |Winning Pool ID
|-
|$SCENARIO_TALK_BIT_FLAG
|Varies
| colspan="4" rowspan="1" |Question Has Been Asked?
|-
|$SCENARIO_MAIN
|0
| colspan="4" rowspan="1" |# of tied pools (-1 if not checking ties)
|-
|$SCENARIO_SIDE
|0
| colspan="4" rowspan="1" |# of pts to add to tied pool
|-
|$RECYCLE_COUNT
| -
| colspan="4" rowspan="1" |Post-Tie Max # of Pts.
|-
|$CONFIG_COLOR_KIND
| -
| -
| colspan="3" rowspan="1" |Aura Bow Color
|-
|$HERO_TALK_KIND
| -
| -
| -
| colspan="2" rowspan="1" |Hero Talk Group
|-
|$PARTNER_TALK_KIND
| -
| -
| -
| -
|Partner Talk Group
|-
|$VERSION
| -
| colspan="3" rowspan="1" |Pool 0 Pts.
|Reset to 1
|-
|$CRYSTAL_COLOR_01
| -
| colspan="3" rowspan="1" |Pool 1 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_02
| -
| colspan="3" rowspan="1" |Pool 2 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_03
| -
| colspan="3" rowspan="1" |Pool 3 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT
| -
| colspan="3" rowspan="1" |Pool 4 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT_SIDE
| -
| colspan="3" rowspan="1" |Pool 5 Pts.
|Reset to 0
|-
|$SCENARIO_SELECT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 6 Pts.
|Reset to 0
|-
|$GROUND_ENTER
| -
| colspan="3" rowspan="1" |Pool 7 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK
| -
| colspan="3" rowspan="1" |Pool 8 Pts.
|Reset to 0
|-
|$GROUND_GETOUT
| -
| colspan="3" rowspan="1" |Pool 9 Pts.
|Reset to 0
|-
|$GROUND_MAP
| -
| colspan="3" rowspan="1" |Pool 10 Pts.
|Reset to 0
|-
|$GROUND_PLACE
| -
| colspan="3" rowspan="1" |Pool 11 Pts.
|Reset to 0
|-
|$GROUND_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 12 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK_BACKUP
|0
| colspan="3" rowspan="1" |Pool 13 Pts.
|Reset to 0
|-
|$GROUND_GETOUT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 14 Pts.
|Reset to 0
|-
|$GROUND_MAP_BACKUP
|0
| colspan="3" rowspan="1" |Pool 15 Pts.
|Reset to 0
|-
|$GROUND_PLACE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 16 Pts.
|Reset to 0
|-
|$DUNGEON_SELECT
| -
| colspan="3" rowspan="1" |Pool 17 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER
| -
| colspan="3" rowspan="1" |Pool 18 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE
| -
| colspan="3" rowspan="1" |Pool 19 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX
| -
| colspan="3" rowspan="1" |Pool 20 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT
| -
| colspan="3" rowspan="1" |Pool 21 Pts.
|Reset to 0
|-
|$GROUND_START_MODE
| -
| colspan="3" rowspan="1" |Pool 22 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 23 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 24 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX_BACKUP
|0
| colspan="3" rowspan="1" |Pool 25 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 26 Pts.
|Reset to 0
|-
|$GROUND_START_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 27 Pts.
|Reset to 0
|-
|$REQUEST_CLEAR_COUNT
| -
| colspan="3" rowspan="1" |Pool 28 Pts.
|Reset to 0
|-
|$PLAYER_KIND
| -
|Pool 29 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND
| -
|Pool 30 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND
| -
| colspan="3" rowspan="1" |Pool 31 Pts.
|Reset to 0
|-
|$PLAYER_KIND_BACKUP
|0
|Pool 32 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND_BACKUP
|0
|Pool 33 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND_BACKUP
|0
| colspan="3" rowspan="1" |Pool 34 Pts.
|Reset to 0
|-
|$HERO_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 35 Pts.
|Reset to 0
|-
|$PARTNER_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 36 Pts.
|Reset to 0
|-
|$RANDOM_REQUEST_NPC03_KIND
| -
| colspan="3" rowspan="1" |Pool 37 Pts.
|Reset to 0
|-
|$WORLD_MAP_LEVEL
| -
| colspan="3" rowspan="1" |Pool 38 Pts.
|Reset to 0
|-
|$EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 39 Pts.
|Reset to 0
|-
|$DUNGEON_EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 40 Pts.
|Reset to 0
|-
|$LOTTERY_RESULT
| -
| colspan="3" rowspan="1" |Pool 41 Pts.
|Reset to 0
|-
|$ITEM_BACKUP
|0
| colspan="3" rowspan="1" |Pool 42 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_KUREKURE
|0
| colspan="3" rowspan="1" |Pool 43 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_TAKE
|0
| colspan="3" rowspan="1" |Pool 44 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_GET
|0
| colspan="3" rowspan="1" |Pool 45 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_KIND
| -
| colspan="3" rowspan="1" |Pool 46 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_VARIATION
| -
| colspan="3" rowspan="1" |Pool 47 Pts.
|Reset to 0
|-
|$SUB30_SPOT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 48 Pts.
|Reset to 0
|-
|$TEAM_RANK_EVENT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 49 Pts.
|Reset to 0
|-
|$PLAY_OLD_GAME
| -
| colspan="3" rowspan="1" |Pool 50 Pts.
|Reset to 0
|}

QuizMenuTool Tutorial

2025-08-10T22:36:48Z

Happylappy: /* Troubleshooting */

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting is helpful for this task, but not strictly required. These topics will be covered at the end for the sake of completion, but only to the extent that they are needed for QuizMenuTool.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according to a custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
!Answer Text
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===
Next, is the process of actually creating the QMT script files. For simplicity, this guide will demonstrate the process on LEVEL_S02P01A, the same location in the script files as the original quiz. If you plan on putting the QMT script files elsewhere, ensure this is properly accounted for in Full Script Compression. Navigate to Script Scenes->S02P01A. If you are using a MegaScript, create ONE new acting scene. Otherwise, create four of them, each with the name in FullScriptCompression.
[[File:ImportingQMTScriptFiles1.png|alt=Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.|center|thumb|600x600px|Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.]]
The newly created scenes should appear in the Acting (ssa) folder. Navigate to the first one created, and double-click on "[script-name].ssb".
[[File:ImportingQMTScriptFiles2.png|alt=In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.|center|thumb|600x600px|In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.]]

From there, simply paste from the respective part of the sheet, and attempt to save the script.
[[File:ImportingQMTScriptFiles3.png|center|thumb|600x600px|You can also navigate between script files with the search bar on the left!]]

Repeat the process of pasting in the remaining scripts. Finally, the script that contains the aura bow segment of the quiz (script #2 or the megascript) needs additional work done to the .ssa file. Navigate to S02P01A->M00A01A, and click the Export Button (square with an up arrow in it).
[[File:Export Quiz .ssa.png|alt=Visual for exporting the .ssa for M00A01A for QuizMenuTool|center|thumb|600x600px|The Export Button is up top!]]
Then just import this file into the script containing the Aura Bow segment, as shown below:
[[File:Aura Bow SSA import.png|center|thumb|600x600px|The Export Button is right next to the Import button!]]
After that, save the ROM. The quiz is nearly ready, all that's left is setting up unionall...

=== Editing Unionall ===
Unionall is a big file, but there's only a very specific part that needs to be edited. Open Unionall by using the search bar in the Script Engine Debugger, then do CTRL + F (Command + F for Mac, you should know your equivalent if you use Linux) to find coroutine inside unionall.
[[File:Unionall coro EVENT M00A 01.png|center|thumb|600x600px|Be sure you search for EXACTLY "coro EVENT_M00A_01". This should be the only match!]]
Once you find it, select the entire coroutine, and replace it with the unionall final output. the result should look something like this:
[[File:QMT coro EVENT M00A 01.png|center|thumb|600x600px|Modified Unionall Coroutine, should look roughly like this after pasting.]]
With that, save unionall, and the quiz is ready for testing!

== Troubleshooting ==
if you run into any of these issues, or the fix doesn't work, reach out to happylappy for questions in the SkyTemple discord!

=== The Game Crashed before the first script loaded! ===
Do your script names and locations match between unionall (or the sheet if it's making the unionall coro), and your script file names? If not, that would cause a crash.

=== The Game Crashed When a SP tried to run! ===
Have you used the correct SP IDs and regions? Might be worth importing them again, just in case.

=== The Game Crashed/Glitched out between scripts! ===
That is... concerning. See, script files are capable of overwriting other things in RAM if they're too big (which is why QMT usually splits into 4 separate scripts). Quizzes with an obscene number of questions or starters may still overwrite something important in RAM anyway, which would need to be handled on a case-by-case basis.

=== One of my scripts won't save! ===
That's concerning, but could be the result of leaving a question or starter unfinished? Depends heavily on the error message.

== Other Resources ==

=== QMT Script Variable Map ===
Below is a table of every script variable used by QuizMenuTool, and what their use-case is for each script. Any variable absent from the table is unused by QMT directly. Variable usage can perhaps be optimized somewhat, but this map functions properly.
{| class="wikitable"
!Script Variable Name
!Index
!Script #1
!Script #2
!Script #3
!Script #4
|-
|$SCENARIO_SUB1
|0
|Backup of Pre-Quiz $PLAYER_KIND
| colspan="3" rowspan="1" |Winning # of Points Backup
|-
|$SCENARIO_SUB2
|0
|Backup of 0th index of Pre-Quiz $PLAYER_KIND_BACKUP
| colspan="3" rowspan="1" |Winning Pool ID Backup
|-
|$SCENARIO_SUB3
|0
|Backup of Pre-Quiz $ATTENDANT1_KIND
| -
|# of times hero gen. failed
| -
|-
|$SCENARIO_SUB4
|0
|Backup of 0th index of Pre-Quiz $ATTENDANT1_KIND_BACKUP
| -
| -
| -
|-
|$BIT_FUWARANTE_LOCAL
|All
| colspan="4" rowspan="1" |FUWARANTE blacklist flags
|-
|$LOCAL0
| -
|Max # of points.
| colspan="3" rowspan="1" |Winning # of Points / (Aura Bow Color Backup)
|-
|$LOCAL1
| -
|# Questions Asked / Winning Pool ID
| colspan="3" rowspan="1" |Winning Pool ID
|-
|$SCENARIO_TALK_BIT_FLAG
|Varies
| colspan="4" rowspan="1" |Question Has Been Asked?
|-
|$SCENARIO_MAIN
|0
| colspan="4" rowspan="1" |# of tied pools (-1 if not checking ties)
|-
|$SCENARIO_SIDE
|0
| colspan="4" rowspan="1" |# of pts to add to tied pool
|-
|$RECYCLE_COUNT
| -
| colspan="4" rowspan="1" |Post-Tie Max # of Pts.
|-
|$CONFIG_COLOR_KIND
| -
| -
| colspan="3" rowspan="1" |Aura Bow Color
|-
|$HERO_TALK_KIND
| -
| -
| -
| colspan="2" rowspan="1" |Hero Talk Group
|-
|$PARTNER_TALK_KIND
| -
| -
| -
| -
|Partner Talk Group
|-
|$VERSION
| -
| colspan="3" rowspan="1" |Pool 0 Pts.
|Reset to 1
|-
|$CRYSTAL_COLOR_01
| -
| colspan="3" rowspan="1" |Pool 1 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_02
| -
| colspan="3" rowspan="1" |Pool 2 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_03
| -
| colspan="3" rowspan="1" |Pool 3 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT
| -
| colspan="3" rowspan="1" |Pool 4 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT_SIDE
| -
| colspan="3" rowspan="1" |Pool 5 Pts.
|Reset to 0
|-
|$SCENARIO_SELECT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 6 Pts.
|Reset to 0
|-
|$GROUND_ENTER
| -
| colspan="3" rowspan="1" |Pool 7 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK
| -
| colspan="3" rowspan="1" |Pool 8 Pts.
|Reset to 0
|-
|$GROUND_GETOUT
| -
| colspan="3" rowspan="1" |Pool 9 Pts.
|Reset to 0
|-
|$GROUND_MAP
| -
| colspan="3" rowspan="1" |Pool 10 Pts.
|Reset to 0
|-
|$GROUND_PLACE
| -
| colspan="3" rowspan="1" |Pool 11 Pts.
|Reset to 0
|-
|$GROUND_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 12 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK_BACKUP
|0
| colspan="3" rowspan="1" |Pool 13 Pts.
|Reset to 0
|-
|$GROUND_GETOUT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 14 Pts.
|Reset to 0
|-
|$GROUND_MAP_BACKUP
|0
| colspan="3" rowspan="1" |Pool 15 Pts.
|Reset to 0
|-
|$GROUND_PLACE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 16 Pts.
|Reset to 0
|-
|$DUNGEON_SELECT
| -
| colspan="3" rowspan="1" |Pool 17 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER
| -
| colspan="3" rowspan="1" |Pool 18 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE
| -
| colspan="3" rowspan="1" |Pool 19 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX
| -
| colspan="3" rowspan="1" |Pool 20 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT
| -
| colspan="3" rowspan="1" |Pool 21 Pts.
|Reset to 0
|-
|$GROUND_START_MODE
| -
| colspan="3" rowspan="1" |Pool 22 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 23 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 24 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX_BACKUP
|0
| colspan="3" rowspan="1" |Pool 25 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 26 Pts.
|Reset to 0
|-
|$GROUND_START_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 27 Pts.
|Reset to 0
|-
|$REQUEST_CLEAR_COUNT
| -
| colspan="3" rowspan="1" |Pool 28 Pts.
|Reset to 0
|-
|$PLAYER_KIND
| -
|Pool 29 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND
| -
|Pool 30 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND
| -
| colspan="3" rowspan="1" |Pool 31 Pts.
|Reset to 0
|-
|$PLAYER_KIND_BACKUP
|0
|Pool 32 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND_BACKUP
|0
|Pool 33 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND_BACKUP
|0
| colspan="3" rowspan="1" |Pool 34 Pts.
|Reset to 0
|-
|$HERO_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 35 Pts.
|Reset to 0
|-
|$PARTNER_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 36 Pts.
|Reset to 0
|-
|$RANDOM_REQUEST_NPC03_KIND
| -
| colspan="3" rowspan="1" |Pool 37 Pts.
|Reset to 0
|-
|$WORLD_MAP_LEVEL
| -
| colspan="3" rowspan="1" |Pool 38 Pts.
|Reset to 0
|-
|$EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 39 Pts.
|Reset to 0
|-
|$DUNGEON_EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 40 Pts.
|Reset to 0
|-
|$LOTTERY_RESULT
| -
| colspan="3" rowspan="1" |Pool 41 Pts.
|Reset to 0
|-
|$ITEM_BACKUP
|0
| colspan="3" rowspan="1" |Pool 42 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_KUREKURE
|0
| colspan="3" rowspan="1" |Pool 43 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_TAKE
|0
| colspan="3" rowspan="1" |Pool 44 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_GET
|0
| colspan="3" rowspan="1" |Pool 45 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_KIND
| -
| colspan="3" rowspan="1" |Pool 46 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_VARIATION
| -
| colspan="3" rowspan="1" |Pool 47 Pts.
|Reset to 0
|-
|$SUB30_SPOT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 48 Pts.
|Reset to 0
|-
|$TEAM_RANK_EVENT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 49 Pts.
|Reset to 0
|-
|$PLAY_OLD_GAME
| -
| colspan="3" rowspan="1" |Pool 50 Pts.
|Reset to 0
|}

QuizMenuTool Tutorial

2025-08-10T22:27:37Z

Happylappy: Troubleshooting

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting is helpful for this task, but not strictly required. These topics will be covered at the end for the sake of completion, but only to the extent that they are needed for QuizMenuTool.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according to a custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
!Answer Text
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===
Next, is the process of actually creating the QMT script files. For simplicity, this guide will demonstrate the process on LEVEL_S02P01A, the same location in the script files as the original quiz. If you plan on putting the QMT script files elsewhere, ensure this is properly accounted for in Full Script Compression. Navigate to Script Scenes->S02P01A. If you are using a MegaScript, create ONE new acting scene. Otherwise, create four of them, each with the name in FullScriptCompression.
[[File:ImportingQMTScriptFiles1.png|alt=Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.|center|thumb|600x600px|Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.]]
The newly created scenes should appear in the Acting (ssa) folder. Navigate to the first one created, and double-click on "[script-name].ssb".
[[File:ImportingQMTScriptFiles2.png|alt=In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.|center|thumb|600x600px|In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.]]

From there, simply paste from the respective part of the sheet, and attempt to save the script.
[[File:ImportingQMTScriptFiles3.png|center|thumb|600x600px|You can also navigate between script files with the search bar on the left!]]

Repeat the process of pasting in the remaining scripts. Finally, the script that contains the aura bow segment of the quiz (script #2 or the megascript) needs additional work done to the .ssa file. Navigate to S02P01A->M00A01A, and click the Export Button (square with an up arrow in it).
[[File:Export Quiz .ssa.png|alt=Visual for exporting the .ssa for M00A01A for QuizMenuTool|center|thumb|600x600px|The Export Button is up top!]]
Then just import this file into the script containing the Aura Bow segment, as shown below:
[[File:Aura Bow SSA import.png|center|thumb|600x600px|The Export Button is right next to the Import button!]]
After that, save the ROM. The quiz is nearly ready, all that's left is setting up unionall...

=== Editing Unionall ===
Unionall is a big file, but there's only a very specific part that needs to be edited. Open Unionall by using the search bar in the Script Engine Debugger, then do CTRL + F (Command + F for Mac, you should know your equivalent if you use Linux) to find coroutine inside unionall.
[[File:Unionall coro EVENT M00A 01.png|center|thumb|600x600px|Be sure you search for EXACTLY "coro EVENT_M00A_01". This should be the only match!]]
Once you find it, select the entire coroutine, and replace it with the unionall final output. the result should look something like this:
[[File:QMT coro EVENT M00A 01.png|center|thumb|600x600px|Modified Unionall Coroutine, should look roughly like this after pasting.]]
With that, save unionall, and the quiz is ready for testing!

== Troubleshooting ==

=== The Game Crashed before the first script loaded! ===
Do your script names and locations match between unionall (or the sheet if it's making the unionall coro), and your script file names? If not, that would cause a crash.

=== The Game Crashed When a SP tried to run! ===
Have you used the correct SP IDs and regions? Might be worth importing them again, just in case.

=== The Game Crashed/Glitched out between scripts! ===
That is... concerning. See, script files are capable of overwriting other things in RAM if they're too big (which is why QMT usually splits into 4 separate scripts). Quizzes with an obscene number of questions or starters may still overwrite something important in RAM anyway, which would need to be handled on a case-by-case basis.

=== One of my scripts won't save! ===
That's concerning, but could be the result of leaving a question or starter unfinished? Depends heavily on the error message.

== Other Resources ==

=== QMT Script Variable Map ===
Below is a table of every script variable used by QuizMenuTool, and what their use-case is for each script. Any variable absent from the table is unused by QMT directly. Variable usage can perhaps be optimized somewhat, but this map functions properly.
{| class="wikitable"
!Script Variable Name
!Index
!Script #1
!Script #2
!Script #3
!Script #4
|-
|$SCENARIO_SUB1
|0
|Backup of Pre-Quiz $PLAYER_KIND
| colspan="3" rowspan="1" |Winning # of Points Backup
|-
|$SCENARIO_SUB2
|0
|Backup of 0th index of Pre-Quiz $PLAYER_KIND_BACKUP
| colspan="3" rowspan="1" |Winning Pool ID Backup
|-
|$SCENARIO_SUB3
|0
|Backup of Pre-Quiz $ATTENDANT1_KIND
| -
|# of times hero gen. failed
| -
|-
|$SCENARIO_SUB4
|0
|Backup of 0th index of Pre-Quiz $ATTENDANT1_KIND_BACKUP
| -
| -
| -
|-
|$BIT_FUWARANTE_LOCAL
|All
| colspan="4" rowspan="1" |FUWARANTE blacklist flags
|-
|$LOCAL0
| -
|Max # of points.
| colspan="3" rowspan="1" |Winning # of Points / (Aura Bow Color Backup)
|-
|$LOCAL1
| -
|# Questions Asked / Winning Pool ID
| colspan="3" rowspan="1" |Winning Pool ID
|-
|$SCENARIO_TALK_BIT_FLAG
|Varies
| colspan="4" rowspan="1" |Question Has Been Asked?
|-
|$SCENARIO_MAIN
|0
| colspan="4" rowspan="1" |# of tied pools (-1 if not checking ties)
|-
|$SCENARIO_SIDE
|0
| colspan="4" rowspan="1" |# of pts to add to tied pool
|-
|$RECYCLE_COUNT
| -
| colspan="4" rowspan="1" |Post-Tie Max # of Pts.
|-
|$CONFIG_COLOR_KIND
| -
| -
| colspan="3" rowspan="1" |Aura Bow Color
|-
|$HERO_TALK_KIND
| -
| -
| -
| colspan="2" rowspan="1" |Hero Talk Group
|-
|$PARTNER_TALK_KIND
| -
| -
| -
| -
|Partner Talk Group
|-
|$VERSION
| -
| colspan="3" rowspan="1" |Pool 0 Pts.
|Reset to 1
|-
|$CRYSTAL_COLOR_01
| -
| colspan="3" rowspan="1" |Pool 1 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_02
| -
| colspan="3" rowspan="1" |Pool 2 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_03
| -
| colspan="3" rowspan="1" |Pool 3 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT
| -
| colspan="3" rowspan="1" |Pool 4 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT_SIDE
| -
| colspan="3" rowspan="1" |Pool 5 Pts.
|Reset to 0
|-
|$SCENARIO_SELECT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 6 Pts.
|Reset to 0
|-
|$GROUND_ENTER
| -
| colspan="3" rowspan="1" |Pool 7 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK
| -
| colspan="3" rowspan="1" |Pool 8 Pts.
|Reset to 0
|-
|$GROUND_GETOUT
| -
| colspan="3" rowspan="1" |Pool 9 Pts.
|Reset to 0
|-
|$GROUND_MAP
| -
| colspan="3" rowspan="1" |Pool 10 Pts.
|Reset to 0
|-
|$GROUND_PLACE
| -
| colspan="3" rowspan="1" |Pool 11 Pts.
|Reset to 0
|-
|$GROUND_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 12 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK_BACKUP
|0
| colspan="3" rowspan="1" |Pool 13 Pts.
|Reset to 0
|-
|$GROUND_GETOUT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 14 Pts.
|Reset to 0
|-
|$GROUND_MAP_BACKUP
|0
| colspan="3" rowspan="1" |Pool 15 Pts.
|Reset to 0
|-
|$GROUND_PLACE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 16 Pts.
|Reset to 0
|-
|$DUNGEON_SELECT
| -
| colspan="3" rowspan="1" |Pool 17 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER
| -
| colspan="3" rowspan="1" |Pool 18 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE
| -
| colspan="3" rowspan="1" |Pool 19 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX
| -
| colspan="3" rowspan="1" |Pool 20 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT
| -
| colspan="3" rowspan="1" |Pool 21 Pts.
|Reset to 0
|-
|$GROUND_START_MODE
| -
| colspan="3" rowspan="1" |Pool 22 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 23 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 24 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX_BACKUP
|0
| colspan="3" rowspan="1" |Pool 25 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 26 Pts.
|Reset to 0
|-
|$GROUND_START_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 27 Pts.
|Reset to 0
|-
|$REQUEST_CLEAR_COUNT
| -
| colspan="3" rowspan="1" |Pool 28 Pts.
|Reset to 0
|-
|$PLAYER_KIND
| -
|Pool 29 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND
| -
|Pool 30 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND
| -
| colspan="3" rowspan="1" |Pool 31 Pts.
|Reset to 0
|-
|$PLAYER_KIND_BACKUP
|0
|Pool 32 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND_BACKUP
|0
|Pool 33 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND_BACKUP
|0
| colspan="3" rowspan="1" |Pool 34 Pts.
|Reset to 0
|-
|$HERO_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 35 Pts.
|Reset to 0
|-
|$PARTNER_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 36 Pts.
|Reset to 0
|-
|$RANDOM_REQUEST_NPC03_KIND
| -
| colspan="3" rowspan="1" |Pool 37 Pts.
|Reset to 0
|-
|$WORLD_MAP_LEVEL
| -
| colspan="3" rowspan="1" |Pool 38 Pts.
|Reset to 0
|-
|$EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 39 Pts.
|Reset to 0
|-
|$DUNGEON_EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 40 Pts.
|Reset to 0
|-
|$LOTTERY_RESULT
| -
| colspan="3" rowspan="1" |Pool 41 Pts.
|Reset to 0
|-
|$ITEM_BACKUP
|0
| colspan="3" rowspan="1" |Pool 42 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_KUREKURE
|0
| colspan="3" rowspan="1" |Pool 43 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_TAKE
|0
| colspan="3" rowspan="1" |Pool 44 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_GET
|0
| colspan="3" rowspan="1" |Pool 45 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_KIND
| -
| colspan="3" rowspan="1" |Pool 46 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_VARIATION
| -
| colspan="3" rowspan="1" |Pool 47 Pts.
|Reset to 0
|-
|$SUB30_SPOT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 48 Pts.
|Reset to 0
|-
|$TEAM_RANK_EVENT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 49 Pts.
|Reset to 0
|-
|$PLAY_OLD_GAME
| -
| colspan="3" rowspan="1" |Pool 50 Pts.
|Reset to 0
|}

QuizMenuTool Tutorial

2025-08-10T22:13:18Z

Happylappy: /* QMT Script Variable Map */

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting is helpful for this task, but not strictly required. These topics will be covered at the end for the sake of completion, but only to the extent that they are needed for QuizMenuTool.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according to a custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
!Answer Text
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===
Next, is the process of actually creating the QMT script files. For simplicity, this guide will demonstrate the process on LEVEL_S02P01A, the same location in the script files as the original quiz. If you plan on putting the QMT script files elsewhere, ensure this is properly accounted for in Full Script Compression. Navigate to Script Scenes->S02P01A. If you are using a MegaScript, create ONE new acting scene. Otherwise, create four of them, each with the name in FullScriptCompression.
[[File:ImportingQMTScriptFiles1.png|alt=Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.|center|thumb|600x600px|Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.]]
The newly created scenes should appear in the Acting (ssa) folder. Navigate to the first one created, and double-click on "[script-name].ssb".
[[File:ImportingQMTScriptFiles2.png|alt=In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.|center|thumb|600x600px|In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.]]

From there, simply paste from the respective part of the sheet, and attempt to save the script.
[[File:ImportingQMTScriptFiles3.png|center|thumb|600x600px|You can also navigate between script files with the search bar on the left!]]

Repeat the process of pasting in the remaining scripts. Finally, the script that contains the aura bow segment of the quiz (script #2 or the megascript) needs additional work done to the .ssa file. Navigate to S02P01A->M00A01A, and click the Export Button (square with an up arrow in it).
[[File:Export Quiz .ssa.png|alt=Visual for exporting the .ssa for M00A01A for QuizMenuTool|center|thumb|600x600px|The Export Button is up top!]]
Then just import this file into the script containing the Aura Bow segment, as shown below:
[[File:Aura Bow SSA import.png|center|thumb|600x600px|The Export Button is right next to the Import button!]]
After that, save the ROM. The quiz is nearly ready, all that's left is setting up unionall...

=== Editing Unionall ===
Unionall is a big file, but there's only a very specific part that needs to be edited. Open Unionall by using the search bar in the Script Engine Debugger, then do CTRL + F (Command + F for Mac, you should know your equivalent if you use Linux) to find coroutine inside unionall.
[[File:Unionall coro EVENT M00A 01.png|center|thumb|600x600px|Be sure you search for EXACTLY "coro EVENT_M00A_01". This should be the only match!]]
Once you find it, select the entire coroutine, and replace it with the unionall final output. the result should look something like this:
[[File:QMT coro EVENT M00A 01.png|center|thumb|600x600px|Modified Unionall Coroutine, should look roughly like this after pasting.]]
With that, save unionall, and the quiz is ready for testing!

== Other Resources ==

=== QMT Script Variable Map ===
Below is a table of every script variable used by QuizMenuTool, and what their use-case is for each script. Any variable absent from the table is unused by QMT directly. Variable usage can perhaps be optimized somewhat, but this map functions properly.
{| class="wikitable"
!Script Variable Name
!Index
!Script #1
!Script #2
!Script #3
!Script #4
|-
|$SCENARIO_SUB1
|0
|Backup of Pre-Quiz $PLAYER_KIND
| colspan="3" rowspan="1" |Winning # of Points Backup
|-
|$SCENARIO_SUB2
|0
|Backup of 0th index of Pre-Quiz $PLAYER_KIND_BACKUP
| colspan="3" rowspan="1" |Winning Pool ID Backup
|-
|$SCENARIO_SUB3
|0
|Backup of Pre-Quiz $ATTENDANT1_KIND
| -
|# of times hero gen. failed
| -
|-
|$SCENARIO_SUB4
|0
|Backup of 0th index of Pre-Quiz $ATTENDANT1_KIND_BACKUP
| -
| -
| -
|-
|$BIT_FUWARANTE_LOCAL
|All
| colspan="4" rowspan="1" |FUWARANTE blacklist flags
|-
|$LOCAL0
| -
|Max # of points.
| colspan="3" rowspan="1" |Winning # of Points / (Aura Bow Color Backup)
|-
|$LOCAL1
| -
|# Questions Asked / Winning Pool ID
| colspan="3" rowspan="1" |Winning Pool ID
|-
|$SCENARIO_TALK_BIT_FLAG
|Varies
| colspan="4" rowspan="1" |Question Has Been Asked?
|-
|$SCENARIO_MAIN
|0
| colspan="4" rowspan="1" |# of tied pools (-1 if not checking ties)
|-
|$SCENARIO_SIDE
|0
| colspan="4" rowspan="1" |# of pts to add to tied pool
|-
|$RECYCLE_COUNT
| -
| colspan="4" rowspan="1" |Post-Tie Max # of Pts.
|-
|$CONFIG_COLOR_KIND
| -
| -
| colspan="3" rowspan="1" |Aura Bow Color
|-
|$HERO_TALK_KIND
| -
| -
| -
| colspan="2" rowspan="1" |Hero Talk Group
|-
|$PARTNER_TALK_KIND
| -
| -
| -
| -
|Partner Talk Group
|-
|$VERSION
| -
| colspan="3" rowspan="1" |Pool 0 Pts.
|Reset to 1
|-
|$CRYSTAL_COLOR_01
| -
| colspan="3" rowspan="1" |Pool 1 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_02
| -
| colspan="3" rowspan="1" |Pool 2 Pts.
|Reset to 0
|-
|$CRYSTAL_COLOR_03
| -
| colspan="3" rowspan="1" |Pool 3 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT
| -
| colspan="3" rowspan="1" |Pool 4 Pts.
|Reset to 0
|-
|$COMPULSORY_SAVE_POINT_SIDE
| -
| colspan="3" rowspan="1" |Pool 5 Pts.
|Reset to 0
|-
|$SCENARIO_SELECT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 6 Pts.
|Reset to 0
|-
|$GROUND_ENTER
| -
| colspan="3" rowspan="1" |Pool 7 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK
| -
| colspan="3" rowspan="1" |Pool 8 Pts.
|Reset to 0
|-
|$GROUND_GETOUT
| -
| colspan="3" rowspan="1" |Pool 9 Pts.
|Reset to 0
|-
|$GROUND_MAP
| -
| colspan="3" rowspan="1" |Pool 10 Pts.
|Reset to 0
|-
|$GROUND_PLACE
| -
| colspan="3" rowspan="1" |Pool 11 Pts.
|Reset to 0
|-
|$GROUND_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 12 Pts.
|Reset to 0
|-
|$GROUND_ENTER_LINK_BACKUP
|0
| colspan="3" rowspan="1" |Pool 13 Pts.
|Reset to 0
|-
|$GROUND_GETOUT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 14 Pts.
|Reset to 0
|-
|$GROUND_MAP_BACKUP
|0
| colspan="3" rowspan="1" |Pool 15 Pts.
|Reset to 0
|-
|$GROUND_PLACE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 16 Pts.
|Reset to 0
|-
|$DUNGEON_SELECT
| -
| colspan="3" rowspan="1" |Pool 17 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER
| -
| colspan="3" rowspan="1" |Pool 18 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE
| -
| colspan="3" rowspan="1" |Pool 19 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX
| -
| colspan="3" rowspan="1" |Pool 20 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT
| -
| colspan="3" rowspan="1" |Pool 21 Pts.
|Reset to 0
|-
|$GROUND_START_MODE
| -
| colspan="3" rowspan="1" |Pool 22 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_BACKUP
|0
| colspan="3" rowspan="1" |Pool 23 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 24 Pts.
|Reset to 0
|-
|$DUNGEON_ENTER_INDEX_BACKUP
|0
| colspan="3" rowspan="1" |Pool 25 Pts.
|Reset to 0
|-
|$DUNGEON_RESULT_BACKUP
|0
| colspan="3" rowspan="1" |Pool 26 Pts.
|Reset to 0
|-
|$GROUND_START_MODE_BACKUP
|0
| colspan="3" rowspan="1" |Pool 27 Pts.
|Reset to 0
|-
|$REQUEST_CLEAR_COUNT
| -
| colspan="3" rowspan="1" |Pool 28 Pts.
|Reset to 0
|-
|$PLAYER_KIND
| -
|Pool 29 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND
| -
|Pool 30 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND
| -
| colspan="3" rowspan="1" |Pool 31 Pts.
|Reset to 0
|-
|$PLAYER_KIND_BACKUP
|0
|Pool 32 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT1_KIND_BACKUP
|0
|Pool 33 Pts.
| colspan="3" rowspan="1" |Reset to Pre-Quiz
|-
|$ATTENDANT2_KIND_BACKUP
|0
| colspan="3" rowspan="1" |Pool 34 Pts.
|Reset to 0
|-
|$HERO_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 35 Pts.
|Reset to 0
|-
|$PARTNER_FIRST_KIND
| -
| colspan="3" rowspan="1" |Pool 36 Pts.
|Reset to 0
|-
|$RANDOM_REQUEST_NPC03_KIND
| -
| colspan="3" rowspan="1" |Pool 37 Pts.
|Reset to 0
|-
|$WORLD_MAP_LEVEL
| -
| colspan="3" rowspan="1" |Pool 38 Pts.
|Reset to 0
|-
|$EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 39 Pts.
|Reset to 0
|-
|$DUNGEON_EVENT_LOCAL
| -
| colspan="3" rowspan="1" |Pool 40 Pts.
|Reset to 0
|-
|$LOTTERY_RESULT
| -
| colspan="3" rowspan="1" |Pool 41 Pts.
|Reset to 0
|-
|$ITEM_BACKUP
|0
| colspan="3" rowspan="1" |Pool 42 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_KUREKURE
|0
| colspan="3" rowspan="1" |Pool 43 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_TAKE
|0
| colspan="3" rowspan="1" |Pool 44 Pts.
|Reset to 0
|-
|$ITEM_BACKUP_GET
|0
| colspan="3" rowspan="1" |Pool 45 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_KIND
| -
| colspan="3" rowspan="1" |Pool 46 Pts.
|Reset to 0
|-
|$REQUEST_THANKS_RESULT_VARIATION
| -
| colspan="3" rowspan="1" |Pool 47 Pts.
|Reset to 0
|-
|$SUB30_SPOT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 48 Pts.
|Reset to 0
|-
|$TEAM_RANK_EVENT_LEVEL
| -
| colspan="3" rowspan="1" |Pool 49 Pts.
|Reset to 0
|-
|$PLAY_OLD_GAME
| -
| colspan="3" rowspan="1" |Pool 50 Pts.
|Reset to 0
|}

QuizMenuTool Tutorial

2025-08-10T19:47:55Z

Happylappy: Changed TitIes

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting is helpful for this task, but not strictly required. These topics will be covered at the end for the sake of completion, but only to the extent that they are needed for QuizMenuTool.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according to a custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
!Answer Text
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===
Next, is the process of actually creating the QMT script files. For simplicity, this guide will demonstrate the process on LEVEL_S02P01A, the same location in the script files as the original quiz. If you plan on putting the QMT script files elsewhere, ensure this is properly accounted for in Full Script Compression. Navigate to Script Scenes->S02P01A. If you are using a MegaScript, create ONE new acting scene. Otherwise, create four of them, each with the name in FullScriptCompression.
[[File:ImportingQMTScriptFiles1.png|alt=Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.|center|thumb|600x600px|Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.]]
The newly created scenes should appear in the Acting (ssa) folder. Navigate to the first one created, and double-click on "[script-name].ssb".
[[File:ImportingQMTScriptFiles2.png|alt=In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.|center|thumb|600x600px|In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.]]

From there, simply paste from the respective part of the sheet, and attempt to save the script.
[[File:ImportingQMTScriptFiles3.png|center|thumb|600x600px|You can also navigate between script files with the search bar on the left!]]

Repeat the process of pasting in the remaining scripts. Finally, the script that contains the aura bow segment of the quiz (script #2 or the megascript) needs additional work done to the .ssa file. Navigate to S02P01A->M00A01A, and click the Export Button (square with an up arrow in it).
[[File:Export Quiz .ssa.png|alt=Visual for exporting the .ssa for M00A01A for QuizMenuTool|center|thumb|600x600px|The Export Button is up top!]]
Then just import this file into the script containing the Aura Bow segment, as shown below:
[[File:Aura Bow SSA import.png|center|thumb|600x600px|The Export Button is right next to the Import button!]]
After that, save the ROM. The quiz is nearly ready, all that's left is setting up unionall...

=== Editing Unionall ===
Unionall is a big file, but there's only a very specific part that needs to be edited. Open Unionall by using the search bar in the Script Engine Debugger, then do CTRL + F (Command + F for Mac, you should know your equivalent if you use Linux) to find coroutine inside unionall.
[[File:Unionall coro EVENT M00A 01.png|center|thumb|600x600px|Be sure you search for EXACTLY "coro EVENT_M00A_01". This should be the only match!]]
Once you find it, select the entire coroutine, and replace it with the unionall final output. the result should look something like this:
[[File:QMT coro EVENT M00A 01.png|center|thumb|600x600px|Modified Unionall Coroutine, should look roughly like this after pasting.]]
With that, save unionall, and the quiz is ready for testing!

== Other Resources ==

=== QMT Script Variable Map ===
[[Category:Tutorials]]

QuizMenuTool Tutorial

2025-08-10T02:08:38Z

Happylappy: /* Creating QMT Script Files */

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting is helpful for this task, but not strictly required. These topics will be covered at the end for the sake of completion, but only to the extent that they are needed for QuizMenuTool.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator: A Good First Impression! ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator: Actually Adding the Starters... ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according toa custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator: Before, After, and For How Long? ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator: Multiple Choice Monotony ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
!Answer Text
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator: Gerrymandering and Tie-Breaking ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator: Fortune Telling and Color Theory ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator: Nearly Finished! ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation: EU ROM Superiority ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings: Future-Proofing The Sheet ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression: It's Finally Over? ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===
Next, is the process of actually creating the QMT script files. For simplicity, this guide will demonstrate the process on LEVEL_S02P01A, the same location in the script files as the original quiz. If you plan on putting the QMT script files elsewhere, ensure this is properly accounted for in Full Script Compression. Navigate to Script Scenes->S02P01A. If you are using a MegaScript, create ONE new acting scene. Otherwise, create four of them, each with the name in FullScriptCompression.
[[File:ImportingQMTScriptFiles1.png|alt=Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.|center|thumb|600x600px|Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.]]
The newly created scenes should appear in the Acting (ssa) folder. Navigate to the first one created, and double-click on "[script-name].ssb".
[[File:ImportingQMTScriptFiles2.png|alt=In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.|center|thumb|600x600px|In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.]]

From there, simply paste from the respective part of the sheet, and attempt to save the script.
[[File:ImportingQMTScriptFiles3.png|center|thumb|600x600px|You can also navigate between script files with the search bar on the left!]]

Repeat the process of pasting in the remaining scripts. Finally, the script that contains the aura bow segment of the quiz (script #2 or the megascript) needs additional work done to the .ssa file. Navigate to S02P01A->M00A01A, and click the Export Button (square with an up arrow in it).
[[File:Export Quiz .ssa.png|alt=Visual for exporting the .ssa for M00A01A for QuizMenuTool|center|thumb|600x600px|The Export Button is up top!]]
Then just import this file into the script containing the Aura Bow segment, as shown below:
[[File:Aura Bow SSA import.png|center|thumb|600x600px|The Export Button is right next to the Import button!]]
After that, save the ROM. The quiz is nearly ready, all that's left is setting up unionall...

=== Editing Unionall ===
Unionall is a big file, but there's only a very specific part that needs to be edited. Open Unionall by using the search bar in the Script Engine Debugger, then do CTRL + F (Command + F for Mac, you should know your equivalent if you use Linux) to find coroutine inside unionall.
[[File:Unionall coro EVENT M00A 01.png|center|thumb|600x600px|Be sure you search for EXACTLY "coro EVENT_M00A_01". This should be the only match!]]
Once you find it, select the entire coroutine, and replace it with the unionall final output. the result should look something like this:
[[File:QMT coro EVENT M00A 01.png|center|thumb|600x600px|Modified Unionall Coroutine, should look roughly like this after pasting.]]
With that, save unionall, and the quiz is ready for testing!

== Other Resources ==

=== QMT Script Variable Map ===
[[Category:Tutorials]]

File:QMT coro EVENT M00A 01.png

2025-08-10T02:07:25Z

Happylappy:

Modified Unionall Coroutine

File:Unionall coro EVENT M00A 01.png

2025-08-10T02:05:25Z

Happylappy: Happylappy uploaded a new version of File:Unionall coro EVENT M00A 01.png

Shows Unionall coro EVENT_M00A_01.

File:Unionall coro EVENT M00A 01.png

2025-08-10T02:03:41Z

Happylappy:

Shows Unionall coro EVENT_M00A_01.

File:Aura Bow SSA import.png

2025-08-10T01:49:09Z

Happylappy:

Visual for importing the .ssa of the quiz into a custom script.

File:Export Quiz .ssa.png

2025-08-10T01:45:22Z

Happylappy:

Visual for exporting the .ssa for M00A01A for QuizMenuTool

QuizMenuTool Tutorial

2025-08-09T22:40:08Z

Happylappy: /* Creating QMT Script Files */

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting is helpful for this task, but not strictly required. These topics will be covered at the end for the sake of completion, but only to the extent that they are needed for QuizMenuTool.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator: A Good First Impression! ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator: Actually Adding the Starters... ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according toa custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator: Before, After, and For How Long? ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator: Multiple Choice Monotony ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
!Answer Text
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator: Gerrymandering and Tie-Breaking ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator: Fortune Telling and Color Theory ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator: Nearly Finished! ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation: EU ROM Superiority ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings: Future-Proofing The Sheet ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression: It's Finally Over? ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===
Next, is the process of actually creating the QMT script files. For simplicity, this guide will demonstrate the process on LEVEL_S02P01A, the same location in the script files as the original quiz. If you plan on putting the QMT script files elsewhere, ensure this is properly accounted for in Full Script Compression. Navigate to Script Scenes->S02P01A. If you are using a MegaScript, create ONE new acting scene. Otherwise, create four of them, each with the name in FullScriptCompression.
[[File:ImportingQMTScriptFiles1.png|alt=Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.|center|thumb|600x600px|Be sure you click "Create Acting Scene"! It is important that these scripts are acting scenes.]]
The newly created scenes should appear in the Acting (ssa) folder. Navigate to the first one created, and double-click on "[script-name].ssb".
[[File:ImportingQMTScriptFiles2.png|alt=In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.|center|thumb|600x600px|In this case, "qmt01.ssb" on the right will open the script file's "ssb" code.]]

[[File:ImportingQMTScriptFiles3.png|center|thumb|600x600px]]

=== Pasting Scripts/Unionall From the Sheet ===

== Other Resources ==

=== QMT Script Variable Map ===
[[Category:Tutorials]]

File:ImportingQMTScriptFiles3.png

2025-08-09T22:39:40Z

Happylappy:

Visual for creating and importing script files for QMT.

File:ImportingQMTScriptFiles2.png

2025-08-09T22:24:05Z

Happylappy:

Visual for creating and importing script files for QMT.

File:ImportingQMTScriptFiles1.png

2025-08-09T22:19:53Z

Happylappy:

Visual for creating and importing script files for QMT.

QuizMenuTool Tutorial

2025-08-09T22:09:26Z

Happylappy: /* Importing The Scripts To SkyTemple */

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting will be assumed, namely adding new acting scenes, and adding scenes to unionall.ssb. These topics have/will be covered in other wiki articles.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator: A Good First Impression! ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator: Actually Adding the Starters... ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according toa custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator: Before, After, and For How Long? ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator: Multiple Choice Monotony ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
!Answer Text
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator: Gerrymandering and Tie-Breaking ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator: Fortune Telling and Color Theory ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator: Nearly Finished! ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation: EU ROM Superiority ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings: Future-Proofing The Sheet ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression: It's Finally Over? ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===
In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]

=== Applying The Special Processes ===
Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
{| class="wikitable"
|+
!Spreadsheet Tab
!Spreadsheet Input Name
!SP File Name
!ID
!Effect
|-
|Starter Selection Generator
|starter_setter SP ID
|starter_setter.asm
|64
|61
|-
|Starter Selection Generator
|set_frame_color SP ID
|set_frame_color.asm
|65
|62
|-
|Aura Bow Generator
|CheckTSPress SP ID
|CheckTSPress.asm
|66
|63
|-
|Aura Bow Generator
|ReturnTSPFrames SP ID
|ReturnTSPFrames.asm
|67
|64
|-
|Aura Bow Generator
|MoveText2TopScreen SP ID
|MoveText2TopScreen.asm
|68
|65
|-
|Starter Selection Generator
|Set_Demo_Character SP ID
|Set_Demo_Character.asm
|69
|66
|-
|Aura Bow Generator
|get_favorite_config_color SP ID
|get_favorite_config_color.asm
|70
|67
|}
Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===

=== Pasting Scripts/Unionall From the Sheet ===

== Other Resources ==

=== QMT Script Variable Map ===
[[Category:Tutorials]]

File:How2AddSpecialProcesses3.png

2025-08-09T22:06:26Z

Happylappy:

Visual for installing special processes for QMT.

File:How2AddSpecialProcesses2.png

2025-08-09T21:56:42Z

Happylappy:

Visual for installing special processes for QMT.

File:How2AddSpecialProcesses1.png

2025-08-09T21:54:55Z

Happylappy: Happylappy uploaded a new version of File:How2AddSpecialProcesses1.png

Visual for installing special processes for QMT.

File:How2AddSpecialProcesses1.png

2025-08-09T21:52:21Z

Happylappy:

Visual for installing special processes for QMT.

File:InstallFixPartnerNamePatch.png

2025-08-09T21:28:26Z

Happylappy:

FixPartnerNamePatch Installation guide image.

File:ExtractSPCode.png

2025-08-09T21:24:21Z

Happylappy:

ExtractSPCode Location

QuizMenuTool Tutorial

2025-08-09T20:43:21Z

Happylappy: /* Importing The Scripts To SkyTemple */

''{{SkyTempleIcon|icon=skytemple-dialog-error-symbolic}} This article is unfinished. You can help [{{fullurl:{{PAGENAME}}|veaction=edit}} expanding it].''<hr>This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting will be assumed, namely adding new acting scenes, and adding scenes to unionall.ssb. These topics have/will be covered in other wiki articles.

== About QuizMenuTool ==

=== What Is QuizMenuTool? ===
QuizMenuTool is a customizable ExplorerScript replica of the Explorers of Sky Personality Quiz and Starter Selection, with minimal hardcoded aspects. The original quiz was designed to consist mostly of <code>message_Menu()</code> ASM, to make editing the personality quiz accessible without the need to learn ASM.

=== What can QuizMenuTool do? ===
QuizMenuTool can modify the process of using the quiz to select a starter, expand/reduce the starter list, add/remove/modify questions from the quiz, and much more! In fact, the better question might be...

=== What Limitations does QuizMenuTool have? ===
There are a few critical things QuizMenuTool was not designed to do, though many of these could be remedied in the future if enough demand exists. Here's a list of what QuizMenuTool fails to replicate from the vanilla quiz:

* Hero/Partner Type Exclusion: In the vanilla quiz, the hero and partner are prevented from sharing a type, to encourage team balance. No option for such a restriction has been implemented yet, though such a thing would be possible in the future, or be scripted manually for a specific hack.
* SwitchMenu Portraits: In the vanilla quiz, scrolling to a partner choice displays a portrait of that partner, which gradually changes in expression. This feature would require significant custom code to emulate, and is unlikely to be available for QuizMenuTool.
* Third Party Starter Tweaks: The original starter list is '''completely unused''' by QuizMenuTool. Changing it has no impact on the quiz. Players of a hack using QuizMenuTool will have difficulty adding their own starters to the game, though this could potentially be remedied with a special process checking the starter list against what it is expected to be, and assigning the desired starter if a mismatch is found?
* Incompatibility with Japanese ROMs: Currently, QuizMenuTool is designed to only work for NA and EU ROMs. while in theory a Japanese Quiz could be designed, the Special Processes are not Japanese-compatible. This could be remedied with little effort, but the tool is designed for EU/NA ROMs.

== Who QuizMenuTool is for ==
If either of the below points do not apply to you, you do not need QuizMenuTool.
* You would like to expand (or shrink) the list of starter options in the game.
* You would like to keep the personality quiz in the game, or edit the quiz directly.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the [[SkipQuiz]] patch is applied), you should instead use [https://github.com/Chesyon/StarterMenuTool StarterMenuTool], which is less powerful but requires much less work to set up.

== Programs and Files ==

=== Required Programs and Files ===

* [https://docs.google.com/spreadsheets/d/1snwIq3-GHntcPTBwH-TJ5Ctk0a8l4pwXTZYwCs53dwo/edit?usp=sharing Explorers of Sky Personality Quiz Assembling Sheet]
* [https://github.com/HappyLappy1/EOS-QuizGenerationTool-ASM Necessary Special Processes and SkyPatches]
* [[SkyTemple]]

== General Spreadsheet Tips ==

=== Making a Copy of the Sheet ===
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
[[File:Copying a Spreadsheet.png|thumb|750x750px|Location of the "File" and "Make a Copy" buttons. |center]]
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.

=== Cell Color-Coding ===
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:

* Green Cells are for user input. If a cell is green, it is intended to contain input data.
* Grey Cells contain formulas. They will update automatically, and should not be edited.
* Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
* Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!

=== Paste Values Only ===
This tab is the first which will require the use of "Paste Values". When this guide specifies that a copy/paste must "Paste Values", this means that the copied text is a formula, and the pasted text should not be a formula.
[[File:How To Paste Values.png|alt=Depiction of the "Values Only" button in the menu|center|thumb|600x600px|Depiction of the "Values Only" button in the menu]]
There are two ways to paste values, either by right-clicking the paste location and selecting "Paste Special" then "Values Only", or by holding shift as you paste.

== Quiz Preamble Generator: A Good First Impression! ==
The Quiz Preamble Generator Tab as a whole exists to create the very beginning of the quiz.

=== Upper Panel ===
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
[[File:Preamble Upper Panel.png|alt=Location of the Quiz Preamble Generator's Upper Panel.|center|thumb|750x750px|Location of the Quiz Preamble Generator's Upper Panel.]]
The "Bottom Screen" and "Top Screen" inputs are the map ID that should be used for that screen's background. Similarly, the Background Music Name/ID is a BGM name (or number) of the BGM that should play throughout the quiz. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines, making the output script more human-readable.

=== Preamble Text ===
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
[[File:Quiz Preamble Location.png|alt=Location of the Quiz Preamble Inputs|center|thumb|600x600px|Location of the Quiz Preamble Inputs]]

=== Outputs ===
The orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Starter Selection Generator: Actually Adding the Starters... ==
This tab of the sheet is primarily for inputting data about the starters, or the personality pools they belong to.

=== Upper Panel ===
[[File:Starter Selection Upper Panel.png|alt=The Upper Panel for the "Starter Selection Generator" Tab|thumb|750x750px|Location of the "Upper Panel" for the "Starter Selection Generator" Tab|center]]This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox is the same as before, except for this tab of the sheet. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.

=== Personality Pool Input ===
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
[[File:Personality Pools Input.png|alt=Location of the "Personality Pool Input", where nature names and descriptions go.|center|thumb|450x450px|Location of the "Personality Pool Input", where nature names/descriptions go.]]
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. '''For best results, ensure all pool names are unique!'''

=== Starter Species Data ===
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
[[File:Starter Species Data Location.png|alt=Location of "Starter Species Data", where species-specific starter info goes.|center|thumb|750x750px|Location of "Starter Species Data", where species-specific starter info goes.]]
While some of these fields should be intuitive, A brief description of each column is as follows:

* '''Species Name:''' The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in '''Vanilla Translation Strings'''. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
* '''Species ID:''' The ID in SkyTemple of the Pokémon. '''[TODO: Explain how this is affected by ExpandPokeList]'''.
* '''Gender:''' The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
* '''Pool ID:''' The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. '''If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!'''
* '''Start w/ Vowel:''' If the Pokémon should be referred to as "...an [Pokémon]", check this box.

=== Talk Group & Role Exclusion ===
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
[[File:Talk Groups and Role Exclusion.png|alt=Location of Talk Group and Role Exclusion Inputs|center|thumb|300x300px|Location of Talk Group and Role Exclusion Inputs]]
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. It does the same for the hero's dialogue, but in the English localization it only affects 2 lines in the entire game ("Whoa" <-> "Wah", "All right" <-> "OK"). This is how they are used in vanilla:
{| class="wikitable"
|+Explorers of Sky Talk Groups
!#
!Used By
!Notable Species
!Description
|-
|1
|Partner
|Male Squirtle/Totodile/Chimchar/Meowth/Munchlax
|More Masculine/"Rural" Dialogue. (Refers to self as "Oira" in Japanese)
|-
|2
|Partner
|All other Male Pokémon
|More Masculine/"Boyish" Dialogue. (Refers to self as "Boku" in Japanese)
|-
|3
|Partner
|All Female Pokémon
|More Feminine Dialogue. (Refers to self as "Watashi" in Japanese)
|-
|4
|Hero
|All Male/Genderless Pokémon
|Uses Masculine Pronouns
|-
|5
|Hero
|All Female Pokémon
|Uses Feminine Pronouns
|}
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, particularly Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.

=== Fuwarante Blacklist ===
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.[[File:Fuwarante Blacklist.png|alt=Location of the Fuwarante Blacklist|center|thumb|300x300px|Location of the Fuwarante Blacklist]]Each column corresponds to a bit of the script variable <code>$BIT_FUWARANTE_LOCAL</code>. If the matching flag is on, the starter in that row '''cannot''' be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
{| class="wikitable"
|+
!Bit
!Description/Use Case
|-
|0
|If enabled, <code>$PLAY_OLD_GAME</code> will be true, meaning the player answered that they have played Time/Darkness before.
|-
|1
|If enabled, the player has played EoS before, according to a custom starting question.
|-
|2
|If enabled, the player has participated in a Mystery Mail event before, according toa custom ending question.
|-
|3
|If enabled, the player claimed to be female in the final gender question. Enable for '''male''' starters.
|-
|4
|If enabled, the player claimed to be male in the final gender question. Enable for '''female''' starters.
|}

=== Outputs ===
Once again, the orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.

== Question Loop Generator: Before, After, and For How Long? ==

=== Upper Panel ===
The upper panel of this sheet mostly consists of inputs, though the single output is a reminder of how many unique pools are used by the Starter Selection Generator. The input directly left of it is for telling the Question Loop Generator how many pools are in use, and should be changed to match the display. On the upper left of the panel, there are inputs for how many questions the game should ask the player, and how many questions will be written for the quiz to randomly choose from. In vanilla, there are 64 possible questions, and 8 will be given to the player.
[[File:Question Loop Generator Upper Panel.png|alt=Location of the Upper Panel of the Question Loop Generator|center|thumb|750x750px|Location of the Upper Panel of the Question Loop Generator]]
The bottom row consists of checkboxes to enable/disable the Custom/Standard First and Last Questions, such as the Gender Question and the Time/Darkness Question, which boosts recruit rates for certain species if you answer yes, and adds points to certain pools containing sky-exclusive Pokémon.

=== ExplorerScript Pre/Post Quiz Questions ===
Room for an additional question before and after the quiz has also been made, which along with the Gender and Time/Darkness questions can be modified in the below ExplorerScript inputs:
[[File:Question Loop Generator ExplorerScript Inputs.png|alt=Location of the ExplorerScript Inputs|center|thumb|600x600px|Location of the ExplorerScript Inputs]]
These are the primary use-cases for the Fuwarante Blacklist described above.

The <code>[S:0]</code> text tag will be explained in further detail below.

== Question Generator: Multiple Choice Monotony ==
Note: The "Yes." and "No." options have the <code>[S:0]</code> text tag after them. This does functionally nothing, and exists primarily to aid in automatic string translation, as the localization teams translated the same English responses for questions differently based on context. This will be elaborated on further in "Full Script Translation". If there are no plans to use the sheet's translation features, it is safe to remove any variants of <code>[S:0]</code>. (instructions to do so in SkyTemple directly are present below).

=== About Question Templates ===
This tab of the sheet is dedicated to the design and storage of the individual random questions in the quiz. The way this sheet works revolves around "Question Templates" that store the question text, question number, answer text, pool ID, and points for that pool ID. Below is an example of a Question Template, and how it translates to question data:
{| class="wikitable"
|+ Do you prefer to be busy or have\na lot of free time?^35 |<code>Being busy.^11^4^8^2|Free time!^9^4|In between.^12^4</code>
!Question Text
! colspan="8" |Question #
|-
|Do you prefer to be busy or to have a lot of free time?
| colspan="8" |35
|-
!Answer Text
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
! colspan="2" |Pool 1 ID and Pts
|-
|Being busy.
|11
|4
|8
|2
| -
| -
| -
| -
|-
|Free time!
|9
|4
| -
| -
| -
| -
| -
| -
|-
|In between.
|12
|4
| -
| -
| -
| -
| -
| -
|}

=== Question Template Input ===

On the far left, is an input for an existing Question Template.[[File:Question Template Input.png|alt=Question Template Input Location|center|thumb|600x600px|Question Template Input Location]]The "Use Question Template Input" checkbox tells the sheet whether or not to use the Question Template provided. When writing questions entirely from scratch, disable this checkbox. When modifying existing questions, enable the checkbox, and paste in the Question Template. This will subsequently auto-fill the Question Data Inputs with the data within the template. If the auto-filled data itself needs to be altered, you will need to copy and '''paste values''' the data, then disable the checkbox.

=== Question Data Inputs ===
[[File:Question Data Inputs.png|alt=Location of the Question Data Inputs Area|center|thumb|750x750px|Location of the Question Data Inputs Area]]
The Question Data Inputs Area should seem relatively intuitive. The question text is at the top, the answers are beneath, and up to 4 Personality Pools can gain points from each answer choice. The White Space checkbox is identical to the previous tab, and the question index is just the internal "ID" of the question. It should be incremented for each new question created, and will translate to the ID of the switch case in the final code. Note that the drop-down for the Pool Names is sourced from the Pool Names column of the Starter Selection Generator, and any changes to that list after creating the questions may lead to problems. With the current setup of the sheet, each question is limited to a maximum of 26 answer choices, but this limit is arbitrary, and can be circumvented by editing the question template manually, and pasting it in the Template List. In the event that a single question requires more than 26 choices, please ping happylappy in a support thread.

=== Question Template Output & Template List ===
Finally, once the question is complete, a template for the question will be created in "Question Template Output".
[[File:Question Template Output & Template List.png|alt=Location of Question Template Output & Template List|center|thumb|750x750px|Location of Question Template Output & Template List]]
Before moving onto the next question, copy the template output, and '''Paste Values''' in the corresponding slot on the "Question Template List". By default, templates for each vanilla question are already in the Question Template List, ready to be edited or modified by copying and pasting into the Question Template Input. The Script Output Column is again for debug purposes, and is read automatically by another tab of the sheet.

== Personality Pool Selection Generator: Gerrymandering and Tie-Breaking ==
Once the quiz itself is completed, the points need to be tallied, so that a winning pool can be selected. The exact way that this happens in vanilla is a tad complicated, especially when it comes to breaking ties. Here are the steps that occur in vanilla:

# Points are added to pools containing Sky-Exclusive Starters if the player has played Time/Darkness.
#* If Male is chosen for the gender question, +4 Points are added to Relaxed, Hasty, and Sassy. (Phanpy, Shinx, and Riolu)
#* If Female is chosen for the gender question, +4 Points are added to Relaxed and Jolly. (Vulpix and Eevee)
# The highest pool is found, and chosen.
#* If there is a tie, it is broken by adding a random number (0-19) to each, and rescoring the points.
#* If there is STILL a tie, it chooses the smallest pool it can.
This tab of the sheet serves to implement these two features in a customizable way.

=== Upper Panel ===
About half of the upper panel is actually new this time. The "White Space" and "Number/# of Pools In Use" are unchanged, except they apply to this sheet.[[File:Pool Selection Generator Upper Panel.png|alt=Location of Pool Selection Generator Upper Panel|center|thumb|600x600px|Location of Pool Selection Generator Upper Panel]]The checkbox for "Do Pool Tinkering" enables/disables the Pool Tinkering portion of this sheet, while the "Maximum Tiebreaker Points" input determines the random value added to tied pools to decide a victor. Larger numbers result in less chance of a secondary tie, but could result in overflow for certain pools.

=== Pool Tinkering ===
As stated above, the vanilla quiz favors pools with Sky-Exclusive Starters for the specified gender if they've played Time/Darkness. Through checking the <code>$BIT_FUWARANTE_LOCAL</code> flags from the "Question Loop Generator", we can mimic this effect.
[[File:Pool Tinkering.png|alt=Location of Pool Tinkering Portion.|center|thumb|600x600px|Location of Pool Tinkering Portion.]]
On the far left, are the IDs of the two flags that should be checked (without modification, this could be 0 for "Time/Darkness", and 3/4 for "Male/Female"). Depending on if the 1st and 2nd flags are true (1), or false (0), the selected pools (as many as needed) will gain the specified number of points. In order to accommodate for the "Surprise Me!" gender option, 2 points are given for male, 2 for "not male", 2 for "female", and 2 for "not female", in order to influence every pool containing a sky-exclusive starter. (A similar process is done for the Time/Darkness exclusive starters I've added to my example quiz, if the player has NOT played time/darkness). Up to 10 slots are present for pool tinkering, though more could be added if there is a pressing need.

== Aura Bow Generator: Fortune Telling and Color Theory ==
The Aura Bow Generator serves to emulate the cinematics of the vanilla aura bow portion of the quiz. In addition to simply detecting when and for how long the player is touching the Aura Bow, the actual bow color needs to be determined! For the vanilla quiz, the process is as follows:

* Use DS Favorite Color (75% Chance): If the DS Favorite Color is selected, the user's favorite color will match the color of the bow.
* Use DS Mac Address (25% Chance): If the Mac Address is selected, then <code>mac_address & 0xF</code> determines the color of the bow.

This functionality can be replicated by QuizMenuTool, and the chances can even be altered!

=== Upper Panel ===
The Aura Bow Generator's Upper Panel is one of the largest of every tab, though many of these inputs are similar to prior tabs of the sheet. The top left input boxes are Special Process IDs for the 4 Special Processes needed to emulate the Aura Bow portion of the quiz, and the "White Space?" Checkbox is the same as always. The "Aura Bow Output" on the top right is the final script output for this tab, unnecessary outside of debug purposes.
[[File:Aura Bow Generator Upper Panel.png|alt=Location of the Aura Bow Generator Upper Panel.|center|thumb|600x600px|Location of the Aura Bow Generator Upper Panel.]]
Beginning with the bottom left of the panel, there are 4 map LEVEL names. "Bottom 1" is for the background while touching the Aura bow, Bottom Screen 2 is for the presentation of the colored Aura Bow, and the Bottom/Top Screen 3 is the backgrounds that the script should end with, when transitioning to the starter reveal. Finally, on the bottom right of the upper panel is the "Touch Screen Aura Bow Object Name". Per the name, this is the name or ID of the object that should be present on the bottom screen, that will animate when the player touches it. The last three digits of the object seem to vary depending on unknown factors, so be sure to verify that yours matches by inspecting this object in M00A01A with SkyTemple.
[[File:Aura Bow Touch Object Name.png|alt=Where to check the Aura Bow Touch Object Name in SkyTemple|center|thumb|600x600px|Where to check the Aura Bow Touch Object Name in SkyTemple]]

=== Aura Reading Panel ===
Beginning on the lower left of the tab, the Aura Reading Panel consists of 3 ExplorerScript code segments, which play before the blank aura bow fades in, after the aura bow fades in, and if the player lets go of the touch screen too quickly.
[[File:Aura Reading Panel.png|alt=Location of the Aura Reading Panel.|center|thumb|600x600px|Location of the Aura Reading Panel.]]
At the very bottom of this panel, there are inputs for dialogue in all 5 languages that will play during the aura reading process. Unlike most text in the quiz, '''this string must be translated here''', as every localization takes a different amount of time to print the dialogue. The length of time the touch screen should have been held for is calculated for each [W:X] text tag, and compared against the actual length of time the touch screen was held. Customizing this text string is possible in the box, so these calculations must be done by the sheet. If your hack is for a US ROM, or will be english-only, disable the "Use EU Strings" Checkbox. "Expected Text Speed (# of chars per frame)" should be the speed your dialogue prints at in SkyTemple. This will ensure that the actual length of the text is properly accounted for in the calculation. "Touch Screen Frame Tolerance" is a grace period for letting go of the bow. This is necessary for certain emulators, damaged touch-screens, failure to account for the dialogue box opening/closing, etc. Feel free to adjust as desired, such that the quiz is possible to complete.

=== Bow Selection Panel ===
Finally, the Bow Selection Panel handles the actual selection and presentation of the Aura Bow. [[File:Bow Selection Panel.png|alt=Bow Selection Panel Location.|center|thumb|600x600px|Bow Selection Panel Location.]]The upper left of the panel is for assigning weights to the three methods for selecting a bow color: DS Favorite Color, DS MAC Address, or a custom block of code. Note that these weights '''must be integers''' or the sheet will generate invalid code. For convenience, the percent chance of each option is computed by the sheet, based on the weights and total weight. The ExplorerScript input for the custom bow selection is on the right of this panel, and on the bottom left is the flavor-text for each bow color.

== Variable Cleanup & End-Cap Generator: Nearly Finished! ==
This tab of the sheet aims to clean up the bevy of variables used by the quiz, and prep the game for actually running. Since QMT uses a majority of the script variables the game has to function, this tab resets them all back to what they should be at the beginning of a save file, now that the quiz no longer needs them. If some part of the quiz needs to be remembered, such as the color of the aura bow, whether the player has played Time/Darkness, or the winning Quiz personality pool, that needs to be preserved in this tab. In addition, this is the tab where the starters are officially initialized, which allows them to be nicknamed. Finally, the special process for actually assigning the starters, <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>, will wipe <code>$CONFIG_COLOR_KIND</code> clean, replacing it with what the real quiz determined your aura bow color to be. Because the real quiz never runs during QMT, this will always be zero. As a result, the aura bow color needs to be saved somewhere besides <code>$CONFIG_COLOR_KIND</code>, then returned afterwards.

=== Upper Panel ===
This tab ALSO has an upper panel! The number of pools to clear should ideally match the number of pools in use. "White Space" does the same thing it has up to this point, and the far right output cell is read elsewhere, and only exists for debug purposes.
[[File:Variable Cleanup & End-Cap Upper Panel.png|alt=Variable Cleanup & End-Cap Upper Panel Location.|center|thumb|600x600px|Variable Cleanup & End-Cap Upper Panel Location.]]
In the center of the panel are three new checkboxes. "Name Partner?" and "Name Hero?" should be somewhat intuitive, they enable/disable the ExplorerScript inputs for naming the hero and partner respectively, which will be elaborated on below. Finally, "Set $VERSION to 1?" sets the <code>$VERSION</code> script variable to 1 at the very end of the script. Without ASM modification, saving the game with this variable as anything besides 1 results in a "corrupt" save file. In the absence of a strong reason otherwise, this box should remain checked.

=== Hero Name, Partner Name, & Closing Remarks ===
These ExplorerScript Inputs are for... the code used for nicknaming the partner and hero respectively, as well as the last few lines of text before the quiz truly ends.[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]Note that <code>MENU_PARTNER_NAME</code> will not function without the dedicated SkyPatch, in the QMT github repo (linked at the top). Additionally, the menus themselves will close any active text-box the instant they are done printing, which is why the hero monologue ends with a <code>[K]</code>. A <code>message_Close();</code> would also suffice. Finally, the closing remarks should actually fade out the BGM and screen as desired. Feel free to optimize the fades, there is probably a more efficient way to achieve the right effect.

=== Script Variable Preservation Panel ===
The Script Variable Preservation Panel serves to determine what information should be preserved after the quiz. By default, only the variables storing the personality pool counts are actually being erased, though certain configurations may require some variables to be kept, and others to be wiped in addition.[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]Beginning at the top, is the "Variable Erasure Blacklist". Based on other interactions with the sheet, the "Automatic Variables" will fill up automatically, but any script variables specified in this row will be kept as they are at the end of the quiz, and not erased. An example of a manual blacklist example might be <code>$VERSION</code>, which doesn't need a dedicated line of code for erasure if it will ALSO be set to 1 at the end. The next row, "Additional Variables to Erase", will be added to the list of erased variables if they are not already present. The <code>$BIT_FUWARANTE_LOCAL</code> variables should be erased in addition, as the Driftblim Gondola will interpret these variables as valid station passes to enter. Below that, is the "Variable Transfer Table". Prior to erasing anything, variables in the "Old Variable Name" column will be moved to the "New Variable Name". The old variable will be slated for erasure, while the new one will be spared. For convenience, the "Variable Meaning" Tab on the left will autofill one or both of these columns depending on the option you select:
{| class="wikitable"
|+
!Variable Meaning
!Old Variable Name
!New Variable Name
!Comments
|-
|Aura Bow Preserve
|<code>$CONFIG_COLOR_KIND</code>
|<code>$LOCAL0</code>
|If this Variable Meaning is present, <code>$CONFIG_COLOR_KIND</code> will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running <code>PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ</code>.
|-
|Winning Pool
|<code>$SCENARIO_SUB7</code>
|Any
|This variable retains the winning Pool ID from the quiz itself. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Winning Points
|<code>$SCENARIO_SUB6</code>
|Any
|This variable retains the number of points the winning Pool ID had after the tie-breaking process. This could prove useful for dialogue, or perhaps some other purpose?
|-
|Fuwarante Bit X
|<code>$BIT_FUWARANTE_LOCAL[X]</code>
|Any
|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to <code>$PLAY_OLD_GAME</code>, the variable responsible for the recruitment rate buff for playing Time/Darkness.
|-
|Direct Script Variable
|Any
|Any
|This is an invitation to input whatever script variables are needed, and will adjust the coloration of the row to match.
|}
A full list of script variables with their appropriate descriptions will be provided in "Other Resources", and might prove useful for more advanced tinkering in this panel.

== Full Script Translation: EU ROM Superiority ==
This tab of the sheet is dedicated to translating all lines of dialogue into Spanish, French, German, and Italian, for an EU ROM. If the hack this is for doesn't need translation, this tab can be completely skipped. One of the most essential features of a translated quiz is the ability to pre-translate the vanilla text strings from the original quiz.

=== Upper Panel ===
By default, the left-most checkbox of the upper panel will "activate" this sheet for translation. This may cause lag, and will cause more lag every time a change is made on one of the prior sheets, while enabled. Only begin translating once finished with the quiz, at least in the short term. [[File:Full Script Translation Upper Panel.png|alt=Location of the Full Script Translation Upper Panel.|center|thumb|600x600px|Location of the Full Script Translation Upper Panel.]]The "Auto-Translate Vanilla Strings" check-box will automatically search for and translate exact matches to vanilla Quiz strings. Additional translations can be added in "Vanilla Translation Strings" as needed. If no exact match is found, the translation will be left blank for manual translation. "Auto-Translate Pokemon" similarly will attempt to translate exact matches for dialogue specific to the final species. For example, the English string <code>[R][CN]Will be a [CS:K]Magnemite[CR]![W:60]</code> will be automatically translated to <code>[R][CN]wird ein [CS:K]Magnetilo[CR]![W:60</code>] (German), based on Magnemite's German name and the phrase "wird ein ___!". This will only occur if the checkbox is enabled, and only for Pokemon names present in "Vanilla Translation Strings". Finally, the "Trim [S:0] Before Translation" checkbox will remove all <code>[S:0]</code> text tags from the dialogue before searching for a match, ensuring that the various "Yes.", "No.". "Of Course!", and "Open it!" are not translated automatically, per their vanilla quiz questions. Regardless of whether this checkbox is enabled, the final script output will not contain the <code>[S:0]</code> tags.

=== String Translation Panel ===
The string translation panel, on the right of this tab, is where text string translation will actually occur.
[[File:String Translation Panel.png|alt=Location of String Translation Panel.|center|thumb|600x600px|Location of String Translation Panel.]]
On the left, are English lines of text extracted from other tabs of the sheet. each column corresponds to an EU language (Spanish, French, German, Italian). At the top of each column, is a count of how many untranslated lines of dialogue are left for that language, as well as a checkbox to enable/disable each language. In the above screenshot, French dialogue will not be added to the final script, because the checkbox is enabled. In the rows themselves, are pink cells (vanilla translated text), green cells (empty), and blue cells (manual translation). Simply review each pink cell, and manually translate the English for that row for green cells so they turn blue. If a pink cell needs editing, simply copy the cell, and '''Paste Values''' it on top of itself, and it will turn blue, which is safe to edit.

== Vanilla Translation Strings: Future-Proofing The Sheet ==
This tab of the sheet is used to store vanilla strings from the base game, and official Pokemon translations. These can be amended and edited as desired, to include custom strings for auto-translation, or new Pokemon name translations.
[[File:Vanilla Translation Strings Dialogue.png|alt=Vanilla Translation Strings Dialogue|center|thumb|600x600px|Vanilla Translation Strings Dialogue]]
This area above contains all relevant vanilla strings, which can be added to or amended as desired, in the green cells in these 5 columns. If a need arises to make changes to the quiz after translation, it is best to move all manually translated lines to this tab, before making any changes. Additionally, the lookup table for Pokemon species names can be modified:
[[File:Vanilla Translation Strings Species.png|alt=Vanilla Translation Strings Species|center|thumb|452x452px|Vanilla Translation Strings Species]]
On the far right of the tab, are a list of every Pokemon through Scarlet & Violet, and the French/German translations for each species (Spanish and Italian use English species names). These can also be amended or added to as desired.

== Full Script Compression: It's Finally Over? ==
Last but not least, is the Full Script Compression Tab. This tab compiles all of the information from the other tabs, and compresses it into a copy/pastable batch of scripts for SkyTemple.

=== Upper Panel ===
There are a handful of settings in this upper panel. "White Space" is as it has been for every prior tab, but that's the only returning input.
[[File:Full Script Compression Upper Panel.png|alt=Full Script Compression Upper Panel Location.|center|thumb|600x600px|Full Script Compression Upper Panel Location.]]
"Use Full MegaScript" will compile the entire quiz into one script. This is only possible for English-only quizzes, and is only advised for quizzes with few questions and fewer starter choices. "Use Translated Scripts?" will use the outputs from Full Script Translation, which will be empty if the sheet is not active. Disable this checkbox for English-only quizzes. "Generate Unionall CORO" will create the unionall code needed to run the quiz, for a copy and paste replacement for the existing <code>CORO EVENT_M00A_01</code> coroutine. The "Script File LEVEL Name" should reflect the location of the map LEVEL "folder" that the script file will actually be under. The "Script File SCRIPT Name" should become the name of the acting script itself, and should be 8 alphanumerical characters or fewer (not case-sensitive). Finally, the "Sector Param." is the sector parameter of the <code>supervision_ExecuteActingSub();</code> [[List of Opcodes#0x12d - supervision ExecuteActingSub|Opcode]]. Generally this should be zero, though none of these scripts internally utilize the sector parameter, should it be of interest for customization.

=== SkyTemple Script Outputs ===
This portion of the sheet consists of outputs to SkyTemple. Unlike most output cells thus far, these are actually intended for use!
[[File:SkyTemple Script Outputs.png|alt=SkyTemple Script Outputs Location.|center|thumb|600x600px|SkyTemple Script Outputs Location.]]
The intended places for each of these outputs will be described in "Importing The Scripts To SkyTemple", but when copying a script, be sure to copy all cells in the box with text.

== Importing The Scripts To SkyTemple ==
Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out.

=== Converting From StarterMenuTool ===
There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

* FixPartnerNameMenu is Applied: Since the SkyPatch is already applied, it does not need to be applied again. It can be reapplied without issue, though it already exists in the ROM.
* Existing Special Processes: Older versions of <code>starter_setter</code> and <code>set_frame_color</code> were added via StarterMenuTool. These may function as intended for QMT, especially <code>set_frame_color</code> which has seen zero change between the two tools, but it is recommended to update them by replacing them, or to use new slots for the QMT SPs.
* Existing Acting Script: StarterMenuTool takes the same approach as QMT in creating a new acting scene for the quiz itself. This existing script can be repurposed into one of the QMT acting scripts, though with SkyTemple alone it cannot be renamed, meaning the script name it will be used for in the Full Script Compression Upper Panel must be renamed.
* Edit to Vanilla Quiz: StarterMenuTool modifies the original quiz script m00a01a.ssb. While these changes have no net impact on QMT, it would impact the debug mode, as the code to create a team from the default starters has been removed. If this functionality needs to be restored, simply add the following line after "if ( debug ) {" in m00a01a.ssb:

<code>switch ( ProcessSpecial(PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, 0, 0) ) { }</code>

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

== Other Resources ==

=== QMT Script Variable Map ===
[[Category:Tutorials]]

List of Opcodes

2025-08-09T20:39:31Z

Happylappy: /* 0x12d - supervision_ExecuteActingSub */

The scripting engine used in Explorers of Sky has different opcodes. [[ExplorerScript]] translates most of them literally, preserving the same parameters and functionality. However, some opcodes are translated to [[ExplorerScript]] constructs, such as if statements.

This article documents the different opcodes, their purpose and parameters. The purpose of unkX parameters is unknown.

== What is an opcode? ==
An opcode is an instruction to the machine (it tells the machine to 'do' something). In modern programming, it would be most similar to a [https://en.wikipedia.org/wiki/Function_(computer_programming) function]. For a more technical description, see [https://en.wikipedia.org/wiki/Opcode here].

== Types of parameters ==
* uint: An unsigned integer (a number without decimals). It cannot be negative. It is possible that in the game's code, there are only signed integers and no unsigned integers, but not enough research has been done on the matter. For the most part, it shouldn't matter.
* sint: A signed integer (a number without decimals). It can be either positive or negative.
* bitfield: A bitfield is uint where each bits (0 or 1) are treated independantly. They are used to store multiple binary (boolean) values efficiently. Opcodes that use it usually come in the <code>Set</code> and <code>Reset</code> variant. The <code>Set</code> variant define to true the values which are 1 in the input bitfield (while leaving the others untouched), and <code>Reset</code> define to false the values which are 1 in the input bitfield (while also leaving the others untouched).
* String: Text (i.e dialogue). There should always be a quotation mark (") at the beginning and end.
* ConstString: Same as String.
* Routine: Any of the 701 coroutines from [[Unionall]]. Always begins with "CORO_"
* Entity: An actor, performer. (not an object!)
* Object: An object in a scene. (not an actor or perfomer!)
* Level: Any level from the [[Script Engine|Level List]]. Will always begin with "LEVEL_".
* Bgm: Any music in the game. Will always begin with "BGM_". (example: BGM_CRAGGY_COAST)
* PositionMark: A position. Will be written as "Position<'MarkName', x, y>". Once a position mark is written in a script, SkyTemple will show an option to place it visually in the scene.
* Face: A portrait expression. Will always begin with "FACE_". (examples: FACE_NORMAL, FACE_HAPPY, FACE_PAIN)
* FaceMode: A portrait position. Will always begin with "FACE_MODE_".
* Direction: A direction for an entity to move in or turn to. Will always begin with "DIR_". (examples: DIR_UP, DIR_RIGHT)
* ProcessSpecial: One of the games special processes. Can be referred to by its number, or name.
* Effect: A graphical effect.
* GameVar: Any of the game's [[List of Script Variables|Script Variables]]. Will always begin with "$".

== Relevant Opcodes ==
These opcodes can be directly called from ExplorerScript.

=== 0x0 - Null ===
Does nothing.

No parameters.
=== 0x1 - back_ChangeGround ===
Sets the Map Background from a Level without changing the chunks from the currently loaded Map Background. Entities such as actors, objects, and performers will not be deleted when this opcode is executed.

This has very few uses in the game—a notable use is how Wigglytuff's Chamber has its door open, as seen via LEVEL_G01P04A and LEVEL_G01P04A2.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x2 - back_SetBackEffect ===
Performs various effects related to the currently loaded Animation Palettes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x3 - back_SetBackScrollOffset ===
Shifts the background by a certain number of pixels, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level is hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level is hardcoded.
|}

=== 0x4 - back_SetBackScrollSpeed ===
Continuously scrolls the background at a certain speed, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint16
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint16
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x5 - back_SetBanner ===
Displays broken text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x6 - back_SetBanner2 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is typically used for chapter introductions, which includes chapter text and a subtitle displayed over a Map Background. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|-
|2
|uint
|unk1
|Currently unknown. Typically, the game uses 0 for this parameter, but it seems to have no effect.
|-
|3
|uint
|x
|The pixel position the camera will center the Map Background on its X-axis.
|-
|4
|uint
|y
|The pixel position the camera will center the Map Background on its Y-axis.
|-
|5
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|6
|String
|title
|The title of the chapter, e.g., "A Storm At Sea" for Chapter 1.
|}
=== 0x7 - back_SetEffect ===
Performs various effects related to the current Map Background's layers across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x8 - back_SetDungeonBanner ===
Displays a specific string using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. The text chosen is defined in Dungeons tab as a dungeon's <code>back_SetDungeonBanner</code> string. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|The ID of a dungeon, as listed in the Dungeons tab of SkyTemple.
|-
|2
|uint
|unk1
|Currently unknown. Does not seem to affect much.
|}
=== 0x9 - back_SetGround ===
Sets the Map Background from a Level. Upon using this opcode, the variable <code>$GROUND_MAP</code> will be updated to match the ID of the chosen Level. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0xa - back_SetSpecialEpisodeBanner ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is used for Special Episodes 1-3. This opcode plays a short animation of a green line shooting across the screen, followed by text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xb - back_SetSpecialEpisodeBanner2 ===
Displays text using the <code>FONT/banner_c.bin:FONT/b_pal_r.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 4. This opcode features an elaborate animation featuring hearts and sparkles, along with text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xc - back_SetSpecialEpisodeBanner3 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 5. This opcode features no animation, but the end result is similar to the opcode <code>back_SetSpecialEpisodeBanner</code>. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xd - back_SetTitleBanner ===
Displays user-defined text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|y
|The Y-axis pixel position of the title.
|-
|2
|String
|title
|The title displayed on the Touch Screen.
|}
=== 0xe - back_SetWeather ===
Displays a weather effect that overlays the current Map Background.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}
=== 0xf - back_SetWeatherEffect ===
Currently unknown. The only values this opcode accepts seems to be 1, 2, and 3. Its only known use is in V00P02/m01a04a.ssb, which is a test script used by the developers.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x10 - back_SetWeatherScrollOffset ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x11 - back_SetWeatherScrollSpeed ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x12 - back2_SetBackEffect ===
The same as <code>back_SetBackEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect_id
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x13 - back2_SetBackScrollOffset ===
The same as <code>back_SetBackScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}

=== 0x14 - back2_SetBackScrollSpeed ===
The same as <code>back_SetBackScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x15 - back2_SetData ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x16 - back2_SetEffect ===
The same as <code>back_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x17 - back2_SetGround ===
Mostly the same as <code>back_SetGround</code>, but for the Top Screen. This opcode only works if <code>back2_SetMode(4);</code> is used prior to this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x18 - back2_SetMode ===
Determines a hardcoded status of the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|A value of 0 is no mode. A negative value seems to set the Top Screen to the overworld's current Top Screen setting.

# Fades out the Top Screen.
# Team Stats.
# The Map Background S01P01A with the hero idling on a World Map Marker.
# Allows for the Top Screen to display a Map Background from a Level using the <code>back2_SetGround</code> opcode.
# Splits the Map Background used in the Level defined by <code>back_SetGround</code> equally between the Top and Touch Screen.
#Splits the Map Background used in the Level defined by <code>back_SetGround</code> between the Top and Touch Screen.
|}
=== 0x19 - back2_SetSpecialActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0x1a - back2_SetWeather ===
The same as <code>back_SetWeather</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}

=== 0x1b - back2_SetWeatherEffect ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x1c - back2_SetWeatherScrollOffset ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1d - back2_SetWeatherScrollSpeed ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1e - bgm_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x1f - bgm_Play ===
Instantly plays a BGM on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x20 - bgm_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x21 - bgm_Stop ===
Instantly stops the BGM that is currently playing on the first BGM track.

No parameters.
=== 0x22 - bgm_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x23 - bgm2_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x24 - bgm2_Play ===
Instantly plays a BGM on the second BGM track.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x25 - bgm2_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x26 - bgm2_Stop ===
Instantly stops the BGM that is currently playing on the second BGM track.

No parameters.
=== 0x27 - bgm2_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x38 - CallCommon ===
Jumps to the specified Unionall Coroutine, runs its code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the Coroutine). This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub).

If used in the context of an actor/object/performer, this should not be used in with-statements.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x39 - camera_Move2Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3a - camera_Move2MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3b - camera_Move2Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3c - camera_Move2PositionMark ===
Moves the camera to one or more Position Marks without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x3d - camera_Move2PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x3e - camera_Move3Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x3f - camera_Move3MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x40 - camera_Move3Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x41 - camera_Move3PositionMark ===
Moves the camera to one or more Position Marks in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x42 - camera_Move3PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x43 - camera_MoveDefault ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x44 - camera_MoveMyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x45 - camera_MoveMyself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x46 - camera_MovePositionMark ===
Moves the camera to one or more Position Marks while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x47 - camera_MovePositionMark ===
Moves the camera to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x48 - camera_SetDefault ===
Instantly sets the camera to a Type 1 actor (e.g., ACTOR_PLAYER).

No parameters.
=== 0x49 - camera_SetEffect ===
Continuously shakes the camera at specified intensities. Entities will be affected by the camera shaking, but not textboxes and portraits. The camera will continue to shake even if it is moved using another opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x4a - camera_SetMyPosition ===
Instantly sets the camera toward a specific entity's position (i.e., an actor, object, or performer).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4b - camera_SetMyself ===
Instantly sets the camera to a specific entity (i.e., an actor, object, or performer). Once performed, the camera will now follow the entity wherever it moves.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4c - camera_SetPositionMark ===
Instantly sets the camera to a Position Mark.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x4d - camera2_Move2Default ===
The same as <code>camera_Move2Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4e - camera2_Move2MyPosition ===
The same as <code>camera_Move2MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4f - camera2_Move2Myself ===
The same as <code>camera_Move2Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x50 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x51 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x52 - camera2_Move3Default ===
The same as <code>camera_Move3Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x53 - camera2_Move3MyPosition ===
The same as <code>camera_Move3MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x54 - camera2_Move3Myself ===
The same as <code>camera_Move3Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x55 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x56 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x57 - camera2_MoveDefault ===
The same as <code>camera_MoveDefault</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x58 - camera2_MoveMyPosition ===
The same as <code>camera_MoveMyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x59 - camera2_MoveMyself ===
The same as <code>camera_MoveMyself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x5a - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x5b - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x5c - camera2_SetDefault ===
The same as <code>camera_SetDefault</code>, but for the Top Screen.

No parameters.
=== 0x5d - camera2_SetEffect ===
The same as <code>camera_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x5e - camera2_SetMyPosition ===
The same as <code>camera_SetMyPosition</code>, but for the Top Screen.

No parameters.
=== 0x5f - camera2_SetMyself ===
The same as <code>camera_SetMyself</code>, but for the Top Screen.

No parameters.
=== 0x60 - camera2_SetPositionMark ===
The same as <code>camera_SetPositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x61 - CancelCut ===
Reverses the effects of the opcode <code>CancelRecoverCommon</code>, i.e., disallows the game from reloading Unionall at a Coroutine by pressing the Start button.

No parameters.
=== 0x62 - CancelRecoverCommon ===
Allows reloading Unionall at a specified Coroutine by pressing the Start button. This can be done in a cutscene and the overworld.

Once the Start button is pressed, the game will stop the current script, fade out the entire screen, and reload Unionall and begin running code at the specified Coroutine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x6a - debug_Assert ===
Does nothing in the final game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x6b - debug_Print ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6c - debug_PrintFlag ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with the value of the specified script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. Indexed variables are not encouraged to use, since the Debug Log will only read from the first index.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6d - debug_PrintScenario ===
If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with two indices of the specified script variable.

This opcode's Debug Log implementation currently seems broken, as it prints the first index of the specified variable twice.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. A two-indexed variable (e.g., <code>$SCENARIO_MAIN</code>) is encouraged to use.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6f - Destroy ===
Instantly removes an active entity (i.e., an actor, object, or performer) from memory.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.

=== 0x71 - EndAnimation ===
Stops an actor or object's looping animation once it reaches the end of its animation frames.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x72 - ExecuteActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x73 - ExecuteCommon ===
Jumps to a Unionall Coroutine, runs its code, and returns to the line in which this opcode was called. This opcode should be called if the specified Coroutine ends with <code>hold;</code>. Typically, the base game uses this command with Coroutines whose names end with "FUNC_SERIES".

This opcode does not have a parameter for an entity, as it must be used in a with-statement.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|-
|2
|uint
|unk1
|Unknown.
|}
=== 0x81 - Flash ===
Zeroes-out the return address used by the <code>Return</code> opcode. This opcode is not used in the base game.

No parameters.
=== 0x83 - item_GetVariable ===
Saves the value in a specific item slot (set by <code>item_Set</code>) to a script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the indexed variables. Non-indexed values causes the IndexError.
|}
=== 0x84 - item_Set ===
Sets an item into an item slot, which can be used by other various <code>item_</code> opcodes.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

Item slots 0-3 are safe to use, but item slots 4 and beyond will begin to overwrite other memory!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|item_id
|The ID of the item, where all are listed in the Items tab of SkyTemple.
|-
|3
|uint
|item_stack
|The stack count of an item, if it belongs to a Thrown category. Treasure Boxes will also use this as the item earned when opening the box at Xatu's Appraisal.
|}
=== 0x85 - item_SetTableData ===
Sets a random item from predefined tables into an item slot, which can be used by other various <code>item_</code> opcodes. This opcode is used mainly in Spinda's Cafe, for redeeming a random Recycle Shop prize and for receiving items from Treasure Town NPCs after giving them Sky Gifts.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|table_ID
|Some item tables related to Spinda's Cafe.
|}
The table IDs themselves are as follows. Values above 15 are currently unknown and untested.
{| class="wikitable"
!#
!Description
!#
!Description
|-
|0
|Sky Gift Item Pool
|8
|Silver Ticket Win Pool
|-
|1
|Numel "Give" Item Pool
|9
|Silver Ticket Big Win Pool
|-
|2
|Numel "Recieve" Item Pool
|10
|Gold Ticket Loss Pool
|-
|3
|Happiny Lost Item Pool
|11
|Gold Ticket Win Pool
|-
|4
|Prize Ticket Loss Pool
|12
|Gold Ticket Big Win Pool
|-
|5
|Prize Ticket Win Pool
|13
|Prism Ticket Loss Pool
|-
|6
|Prize Ticket Big Win Pool
|14
|Prism Ticket Win Pool
|-
|7
|Silver Ticket Loss Pool
|15
|Prism Ticket Big Win Pool
|}

=== 0x86 - item_SetVariable ===
Saves the value of a script variable to an item slot. Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the 115 possible script variables.
|}
=== 0x88 - JumpCommon ===
Jumps to the specified Unionall Coroutine and runs its code, without returning to the line in which this opcode was first used. This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub), but is mostly used by the base game in Unionall.

If attempting to execute a Unionall Coroutine from inside an Enter, Acting, or Sub script to play Acting scripts, use <code>supervision_ExecuteCommon</code> instead.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x8a - LoadPosition ===
Sets various attributes of an entity (i.e., an actor, object, or performer) to the values of all indexed <code>$POSITION_</code> script variables. These include changing the entity's X and Y coordinates, height, and direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0x8b - Lock ===
Suspends the current routine until the opcode <code>Unlock</code> is called with the same ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x8c - main_EnterAdventure ===
Performs various functions related to entering a dungeon using the crossroads menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|Most modes are not known, but:

* 32767 opens the dungeon selection menu.
* 251 stops the current script to reload Unionall starting from the Coroutine CORO_MOVE_WORLD_MAP.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x8d - main_EnterDungeon ===
Attempts to exit ground mode and begins dungeon mode at a specific dungeon.

If attempting to run this opcode before selecting any option from the Top Menu, the game will not enter any dungeon and instead attempt to load a DEMO Unionall coroutine or the Top Menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|dungeon_id
|The dungeon ID to enter, which are all listed in the Dungeons tab of SkyTemple. A value of -1 actually enters dungeon mode—it is insufficient to use this opcode a single time to enter a specific dungeon.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8e - main_EnterGround ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: Set to 0.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8f - main_EnterGroundMulti ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: This opcode's ''level_id_link'' parameter.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id_enter
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|-
|3
|Level
|level_id_link
|An entry in the Level List. Used to update <code>$GROUND_ENTER_LINK</code>.
|}
=== 0x90 - main_EnterRescueUser ===
Exits ground mode and begins dungeon mode while taking an SOS Mail. Dungeon selection seems to be determined by the SOS Mail chosen via <code>message_Menu(MENU_S_O_S_MAIL_PICKER);</code>.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x91 - main_EnterTraining ===
Performs various functions related to entering a dungeon using Marowak Dojo.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens the generic dojo selection menu
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x92 - main_EnterTraining2 ===
Performs various functions related to entering a dungeon using Marowak Dojo's Final Maze.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens a dojo selection menu that only involves Final Maze.
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x93 - main_SetGround ===
Updates the following variables' values to be this opcode's ''level_id'' parameter:

* <code>$GROUND_ENTER</code>
* <code>$GROUND_GETOUT</code>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List.
|}
=== 0x94 - me_Play ===
Instantly plays a special [[sound effect]] that can seamlessly interrupt any BGM tracks that are currently playing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|me_id
|A sound effect defined in SOUND/ME of the ROM.
|}
=== 0x95 - me_Stop ===
Instantly stops the currently-playing special [[sound effect]] called with <code>me_Play</code>.

No parameters.
=== 0x96 - message_Close ===
Suspends the current routine and allows for closing an active textbox (and portrait, if active) set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

By pressing the A Button, B Button, or tapping the textbox via the Touch Screen. Once the textbox is closed, the current routine resumes.

No parameters.
=== 0x97 - message_CloseEnforce ===
Instantly closes an active textbox (and portrait, if active) once the game finishes displaying a string set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

No parameters.
=== 0x98 - message_Explanation ===
Displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine.

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x99 - message_FacePositionOffset ===
Offsets the active portrait in pixels by multiples of 8.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|The offset to shift the portrait box across the X-axis.
|-
|2
|sint
|y
|The offset to shift the portrait box across the Y-axis.
|}
=== 0x9a - message_ImitationSound ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9b - message_KeyWait ===
If an active textbox has finished displaying its string and was created by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

This opcode suspends the current routine until the A Button, B Button or textbox is pressed (via the Touch Screen). Once done so, the textbox will not close, but the current routine will resume.

No parameters.
=== 0x9c - message_Mail ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9d - message_Menu ===
Executes various hardcoded "menu" functionalities given a certain ID. Some IDs result in an actual menu, while others simply perform a silent task.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Menu
|menu_id
|The ID of a menu, the list of which can be seen by typing <code>MENU_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x9e - message_Monologue ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9f - message_Narration ===
Fades in the screen and instantly displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine. Once the routine is resumed (by pressing the A Button, B Button, or text via the Touch Screen), the screen will fade out, including the string.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade in/out the Touch Screen.
|-
|2
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa0 - message_Notice ===
Instantly displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa1 - message_EmptyActor ===
Disallows a portrait from appearing alongside a textbox, along with disallowing a name to appear in the textbox if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa2 - message_ResetActor ===
Disallows a portrait from appearing alongside a textbox, along with setting a speech bubble (the text tag [M:T1]) to the start of next script string if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa3 - message_SetActor ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xa4 - message_SetFace ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa5 - message_SetFaceEmpty ===
Displays a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa6 - message_SetFaceOnly ===
Sets a speech bubble (the text tag [M:T1]) to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa7 - message_SetFacePosition ===
Re-positions an actor's portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa8 - message_SetWaitMode ===
Makes strings displayed with a <code>message_</code> opcode auto-scroll. For both parameters, a value of -1 means the auto-scroll will stop.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|duration0
|Sets the frame count for a textbox auto-advancing, once the end of the string has been displayed and the following opcode is <code>message_KeyWait();</code>.
|-
|2
|sint
|duration1
|Sets the frame count for text tags such as [K] auto-advancing.
|}
=== 0xa9 - message_SpecialTalk ===
Displays a random Text String based off of the actor ACTOR_TALK_SUB's Talk Group.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|category
|A category of Text String.

* 0 seems to use Text Strings while not in a dungeon (e.g., teammates waiting at Spinda's Cafe).
* 1 seems to be use Text Strings while mid-dungeon (e.g., teammates at Amp Plains).
|}
=== 0xae - message_Talk ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xaf - Move2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb0 - Move2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without restricting the angles used.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb1 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0xb2 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xb3 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xb4 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xb5 - Move2PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xb6 - Move3Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb7 - Move3PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor in a rapid, strange motion.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb8 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xb9 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xba - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xbb - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xbc - Move3PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xbd - MoveDirection ===
Offsets an entity (i.e., an actor, object, or performer) by a certain number of pixels based on a given direction. Movement is performed while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|offset
|The pixel offset to shift the entity relative to the entity's direction.
|-
|3
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xbe - MoveHeight ===
Moves an entity (i.e., an actor, object, or performer) to a certain pixel height, displacing it from its shadow. When used, the entity's animation and direction will not change.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|height
|The pixel height to set the entity relative to their shadow.
|}
=== 0xbf - MovePosition ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xc0 - MovePositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xc1 - MovePositionLivesTime ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the actor or after a certain number of frames have passed—whichever comes first.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc2 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xc3 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xc4 - MovePositionMarkTime ===
Moves an entity (i.e., an actor, object, or performer) to an Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the Position Mark or after a certain number of frames have passed—whichever comes first.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc5 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xc6 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xc7 - MoveSpecial ===
Currently unknown. Seems to move an entity (i.e., an actor, object, or performer) based on some hardcoded behaviors.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Determines the kind of action.

# Spin and move in a circular motion.
# Spin and move in a circular motion.
# Currently unknown.
# Currently unknown.
# Currently unknown. Seems to be the most commonly-used value, as a part of the Unionall Coroutine CORO_LIVES_REPLY_NOMRAL.
|-
|2
|uint
|unk1
|Currently unknown. Seems to affect how far the entity will move?
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0xc8 - MoveTurn ===
Moves an entity (i.e., an actor, object, or performer) based on a certain pattern. Unlike other <code>Move</code> opcodes, this opcode will make the entity interact with the currently loaded Map Background's collision (i.e., the entity stops when hitting a wall).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|distance
|How far the entity will move. Higher values result in greater distance being covered.
|-
|2
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.

This parameter also seems to affect the distance traveled.
|-
|3
|uint
|pattern
|A hardcoded pattern to move in.

# Moves in a circle clockwise.
# Moves in a circle counterclockwise.
# Moves in a square clockwise.
# Moves in a square counterclockwise.
# Zig-zags back and forth.

Values 6 and above seem to be variations of random movement.
|}
=== 0xca - PauseEffect ===
Instantly pauses the current graphical effect of an entity (i.e., an actor, object, or performer). The effect will freeze mid-frame.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xcc - ProcessSpecial ===
Executes one of the game's Special Processes. The return value of a Special Process can be checked by encasing this opcode in a <code>switch</code> statement. A negative return value is not acceptable and will cause the game to suspend indefinitely.

This opcode cannot be used in targeted routines.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ProcessSpecial
|process_id
|One of the game's Special Processes.
|-
|2
|sint
|process_param1
|The first parameter used by the Special Process.
|-
|3
|sint
|process_param2
|The first parameter used by the Special Process.
|}
=== 0xcd - PursueTurnLives ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xce - PursueTurnLives2 ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xcf - ResetAttribute ===
Currently unknown. Seems to get ignored when parsed in the scripting engine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0xd0 - ResetFunctionAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "function" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|function_bitfield
|Most bits' purposes are unknown. Bit 1 appears to be the bit used for allowing an entity to follow a Type 1 actor, like the actor ACTOR_ATTENDANT1 in the overworld.
|}
=== 0xd1 - ResetHitAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "hit" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|hit_bitfield
|Most bits' purposes are unknown.

* 2: Entity collision.
* 6: Talk Script upon collision.
* 7: Talk Script upon pressing the A Button near the entity.
|}
=== 0xd2 - ResetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0xd3 - ResetReplyAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "reply" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|reply_bitfield
|Most bits' purposes are unknown.

* 1: Talk Script upon collision.
* 2: Talk Script upon pressing the A Button near the entity.
* 6: Underlay below entities.
* 7: Overlay above entities.
|}
=== 0xd4 - ResumeEffect ===
Resumes the current graphical effect of an entity (i.e., an actor, object, or performer) that has been paused with <code>PauseEffect</code> prior to using this opcode.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xd6 - SavePosition ===
Saves various attributes of an entity (i.e., an actor, object, or performer) to the following script variables:

* <code>$POSITION_X</code>: The pixel position of the entity on the X-axis multiplied by 256.
* <code>$POSITION_Y</code>: The pixel position of the entity on the Y-axis multiplied by 256.
* <code>$POSITION_HEIGHT</code>: The pixel height (i.e., displacement of the entity from their shadow) of the entity multiplied by 256.
* <code>$POSITION_DIRECTION</code>: The direction the entity is facing.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0xd7 - screen_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd8 - screen_FadeChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd9 - screen_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xda - screen_FadeInAll ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdb - screen_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdc - screen_FadeOutAll ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdd - screen_FlushChange ===
Does nothing.
{| class="wikitable"
|+Parameters
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}

=== 0xde - screen_FlushIn ===
Changes the color of the screen from a specific state (given by the opcode's parameters, which affect the Touch Screen instantly) to its default state across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xdf - screen_FlushOut ===
Changes the color of the screen across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xe0 - screen_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe1 - screen_WhiteChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe2 - screen_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOut</code>, use <code>screen_FadeIn</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe3 - screen_WhiteInAll ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOutAll</code>, use <code>screen_FadeInAll</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe4 - screen_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe5 - screen_WhiteOutAll ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe6 - screen2_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xe7 - screen2_FadeChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xe8 - screen2_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xe9 - screen2_FadeInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xea - screen2_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xeb - screen2_FadeOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xec - screen2_FlushChange ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}
=== 0xed - screen2_FlushIn ===
The same as <code>screen_FlushIn</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xee - screen2_FlushOut ===
The same as <code>screen_FlushOut</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xef - screen2_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xf0 - screen2_WhiteChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xf1 - screen2_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen2_WhiteOut</code>, use <code>screen2_FadeIn</code> to restore the Top Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf2 - screen2_WhiteInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf3 - screen2_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xf4 - screen2_WhiteOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf5 - se_ChangePan ===
Changes the panning of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's panning.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xf6 - se_ChangeVolume ===
Changes the volume of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's volume.
|-
|3
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xf7 - se_FadeOut ===
Fades out the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to fade out and silence a given SE.
|}
=== 0xf8 - se_Play ===
Instantly plays a [[sound effect]].

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xf9 - se_PlayFull ===
Instantly plays a [[sound effect]] at a specified volume and panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfa - se_PlayPan ===
Instantly plays a [[sound effect]] at a specified panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfb - se_PlayVolume ===
Instantly plays a [[sound effect]] at a specified volume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xfc - se_Stop ===
Instantly stops a specified sound effect.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xfd - SetAnimation ===
Plays a sprite's animation, optionally changing its speed and animation flags.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|id
|Animation table index. Converted to an [[Animation ID]] for the current sprite using the [https://docs.google.com/spreadsheets/d/11xHv80Def5mtF60ZsfI1lF1eNX0dBE2It837Q08AlRk/htmlview SetAnimation table].
|}
=== 0xfe - SetAttribute ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|}
=== 0xff - SetBlink ===
Sets a specific entity (i.e., an actor, object, or performer) to continuously flicker in and out of view at a certain interval.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|visible_interval
|The number of frames to wait for while the entity is visible.
|-
|2
|uint
|invisible_interval
|The number of frames to wait for while the entity is invisible.
|}
=== 0x100 - SetDirection ===
Instantly sets a specific entity (i.e., an actor, object, or performer) to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x101 - SetDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x102 - SetEffect ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|
|-
|2
|uint
|position_marker_id?
|
|}
=== 0x103 - SetFunctionAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x104 - SetHeight ===
Moves an actor "vertically" by distancing it from its shadow.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|number of pixels to move up or down by.
|}
=== 0x105 - SetHitAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x106 - SetMoveRange ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|-
|5
|uint
|unk4
|
|-
|6
|uint
|unk5
|
|}
=== 0x107 - SetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 1.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0x108 - SetPosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|x
|
|-
|2
|uint
|y
|
|}
=== 0x109 - SetPositionInitial ===
<TO DO: Opcode description>

No parameters.
=== 0x10a - SetPositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x10b - SetPositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x10c - SetPositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10d - SetPositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10e - SetReplyAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x10f - SetupOutputAttributeAndAnimation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x110 - Slide2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}

=== 0x111 - Slide2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|actor_id
|The ID of the actor to move the entity to.
|}

=== 0x112 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x113 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_mark
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x114 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x115 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x116 - Slide2PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x117 - Slide3Position ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x118 - Slide3PositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|actor_id
|
|}
=== 0x119 - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|PositionMark
|pos_marker
|This parameter may be repeated multiple times
|}
=== 0x11a - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x11b - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x11c - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11d - Slide3PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11e - SlideHeight ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x11f - SlidePosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x120 - SlidePositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x121 - SlidePositionLivesTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x122 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x123 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x124 - SlidePositionMarkTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|}
=== 0x125 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
|This parameter may be repeated multiple times
|}
=== 0x126 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x127 - sound_FadeOut ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x128 - sound_Stop ===
<TO DO: Opcode description>

No parameters.
=== 0x129 - StopAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x12a - supervision_Acting ===
Loads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12b - supervision_ActingInvisible ===
Loads a sector of the Acting scene. Actors and objects in this sector will be invisible.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12c - supervision_ExecuteActing ===
Loads a specified Acting script from the specified level from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|Map LEVEL the script should be located in.
|-
|2
|ConstString
|script_id
|Name of the script itself, only the first 8 characters are read.
|-
|3
|uint
|script_sector
|The "sector" of the script, and the value <code>switch(sector())</code> will return in def 0. Often used to determine whether a cutscene should be played as a flashback or not.
|}

=== 0x12d - supervision_ExecuteActingSub ===
Loads a specified Acting script from the specified level from within Unionall.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|Map LEVEL the script should be located in.
|-
|2
|ConstString
|script_id
|Name of the script itself, only the first 8 characters are read.
|-
|3
|uint
|script_sector
|The "sector" of the script, and the value <code>switch(sector())</code> will return in def 0. Often used to determine whether a cutscene should be played as a flashback or not.
|}

=== 0x12e - supervision_ExecuteCommon ===
Loads a specified Unionall coroutine from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|
|}

=== 0x12f - supervision_ExecuteEnter ===
Loads an Enter script from the specified level.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|level_id
|An entry in the Level list.
|}

=== 0x130 - supervision_ExecuteStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x131 - supervision_ExecuteStationCommon ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x132 - supervision_ExecuteStationCommonSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x133 - supervision_ExecuteStationSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x134 - supervision_ExecuteExport ===
Loads a specified Acting scene of the level S00P01A

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|script_id
|
|}

=== 0x135 - supervision_ExecuteExportSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|const
|
|}
=== 0x136 - supervision_LoadStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|}
=== 0x137 - supervision_Remove ===
Unloads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x138 - supervision_RemoveActing ===
Unloads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x139 - supervision_RemoveCommon ===
Unloads a sector of the Enter scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x13a - supervision_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x13b - supervision_Station ===
Loads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13c - supervision_StationCommon ===
Loads a sector of the Enter scene.

Can be used to call sectors of an enter scene within acting scenes!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13d - supervision_Suspend ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|unk0
|
|}
=== 0x13e - supervision2_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14c - Turn2Direction ===
Makes an actor rotate to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Direction
|direction
|The direction that the actor will turn to face.
|}

=== 0x14d - Turn2DirectionLives ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Entity
|actor_id
|The target actor that the actor will turn to face.
|}

=== 0x14e - Turn2DirectionLives2 ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|actor_id
|ID of the target actor from Level List that the actor will turn to face.
|}

=== 0x14f - Turn2DirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|-
|4
|uint
|unk6
|
|-
|5
|uint
|unk7
|
|}
=== 0x150 - Turn2DirectionTurn ===
Makes an actor turn at a certain angle.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|angle
|1: 45 degrees left, 2: 45 degrees right, 3: 90 degrees right, 4: 90 degrees left, 5: 180 degrees
|}

=== 0x151 - Turn3 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|unk3
|
|}
=== 0x152 - TurnDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x153 - TurnDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x154 - TurnDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x155 - TurnDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x156 - Unlock ===
Resumes the routine that was suspended when <code>Lock</code> was called with the specified ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x157 - Wait ===
Pauses the routine for a set number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames that the routine will wait for before resuming.
|}

=== 0x158 - WaitAnimation ===
Pauses the routine until the specified actor has finished its animation. After the actor finishes its animation, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x159 - WaitBackEffect ===
Pauses the current routine until [[List of Opcodes#0x2 - back SetBackEffect|back_SetBackEffect]] is called.

No parameters.
=== 0x15a - WaitBack2Effect ===
Pauses the current routine until [[List of Opcodes#0x12 - back2 SetBackEffect|back2_SetBackEffect]] is called.

No parameters.

=== 0x15b - WaitBgm ===
Pauses the current routine until the specified BGM on the first BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15c - WaitBgm2 ===
Pauses the current routine until the specified BGM on the second BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15d - WaitBgmSignal ===
Pauses the routine until a DSE event with ID 0xF6 on the current BGM track is triggered. This can be used to sync certain parts of the scene to the background music.

No parameters.
=== 0x15e - WaitEffect ===
Pauses the routine until the effect on the specified actor/peformer has ended. After the effect ends, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x15f - WaitEndAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x160 - WaitExecuteLives ===
Pauses the routine until the specified actor has finished its action (Move2Position, Slide2Position, etc.). After the actor finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|The actor that the routine will wait for.
|}

=== 0x161 - WaitExecuteObject ===
Pauses the current routine until the specified object has finished its action (Move2Position, Slide2Position, etc.). After the object finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|The ID of the object that the routine will wait for.
|}

=== 0x162 - WaitExecutePerformer ===
Pauses the current routine until the specified performer has finished its current action (Move2Position, Slide2Position, etc.) After the performer has finished its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|The ID of the performer that the routine will wait for.
|}

=== 0x163 - WaitFadeIn ===
Pauses the current routine and waits for the screen to fade in. After the screen fades in, the routine will resume.

No parameters.

=== 0x164 - WaitLockLives ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified actor's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Entity
|actor
|
|}

=== 0x165 - WaitLockObject ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified object's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Object
|object
|
|}

=== 0x166 - WaitLockPerformer ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified performer's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|uint
|performer
|
|}

=== 0x167 - WaitLockSupervision ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in <code>def 0</code>. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|}

=== 0x168 - WaitMe ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x169 - WaitMoveCamera ===
<TO DO: Opcode description>

No parameters.
=== 0x16a - WaitMoveCamera2 ===
<TO DO: Opcode description>

No parameters.
=== 0x16b - WaitRandom ===
Pauses the routine for a random number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration_min
|Minimum number of frames that the routine will wait for before resuming.
|-
|2
|uint
|duration_max
|Maximum number of frames that the routine will wait for before resuming.
|}

=== 0x16c - WaitScreenFade ===
Waits until screen_FadeIn finishes executing.

No parameters.
=== 0x16d - WaitScreenFadeAll ===
Waits until screen_FadeInAll finishes executing.

No parameters.
=== 0x16e - WaitScreen2Fade ===
Waits until screen2_FadeIn finishes executing.

No parameters.
=== 0x16f - WaitSe ===
Pauses the current routine until the specified sound effect has ended. After the sound effect ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|The ID of the sound to wait for the end of before resuming the routine.
|}

=== 0x170 - WaitSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x171 - WaitSubScreen ===
<TO DO: Opcode description>

No parameters.
=== 0x172 - WaitSubSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x173 - worldmap_BlinkMark ===
Shows a blinking world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x174 - worldmap_ChangeLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x175 - worldmap_DeleteArrow ===
Remove the yellow arrow from the world map.

No parameters.

=== 0x176 - worldmap_MoveCamera ===
Moves the camera to the specified world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x177 - worldmap_OffMessage ===
Removes a textbox with the world map marker's name from the Top Screen

No parameters.

=== 0x178 - worldmap_SetArrow ===
Shows an arrow pointing to a specified world map marker

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x179 - worldmap_SetCamera ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x17a - worldmap_SetLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x17b - worldmap_SetMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x17c - worldmap_SetMessage ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x17d - worldmap_SetMessagePlace ===
Shows a textbox on the Top Screen with the specified world map marker's name.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x17e - worldmap_SetMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}

== Other Opcodes ==
These opcodes cannot be directly called from ExplorerScript, since they are represented as higher-level constructs.

=== 0x28 - Branch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x29 - BranchBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2a - BranchDebug ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2b - BranchEdit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2c - BranchExecuteSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2d - BranchPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2e - BranchScenarioNow ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x2f - BranchScenarioNowAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x30 - BranchScenarioNowBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x31 - BranchScenarioAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x32 - BranchScenarioBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x33 - BranchSum ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x34 - BranchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|uint
|value
|
|-
|4
|uint
|jump_address
|
|}
=== 0x35 - BranchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|GameVar
|cmp_var
|
|-
|4
|uint
|jump_address
|
|}
=== 0x36 - BranchVariation ===
Used for demo cutscenes.

Jumps to the specified address if the first parameter is 0. On the demo version of the game, jumps if the first parameter is 3.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|Unknown. Always 3.
|-
|2
|uint
|jump_address
|Address to jump to.
|}
=== 0x37 - Call ===
Jumps to the specified address, runs code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the routine this opcode calls). Only one call can be stored at a time!

Use within macros is ill-advised, as using <code>return;</code> within a macro will just end the macro!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|The address to call, e.g., <code>call @label_0;</code> if <code>§label_0;</code> is defined in the script.
|}
=== 0x63 - Case ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|uint
|jump_address
|
|}
=== 0x64 - CaseMenu ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|choice
|
|-
|2
|uint
|jump_address
|
|}
=== 0x65 - CaseMenu2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint?
|choice?
|
|-
|2
|uint
|jump_address
|
|}
=== 0x66 - CaseScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x67 - CaseText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|String
|display
|
|}
=== 0x68 - CaseValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x69 - CaseVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|GameVar
|var
|
|-
|3
|uint
|jump_address
|
|}
=== 0x6e - DefaultText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x70 - End ===
<TO DO: Opcode description>

No parameters.
=== 0x74 - flag_CalcBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|value
|
|}
=== 0x75 - flag_CalcValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|uint
|value
|
|}
=== 0x76 - flag_CalcVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|GameVar
|var_to_set_from
|
|}
=== 0x77 - flag_Clear ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x78 - flag_Initial ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x79 - flag_Set ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|}
=== 0x7a - flag_ResetDungeonResult ===
<TO DO: Opcode description>

No parameters.
=== 0x7b - flag_ResetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x7c - flag_SetAdventureLog ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x7d - flag_SetDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|-
|2
|DungeonMode
|dungen_mode
|
|}
=== 0x7e - flag_SetDungeonResult ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x7f - flag_SetPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|}
=== 0x80 - flag_SetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|scenario_value
|
|-
|3
|uint
|level_value
|
|}
=== 0x82 - Hold ===
Will stall a script forever.

No parameters.
=== 0x87 - Jump ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|
|}
=== 0x89 - lives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|
|}
=== 0xaa - message_SwitchMenu ===
Enclose within a switch case, and generates a dialogue prompt with the options present in subsequent "case menu("text"):"

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|}
=== 0xab - message_SwitchMenu2 ===
Same as message_SwitchMenu, but it also takes an argument for a bitfield, and will only display dialogue options for which the corresponding bit is enabled (set to 1).

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|-
|3
|uint
|unk2
|Bitfield $VAR
|}
=== 0xac - message_SwitchMonologue ===
Structured similarly to a switch statement. Typically uses <code>$HERO_TALK_KIND</code> as an argument, and uses multiple cases to display certain dialogue strings.

<code>case 4:</code> used when the player is male or genderless

<code>case 5:</code> used when the player is female

<code>default:</code> used when <code>$HERO_TALK_KIND</code>'s Talk Group has a value other than 4 or 5

This opcode supports displaying a portrait. No sound effect is used when text is scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xad - message_SwitchTalk ===
Same as _SwitchMonologue, but typically uses <code>$PARTNER_TALK_KIND</code> as an argument, and the cases used vary.

Of the vanilla game partner options:

<code>case 1:</code> used if Squirtle, Tododile, Chimchar, Meowth, or Munchlax

<code>case 2:</code> used for all other male partners

<code>case 3:</code> used for all female partners

<code>default:</code> used when <code>$PARTNER_TALK_KIND</code>'s Talk Group has a value other than 1, 2, or 3

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xc9 - object ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|
|}
=== 0xcb - performer ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|
|}
=== 0xd5 - Return ===
If run from within a macro, ends the macro.

If run after the "call" opcode was used, will return to the address of the call opcode.

If used within a script, ends the script.

No parameters.
=== 0x13f - Switch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x140 - SwitchDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x141 - SwitchDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x142 - SwitchDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x143 - SwitchDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x144 - SwitchDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|}
=== 0x145 - SwitchLives ===
If inside a Switch Case, take the case equal to the species ID of the specified Actor!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0x146 - SwitchRandom ===
To be used in a switch statement. Will switch to a case of a random number below the specified integer.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|max_value
|Largest random output, plus 1
|}
=== 0x147 - SwitchScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x148 - SwitchScenarioLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x149 - SwitchSector ===
<TO DO: Opcode description>

No parameters.
=== 0x14a - SwitchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14b - SwitchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
{{NavScriptTerms}}
[[Category:Documentation]]