UI Apps

UI Apps are modular user interface components used to display full-screen menus, overlays, and other interactive screens.

[!WARNING] Sometimes UI apps depend on the game's internal UI state machine and flow block systems to initialize correctly. If you attempt to launch an app and it immediately closes, fails to open, or lacks its normal functionality, it is likely because the app requires you to use these.

[!WARNING] Some of these UI apps won't open visually and instead fire a UI event. Examples of this are the abilities and shop_menu apps. Those rely on transitions to function properly and will cause you to get softlocked if not handled properly.

How to Use UI Apps

To open these interfaces in your scripts, you can utilize the following native functions depending on whether you are using the app's string name or its hash, and whether you need to specify a starting entry point.

How to Use UI Apps > Launching by Hash

This method is used when the app has a default entry point or requires no specific entry state. Most UI apps have some sort of default entry state. Occasionally the default is to immediately close or not function properly.

LaunchUiappByHash(joaat("map"))

How to Use UI Apps > Launching with String Entry Points

Use this native when you want to directly pass the string names for both the app and the specific entry point. This is often the most readable method during development.

LaunchUiappWithEntry("progress_menu", "progress_compendium_animals")

How to Use UI Apps > Launching by Hash with Entry

This is the most performant way to launch an app into a specific state. By using the hashes of both the app and the entry point, you avoid the overhead of the game engine calculating hashes at runtime.

LaunchUiappByHashWithEntry(joaat("player_menu"), joaat("daily_challenges"))

Reference