Properties

Drawer#

Color#

The entire view is filled with a background color.

Image#

Draw an image stretched to the bounds of the view. Use Match Image Width and Match Image Height to cause the view to be sized to the image's intrinsic width and height.

Image Color#

A color to multiply this view's image by. Defaults to white.

Blend#

Specify how this view blends with views behind it. Unless you know what you're doing, you probably shouldn't touch this property.

Desaturate#

Desaturates the image and/or color this view draws.

Clip To Parent#

Drawing of this view and its children are clipped to this view's parent.

Clip Children#

All children are clipped to this view.

Mask Image#

The specified image's alpha channel is used to mask any set image and/or color.

Layer#

Override draw order and group with other views on the specified layer.

For example, all views with a layer of 1 will be drawn above all views with a layer of 0. This property affects this view's children as well.

Layer With#

Draw this view and its children at the same draw order as the specified view.

Scale#

Scale the rendering of this view. Layout is unaffected.

Alpha#

Set the opacity level of this view and all its children.

Blur Under Layer#

When set, all views rendered beneath this view's layer will be blurred by Blur Scale amount.

Blur Scale#

How much to blur views affected by the Blur Under Layer property.

Events#

Event properties allow you to control how your UI responds to user input.

Disabled#

Disables all event related properties. No events of any type will be captured, handled, or blocked by this view or any of its children.

Block Pointer Events#

Any pointer events that hit this view will be prevented from falling through to any views below.

Block Key Events#

Un-captured Key events bubble up the view tree. If this property is set, any key events that hit this view will be stopped immediatly and won't be dispatched to any other views or scenes.

Text Undo Stack Disabled#

By default editable text maintains its own undo system that consumes undo and redo events. This property allows you to disable it, causing focused editable text to not capture undo and redo events.

On Drag#

An impulse that is fired when the user clicks and drags this view. Refer to Handling On Drag.

Drag Id#

Correlates to drag_type_id in the drag arbiter system.

Drag Target#

Correlates to target_type_id in the drag arbiter system.

Id#

Used by drag arbiters to identify this view. When this view is being queried as a Drag Target, the value of this property will be assigned to target_id in the drag arbiter event data structure. If this is the view being dragged, it will be assigned to the dragging_id member.

On Hover In#

An impulse that's fired when this view is hovered by a pointer.

On Hover Out#

An impulse that's fired when a pointer moves out of this view.

On Event#

A special property for passing all events that hit this view to an Event Filter or Text Event Filter node. Events that match inline view event filters are excluded.

Feedback#

A special property that can be connected to a Feedback Node.

Navigation properties control how views interact with the focus system as well as view scrolling.

Focus Policy#

Specifies if and how this view may be focused.

Options are:

  • Never - This is the default value, which indicates that the view can never be focused.
  • Always - The view can be focused with either pointer or navigation events.
  • Pointer - The view may only be focused by pointer events (i.e. clicking on it.)
  • Navigation - The view may only be focused by navigation events (i.e. the tab or right arrow key.)

Request Default Focus#

When true, this view will be focused when its containing scene searchs for a view to focus.

Focus Greedy#

When true, this view will be focused if nothing else in the scene is focused.

Focus#

Trigger to focus this view.

Defocus#

Trigger to de-focus this view.

Focus Order#

By default, the focus next event will follow the view tree's hierarchy. This property overrides the default ordering.

On Focus#

An impulse that's fired when this view gains focus.

On Focus Out#

An impulse that's fired when this view loses focus.

Select Text On Focus#

When true (default), editable text views will select their contents when focused.

Text Focus Navigation Overflow#

When set, pressing the left and right arrow keys will focus left and right when the text cursor is at the appropriate end.

Scrolling X#

When set, all children will scroll horizontally. If scroll clamping is enabled (default), children will only scroll if they are larger than this view.

Scrolling Y#

When set, all children will scroll vertically. If scroll clamping is enabled (default), children will only scroll if they are larger than this view.

Scroll X#

The distance children are translated horizontally as a result of scrollingX. The value of this property is used even when scrolling is disabled.

Scroll Y#

The distance children are translated vertically as a result of scrollingY. The value of this property is used even when scrolling is disabled.

Scroll X Clamp Start#

When set (default), Scroll X won't be allowed to move past the left boundary.

Scroll X Clamp End#

When set (default), Scroll X won't be allowed to move past the right boundary.

Scroll Y Clamp Start#

When set (default), Scroll Y won't be allowed to move past the top boundary.

Scroll Y Clamp End#

When set (default), Scroll Y won't be allowed to move past the bottom boundary.

Scroll Cancel Slop#

The distance a view will be scrolled before it cancels possible click events. When canceled, views that captured a down event won't receive a matching up event.

Text#

Text#

A UTF-8 value to render using the set font.

Editable#

When set, the text property's value can be focused and edited by the user.

Text Cursor#

The character index of the carrot in an editable text view. The value is -1 when no cursor is visible, 0 when in front of the first character, etc.

Font Face#

The font to use for rendering text. Add fonts by placing oft or ttf font files in your project's assets directory.

Text Size#

The font size in points to draw text.

Text Color#

What color text should be drawn.

Text X Align#

Horizontal alignment of text within its view.

Text Y Align#

Vertical alignment of text within its view.

Letter Spacing#

How much additional spacing should be added or removed between letters drawn by the text property.

Line Spacing#

How much additional spacing should be added or removed between text lines.

Word Spacing#

How much additional spacing should be added or removed between words drawn by the text property.

Text Padding Left#

Spacing between the left edge of the text and the view's left edge.

Text Padding Top#

Spacing between the top edge of the text and the view's top edge.

Text Padding Right#

Spacing between the right edge of the text and the view's right edge.

Text Padding Bottom#

Spacing between the bottom edge of the text and the view's bottom edge.

Max Single Line#

When set, text drawing ignores line-breaks, and entering them in editable text is disabled.

Text Overflow#

Word-wrap behavior of text when there isn't enough horizontal space to layout an entire line.

Text Shadow Color#

Color to draw a shadow underneath text. Defaults to fully transparent.

Text Shadow X#

Horizontal offset to draw the text's shadow.

Text Shadow Y#

Vertical offset to draw the text's shadow.

Layout#

See the Layout System page for information on how views are laid out.

Children Arrange#

Allows you to stack children vertically, horizontally, or behave like word-wrap. When no arrange value is set (default), all children views will overlap.

Translate X#

Horizontal offset to draw this view without affecting layout.

Translate Y#

Vertical offset to draw this view without affecting layout.

Translate Z#

Offset along a depth axis to draw this view. Only applies when using a 3D rendering back-end. This does not affect draw ordering. To change the draw ordering of a view, see Layer and Layer With.

Rotate X#

Rotate this view along its x axis in degrees.

Rotate Y#

Rotate this view along its y axis in degrees.

Rotate Z#

Rotate this view along its z axis in degrees. This is the most commonly used rotation axis in UIs.

Min Width#

The minimum width this view is allowed to be when laying out.

Max Width#

The maximum width this view is allowed to be when laying out. This takes precedence over the min width property.

Min Height#

The minimum height this view is allowed to be when laying out.

Max Height#

The maximum height this view is allowed to be when laying out. This takes precedence over the min height property.

Align X#

How this view should align itself to its parent when the parent's width and this view's width don't match up. Alignment options are left (default), center, and right.

Align Y#

How this view should align itself to its parent when the parent's height and this view's height don't match up. Alignment options are top (default), center, and bottom.

Match Image Width#

When set, this view's width will be made equal to the set image.

Match Image Height#

When set, this view's height will be made equal to the set image.

Match Text Width#

When set, this view will match its width to the laid out width of its text property.

Match Text Height#

When set, this view will match its height to the laid out height of its text property.

Match Children Width#

When set, this view will match its width to the width of its direct children.

Match Children Height#

When set, this view will match its height to the height of its direct children.

Padding Left#

The spacing between this view's left edge and where children will be laid out.

Padding Top#

The spacing between this view's top edge and where children will be laid out.

Padding Right#

The spacing between this view's right edge and where children will be laid out.

Padding Bottom#

The spacing between this view's bottom edge and where children will be laid out.

Inset Left#

The spacing between this view's left edge and the parent view's left edge.

Inset Top#

The spacing between this view's left edge and the parent view's top edge.

Inset Right#

The spacing between this view's left edge and the parent view's right edge.

Inset Bottom#

The spacing between this view's left edge and the parent view's bottom edge.

Anchor Left View#

Another view to align this view's left edge to.

Anchor Left Align#

Which edge of the view specified in Anchor Left View to align to.

Anchor Top View#

Another view to align this view's top edge to.

Anchor Top Align#

Which edge of the view specified in Anchor Left Top to align to.

Anchor Right View#

Another view to align this view's right edge to.

Anchor Right Align#

Which edge of the view specified in Anchor Right View to align to.

Anchor Bottom View#

Another view to align this view's bottom edge to.

Anchor Bottom Align#

Which edge of the view specified in Anchor Bottom View to align to.