QuizMenuTool Tutorial: Difference between revisions

Line 252:

== 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.

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, PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, will wipe $CONFIG_COLOR_KIND 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 $CONFIG_COLOR_KIND, then returned afterwards.

=== Upper Panel ===

Line 260:

=== 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 MENU_PARTNER_NAME 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 [K]. A message_Close(); 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 $VERSION, 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 $BIT_FUWARANTE_LOCAL 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

|$CONFIG_COLOR_KIND

|$LOCAL0

|If this Variable Meaning is present, $CONFIG_COLOR_KIND will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running "PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ".

|-

|Winning Pool

|$SCENARIO_SUB7

|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

|$SCENARIO_SUB6

|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

|$BIT_FUWARANTE_LOCAL[X]

|Any

|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to $PLAY_OLD_GAME, the variable responsible for the recruitment rate buff for playing Time/Darkness.

|-

|Direct Script Variable

|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: ==

Line 274:

Line 307:

=== Converting From StarterMenuTool ===

== Other Resources ==

=== QMT Script Variable Map ===

[[Category:Tutorials]]

@@ Line 252: / Line 252: @@
 == 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.
+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, PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ, will wipe $CONFIG_COLOR_KIND 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 $CONFIG_COLOR_KIND, then returned afterwards.
 === Upper Panel ===
@@ Line 260: / Line 260: @@
 === Hero Name, Partner Name, & Closing Remarks ===
-[[File:Hero-Partner-Closing Remarks Input.png|alt=Location of ExplorerScript Code Inputs.|center|thumb|600x600px|Location of ExplorerScript Code Inputs.]]
+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 MENU_PARTNER_NAME 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 [K]. A message_Close(); 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 ===
-[[File:Script Variable Preservation Panel.png|alt=Script Variable Preservation Panel Location.|center|thumb|600x600px|Script Variable Preservation Panel Location.]]
+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 $VERSION, 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 $BIT_FUWARANTE_LOCAL 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
+|$CONFIG_COLOR_KIND
+|$LOCAL0
+|If this Variable Meaning is present, $CONFIG_COLOR_KIND will be restored in post. It's only purpose is to prevent the quiz from wiping the variable on running  "PROCESS_SPECIAL_INIT_MAIN_TEAM_AFTER_QUIZ".
+|-
+|Winning Pool
+|$SCENARIO_SUB7
+|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
+|$SCENARIO_SUB6
+|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
+|$BIT_FUWARANTE_LOCAL[X]
+|Any
+|These correspond directly to the FUWARANTE blacklist, and in this example is used to pass forward the Time/Darkness question to $PLAY_OLD_GAME, 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: ==
@@ Line 274: / Line 307: @@
 === Converting From StarterMenuTool ===
+== Other Resources ==
+=== QMT Script Variable Map ===
 [[Category:Tutorials]]