UI (functions)

More functions: Script Reference

The UI functions control UI elements, such as textboxes. Each UI function is run by using UI:[function]

Textbox

Subpage: UI (functions)/Textbox

Function	Description
WaitShowDialogue	Displays a dialogue box with text, waiting until the player completes it.
WaitShowTimedDialogue	Displays a dialogue box with text, waiting until the specified time has expired.
TextDialogue	Sets the current dialogue text to be shown. Requires WaitDialog to actually display.
WaitShowVoiceOver	Displays a voice over, waiting until the player completes it.
TextVoiceOver	Sets the current voice-over text to be shown. Requires WaitDialog to actually display.
TextPopUp	Makes text pop up in the bottom-left corner by default.
WaitShowTitle	Fades in a title text, waiting until the fade-in is complete.
TextShowTitle	Shows text in the format of a title drop. Requires WaitDialog to actually display.
WaitHideTitle	Fades out the currently displayed title, waiting until the fade-out is complete.
TextFadeTitle	Fades out the text set in a title drop. Requires WaitDialog to actually fade.
WaitDialog	Displays the currently set dialogue box and waits for the player to complete it.
_DummyWait	Instantly break. Used as default/invalid value when returning a yieldable value.

Textbox Settings

Subpage: UI (functions)/Textbox Settings

Function	Description
SetBounds	Sets the position and size of the dialogue box.
ResetBounds	Resets the position and size of the dialogue box.
SetCenter	Sets the centering of the text in the textbox.
SetAutoFinish	Makes the text automatically finish when it shows up.

Background

Subpage: UI (functions)/Background

Function	Description
WaitShowBG	Fades in a chosen background image, with a chosen framerate, at a certain fade time, waiting until the fade-in is complete.
ShowBG	Sets an image to display. Requires WaitDialog to actually display.
WaitHideBG	Fades out the current background image, waiting until the fade-out is complete.
FadeBG	Prepares a fade-out of the current image. Requires WaitDialog to actually display.

Speakers

Subpage: UI (functions)/Speakers

Function	Description
ResetSpeaker	Clears the current speaker, so none is displayed the next time TextDialogue is called.
SetSpeaker	Sets the speaker to be displayed during the following calls to the TextDialogue functions. It resets speaker emotion.
SetSpeakerReverse	Reverses the speaker orientation to face left instead of right. This depends on the boolean passed in.

Speaker Settings

Subpage: UI (functions)/Speaker Settings

Function	Description
SetSe	Sets the speaker sound effect and speak frames played in the TextDialogue functions.
SetSpeakTime	Sets the speak frames played in the TextDialogue functions.
ResetSe	Resets to the default speaker sound effect and speaker frames.
SetSpeakerLoc	Sets the position of the speaker in a dialogue box.
ResetSpeakerLoc	Resets the position of the speaker in a dialogue box.
SetSpeakerEmotion	Sets the emotion of the speaker in the dialogue box.

Choice Menu

Subpage: UI (functions)/Choice Menu

Function	Description
SetChoiceLoc	Sets the position of the choices for a question dialog.
ResetChoiceLoc	Sets the position of the choices for a question dialog back to default.
ChoiceMenuYesNo	Ask a question answered by yes or no via character dialogue to the player.
BeginChoiceMenu	Marks the start of a multi-choice menu.
BeginMultiPageMenu	Marks the start of a multi-paged choice menu.
ChoiceResult	Get the result of the last choice menu
GetChoiceAction	(undocumented)
WaitForChoice	Displays the currently set choice menu and waits for the player's selection to complete.
__WaitForChoice	Wait for choice and then CLEAN UP m_curchoice

Functional Menus

Subpage: UI (functions)/Functional Menus

Function	Description
NameMenu	Displays the name input box.
AssemblyMenu	Displays a menu for replacing party members with the assembly.
ShopMenu	Displays the Shop menu.
SellMenu	Displays the Sell menu.
StorageMenu	Displays the Storage menu for which to exchange items in the inventory with.
WithdrawMenu	Displays the Storage menu for which to withdraw from.
BankMenu	Displays the Bank menu.
SpoilsMenu	Displays the Spoils menu.
AppraiseMenu	Displays the Appraisal menu.
TutorTeamMenu	Displays the Tutor Team menu.
RelearnMenu	Displays the Relearn menu for a character.
LearnMenu	Displays the Learn menu for a character to replace an existing skill with a new one.
ForgetMenu	Displays the Forget menu for a character to forget a skill.
ShowPromoteMenu	Displays the Promote menu to choose a team member to promote.
CanSwapMenu	(Undocumented)
SwapMenu	(Undocumented)
TributeMenu	(Undocumented)
ShowMusicMenu	Displays the Music menu to browse music for the game.
DungeonChoice	Ask to enter a destintion via character dialogue to the player.
DestinationMenu	Marks the start of a choice menu for choosing destinations, showing a preview of restrictions and requirements for dungeons.
ChooseMonsterMenu	Marks the start of a choice menu for choosing monsters, showing a preview of their appearances via portrait.

Rescue Menus

Subpage: UI (functions)/Rescue Menus

Function	Description
ServersMenu	undocumented
ContactsMenu	undocumented
SOSMenu	undocumented
AOKMenu	undocumented
PeersMenu	undocumented
ShowConnectMenu	undocumented

Custom Menus

Subpage: UI (functions)/Custom Menus

Function	Description
SetCustomMenu	Displays a custom menu of the caller's choice.
BeginMultiPageMenu	Marks the start of a multi-paged choice menu.