UIField

Inherits Instance

UIField is the abstract base class of all UI classes.

Properties

PositionOffset : Vector2

The offset of the UI element in pixels.

PositionRelative : Vector2

The position of the UI element relative to its parent.

Rotation : number

The rotation of the UI element in degrees.

SizeOffset : Vector2

The size offset of the UI element in pixels.

SizeRelative : Vector2

The size of the UI element relative to its parent.

ClipDescendants : boolean

Determines whether the UI element clips its descendants.

PivotPoint : Vector2

The pivot point of the UI element.

Scale : Vector2

The scale of the UI element.

Visible : boolean

Determines whether the UI element is visible.

MaskMode : MaskModeEnum

Determines the mask mode of the UI element.

AbsoluteSize : Vector2

The absolute size of the UI element in pixels.

IsVisibleInTree : boolean

Indicates whether the UI element is visible in the UI hierarchy.

Events

MouseEnter

Parameters: ``

Fires when user's cursor hovers on this UI

MouseExit

Parameters: ``

Fires when user's cursor leaves this UI

MouseDown

Parameters: ``

Fires when user hold down mouse on this UI

MouseUp

Parameters: ``

Fires when user release mouse on this UI

TransformChanged

Parameters: ``

Fires when this UI transform has been changed

VisibilityChanged

Parameters: ``

Fires when this UI visibility has been changed