W3cubDocs

/Godot 3.0

Popup

Inherits: Control < CanvasItem < Node < Object

Inherited By: PopupPanel, PopupDialog, PopupMenu, WindowDialog

Category: Core

Brief Description

Base container control for popups and dialogs.

Member Functions

void popup ( Rect2 bounds=Rect2( 0, 0, 0, 0 ) )
void popup_centered ( Vector2 size=Vector2( 0, 0 ) )
void popup_centered_minsize ( Vector2 minsize=Vector2( 0, 0 ) )
void popup_centered_ratio ( float ratio=0.75 )

Signals

about_to_show ( )

This signal is emitted when a popup is about to be shown. (often used in PopupMenu for clearing the list of options and creating a new one according to the current context).

popup_hide ( )

This signal is emitted when a popup is hidden.

Member Variables

bool popup_exclusive - 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.

Numeric Constants

  • NOTIFICATION_POST_POPUP = 80 — Notification sent right after the popup is shown.
  • NOTIFICATION_POPUP_HIDE = 81 — Notification sent right after the popup is hidden.

Description

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.

Member Function Description

void popup ( Rect2 bounds=Rect2( 0, 0, 0, 0 ) )

Popup (show the control in modal form).

void popup_centered ( Vector2 size=Vector2( 0, 0 ) )

Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by “size”.

void popup_centered_minsize ( Vector2 minsize=Vector2( 0, 0 ) )

Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than minsize.

void popup_centered_ratio ( float ratio=0.75 )

Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen.

© 2014–2018 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.0/classes/class_popup.html