User Interface Elements

List Element

Lists are used to setup option/choice menus. Yes and No choice lists for a simple example. They can run scripts when they are Focused or Unfocused.

A list is made up of Items. Items are then used to run Scripts based on pre determined conditions, Execute, Focused, and Unfocused, when a List Item is selected.

Properties

System

NameExplanationType
NameN/AN/A

Appearance

NameExplanationType
Enable LoopingN/AN/A
Hide When UnfocusedN/AN/A
OrientationN/AN/A

Cursor Appearance

NameExplanationType
Animate Cursor When UnfocusedN/AN/A
Color MaskN/AN/A
Color Mask MarginN/AN/A
Mask StrategyN/AN/A
Cursor OffsetN/AN/A
Hide Cursor When UnfocusedN/AN/A
SpriteN/AN/A
TypeN/AN/A

Cursor Sound Effects

NameExplanationType
Use Default SoundsN/AN/A
Buzzer Sound EffectN/AN/A
Confirm Sound EffectN/AN/A
Movement Sound EffectN/AN/A

Item Appearance

NameExplanationType
ColorN/AN/A
Drop Shadow ColorN/AN/A
Drop Shadow OffsetN/AN/A
Font FamilyN/AN/A
Horizontal AlignmentN/AN/A
Sprite Horizontal AlignmentN/AN/A
Sprite Margin LeftN/AN/A
Sprite Margin TopN/AN/A
Sprite Margin RightN/AN/A
Sprite Margin BottomN/AN/A
Sprite Vertical AlignmentN/AN/A
Text Margin LeftN/AN/A
Text Margin TopN/AN/A
Text Margin RightN/AN/A
Text Margin MarginN/AN/A
Use Drop ShadowN/AN/A
Vertical AlignmentN/AN/A

Position

NameExplanationType
Margin LeftN/AN/A
Margin TopN/AN/A
Margin RightN/AN/A
Margin MarginN/AN/A
Pixel XN/AN/A
Pixel YN/AN/A
Relative WidthN/AN/A
Relative HeightN/AN/A
Use Relative PositioningN/AN/A

Scripts

NameExplanationType
FocusedN/AN/A
UnFocusedN/AN/A

Item Properties

Appearance

NameExplanationType
Color MaskN/AN/A
Override StylesN/AN/A
Sprite Horizontal AlignmentN/AN/A
Sprite Margin LeftN/AN/A
Sprite Margin TopN/AN/A
Sprite Margin RightN/AN/A
Sprite Margin BottomN/AN/A
Sprite Vertical AlignmentN/AN/A
TextN/AN/A
Text Margin LeftN/AN/A
Text Margin TopN/AN/A
Text Margin RightN/AN/A
Text Margin MarginN/AN/A
Use Space if HiddenN/AN/A
Use Sprite OnlyN/AN/A

Scripts

NameExplanationType
ExecuteN/AN/A
FocusedN/AN/A
UnFocusedN/AN/A

Pane Element

Panes are images that are meant to be used like background windows.

Properties

System

NameExplanationType
NameN/AN/A

Appearance

NameExplanationType
BackgroundN/AN/A
Color MaskN/AN/A
Hue ShiftN/AN/A
StrategyN/AN/A

Context

NameExplanationType
Is Linked to Selected Context?N/AN/A
Is Linked to UI Context?N/AN/A
Template TypeN/AN/A

Position

NameExplanationType
Margin LeftN/AN/A
Margin TopN/AN/A
Margin RightN/AN/A
Margin MarginN/AN/A
Pixel XN/AN/A
Pixel YN/AN/A
Relative WidthN/AN/A
Relative HeightN/AN/A
Use Relative PositioningN/AN/A

Picture

Pictures are used to show static images or sprites, including animated, in a user interface.

Properties

System

NameExplanationType
NameThe name of the element.String

Appearance

NameExplanationType
Color MaskThe color mask to apply to the element.Color
Horizontal AlignmentThe horizontal alignment of the element.Alignment
Hue ShiftThe hue shift to apply to the element.Number
ImageThe static image to display in the element.Image
SpriteThe sprite to display in the element.Sprite?
Stretch to BoundariesWhether or not to stretch the image or sprite to fit the size of the element.Toggle
TemplateThe template details for the element.String
Use TemplateWhether or not to use a template for the image or sprite.Toggle
Vertical AlignmentThe vertical alignment of the element.Alignment

Context

NameExplanationType
Is Linked to Selected ContextWhether or not the context is linked to the current selection in the user interface.Toggle
Is Linked to UI ContextWhether or not the context is linked to the user interface.Toggle
Template TypeThe 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

NameExplanationType
Margin LeftThe left margin in pixels of the element.Number
Margin TopThe top margin in pixels of the element.Number
Margin RightThe right margin in pixels of the element.Number
Margin BottomThe bottom margin in pixels of the element.Number
Pixel XThe x coordinate in pixels of the element.Number
Pixel YThe y coordinate in pixels of the element.Number
Pixel WidthThe width in pixels of the element.Number
Pixel HeightThe height in pixels of the element.Number
Relative XThe x coordinate relative to the container of the element.Number
Relative YThe y coordinate relative to the container of the element.Number
Relative WidthThe width relative to the container of the element.Number
Relative HeightThe height relative to the container of the element.Number
Use Relative PositioningWhether or not to use relative positioning and sizing for the element.Toggle

Templated List

Templated Lists use Contexts to display bulk amounts data setup elsewhere in the Database. Templated Lists run Scripts based on pre determined conditions, Execute, Focused, Item Focused, Item Unfocused, and Unfocused, when a List Item is selected.

Templated Lists use components to make up its contents. They can use Panes, Pictures, and Text elements to make up the list.

Properties

System

NameExplanationType
NameN/AN/A

Appearance

NameExplanationType
Enable LoopingN/AN/A
Hide When UnfocusedN/AN/A
OrientationN/AN/A
Template TypeN/AN/A

Context

NameExplanationType
Custom ContextN/AN/A
Use Custom ContextN/AN/A

Cursor Appearance

NameExplanationType
Animate Cursor When UnfocusedN/AN/A
Color MaskN/AN/A
Color Mask MarginN/AN/A
Mask StrategyN/AN/A
Cursor OffsetN/AN/A
Hide Cursor When UnfocusedN/AN/A
SpriteN/AN/A
TypeN/AN/A

Cursor Sound Effects

NameExplanationType
Use Default SoundsN/AN/A
Buzzer Sound EffectN/AN/A
Confirm Sound EffectN/AN/A
Movement Sound EffectN/AN/A

Item Details

NameExplanationType
Item ComponentsN/AN/A
Margin LeftN/AN/A
Margin TopN/AN/A
Margin RightN/AN/A
Margin MarginN/AN/A
Pixel XN/AN/A
Pixel YN/AN/A
Relative WidthN/AN/A
Relative HeightN/AN/A
Use Relative PositioningN/AN/A

Item Disabled Effect

NameExplanationType
Color MaskN/AN/A
GrayscaleN/AN/A
Invert Condition ValueN/AN/A
OpacityN/AN/A
SwitchN/AN/A
TemplateN/AN/A
Use SwitchN/AN/A
Use Template ValueN/AN/A
VisibleN/AN/A

Position

NameExplanationType
Margin LeftN/AN/A
Margin TopN/AN/A
Margin RightN/AN/A
Margin MarginN/AN/A
Pixel XN/AN/A
Pixel YN/AN/A
Relative WidthN/AN/A
Relative HeightN/AN/A
Use Relative PositioningN/AN/A

Scripts

NameExplanationType
ExecuteN/AN/A
FocusedN/AN/A
Item FocusedN/AN/A
Item UnfocusedN/AN/A
UnFocusedN/AN/A

Text Element

Text Elements display text that can be further customized using properties.

Text Elements can also use Contexts.

Properties

System

NameExplanationType
NameN/AN/A

Appearance

NameExplanationType
ColorN/AN/A
Drop Shadow ColorN/AN/A
Drop Shadow OffsetN/AN/A
Font FamilyN/AN/A
Font SizeN/AN/A
Horizontal AlignmentN/AN/A
TextN/AN/A
Use Drop ShadowN/AN/A
Use Word WrappingN/AN/A
Vertical AlignmentN/AN/A

Context

NameExplanationType
Is Linked to Selected Context?N/AN/A
Is Linked to UI Context?N/AN/A
Template TypeN/AN/A

Effects

NameExplanationType
Character Delay (milliseconds)N/AN/A
Character SoundN/AN/A

Position

NameExplanationType
Margin LeftN/AN/A
Margin TopN/AN/A
Margin RightN/AN/A
Margin MarginN/AN/A
Pixel XN/AN/A
Pixel YN/AN/A
Relative WidthN/AN/A
Relative HeightN/AN/A
Use Relative PositioningN/AN/A