Editing Custom level creation/ui.txt

{{Breadcrumbs|Alpha Branch|Custom level creation}}
The <code>ui.txt</code> is used to define text and image metadata used by the bottom flyout panel, and can be manipulated from within the [[Custom level creation/test.si|<code>test.si</code>]] test code.  It has a relatively simple structure in comparison to the other files used for custom level creation.  Each entry is a single line enclosed in square brackets (<code>[]</code>).  There are currently only two valid entry types:
<pre>
[text id="text_id" text="Any text you wish to display" font=mono size=24 align=left x=78 y=90 hidden=true]
[image id="image_id" file="filename.png" x=78 y=90 hidden=true]
</pre>
{{note|type=info|<code>ui.txt</code> is not hot-reloaded, even upon level change.  You will need to restart the game to pick up changes to this file.}}

== Text metadata ==
<pre>
[text id="text_id" text="Any text you wish to display" font=mono size=24 align=left x=78 y=90 hidden=true]
</pre>
* <code>id</code> An identifier that can be used by the test code to reference the text object.
* <code>text</code> The text to be displayed.
* <code>font</code> The font face.  Currently only <code>mono</code> is supported.  Any other option will use the game's normal font.
* <code>size</code> The font size.  The game's standard size is 24.
* <code>align</code> The text alignment.  Can be <code>left</code> or <code>right</code>.  The default is centered text.
** {{note}} The alignment is measured from center, so <code>left</code> aligned grows from center to the right, and <right> aligned grows from center to the left.  This can make it appear like the values are reversed if you're not expecting it!
* <code>x</code> The horizontal offset of the text from the center of the panel (negative values are left).
* <code>y</code> The vertical offset of the text from the top of the panel (negative values are up - above the panel itself).
* <code>hidden</code> If true, the text will not be displayed until the test code changes this property to false.

== Image metadata ==
{{note|type=warn|Images currently need to be compiled into the game files.  Simply including them in your level directory is not sufficient and attempting to reference such a file will result in the game crashing on startup.}}
{{note|type=info|You can reuse images from existing levels using normal path navigation (eg: <code>../sort/0.png</code> for a slice of pie on a plate).

This should not be considered a viable long-term solution as your level becomes dependent both on the other level(s) not changing their images, and also on the game not enforcing directory locality in the future.  It can be a good placeholder during development however, and if your level is accepted into the base game you can replace the temporary image references with valid ones at that time.}}
<pre>
[image id="image_id" file="filename.png" x=78 y=90 hidden=true]
</pre>
* <code>id</code> An identifier that can be used by the test code to reference the image object.
* <code>filename</code> The name of the file to load.
* <code>x</code> The horizontal offset of the image from the center of the panel (negative values are left).
* <code>y</code> The vertical offset of the image from the top of the panel (negative values are up - above the panel itself).
* <code>hidden</code> If true, the image will not be displayed until the test code changes this property to false.