| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Alignment | ElementAlignment | View alignment. | |||||||||||||||||||||
Used to align the view relative to the layout parent region it resides in. Enum Values
| |||||||||||||||||||||||
| Alpha | float | Alpha value. | |||||||||||||||||||||
Can be used to adjust the alpha color of this view and all its children. E.g. used for fade in/out animations. Is separate from and different from the background color of the view as it affects the children as well. | |||||||||||||||||||||||
| BackgroundColor | UserInterface | Background color of the view. | |||||||||||||||||||||
Background color of the view. | |||||||||||||||||||||||
| BackgroundImage | SpriteAsset | Background image sprite. | |||||||||||||||||||||
The sprite that will be rendered. | |||||||||||||||||||||||
| BackgroundImageEventAlphaThreshold | UserInterface | Alpha threshold for letting through events. | |||||||||||||||||||||
The alpha threshold specifying the minimum alpha a pixel must have for the event to be passed through. | |||||||||||||||||||||||
| BackgroundImageFillAmount | UserInterface | Background image fill amount. | |||||||||||||||||||||
Amount of the Image shown when the Image.type is set to Image.Type.Filled. | |||||||||||||||||||||||
| BackgroundImageFillCenter | UserInterface | Indicates if center should be filled. | |||||||||||||||||||||
Boolean indicating whether or not to render the center of a Tiled or Sliced image. | |||||||||||||||||||||||
| BackgroundImageFillClockwise | UserInterface | Indicates if the image should be filled clockwise. | |||||||||||||||||||||
Whether the Image should be filled clockwise (true) or counter-clockwise (false). | |||||||||||||||||||||||
| BackgroundImageFillMethod | UserInterface | Background image fill method. | |||||||||||||||||||||
Indicates what type of fill method should be used. | |||||||||||||||||||||||
| BackgroundImageFillOrigin | UserInterface | Background image fill origin. | |||||||||||||||||||||
Controls the origin point of the Fill process. Value means different things with each fill method. | |||||||||||||||||||||||
| BackgroundImageMaskable | UserInterface | Indicates if the image is maskable. | |||||||||||||||||||||
Indicates if the background image graphic is to be maskable. | |||||||||||||||||||||||
| BackgroundImageOverrideSprite | SpriteAsset | Background image override sprite. | |||||||||||||||||||||
Set an override sprite to be used for rendering. If set the override sprite is used instead of the regular image sprite. | |||||||||||||||||||||||
| BackgroundImagePreserveAspect | UserInterface | Preserve aspect ratio. | |||||||||||||||||||||
Indicates whether this image should preserve its Sprite aspect ratio. | |||||||||||||||||||||||
| BackgroundImageType | UserInterface | Type of background image. | |||||||||||||||||||||
The type of the image sprite that is to be rendered. | |||||||||||||||||||||||
| BackgroundMaterial | UserInterface | Background image material. | |||||||||||||||||||||
Background image material. | |||||||||||||||||||||||
| BaseDirectory | string | Base directory. | |||||||||||||||||||||
Specifies the base directory to be used by the view and its children. The base directory is used when loading resources such as sprites, fonts, etc. | |||||||||||||||||||||||
| BasedOn | string | Based on style. | |||||||||||||||||||||
Used in style definition to specify which style it's based on. | |||||||||||||||||||||||
| BlockingObjects | BlockingObjects | Blocking objects. | |||||||||||||||||||||
Indicates the types of objects that should block the raycasts. Enum Values
| |||||||||||||||||||||||
| DynamicPixelsPerUnit | float | Dynamic pixels per unit. | |||||||||||||||||||||
Pixels per unit to use for dynamically generated bitmaps such as text. | |||||||||||||||||||||||
| Height | ElementSize | The height of the view. | |||||||||||||||||||||
Specifies the height of the view either in pixels or percents. | |||||||||||||||||||||||
| HideFlags | HideFlags | Hide flags for the game object. | |||||||||||||||||||||
Bit mask that controls object destruction, saving and visibility in editor. Enum Values
| |||||||||||||||||||||||
| Id | string | The ID of the view. | |||||||||||||||||||||
Specifies a unique ID for the view. Used to map the view to reference fields on the parent view model. Provides a way to reference the view in data bindings. Is used as selectors in styles. | |||||||||||||||||||||||
| IgnoreReversedGraphics | bool | Indicates if reversed graphics should be ignored. | |||||||||||||||||||||
Tells the graphic raycaster to ignore graphical components facing away from the camera. | |||||||||||||||||||||||
| IsActive | bool | Indicates if the view is enabled. | |||||||||||||||||||||
Activates/deactivates the view. If set to false in this or in any parent view, all components are disabled, attached renderers are turned off, etc. Any components attached will no longer have Update() called. | |||||||||||||||||||||||
| IsDestroyed | bool | Indicates if the view has been destroyed by GameObject.Destroy(). | |||||||||||||||||||||
| IsDynamic | bool | Indicates if the view has been created dynamically. | |||||||||||||||||||||
| IsInitialized | bool | Gets or sets bool indicating if the view has been initialized. | |||||||||||||||||||||
| IsTemplate | bool | Indicates if this view is to be used as a template. | |||||||||||||||||||||
A template view is used to create dynamic instances of the view. Used by certain views such as the List and TabPanel. | |||||||||||||||||||||||
| IsVisible | bool | Indicate if the view is visible. | |||||||||||||||||||||
Can be used to adjust the visiblity of the view. If set to false the view is made invisible but unlike when deactivating the view, invisible views are still is active and takes up space. | |||||||||||||||||||||||
| Item | object | Item data. | |||||||||||||||||||||
Provides a mechanism to bind to dynamic list data. The item is set, e.g. by the List view on the child views it generates for its dynamic list data. The Item points to the list item data the view is associated with. | |||||||||||||||||||||||
| LayoutRoot | UserInterface | Gets layout root canvas. | |||||||||||||||||||||
| Margin | ElementMargin | View margin | |||||||||||||||||||||
Determines the size of the content region relative the view's width and height. Adding margins to a view does not change its width or height. | |||||||||||||||||||||||
| MatchWidthOrHeight | float | Match width or height or in between. | |||||||||||||||||||||
Scale the canvas area with the width as reference (0), the height as reference (1), or something in between (e.g. 0.75). | |||||||||||||||||||||||
| Offset | ElementMargin | View offset. | |||||||||||||||||||||
Determines the offset of the content region relative to the view's position. | |||||||||||||||||||||||
| OffsetFromParent | ElementMargin | View offset from parent. | |||||||||||||||||||||
Used by parent views to adjust the positioning of its children without affecting the internal offset of the children. | |||||||||||||||||||||||
| OrderInLayer | UserInterface | Canvas sorting order. | |||||||||||||||||||||
Canvas draw order within a sorting layer. | |||||||||||||||||||||||
| OverrideHeight | ElementSize | Override height. | |||||||||||||||||||||
Used to override the layouting logic of inherited views and set the specified height. | |||||||||||||||||||||||
| OverridePixelPerfect | bool | Override pixel perfect. | |||||||||||||||||||||
Boolean indicating if the pixel perfect setting should be overriden (not inherited from parent canvas). | |||||||||||||||||||||||
| OverrideSorting | bool | Override canvas sort order. | |||||||||||||||||||||
Boolean indicating if the sort order should be overriden (not inherited from parent canvas). | |||||||||||||||||||||||
| OverrideWidth | ElementSize | Override width. | |||||||||||||||||||||
Used to override the layouting logic of inherited views and set the specified width. | |||||||||||||||||||||||
| Pivot | Vector2 | View pivot position. | |||||||||||||||||||||
The normalized position that the view rect transform rotates around. | |||||||||||||||||||||||
| PixelPerfect | bool | Indicates if rendering should be pixel perfect. | |||||||||||||||||||||
Indicates if the canvas is to be aligned with pixels. Only applied if render mode is set to ScreenSpace. | |||||||||||||||||||||||
| PlaneDistance | float | Canvas distance from camera. | |||||||||||||||||||||
The plane distance determines how far away from the camera the canvas is generated. | |||||||||||||||||||||||
| Position | Vector3 | Position of the view. | |||||||||||||||||||||
The local position of the view in relation to the layout parent view transform. | |||||||||||||||||||||||
| PropagateChildLayoutChanges | bool | Indicates if the view propagates child layout changes. | |||||||||||||||||||||
Boolean indicating if view propagates child layout changes. Generally set to true whenever a view adjusts its size to child layout changes. | |||||||||||||||||||||||
| RaycastBlockMode | RaycastBlockMode | Indicates when raycast should be blocked. | |||||||||||||||||||||
Enum indicating when raycasts should be blocked by the view. Enum Values
| |||||||||||||||||||||||
| ReferencePixelsPerUnit | float | Reference pixels per unit. | |||||||||||||||||||||
If a sprite has 'Pixels Per Unit' setting, one pixel in the sprite will cover one unit in the UI. | |||||||||||||||||||||||
| ReferenceResolution | Vector2 | Reference resolution. | |||||||||||||||||||||
The resolution the UI layout is designed for. If the screen resolution is larger, the UI will be scaled up, and if it’s smaller, the UI will be scaled down. | |||||||||||||||||||||||
| RenderCamera | Camera | Render camera. | |||||||||||||||||||||
Camera used for sizing the canvas when in render mode set to: Screen Space - Camera. Also used as camera that events will be sent through in world space. | |||||||||||||||||||||||
| RenderMode | RenderMode | Canvas render mode. | |||||||||||||||||||||
Specifies the render mode to be used by the canvas. Enum Values
| |||||||||||||||||||||||
| Rotation | Quaternion | Rotation of the view. | |||||||||||||||||||||
The local rotation of the view in relation to the layout parent view transform. Stored as a Quaternion but specified in XUML as euler angles. | |||||||||||||||||||||||
| Scale | Vector3 | Scale of the view. | |||||||||||||||||||||
The scale of the view in relation to the layout parent view transform. | |||||||||||||||||||||||
| ScaleFactor | float | Scale factor. | |||||||||||||||||||||
Scales all children within the canvas by this factor. | |||||||||||||||||||||||
| SortIndex | int | View sort index. | |||||||||||||||||||||
The sort index is used by views such as Group and List to sort its child views. | |||||||||||||||||||||||
| SortingLayerId | int | Unique ID of the canvas sorting layer. | |||||||||||||||||||||
Unique ID of the canvas sorting layer. | |||||||||||||||||||||||
| SortingLayerName | string | Name of the canvas sorting layer. | |||||||||||||||||||||
Name of the canvas sorting layer. | |||||||||||||||||||||||
| SortingOrder | int | Canvas sorting order. | |||||||||||||||||||||
Canvas draw order within a sorting layer. | |||||||||||||||||||||||
| State | string | View state. | |||||||||||||||||||||
View state name. Determines state values to be applied to the view. All views start out in the "Default" state and when the state changes the values associated with that state are applied to the view. | |||||||||||||||||||||||
| Style | string | The style of the view. | |||||||||||||||||||||
Used as selector by the styles. Specifies the name of the style that is to be applied to the view and any children that explicitly inherits its style. The style is applied when the view is created (usually in the editor as the XUML is processed). | |||||||||||||||||||||||
| Theme | string | The theme of the view. | |||||||||||||||||||||
Specifies the name of the theme that is applied to the view and its children. The theme determines which set of styles are to be considered when applying matching styles to the view. | |||||||||||||||||||||||
| UIScaleMode | ScaleMode | UI scale mode. | |||||||||||||||||||||
Determines how the children within the canvas are scaled. Enum Values
| |||||||||||||||||||||||
| UnitSize | Vector3 | Unit size. | |||||||||||||||||||||
Specifies the user-defined unit size to be used by the view and its children. Used when element size is specified in user-defined units to convert it into pixels. | |||||||||||||||||||||||
| UpdateBackground | bool | Indicates if background is updated. | |||||||||||||||||||||
If set to false the background image and color is not updated by the view. Is used when the background updates is done elsewhere. | |||||||||||||||||||||||
| UpdateRectTransform | bool | Indicates if rect transform is updated. | |||||||||||||||||||||
If set to false the rect transform is not updated by the layout logic. It is used when layouting is done elsewhere. | |||||||||||||||||||||||
| Width | ElementSize | The width of the view. | |||||||||||||||||||||
Specifies the width of the view either in pixels or percents. | |||||||||||||||||||||||
| Name | Action Data | Description | |
|---|---|---|---|
| Cancel | none | Cancel view action. | |
Triggered by the EventSystem when a cancel event occurs. | |||
| Deselect | none | Deselect view action. | |
Triggered by the EventSystem when another view is selected. | |||
| Drop | none | Drop view action. | |
Triggered by the EventSystem when the view accepts a drop. | |||
| Move | none | Move view action. | |
Triggered by the EventSystem when a move event occurs. | |||
| Click | none | Click view action. | |
Triggered by the EventSystem when the user clicks/touches on the view. | |||
| BeginDrag | none | Drag view action. | |
Triggered by the EventSystem when the user presses mouse on and starts to drag over the view. | |||
| EndDrag | none | End drag view action. | |
Triggered by the EventSystem when the user stops dragging mouse over the view. | |||
| Drag | none | Drag view action. | |
Triggered by the EventSystem as the user drags the mouse over the view. | |||
| InitializePotentialDrag | none | Initialize potential drag view action. | |
Triggered by the EventSystem as the user initiates a potential drag over the view. | |||
| MouseDown | none | Mouse down view action. | |
Triggered by the EventSystem when the mouse/touch presses down over the view. | |||
| MouseEnter | none | Mouse enter view action. | |
Triggered by the EventSystem when the mouse enters the view. | |||
| MouseExit | none | Mouse exit view action. | |
Triggered by the EventSystem when the mouse exits the view. | |||
| MouseUp | none | Mouse up view action. | |
Triggered by the EventSystem when the mouse/thouch releases over the view. | |||
| Scroll | none | Scroll view action. | |
Triggered by the EventSystem when the user scrolls when the view is selected. | |||
| Select | none | Select view action. | |
Triggered by the EventSystem when the view is selected. | |||
| Submit | none | Submit view action. | |
Triggered by the EventSystem when the user submits while view is selected. | |||
| UpdateSelected | none | Update selected view action. | |
Triggered by the EventSystem when the object associated with this EventTrigger is updated. | |||
| Activated | none | Activated view action. | |
Triggered every time the view is activated. Also triggered once the view is intialized if it starts out activated. | |||
| Deactivated | none | Deactivated view action. | |
Triggered every time the view is deactivated. Also triggered once the view is intialized if it starts out deactivated. | |||
Be notified when new themes, views, tutorials and updates are available