UiPatchLib

UiPatchLib is a collection of functions that can dynamically modify the game's UI files without compromising mod compatibility. It is a mod that does nothing on it's own and is only used by other mods.

Example mod

Create your mod file ("ZS_vanilla\mods\config\code_patch\New Game Greeting.yaml") with following content:

gml_Object_obj_logo_screen_Create_0:

- type: append

ui_patch_add_replace_all("ZS_vanilla/ui/mm_sidebar_main.ui", "label = \"New Game\"", "label = \"Wheeee New Game!\"");

Documentation

Functions available:

// Simple string replacement patch

// - ui_file - relative file path to UI file (eg. "ZS_vanilla/ui/pda_hunter_skills_select.ui";

// - find - substring to find

// - replace - replacement string to use

// - name - optional name of this patch

ui_patch_add_replace_all(ui_file, find, replace, name = "");

// Example:

ui_patch_add_replace_all("ZS_vanilla/ui/mm_sidebar_main.ui", "label = \"New Game\"", "label = \"Wheeee\"", "MyFirstPatch");

// Simple string replacement patch, but if it fails to find, displays ingame warning message

// - ui_file - relative file path to UI file (eg. "ZS_vanilla/ui/pda_hunter_skills_select.ui";

// - find - substring to find

// - replace - replacement string to use

// - name - optional name of this patch

ui_patch_add_replace_all_verbose(ui_file, find, replace, name = "");

// Example:

ui_patch_add_replace_all_verbose("ZS_vanilla/ui/pda_hunter_skills_select.ui", "find this string", "replace with this string", "MyFirstPatch");

// Fully replace content of a UI file

// - ui_file - relative file path to UI file (eg. "ZS_vanilla/ui/pda_hunter_skills_select.ui";

// - ui_file_content - target content of the UI file

// - name - optional name of this patch

ui_patch_add_set_content(ui_file, ui_file_content, name = "");

// Example:

ui_patch_add_set_content("ZS_vanilla/ui/pda_hunter_skills_select.ui", "this is my content", "MyFirstPatch");

// Generic callback function patch

// - ui_file - relative file path to UI file (eg. "ZS_vanilla/ui/pda_hunter_skills_select.ui";

// - __Name - name of the patch (eg. "MyPatch")

// - __Function - callback function that will modify the content of ui_file.

//   It will be executed with 3 arguments:

//   - argument0 - previously provided __Name

//   - argument1 - current content of the UI file

//   - argument2 - previously provided __Args

//   The string value returned by this function will be used as the new content of the UI file.

// - __Args - arguments provided to the function

// - __ExceptionHandler - optional, function to be executed when the body of the function throws an error (eg. scr_draw_text_with_box)

//  - function has to accept at least 1 argument

ui_patch_add(ui_file, __Name, __Function, __Args, __ExceptionHandler = "");

// Example:

ui_patch_add(

"ZS_vanilla/ui/pda_hunter_skills_select.ui",

"MyPatch_To_Replace_Content_Of_pda_hunter_skills_select.ui",

function(_name, _original_content, _args) {

return _args;

["this is my new content"],

scr_draw_text_with_box // optional exception handler