Learn / Documentation / UIView
Scripting

Description

The UIView is a core component in the DoozyUI system. It manages a container, that can contain any type of UI elements (buttons, toggles, images, texts...) and that can be animated in and out of view.

Component Details

Gesture Listener
Gesture Listener
Gesture Listener
  • Settings – Opens the Control Panel at the Settings tab

  • Manual – Link to the manual page for this component

  • YouTube – Link to the quick video tutorial for this component

  • Debug Mode – Enables relevant debug messages to be printed to the console

  • View Category – View category name

  • View Name – View name

  • Rename GameObject – Renames the UIView GameObject to a predefined name

  • Open Database – Opens the Control Panel at the Views tab

  • Behavior at Start – Determines the actions this UIView will automatically perform at Start (when it gets initialized). Do Nothing / Hide / Play Show Animation

  • Custom Start Position – If enabled, this UIView will use the set custom position to calculate the Show and Hide Move animations positions

  • Show View – Behavior when this UIView gets shown (becomes visible on screen)

  • Hide View – Behavior when this UIView gets hidden (goes off screen)

  • View Loop – Loop animation started after this UIView gets shown and stopped before this UIView gets hidden. See the Execution Order image for more details.

  • Auto Hide After Show – If enabled, after this UIView gets shown, it will get automatically hidden after the AutoHideAfterShowDelay time interval has passed

  • Auto Hide After Show Delay – If AutoHideAfterShow is enabled, this is the time interval after which this UIView will get automatically hidden

  • If any button is selected deselect it on Show / Hide  – If TRUE, when this UIView is shown / hidden, any button that is selected (EventSystem.current) will get deselected

  • Auto selected button after Show – If enabled, after this UIView has been shown, the referenced SelectedButton GameObject will get automatically selected by EventSystem.current

  • When UIView is hidden disable Game Object – If enabled, when this UIView gets hidden, the GameObject this UIView component is attached to, will be disabled

  • When UIView is hidden disable Canvas – If enabled, when this UIView gets hidden, the Canvas component found on the same GameObject this UIView component is attached to, will be disabled

  • When UIView is hidden disable Graphic Raycaster – If TRUE, when this UIView gets hidden, the GraphicRaycaster component found on the same GameObject this UIView component is attached to, will be disabled

  • Show Progressor – Reference to a Progressor that allows animating anything (texts, images, animations…) while showing this view

  • Update on Hide – Should the Show Progressor get updated when this UIView is hiding?

  • Hide Progressor – Reference to a Progressor that allows animating anything (texts, images, animations…) while hiding this view

  • Update on Show – Should the Hide Progressor get updated when this UIView is showing?

  • OnVisibilityChangedProgressEvent executed when the view is animating (showing or hiding) and the progress has been updated. Passes the Visibility (float between 0 – NotVisible and 1 – Visible)

  • OnInverseVisibilityChangedProgressEvent executed when the view is animating (showing or hiding) and the progress has been updated. Passes the InverseVisibility (float between 1 – NotVisible and 0 – Visible). InverseVisibility = 1 – Visibility

Gesture Listener
Gesture Listener
Gesture Listener

Show View Behavior

  • New Preset – Create a new preset with the current animation settings

  • Load Preset – Load the currently selected preset

  • Delete Preset – Delete the currently selected preset

  • Preset Category – Preset category name

  • Preset Name – Preset name

  • Load selected preset at runtime – Determines if the selected preset should override at runtime the current editor settings or not

  • Animation – @[email protected] executed when the behavior is triggered

  • @STARTUIAction executed when the Show View Behavior starts

  • @FINISHEDUIAction executed when the Show View Behavior finished

Gesture Listener
Gesture Listener
Gesture Listener

Hide View Behavior

  • New Preset – Create a new preset with the current animation settings

  • Load Preset – Load the currently selected preset

  • Delete Preset – Delete the currently selected preset

  • Preset Category – Preset category name

  • Preset Name – Preset name

  • Load selected preset at runtime – Determines if the selected preset should override at runtime the current editor settings or not

  • Animation – @[email protected] executed when the behavior is triggered

  • @STARTUIAction executed when the Hide View Behavior starts

  • @FINISHEDUIAction executed when the Hide View Behavior finished

Gesture Listener
Gesture Listener
Gesture Listener

View Loop Behavior

  • New Preset – Create a new preset with the current animation settings

  • Load Preset – Load the currently selected preset

  • Delete Preset – Delete the currently selected preset

  • Preset Category – Preset category name

  • Preset Name – Preset name

  • Load selected preset at runtime – Determines if the selected preset should override at runtime the current editor settings or not

  • Auto Start Loop Animation – Automatically starts the loop animation without waiting for a show (in) animation to finish playing.

  • Animation – @[email protected] loop animation started after this UIView gets shown and stopped before this UIView gets hidden (if enabled)

  • @STARTUIAction executed when the Loop View Behavior starts

  • @FINISHEDUIAction executed when the Loop View Behavior finished