Joshcamas: Created page with "Creating new UI elements is for now, quite simple. More complex UI features will be coming later. == Event Message == Event Message is text that appears on the top left of the screen. Can appear at any time in gameplay and in most menus. Messages will stack, and only a handful will appear at a time. === ShowMessage === Displays the message//Shows a simple text message. Will play a sound, and will stack. EventMessageInfoUI.ShowMessage(string m..."

2026-07-30T01:35:40Z

Created page with "Creating new UI elements is for now, quite simple. More complex UI features will be coming later. == Event Message == Event Message is text that appears on the top left of the screen. Can appear at any time in gameplay and in most menus. Messages will stack, and only a handful will appear at a time. === ShowMessage === Displays the message<syntaxhighlight lang="c#">//Shows a simple text message. Will play a sound, and will stack. EventMessageInfoUI.ShowMessage(string m..."

New page

Creating new UI elements is for now, quite simple. More complex UI features will be coming later.

== Event Message ==
Event Message is text that appears on the top left of the screen. Can appear at any time in gameplay and in most menus. Messages will stack, and only a handful will appear at a time.

=== ShowMessage ===
Displays the message<syntaxhighlight lang="c#">//Shows a simple text message. Will play a sound, and will stack.
EventMessageInfoUI.ShowMessage(string message);

//Shows a message with the more complex EventMessageUIMessageItem
EventMessageInfoUI.ShowMessage(EventMessageUIMessageItem message);</syntaxhighlight>

=== Event Message UI Message Item ===
<syntaxhighlight lang="c#">
EventMessageUIMessageItem:
string text // The text message
bool allowStacking = true // Whether duplicate messages will stack
bool playSound = true // Whether the message will display a sound when it appears
bool skipIfVisible // Whether to not display the message entirely if a duplicate one is visible
int stackCount = 1 // How many 'stacks' this message counts as (This is uncommonly used)
</syntaxhighlight>

== Alert Message UI ==
An alert message is a popup that pauses the game, and can appear at any time in gameplay or in any menu.

=== 'Ok' Alert ===
Displays an alert with a title (optional), text, and an ok button. You can hook into the button event. Supports AlertMessageSettings.<syntaxhighlight lang="c#">
AlertMessageUI.OpenAlertMessage(string title, string message, Action onOk = null, string customOkLabel = null, AlertMessageSettings settings = new AlertMessageSettings())
</syntaxhighlight>

=== Cancelable Alert ===
Displays an alert with a title (optional), text, and a ok + cancel button. You can hook into both button events. Supports AlertMessageSettings.<syntaxhighlight lang="c#">
AlertMessageUI.OpenCancelableAlertMessage(string title, string message, Action onOk, Action onCancel = null, string customOkLabel = null, string customCancelLabel = null, AlertMessageSettings settings = new AlertMessageSettings())
</syntaxhighlight>

=== No Buttons Alert ===
An alert with a title (optional), and text. No buttons. Supports AlertMessageSettings. Meant to be paired with Alert objects.<syntaxhighlight lang="c#">
AlertMessageUI.OpenNoButtonsAlertMessage(string title, string message, AlertMessageSettings settings = new AlertMessageSettings())
</syntaxhighlight>

=== Alert Message Settings ===
A few settings to modify an alert.

<u>onTopOfFader:</u> Makes the alert message appear on top of the fading screen. Useful to display narration popups.

<u>objects:</u> Allows you to register Alert Objects<syntaxhighlight lang="c#">
AlertMessageSettings:
bool onTopOfFader
List<AlertMessageObject> objects

</syntaxhighlight>

=== Other Methods ===
<syntaxhighlight lang="c#">
//Closes the current alert if there is one
void AlertMessageUI.CloseCurrentAlert();

//Returns whether an alert message is open
bool AlertMessageUI.IsOpen();

</syntaxhighlight>

=== Alert Objects ===
Add additional buttons, toggles, sliders, text input, dropdowns, and more.<syntaxhighlight lang="c#">
AlertMessageSliderObject:
string title
float min
float max
float value
bool isInt

AlertMessageToggleObject
string title
bool value

AlertMessageTextInputObject
string title
string value
int characterLimit
Func<string, bool> Validate

AlertMessageDropdownObject
string title
int value
List<TMP_Dropdown.OptionData> options

AlertMessageButtonObject
string title
string label
Action onClick

AlertMessageImageObject
string title
Sprite texture

</syntaxhighlight>

Creating UI - Revision history