UI - Revision history

Phil: /* Strings */

2026-09-03T21:12:33Z

Strings

← Older revision		Revision as of 21:12, 3 September 2026
Line 626:		Line 626:
	* <nowiki>for line breaks, you may alternatively use a ~ character in the string files or \n in literal strings in script</nowiki>		* <nowiki>for line breaks, you may alternatively use a ~ character in the string files or \n in literal strings in script</nowiki>
	* <nowiki><tabstopN> moves the rendering to the percent of the width of the output rectangle. e.g. <tabstop50> is the middle. Undefined behavior for non-single line text. If you are already past the tab point, it moves you back.</nowiki>		* <nowiki><tabstopN> moves the rendering to the percent of the width of the output rectangle. e.g. <tabstop50> is the middle. Undefined behavior for non-single line text. If you are already past the tab point, it moves you back.</nowiki>
			* <nowiki><right> right justify the rest of the line, turns off on next line.</nowiki>

	You can embed clickable links in a string by using		You can embed clickable links in a string by using

Phil: /* PROGRESS BAR */

2026-08-26T21:05:07Z

PROGRESS BAR

← Older revision		Revision as of 21:05, 26 August 2026
Line 274:		Line 274:
	NUBWIDTH <width> // defaults to 32		NUBWIDTH <width> // defaults to 32
	WHOLETEXTURE // boolean that denotes whether the texture is to be shown full sized across the progress bar.		WHOLETEXTURE // boolean that denotes whether the texture is to be shown full sized across the progress bar.
			SIMPLEIMAGE // boolean that draws the frame texture as a window if not set, otherwise just uses the given texture across the whole frame
	The WHOLETEXTURE tag means that whichever portion of the progress bar is shown, that will be the proportion of the texture shown. So any details on (the visible part of) the texture will remain in the same place as the progress value changes.		The WHOLETEXTURE tag means that whichever portion of the progress bar is shown, that will be the proportion of the texture shown. So any details on (the visible part of) the texture will remain in the same place as the progress value changes.

Phil: /* 3DOBJECT */

2026-05-13T20:14:05Z

3DOBJECT

← Older revision		Revision as of 20:14, 13 May 2026
Line 541:		Line 541:
	// places the name of the last mesh (or submesh) in the object that was picked into a working string (default index 0)		// places the name of the last mesh (or submesh) in the object that was picked into a working string (default index 0)
	GetUIObject3DLastPicked(objectName [, stringIndex])		GetUIObject3DLastPicked(objectName [, stringIndex])

			//set a texture on a 3DObject. Uses default texture path as per loading. If submesh named then only that submesh texture is changed
			SetUI3DObjectTexture(objectName, textureFile, [texturePath], [submeshName])
	</nowiki>		</nowiki>

Phil: /* Additional Common Tags */

2026-02-23T22:36:22Z

Additional Common Tags

← Older revision		Revision as of 22:36, 23 February 2026
Line 47:		Line 47:
	DRAGGABLE <size> // denotes that an object is draggable. Size is the height of draggable top border.		DRAGGABLE <size> // denotes that an object is draggable. Size is the height of draggable top border.
	DRAGLIMIT // limit the draggable object to the screen bounds during dragging		DRAGLIMIT // limit the draggable object to the screen bounds during dragging
			DRAGGABLEBY // values can be 1 (LMB), 2 (RMB), or 3 (both)
	FOCUS // can this object have focus (be moused over, clicked on, etc). Some objects (e.g. buttons) are always focus-able.		FOCUS // can this object have focus (be moused over, clicked on, etc). Some objects (e.g. buttons) are always focus-able.
	SFXFOCUS <id> // play the sound (based on the position in the sound list) when the object is moused over.		SFXFOCUS <id> // play the sound (based on the position in the sound list) when the object is moused over.

Phil: /* Additional Common Tags */

2026-01-30T17:44:58Z

Additional Common Tags

← Older revision		Revision as of 17:44, 30 January 2026
Line 46:		Line 46:
	<nowiki>		<nowiki>
	DRAGGABLE <size> // denotes that an object is draggable. Size is the height of draggable top border.		DRAGGABLE <size> // denotes that an object is draggable. Size is the height of draggable top border.
			DRAGLIMIT // limit the draggable object to the screen bounds during dragging
	FOCUS // can this object have focus (be moused over, clicked on, etc). Some objects (e.g. buttons) are always focus-able.		FOCUS // can this object have focus (be moused over, clicked on, etc). Some objects (e.g. buttons) are always focus-able.
	SFXFOCUS <id> // play the sound (based on the position in the sound list) when the object is moused over.		SFXFOCUS <id> // play the sound (based on the position in the sound list) when the object is moused over.

Phil: /* 3D Object */

2025-11-27T21:01:07Z

3D Object

← Older revision		Revision as of 21:01, 27 November 2025
Line 518:		Line 518:


	==== ~~3D Object~~ ====		==== 3DOBJECT ====

	A generic 3D object that is rendered to the center of the screen. It can have an animation file in the standard format.		A generic 3D object that is rendered to the center of the screen. It can have an animation file in the standard format.
Line 524:		Line 524:

	Tags:		Tags:
	<nowiki>		<nowiki>
	TEXPATH <path> - set the path that textures should be loaded from		TEXPATH <path> - set the path that textures should be loaded from
	ANIM <animName> - set a start anim for the object to play		ANIM <animName> - set a start anim for the object to play
	LOOPANIM - loop the animation		LOOPANIM - loop the animation
	SCALE - additional scale applied to the object on rendering		SCALE - additional scale applied to the object on rendering
	</nowiki>		</nowiki>

	Command that can be used:		Command that can be used:
	<nowiki>		<nowiki>
	SetUIObject3DAnim		SetUIObject3DAnim
	SetUIObject3DShaderValues		SetUIObject3DShaderValues
Line 539:		Line 539:
	// places the name of the last mesh (or submesh) in the object that was picked into a working string (default index 0)		// places the name of the last mesh (or submesh) in the object that was picked into a working string (default index 0)
	GetUIObject3DLastPicked(objectName [, stringIndex])		GetUIObject3DLastPicked(objectName [, stringIndex])
	</nowiki>		</nowiki>
	~~GetUIObject3DLastPicked~~

	== Object Commands ==		== Object Commands ==

Phil: /* Core Object Types */

2025-11-27T20:59:59Z

Core Object Types

@@ Line 516: / Line 516: @@
 //clear data from a PIECHART UI object
 ClearUIChartData(objectName)</nowiki>
 == Object Commands ==

Phil: /* Additional Common Tags */

2025-08-01T19:36:37Z

Additional Common Tags

← Older revision		Revision as of 19:36, 1 August 2025
Line 58:		Line 58:
	ATTACH <tags> // attach an object to a screen edge, with an optional (unscaled) offset. See below.		ATTACH <tags> // attach an object to a screen edge, with an optional (unscaled) offset. See below.
	KEEPONSCREEN <flags> // keep the object onscreen. Values for flags are 1 (ignore vertical), 2 (ignore horizontal), 4 (do both vertical and horizontal)		KEEPONSCREEN <flags> // keep the object onscreen. Values for flags are 1 (ignore vertical), 2 (ignore horizontal), 4 (do both vertical and horizontal)
	VALUE<N> <value> // user defined values, generally fed into the code. Zero based. Current max 8. value can be either decimal, or hex prefixed by 0x (e.g. 0xFFFFFFFF)		VALUE<N> <value> // user defined values, generally fed into the code. Zero based (from VALUE0). Current max 8. value can be either decimal, or hex prefixed by 0x (e.g. 0xFFFFFFFF)
	SQUAREASPECT // see below</nowiki>		SQUAREASPECT // see below</nowiki>
	SQUAREASPECT tells controls to maintain their aspect, along with all their children. This differs from the KEEPSQUARE logic in that the actual positioning of child objects will retain a constant aspect (rather than just their control dimensions, as with KEEPSQUARE). Effectively, setting SQUAREASPECT on a control will cause it to be centered around it's usual position, with all its children positions as they would have been in their 1024x768 defined coordinates. So a popup (for example) will have the same look and layout all screen resolutions, but will scale uniformly to the appropriate size. Note that while it is possible to turn off SQUAREASPECT on child objects of SQUAREASPECT parents, the results will likely be undesired.		SQUAREASPECT tells controls to maintain their aspect, along with all their children. This differs from the KEEPSQUARE logic in that the actual positioning of child objects will retain a constant aspect (rather than just their control dimensions, as with KEEPSQUARE). Effectively, setting SQUAREASPECT on a control will cause it to be centered around it's usual position, with all its children positions as they would have been in their 1024x768 defined coordinates. So a popup (for example) will have the same look and layout all screen resolutions, but will scale uniformly to the appropriate size. Note that while it is possible to turn off SQUAREASPECT on child objects of SQUAREASPECT parents, the results will likely be undesired.

Phil: /* Additional Common Tags */

2025-08-01T19:36:13Z

Additional Common Tags

← Older revision		Revision as of 19:36, 1 August 2025
Line 58:		Line 58:
	ATTACH <tags> // attach an object to a screen edge, with an optional (unscaled) offset. See below.		ATTACH <tags> // attach an object to a screen edge, with an optional (unscaled) offset. See below.
	KEEPONSCREEN <flags> // keep the object onscreen. Values for flags are 1 (ignore vertical), 2 (ignore horizontal), 4 (do both vertical and horizontal)		KEEPONSCREEN <flags> // keep the object onscreen. Values for flags are 1 (ignore vertical), 2 (ignore horizontal), 4 (do both vertical and horizontal)
			VALUE<N> <value> // user defined values, generally fed into the code. Zero based. Current max 8. value can be either decimal, or hex prefixed by 0x (e.g. 0xFFFFFFFF)
	SQUAREASPECT // see below</nowiki>		SQUAREASPECT // see below</nowiki>
	SQUAREASPECT tells controls to maintain their aspect, along with all their children. This differs from the KEEPSQUARE logic in that the actual positioning of child objects will retain a constant aspect (rather than just their control dimensions, as with KEEPSQUARE). Effectively, setting SQUAREASPECT on a control will cause it to be centered around it's usual position, with all its children positions as they would have been in their 1024x768 defined coordinates. So a popup (for example) will have the same look and layout all screen resolutions, but will scale uniformly to the appropriate size. Note that while it is possible to turn off SQUAREASPECT on child objects of SQUAREASPECT parents, the results will likely be undesired.		SQUAREASPECT tells controls to maintain their aspect, along with all their children. This differs from the KEEPSQUARE logic in that the actual positioning of child objects will retain a constant aspect (rather than just their control dimensions, as with KEEPSQUARE). Effectively, setting SQUAREASPECT on a control will cause it to be centered around it's usual position, with all its children positions as they would have been in their 1024x768 defined coordinates. So a popup (for example) will have the same look and layout all screen resolutions, but will scale uniformly to the appropriate size. Note that while it is possible to turn off SQUAREASPECT on child objects of SQUAREASPECT parents, the results will likely be undesired.

Phil: /* BUTTON */

2025-07-22T16:27:23Z

BUTTON

← Older revision		Revision as of 16:27, 22 July 2025
Line 152:		Line 152:
	CHECKBOXTICK <filename> // the name of the image containing the tick used when drawing a checkbox-style button		CHECKBOXTICK <filename> // the name of the image containing the tick used when drawing a checkbox-style button
	MARQUEE <0,1> // if text is too long for button, scroll horizontally over time (cannot be used with MULTILINE)</nowiki>		MARQUEE <0,1> // if text is too long for button, scroll horizontally over time (cannot be used with MULTILINE)</nowiki>
	For hotkeys, valid key values are A-Z and 0-9 as well as TAB, SPACE, RETURN, BACKSPACE, ~~ESC~~, LEFT, RIGHT, UP, DOWN, F1 - F12. You can also add required modifiers using +SHIFT and/or +CTRL. If using both must be +SHIFT+CTRL. No whitespace allowed in definition. You can automatically show hotkey definitions as tooltips (added in a new line after any defined tooltip). To enable this either add		For hotkeys, valid key values are A-Z and 0-9 as well as TAB, SPACE, RETURN, BACKSPACE, ESCAPE, LEFT, RIGHT, UP, DOWN, F1 - F12. You can also add required modifiers using +SHIFT and/or +CTRL. If using both must be +SHIFT+CTRL. No whitespace allowed in definition. You can automatically show hotkey definitions as tooltips (added in a new line after any defined tooltip). To enable this either add
	SHOWHOTKEYS 1		SHOWHOTKEYS 1
	To the UI settings file for the given flavour, or you can add SHOWHOTKEY to the specific object definition in its UI file. When showing these tooltip additions you can define a number of strings, all are optional:		To the UI settings file for the given flavour, or you can add SHOWHOTKEY to the specific object definition in its UI file. When showing these tooltip additions you can define a number of strings, all are optional: