Struct Popup
Base container control for popups and dialogs.
Popup is a base Control used to show dialogs and popups. It's a subwindow and modal by default (see Control) and has helpers for custom popup behavior. All popup methods ensure correct placement within the viewport.
Properties
| Name | Type | Description |
popupExclusive[get, set]
|
bool | If true, the popup will not be hidden when a click event occurs outside of it, or when it receives the ui_cancel action event.
|
Methods
| Name | Description |
isExclusive
|
|
popup
|
Popup (show the control in modal form).
|
popupCentered
|
Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by size.
|
popupCenteredClamped
|
Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, clamping the size to size, then ensuring the popup is no larger than the viewport size multiplied by fallback_ratio.
|
popupCenteredMinsize
|
Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, ensuring the size is never smaller than minsize.
|
popupCenteredRatio
|
Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, scaled at a ratio of size of the screen.
|
setAsMinsize
|
Shrink popup to keep to the minimum size of content.
|
setExclusive
|
|