Skip to content

PopUp Manager

NebSeniah edited this page Jun 17, 2026 · 9 revisions

System Summary

Descriptive summary of what the system is and what it does.

The PopUp Manager handles the creation and display of custom popup templates in the editor. It is primarily used for displaying error messages to the user, but it can also be used to display other types of messages as well (Templates and code would need to be created for more popUp types).


Connected Systems

List of connecting/parent/subsystems.

Connecting Systems:

  • No connected systems

Subsystems:

  • No subsystems

Related Controls

List of related controls.

Key(s): (key)

  • No controls

Bugs

List of known bugs. Be descriptive but keep it brief!

  • No bugs

Feature List / Breakdown of Features

List of features and descriptions within system.

Error Popup:

  • Popup message for errors that can be called anywhere in the script at long as a reference to PopUpManager exists
  • Greys out project behind popup and prevents interaction until resolved
  • Default generic message if no parameters filled out during creation
  • Popup scales with content inside

Important Variables

Name the most important variables, their type, and what their purpose is

  • ERROR_TEMPLATE: PackedScene = A preloaded and constant template for the popup message.

Important Functions

Name of the most important functions, their parameters, and what they do.

  • func create_error_popup(title: String, body: String) -> void: Creates an new popup with the given title and body for the message.

  • func create_multi_error_popup(title: String, body: Array[String]) -> void: Creates an new popup with the given title and a series of errors in body for the message.


Future Work / Risks

List and description of upcoming work/risks.

Future Work:

  1. Create new popup templates for other message types (if needed).

Risks:

  • No risks

Miscellaneous Notes

A place for miscellaneous notes pertaining to this system.

  • Code exists for a popup stack, but is currently commented out.

Clone this wiki locally