Compass List
Compass lists are similar to lists, but map their items to cardinal directions for selection.
Properties
System
| Name | Explanation | Type |
|---|
| Name | The name of the element. | String |
Appearance
| Name | Explanation | Type |
|---|
| Is Visible | Whether or not the element is visible. | Toggle |
| Hide When Unfocused | Whether or not to hide the element when it becomes unfocused | Toggle |
Cursor Appearance
| Name | Explanation | Type |
|---|
| Sprite | The sprite to display in the element. | Sprite |
| Type | The method of displaying the cursor on the element | Strategy |
| Cursor Mask Strategy | The strategy used to compose the masked cursor on the element. | Skin Strategy |
| Color Mask | The color mask to apply to the cursor on the element. | Color |
| Cursor Mask Margin | The margin to apply to the cursor on the element. | Number |
| Cursor Offset | The amount in pixels to offset the cursor on the element. | Number |
| Cursor Fits Contents | Whether or not the cursor is stretched to fit the currently selected item in the element. | Toggle |
| Animate Cursor When Unfocused | Whether or not to animate the cursor when the element is unfocused | Toggle| |
| Hide Cursor When Unfocused | Whether or not to hide the cursor when the element is unfocused. | Toggle |
| Require Key Selection | Whether or not the appropriate key is required to maintain the selection. | Toggle |
| Renders in Background | Whether or not the cursor renders behind the selected item. | Toggle |
Cursor Sound Effects
| Name | Explanation | Type |
|---|
| Use Default Sounds | Whether or not to use the default system sound effects. | Toggle |
| Movement Sound Effect | The sound to play when a cursor moves. | Sound Effect? |
| Confirm Sound Effect | The sound to play when confirmation occurs. | Sound Effect? |
| Buzzer Sound Effect | The sound to play when an invalid action occurs. | Sound Effect? |
Item Appearance
| Name | Explanation | Type |
|---|
| Font Family | The font family of the text in the element. | Font Family |
| Font Size | The font size of the text in the element. | Number |
| Color | The color of the text in the element. | Color |
| Use Drop Shadow | Whether or not to use a drop shadow on the text in the element. | Toggle |
| Drop Shadow Color | The drop shadow color of the text in the element. | Color |
| Drop Shadow Offset | The amount in pixels to offset the drop shadow for the text in the element. | Number |
| Text Horizontal Alignment | The horizontal alignment of the text in the element. | Alignment |
| Text Vertical Alignment | The vertical alignment of the text in the element. | Alignment |
| Text Margin Left | The left margin in pixels of the text in the element. | Number |
| Text Margin Top | The top margin in pixels of the text in the element. | Number |
| Text Margin Right | The right margin in pixels of the text in the element. | Number |
| Text Margin Bottom | The bottom margin in pixels of the text in the element. | Number |
| Sprite Horizontal Alignment | The horizontal alignment of the sprite or image in the element. | Alignment |
| Sprite Margin Left | The left margin in pixels of the sprite or image in the element. | Number |
| Sprite Margin Right | The right margin in pixels of the sprite or image in the element. | Number |
| Sprite Margin Top | The top margin in pixels of the sprite or image in the element. | Number |
| Sprite Margin Bottom | The bottom margin in pixels of the sprite or image in the element. | Number |
| Sprite Vertical Alignment | The vertical alignment of the sprite or image in the element. | Alignment |
Position
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the element. | Toggle |
| Pixel X | The x coordinate in pixels of the element. | Number |
| Pixel Y | The y coordinate in pixels of the element. | Number |
| Pixel Width | The width in pixels of the element. | Number |
| Pixel Height | The height in pixels of the element. | Number |
| Relative X | The x coordinate relative to the container of the element. | Number |
| Relative Y | The y coordinate relative to the container of the element. | Number |
| Relative Width | The width relative to the container of the element. | Number |
| Relative Height | The height relative to the container of the element. | Number |
| Margin Left | The left margin in pixels of the element. | Number |
| Margin Right | The right margin in pixels of the element. | Number |
| Margin Top | The top margin in pixels of the element. | Number |
| Margin Bottom | The bottom margin in pixels of the element. | Number |
Gauge
Gauges display values as ratios or percentages, either vertically or horizontally.
Properties
System
| Name | Explanation | Type |
|---|
| Name | The name of the element. | String |
Appearance
| Name | Explanation | Type |
|---|
| Is Visible | Whether or not the element is visible. | Toggle |
| Current Value | The templated value to leverage to control the current value of the gauge. | String |
| Minimum Value | The templated value to leverage to control the minimum value of the gauge. | String |
| Maximum Value | The templated value to leverage to control the maximum value of the gauge. | String |
| Start | The sprite to use for the start of the gauge. | Sprite |
| End | The sprite to use for the end of the gauge. | Sprite |
| Fill | The sprite to use for the filled area between the start and end of the gauge. | Sprite |
| Fill Strategy | The method of utilizing the Fill to fill between the start and end of the gauge. | Fill Strategy |
| Alignment | The anchor of the gauge. | Alignment |
| Orientation | The orientation of the gauge. | Orientation |
| Color Mask | The color mask to apply to the element. | Color |
| Maintain Limits | Whether or not to prevent the gauge from growing beyond the minimum or maximum values. | Toggle |
Context
| Name | Explanation | Type |
|---|
| Is Linked to Selected Context | Whether or not the context is linked to the current selection in the user interface. | Toggle |
| Is Linked to UI Context | Whether or not the context is linked to the user interface. | Toggle |
| Template Type | The data type to expect for templating.
Note: This is not used by the engine and only assists in providing suggestions in the Template. | Data Type? |
Position
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the element. | Toggle |
| Pixel X | The x coordinate in pixels of the element. | Number |
| Pixel Y | The y coordinate in pixels of the element. | Number |
| Pixel Width | The width in pixels of the element. | Number |
| Pixel Height | The height in pixels of the element. | Number |
| Relative X | The x coordinate relative to the container of the element. | Number |
| Relative Y | The y coordinate relative to the container of the element. | Number |
| Relative Width | The width relative to the container of the element. | Number |
| Relative Height | The height relative to the container of the element. | Number |
| Margin Left | The left margin in pixels of the element. | Number |
| Margin Right | The right margin in pixels of the element. | Number |
| Margin Top | The top margin in pixels of the element. | Number |
| Margin Bottom | The bottom margin in pixels of the element. | Number |
List
Lists are used to setup simple, fixed selectable options. A more extensible version, the Templated List, can be used to display highly configurable, variable selectable options.
Properties
System
| Name | Explanation | Type |
|---|
| Name | The name of the element. | String |
Appearance
| Name | Explanation | Type |
|---|
| Is Visible | Whether or not the element is visible. | Toggle |
| Orientation | The direction of the items composition in the element. | Orientation |
| Enable Looping | Whether or not the items in the element loop to the beginning after reaching the end and vice versa. | Toggle |
| Hide When Unfocused | Whether or not to hide the element when it becomes unfocused. | Toggle |
Cursor Appearance
| Name | Explanation | Type |
|---|
| Sprite | The sprite to use for the cursor on the element. | Sprite |
| Type | The method of displaying the cursor on the element. | Cursor Type |
| Cursor Mask Strategy | The strategy used to compose the masked cursor on the element. | Skin Strategy |
| Color Mask | The color mask to apply to the cursor on the element. | Color |
| Cursor Mask Margin | The margin to apply to the cursor on the element. | Number |
| Cursor Offset | The amount in pixels to offset the cursor on the element. | Number |
| Cursor Fits Contents | Whether or not the cursor is stretched to fit the currently selected item in the element. | Toggle |
| Animate Cursor When Unfocused | Whether or not to animate the cursor when the element is unfocused. | Toggle |
| Hide Cursor When Unfocused | Whether or not to hide the cursor when the element is unfocused. | Toggle |
| Renders in Background | Whether or not the cursor renders behind the selected item. | Toggle |
Cursor Sound Effects
| Name | Explanation | Type |
|---|
| Use Default Sounds | Whether or not to use the default system sound effects. | Toggle |
| Movement Sound Effect | The sound to play when a cursor moves. | Sound Effect? |
| Confirm Sound Effect | The sound to play when confirmation occurs. | Sound Effect? |
| Buzzer Sound Effect | The sound to play when an invalid action occurs. | Sound Effect? |
Item Appearance
| Name | Explanation | Type |
|---|
| Font Family | The font family of the text in the element. | Font Family |
| Font Size | The font size of the text in the element. | Number |
| Color | The color of the text in the element. | Color |
| Use Drop Shadow | Whether or not to use a drop shadow on the text in the element. | Toggle |
| Drop Shadow Color | The drop shadow color of the text in the element. | Color |
| Drop Shadow Offset | The amount in pixels to offset the drop shadow for the text in the element. | Number |
| Text Horizontal Alignment | The horizontal alignment of the text in the element. | Alignment |
| Text Vertical Alignment | The vertical alignment of the text in the element. | Alignment |
| Text Margin Left | The left margin in pixels of the text in the element. | Number |
| Text Margin Top | The top margin in pixels of the text in the element. | Number |
| Text Margin Right | The right margin in pixels of the text in the element. | Number |
| Text Margin Bottom | The bottom margin in pixels of the text in the element. | Number |
| Sprite Horizontal Alignment | The horizontal alignment of the sprite or image in the element. | Alignment |
| Sprite Margin Left | The left margin in pixels of the sprite or image in the element. | Number |
| Sprite Margin Right | The right margin in pixels of the sprite or image in the element. | Number |
| Sprite Margin Top | The top margin in pixels of the sprite or image in the element. | Number |
| Sprite Margin Bottom | The bottom margin in pixels of the sprite or image in the element. | Number |
| Sprite Vertical Alignment | The vertical alignment of the sprite or image in the element. | Alignment |
Item Details
| Name | Explanation | Type |
|---|
| Use Item Sizing | Whether or not item sizing is defined rather than automatically calculated. | Toggle |
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the item in the element. | Toggle |
| Pixel Width | The width in pixels of the item in the element. | Number |
| Pixel Height | The height in pixels of the item in the element. | Number |
| Relative Width | The width relative to the templated list of the item. | Number |
| Relative Height | The height relative to the templated list of the item. | Number |
Position
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the element. | Toggle |
| Pixel X | The x coordinate in pixels of the element. | Number |
| Pixel Y | The y coordinate in pixels of the element. | Number |
| Pixel Width | The width in pixels of the element. | Number |
| Pixel Height | The height in pixels of the element. | Number |
| Relative X | The x coordinate relative to the container of the element. | Number |
| Relative Y | The y coordinate relative to the container of the element. | Number |
| Relative Width | The width relative to the container of the element. | Number |
| Relative Height | The height relative to the container of the element. | Number |
| Margin Left | The left margin in pixels of the element. | Number |
| Margin Right | The right margin in pixels of the element. | Number |
| Margin Top | The top margin in pixels of the element. | Number |
| Margin Bottom | The bottom margin in pixels of the element. | Number |
Scripts
| Name | Explanation | Type |
|---|
| Focused | The script to execute when the element gains focus. | Script |
| Unfocused | The script to execute when the element loses focus. | Script |
Item Properties
Appearance
| Name | Explanation | Type |
|---|
| Text | The text to display in the element. | String |
| Sprite | The sprite to display in the element. | Sprite or Model |
| Use Sprite Only | Whether or not to display the sprite or image only. | Toggle |
| Use Space if Hidden | Whether or not to occupy the space if the item is not rendered. | Toggle |
| Color Mask | The color of the text to override in the element. | Color |
| Override Styles | Whether or not the item should use different styling from what was specified in the list element. | Toggle |
| Text Margin Left | The left margin in pixels of the text to override in the element. | Number |
| Text Margin Right | The right margin in pixels of the text to override in the element. | Number |
| Text Margin Top | The top margin in pixels of the text to override in the element. | Number |
| Text Margin Bottom | The bottom margin in pixels of the text to override in the element. | Number |
| Sprite Horizontal Alignment | The horizontal alignment of the sprite or image to override in the element. | Alignment |
| Sprite Vertical Alignment | The vertical alignment of the sprite or image to override in the element. | Alignment |
| Sprite Margin Left | The left margin in pixels of the sprite or image to override in the element. | Number |
| Sprite Margin Top | The top margin in pixels of the sprite or image to override in the element. | Number |
| Sprite Margin Right | The right margin in pixels of the sprite or image to override in the element. | Number |
| Sprite Margin Bottom | The bottom margin in pixels of the sprite or image to override in the element. | Number |
Disabled Effect
| Name | Explanation | Type |
|---|
| Color Mask | The color of the text to override in the element. | Color |
| Grayscale | Whether or not to apply greyscale tone to the element. | Toggle |
| Invert Condition Value | Whether or not to invert the value of the relevant element. | Toggle |
| Opacity | The opacity of the element. | Number |
| Switch | The global switch to leverage for the disabled effect. | Switch |
| Use Effect | Whether or not to use the effect. | Toggle |
| Use Switch | Whether or not to use a global switch to control the accessibility of the element. | Toggle |
| Visible | Whether or not the element should be visible when disabled. | Toggle |
Scripts
| Name | Explanation | Type |
|---|
| Execute | The script to execute when the item is selected. | Script |
| Focused | The script to execute when the item gains focus. | Script |
| Unfocused | The script to execute when the item loses focus. | Script |
Pane
Panes are used to show a background pattern or border.
Properties
System
| Name | Explanation | Type |
|---|
| Name | The name of the element. | String |
Appearance
| Name | Explanation | Type |
|---|
| Is Visible | Whether or not the element is visible. | Toggle |
| Background | The image to display as a background in the element. | Sprite |
| Strategy | The strategy used to compose the background. | Skin Strategy |
| Color Mask | The color mask to apply to the element. | Color |
| Hue Shift | The hue shift to apply to the element. | Number |
Context
| Name | Explanation | Type |
|---|
| Is Linked to Selected Context | Whether or not the context is linked to the current selection in the user interface. | Toggle |
| Is Linked to UI Context | Whether or not the context is linked to the user interface. | Toggle |
| Template Type | The data type to expect for templating.
Note: This is not used by the engine and only assists in providing suggestions in the Template. | Data Type? |
Position
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the element. | Toggle |
| Pixel X | The x coordinate in pixels of the element. | Number |
| Pixel Y | The y coordinate in pixels of the element. | Number |
| Pixel Width | The width in pixels of the element. | Number |
| Pixel Height | The height in pixels of the element. | Number |
| Relative X | The x coordinate relative to the container of the element. | Number |
| Relative Y | The y coordinate relative to the container of the element. | Number |
| Relative Width | The width relative to the container of the element. | Number |
| Relative Height | The height relative to the container of the element. | Number |
| Margin Left | The left margin in pixels of the element. | Number |
| Margin Top | The top margin in pixels of the element. | Number |
| Margin Right | The right margin in pixels of the element. | Number |
| Margin Bottom | The bottom margin in pixels of the element. | Number |
Picture
Pictures are used to show static images or sprites, including animated, in a user interface.
Properties
System
| Name | Explanation | Type |
|---|
| Name | The name of the element. | String |
Appearance
| Name | Explanation | Type |
|---|
| Image | The static image to display in the element. | Image |
| Sprite | The sprite to display in the element. | Sprite |
| Template | The template details for the element. | String |
| Is Visible | Whether or not the element is visible upon load. | Toggle |
| Stretch to Boundaries | Whether or not to stretch the image or sprite to fit the size of the element. | Toggle |
| Horizontal Alignment | The horizontal alignment of the element. | Alignment |
| Vertical Alignment | The vertical alignment of the element. | Alignment |
| Color Mask | The color mask to apply to the element. | Color |
| Hue Shift | The hue shift to apply to the element. | Number |
Context
| Name | Explanation | Type |
|---|
| Is Linked to Selected Context | Whether or not the context is linked to the current selection in the user interface. | Toggle |
| Is Linked to UI Context | Whether or not the context is linked to the user interface. | Toggle |
| Template Type | The data type to expect for templating.
Note: This is not used by the engine and only assists in providing suggestions in the Template. | Data Type? |
Position
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the element. | Toggle |
| Pixel X | The x coordinate in pixels of the element. | Number |
| Pixel Y | The y coordinate in pixels of the element. | Number |
| Pixel Width | The width in pixels of the element. | Number |
| Pixel Height | The height in pixels of the element. | Number |
| Relative X | The x coordinate relative to the container of the element. | Number |
| Relative Y | The y coordinate relative to the container of the element. | Number |
| Relative Width | The width relative to the container of the element. | Number |
| Relative Height | The height relative to the container of the element. | Number |
| Margin Left | The left margin in pixels of the element. | Number |
| Margin Top | The top margin in pixels of the element. | Number |
| Margin Right | The right margin in pixels of the element. | Number |
| Margin Bottom | The bottom margin in pixels of the element. | Number |
Slider
Sliders allow numeric values to be altered up or down.
Properties
System
| Name | Explanation | Type |
|---|
| Name | The name of the element. | String |
Cursor
| Name | Explanation | Type |
|---|
| Sprite | The sprite to use for the current position on the slider | Sprite |
| Cursor Offset | The amount in pixels to offset the cursor on the element. | Number |
| Hide Cursor When Unfocused | Whether or not to hide the cursor when the element is unfocused. | Toggle |
Cursor Sound Effects
| Name | Explanation | Type |
|---|
| Use Default Sounds | Whether or not to use the default system sound effects. | Toggle |
| Movement Sound Effect | The sound to play when a cursor moves. | Sound Effect? |
| Confirm Sound Effect | The sound to play when confirmation occurs. | Sound Effect? |
Appearance
| Name | Explanation | Type |
|---|
| Is Visible | Whether or not the element is visible. | Toggle |
| Fill | The sprite to use for the filled area between the start and end of the slider. | Sprite |
| Fill Strategy | The method of utilizing the Fill to fill between the start and end of the slider. | Strategy |
| Color Mask | The color mask to apply to the element. | Color |
| Minimum Value | The Value to leverage to control the minimum value of the slider. | Variable or Value |
| Maximum Value | The value to leverage to control the maximum value of the slider. | Variable or Value |
| Current Value | The current value to leverage to control the minimum value of the slider | Variable |
| Change | The value to leverage to control the change of the value of the slider. | Variable or Value |
| Orientation | The orientation of the slider. | Orientation |
| Animate When Unfocused | Whether or not to animate the cursor and fill when unfocused. | Toggle |
| Invert Direction | Whether or not to invert the direction of the slider | Toggle |
| Use Floating Points | Whether or not to use floating points when evaluating the values. | Toggle |
| Use Integers | Whether or not to use integers when evaluating the values. | Toggle |
Position
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the element. | Toggle |
| Pixel X | The x coordinate in pixels of the element. | Number |
| Pixel Y | The y coordinate in pixels of the element. | Number |
| Pixel Width | The width in pixels of the element. | Number |
| Pixel Height | The height in pixels of the element. | Number |
| Relative X | The x coordinate relative to the container of the element. | Number |
| Relative Y | The y coordinate relative to the container of the element. | Number |
| Relative Width | The width relative to the container of the element. | Number |
| Relative Height | The height relative to the container of the element. | Number |
| Margin Left | The left margin in pixels of the element. | Number |
| Margin Top | The top margin in pixels of the element. | Number |
| Margin Right | The right margin in pixels of the element. | Number |
| Margin Bottom | The bottom margin in pixels of the element. | Number |
Templated List
Templated lists are used to setup dynamic selectable options. They are Context? driven, which allows for properties of different data types to be displayed.
Properties
System
| Name | Explanation | Type |
|---|
| Name | The name of the element. | String |
Appearance
| Name | Explanation | Type |
|---|
| Is Visible | Whether or not the element is visible upon load. | Toggle |
| Orientation | The direction of the items composition in the element. | Orientation |
| Enable Looping | Whether or not the items in the element loop to the beginning after reaching the end and vice versa. | Toggle |
| Hide When Unfocused | Whether or not to hide the element when it becomes unfocused. | Toggle |
| Template Type | The data type to expect for templating.
Note: This is not used by the engine and only assists in providing suggestions in the Template. | Data Type? |
Context
| Name | Explanation | Type |
|---|
| Custom Context | The custom context property to use on the element. | String |
| Use Custom Context | Whether or not to use a custom context property on the element. | Toggle |
Cursor Appearance
| Name | Explanation | Type |
|---|
| Sprite | The sprite to use for the cursor on the element. | Sprite |
| Type | The method of displaying the cursor on the element. | Cursor Type |
| Cursor Mask Strategy | The strategy used to compose the masked cursor on the element. | Skin Strategy |
| Color Mask | The color mask to apply to the cursor on the element. | Color |
| Cursor Mask Margin | The margin to apply to the cursor on the element. | Number |
| Cursor Offset | The amount in pixels to offset the cursor on the element. | Number |
| Animate Cursor When Unfocused | Whether or not to animate the cursor when the element is unfocused. | Toggle |
| Hide Cursor When Unfocused | Whether or not to hide the cursor when the element is unfocused. | Toggle |
| Renders In Background | Whether or not the sursor renders behind the selected item. |
Cursor Sound Effects
| Name | Explanation | Type |
|---|
| Use Default Sounds | Whether or not to use the default system sound effects. | Toggle |
| Movement Sound Effect | The sound to play when a cursor moves. | Sound Effect? |
| Confirm Sound Effect | The sound to play when confirmation occurs. | Sound Effect? |
| Buzzer Sound Effect | The sound to play when an invalid action occurs. | Sound Effect? |
Item Details
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the item in the element. | Toggle |
| Item Components | Enables the item component editor. | |
| Margin Left | The left margin in pixels of the item in the element. | Number |
| Margin Top | The top margin in pixels of the item in the element. | Number |
| Margin Right | The right margin in pixels of the item in the element. | Number |
| Margin Bottom | The bottom margin in pixels of the item in the element. | Number |
| Pixel Width | The width in pixels of the item in the element. | Number |
| Pixel Height | The height in pixels of the item in the element. | Number |
| Relative Width | The width relative to the templated list of the item. | Number |
| Relative Height | The height relative to the templated list of the item. | Number |
Item Disabled Effect
| Name | Explanation | Type |
|---|
| Use Effect | Whether or not to use the effect. | Toggle |
| Visible | Whether or not the item should be visible when disabled. | Toggle |
| Grayscale | Whether or not to apply a grayscale tone to the item in the element. | Toggle |
| Color Mask | The color mask to apply to the item in the element. | Color |
| Invert Condition Value | Whether or not to invert the value of the relevant property. | Toggle |
| Opacity | The opacity of the item in the element. | Number |
| Use Switch | Whether or not to use a global switch to control the accessibility of the item. | Toggle |
| Switch | The global switch to leverage for the disabled effect. | Switch |
| Template | The templated value to leverage for the disabled effect. | String |
| Use Template Value | Whether or not to use a templated value to control the accessibility of the item. | Toggle |
Position
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the element. | Toggle |
| Pixel X | The x coordinate in pixels of the element. | Number |
| Pixel Y | The y coordinate in pixels of the element. | Number |
| Pixel Width | The width in pixels of the element. | Number |
| Pixel Height | The height in pixels of the element. | Number |
| Relative X | The x coordinate relative to the container of the element. | Number |
| Relative Y | The y coordinate relative to the container of the element. | Number |
| Relative Width | The width relative to the container of the element. | Number |
| Relative Height | The height relative to the container of the element. | Number |
| Margin Left | The left margin in pixels of the element. | Number |
| Margin Top | The top margin in pixels of the element. | Number |
| Margin Right | The right margin in pixels of the element. | Number |
| Margin Bottom | The bottom margin in pixels of the element. | Number |
Scripts
| Name | Explanation | Type |
|---|
| Execute | The script to execute when an item is selected. | Script |
| Focused | The script to execute when the templated list gains focus. | Script |
| Item Focused | The script to execute when an item gains focus. | Script |
| Item Unfocused | The script to execute when an item loses focus. | Script |
| Unfocused | The script to execute when the templated list loses focus. | Script |
Text
Text is used to display text or text patterns.
Properties
System
| Name | Explanation | Type |
|---|
| Name | The name of the element. | String |
Appearance
| Name | Explanation | Type |
|---|
| Is Visible | Whether or not the element is visible upon load. | Toggle |
| Font Family | The font family of the text in the element. | Font Family |
| Font Size | The font size of the text in the element. | Number |
| Color | The color of the text in the element. | Color |
| Text | The text to display in the element. | String |
| Horizontal Alignment | The horizontal alignment of the text in the element. | Alignment |
| Vertical Alignment | The vertical alignment of the text in the element. | Alignment |
| Use Word Wrapping | Whether or not to wrap text to fit cleanly on multiple lines. | Toggle |
| Use Drop Shadow | Whether or not to use a drop shadow on the text in the element. | Toggle |
| Drop Shadow Color | The drop shadow color of the text in the element. | Color |
| Drop Shadow Offset | The amount in pixels to offset the drop shadow for the text in the element. | Number |
Context
| Name | Explanation | Type |
|---|
| Is Linked to Selected Context | Whether or not the context is linked to the current selection in the user interface. | Toggle |
| Is Linked to UI Context | Whether or not the context is linked to the user interface. | Toggle |
| Template Type | The data type to expect for templating.
Note: This is not used by the engine and only assists in providing suggestions in the Template. | Data Type? |
Effects
| Name | Explanation | Type |
|---|
| Character Delay (milliseconds) | The number of milliseconds to wait before displaying the next character in the text | Number |
| Character Sound | The sound effect to play when each character displays in the text. | Sound Effect? |
Position
| Name | Explanation | Type |
|---|
| Use Relative Positioning | Whether or not to use relative positioning and sizing for the element. | Toggle |
| Pixel X | The x coordinate in pixels of the element. | Number |
| Pixel Y | The y coordinate in pixels of the element. | Number |
| Pixel Width | The width in pixels of the element. | Number |
| Pixel Height | The height in pixels of the element. | Number |
| Relative X | The x coordinate relative to the container of the element. | Number |
| Relative Y | The y coordinate relative to the container of the element. | Number |
| Relative Width | The width relative to the container of the element. | Number |
| Relative Height | The height relative to the container of the element. | Number |
| Margin Left | The left margin in pixels of the element. | Number |
| Margin Top | The top margin in pixels of the element. | Number |
| Margin Right | The right margin in pixels of the element. | Number |
| Margin Bottom | The bottom margin in pixels of the element. | Number |
