Window
Hereda: Viewport < Node < Object
Heredado por: AcceptDialog, Popup
Clase base para todas las ventanas, cuadros de diálogo y ventanas emergentes.
Descripción
Un nodo que crea una ventana. La ventana puede ser una ventana nativa del sistema o incrustada dentro de otra Window (véase Viewport.gui_embed_subwindows).
En tiempo de ejecución, las Windows no se cerrarán automáticamente cuando se soliciten. Debes manejarlo manualmente usando la señal close_requested (esto se aplica tanto a presionar el botón de cierre como a hacer clic fuera de una ventana emergente).
Propiedades
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Métodos
Propiedades del Tema
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Señales
about_to_popup() 🔗
Emitida justo después de la llamada a popup(), antes de que la Window aparezca o haga algo.
close_requested() 🔗
Emitida cuando se pulsa el botón de cierre de la Window o cuando popup_window está habilitado y el usuario hace clic fuera de la ventana.
Esta señal se puede utilizar para gestionar el cierre de la ventana, por ejemplo, conectándola a hide().
dpi_changed() 🔗
Emitida cuando el DPI de la Window cambia como resultado de los cambios a nivel del sistema operativo (por ejemplo, al mover la ventana de una pantalla Retina a una de menor resolución).
Nota: Solo se implementa en macOS y Linux (Wayland).
files_dropped(files: PackedStringArray) 🔗
Emitida cuando los archivos se arrastran desde el administrador de archivos del sistema operativo y se sueltan en la ventana del juego. El argumento es una lista de rutas de archivo.
func _ready():
get_window().files_dropped.connect(on_files_dropped)
func on_files_dropped(files):
print(files)
Nota: Esta señal sólo funciona con ventanas nativas, es decir, la ventana principal y los nodos derivados de Window cuando Viewport.gui_embed_subwindows está desactivado en el viewportprincipal.
focus_entered() 🔗
Emitida cuando la Window obtiene el foco.
focus_exited() 🔗
Emitida cuando la Window pierde su foco.
go_back_requested() 🔗
Emitida cuando se envía una solicitud de retroceso (por ejemplo, al pulsar el botón "Back" en Android), justo después de Node.NOTIFICATION_WM_GO_BACK_REQUEST.
mouse_entered() 🔗
Emitida cuando el cursor del ratón entra en el área visible de la Window, que no está ocluida detrás de otros Controls o ventanas, siempre que su Viewport.gui_disable_input sea false e independientemente de si está actualmente enfocado o no.
mouse_exited() 🔗
Emitida cuando el cursor del ratón sale del área visible de la Window, que no está ocluida detrás de otros Controls o ventanas, siempre que su Viewport.gui_disable_input sea false e independientemente de si está actualmente enfocado o no.
theme_changed() 🔗
Emitida cuando se envía la notificación NOTIFICATION_THEME_CHANGED.
title_changed() 🔗
Emitida cuando se cambia el texto de la barra de título de la ventana.
titlebar_changed() 🔗
Emitida cuando se cambian las decoraciones de la barra de título de la ventana, por ejemplo, la ventana de macOS entra/sale del modo de pantalla completa, o se cambia la bandera de extender al título.
visibility_changed() 🔗
Emitida cuando Window se hace visible o desaparece.
window_input(event: InputEvent) 🔗
Emitida cuando la Window está actualmente enfocada y recibe cualquier entrada, pasando el evento recibido como argumento. La posición del evento, si está presente, está en el sistema de coordenadas del incrustador.
Enumeraciones
enum Mode: 🔗
Mode MODE_WINDOWED = 0
Modo de ventana, es decir, Window no ocupa toda la pantalla (a menos que se establezca el tamaño de la pantalla).
Mode MODE_MINIMIZED = 1
Modo de ventana minimizada, es decir, Window no es visible y está disponible en la lista de ventanas del gestor de ventanas. Normalmente ocurre cuando se pulsa el botón de minimizar.
Mode MODE_MAXIMIZED = 2
Modo de ventana maximizada, es decir, Window ocupará toda el área de la pantalla excepto la barra de tareas y seguirá mostrando sus bordes. Normalmente ocurre cuando se pulsa el botón de maximizar.
Mode MODE_FULLSCREEN = 3
Modo de pantalla completa con soporte completo para múltiples ventanas.
La ventana de pantalla completa cubre toda el área de visualización de una pantalla y no tiene decoraciones. El modo de vídeo de la pantalla no se cambia.
En Android: Esto habilita el modo inmersivo.
En macOS: Se utiliza un nuevo escritorio para mostrar el proyecto en ejecución.
Nota: Independientemente de la plataforma, habilitar la pantalla completa cambiará el tamaño de la ventana para que coincida con el tamaño del monitor. Por lo tanto, asegúrate de que tu proyecto admita múltiples resoluciones al habilitar el modo de pantalla completa.
Mode MODE_EXCLUSIVE_FULLSCREEN = 4
Un solo modo de pantalla completa. Este modo tiene menos sobrecarga, pero solo una ventana puede estar abierta en una pantalla a la vez (abrir una ventana secundaria o cambiar de aplicación provocará una transición a pantalla completa).
La ventana de pantalla completa cubre toda el área de visualización de una pantalla y no tiene bordes ni decoraciones. El modo de vídeo de la pantalla no se cambia.
Nota: Este modo podría no funcionar con el software de grabación de pantalla.
En Android: Esto habilita el modo inmersivo.
En Windows: Dependiendo del controlador de vídeo, la transición a pantalla completa podría provocar que las pantallas se pongan negras por un momento.
En macOS: Se utiliza un nuevo escritorio para mostrar el proyecto en ejecución. El modo de pantalla completa exclusivo evita que el Dock y el Menú aparezcan cuando el puntero del ratón se sitúa sobre el borde de la pantalla.
En Linux (X11): El modo de pantalla completa exclusivo evita el compositor.
En Linux (Wayland): Equivalente a MODE_FULLSCREEN.
Nota: Independientemente de la plataforma, habilitar la pantalla completa cambiará el tamaño de la ventana para que coincida con el tamaño del monitor. Por lo tanto, asegúrate de que tu proyecto admita múltiples resoluciones al habilitar el modo de pantalla completa.
enum Flags: 🔗
Flags FLAG_RESIZE_DISABLED = 0
La ventana no se puede redimensionar arrastrando su control de redimensionamiento. Todavía es posible redimensionar la ventana usando size. Esta bandera se ignora para las ventanas de pantalla completa. Se establece con unresizable.
Flags FLAG_BORDERLESS = 1
La ventana no tiene barra de título nativa ni otras decoraciones. Esta bandera se ignora para las ventanas de pantalla completa. Se establece con borderless.
Flags FLAG_ALWAYS_ON_TOP = 2
La ventana está flotando por encima de todas las demás ventanas. Esta bandera se ignora para las ventanas de pantalla completa. Se establece con always_on_top.
Flags FLAG_TRANSPARENT = 3
El fondo de la ventana puede ser transparente. Se establece con transparent.
Nota: Esta bandera no tiene efecto si ProjectSettings.display/window/per_pixel_transparency/allowed o Viewport.transparent_bg de la ventana está establecido en false.
Flags FLAG_NO_FOCUS = 4
La ventana no se puede enfocar. Si no se enfoca, se ignorarán todas las entradas, excepto los clics del ratón. Se configura con unfocusable.
Flags FLAG_POPUP = 5
La ventana es parte del menú o el desplegable OptionButton. Esta bandera no se puede cambiar cuando la ventana está visible. Una ventana emergente activa recibirá exclusivamente toda la entrada, sin robar el foco de su padre. Las ventanas emergentes se cierran automáticamente cuando los usuarios hacen clic fuera de ella o cuando se cambia de aplicación. La ventana emergente debe tener un padre transitorio establecido (véase transient).
Nota: Esta bandera no tiene efecto en las ventanas incrustadas (a menos que dicha ventana sea un Popup).
Flags FLAG_EXTEND_TO_TITLE = 6
El contenido de la ventana se expande al tamaño completo de la ventana. A diferencia de la ventana sin bordes, el marco se deja intacto y se puede utilizar para redimensionar la ventana, la barra de título es transparente, pero tiene botones de minimizar/maximizar/cerrar. Se establece con extend_to_title.
Nota: Esta bandera sólo se implementa en macOS.
Nota: Esta bandera no tiene efecto en las ventanas incrustadas.
Flags FLAG_MOUSE_PASSTHROUGH = 7
Todos los eventos del ratón se transfieren a la ventana subyacente de la misma aplicación.
Nota: Esta opción no tiene efecto en ventanas incrustadas.
Flags FLAG_SHARP_CORNERS = 8
El estilo de la ventana es sobreescrito, forzando las esquinas a ser rectas.
Nota: Esta bandera no tiene efecto en ventanas embebidas.
Nota: Esta bandera solo está implementada en Windows (11).
Flags FLAG_EXCLUDE_FROM_CAPTURE = 9
Las ventanas se excluyen de las capturas de pantalla tomadas por DisplayServer.screen_get_image(), DisplayServer.screen_get_image_rect() y DisplayServer.screen_get_pixel().
Nota: Esta bandera no tiene ningún efecto en ventanas integradas.
Nota: Esta bandera está implementada en macOS y Windows (10, 20H1).
Nota: Establecer esta bandera evitará que los métodos de captura de pantalla estándar capturen una imagen de la ventana, pero NO garantiza que otras aplicaciones no puedan capturar una imagen. No debe utilizarse como medida de DRM o de seguridad.
Flags FLAG_POPUP_WM_HINT = 10
Señala al gestor de ventanas que se supone que esta ventana es un "popup" definido por la implementación (normalmente una ventana hija flotante, sin bordes, no tileable e inamovible).
Flags FLAG_MINIMIZE_DISABLED = 11
El botón para minimizar la ventana se deshabilita.
Nota: Esta opción está implementada en macOS y Windows.
Flags FLAG_MAXIMIZE_DISABLED = 12
El botón para maximizar la ventana se deshabilita.
Nota: Esta opción está implementada en macOS y Windows.
Flags FLAG_MAX = 13
Valor máximo de Flags.
enum ContentScaleMode: 🔗
ContentScaleMode CONTENT_SCALE_MODE_DISABLED = 0
El contenido no se escalará para coincidir con el tamaño de la Window.
ContentScaleMode CONTENT_SCALE_MODE_CANVAS_ITEMS = 1
El contenido se renderizará al tamaño objetivo. Esto consume más rendimiento que CONTENT_SCALE_MODE_VIEWPORT, pero proporciona mejores resultados.
ContentScaleMode CONTENT_SCALE_MODE_VIEWPORT = 2
El contenido se renderizará al tamaño base y luego se escalará al tamaño objetivo. Más rendidor que CONTENT_SCALE_MODE_CANVAS_ITEMS, pero resulta en una imagen pixelada.
enum ContentScaleAspect: 🔗
ContentScaleAspect CONTENT_SCALE_ASPECT_IGNORE = 0
La relación de aspecto será ignorada. El escalado simplemente estirará el contenido para que se ajuste al tamaño objetivo.
ContentScaleAspect CONTENT_SCALE_ASPECT_KEEP = 1
La relación de aspecto del contenido será preservada. Si el tamaño objetivo tiene una relación de aspecto diferente al base, la imagen será centrada y aparecerán barras negras a los lados izquierdo y derecho.
ContentScaleAspect CONTENT_SCALE_ASPECT_KEEP_WIDTH = 2
El contenido puede ser expandido verticalmente. Escalar horizontalmente resultará en mantener la relación de ancho y luego barras negras a los lados izquierdo y derecho.
ContentScaleAspect CONTENT_SCALE_ASPECT_KEEP_HEIGHT = 3
El contenido puede ser expandido horizontalmente. Escalar verticalmente resultará en mantener la relación de alto y luego barras negras en la parte superior e inferior.
ContentScaleAspect CONTENT_SCALE_ASPECT_EXPAND = 4
La relación de aspecto del contenido será preservada. Si el tamaño objetivo tiene una relación de aspecto diferente al base, el contenido permanecerá en la esquina superior izquierda y añadirá un área visible extra en el espacio estirado.
enum ContentScaleStretch: 🔗
ContentScaleStretch CONTENT_SCALE_STRETCH_FRACTIONAL = 0
El contenido se estirará de acuerdo a un factor fraccional. Esto llena todo el espacio disponible en la ventana, pero permite que ocurra un "tambaleo de píxeles" debido a un escalado de píxeles desigual.
ContentScaleStretch CONTENT_SCALE_STRETCH_INTEGER = 1
El contenido se estirará únicamente según un factor entero, preservando la nitidez de los píxeles. Esto puede dejar un fondo negro visible en los bordes de la ventana dependiendo del tamaño de la misma.
enum LayoutDirection: 🔗
LayoutDirection LAYOUT_DIRECTION_INHERITED = 0
Dirección de diseño automática, determinada a partir de la dirección de diseño de la ventana padre.
LayoutDirection LAYOUT_DIRECTION_APPLICATION_LOCALE = 1
Dirección de diseño automática, determinada a partir de la configuración regional actual.
LayoutDirection LAYOUT_DIRECTION_LTR = 2
Dirección de diseño de izquierda a derecha.
LayoutDirection LAYOUT_DIRECTION_RTL = 3
Dirección de diseño de derecha a izquierda.
LayoutDirection LAYOUT_DIRECTION_SYSTEM_LOCALE = 4
Dirección de diseño automática, determinada a partir de la configuración regional del sistema.
LayoutDirection LAYOUT_DIRECTION_MAX = 5
Representa el tamaño del enum LayoutDirection.
LayoutDirection LAYOUT_DIRECTION_LOCALE = 1
Obsoleto: Use LAYOUT_DIRECTION_APPLICATION_LOCALE instead.
enum WindowInitialPosition: 🔗
WindowInitialPosition WINDOW_INITIAL_POSITION_ABSOLUTE = 0
La posición inicial de la ventana es determinada por position.
WindowInitialPosition WINDOW_INITIAL_POSITION_CENTER_PRIMARY_SCREEN = 1
La posición inicial de la ventana es el centro de la pantalla principal.
WindowInitialPosition WINDOW_INITIAL_POSITION_CENTER_MAIN_WINDOW_SCREEN = 2
La posición inicial de la ventana es el centro de la pantalla de la ventana principal.
WindowInitialPosition WINDOW_INITIAL_POSITION_CENTER_OTHER_SCREEN = 3
La posición inicial de la ventana es el centro de la pantalla de current_screen.
WindowInitialPosition WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_MOUSE_FOCUS = 4
La posición inicial de la ventana es el centro de la pantalla que contiene el puntero del ratón.
WindowInitialPosition WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_KEYBOARD_FOCUS = 5
La posición inicial de la ventana es el centro de la pantalla que contiene la ventana con el foco del teclado.
Constantes
NOTIFICATION_VISIBILITY_CHANGED = 30 🔗
Emitida cuando la visibilidad de la Window cambia, justo antes de visibility_changed.
NOTIFICATION_THEME_CHANGED = 32 🔗
Se envía cuando el nodo necesita actualizar sus elementos de tema. Esto ocurre en uno de los siguientes casos:
La propiedad theme se cambia en este nodo o en cualquiera de sus ancestros.
La propiedad theme_type_variation se cambia en este nodo.
El nodo entra en el árbol de escenas.
Nota: Como optimización, esta notificación no se enviará desde los cambios que se produzcan mientras este nodo esté fuera del árbol de la escena. En su lugar, todas las actualizaciones de los elementos del tema se pueden aplicar a la vez cuando el nodo entra en el árbol de escenas.
Descripciones de Propiedades
String accessibility_description = "" 🔗
La descripción del nodo legible por humanos que se reporta a las aplicaciones de asistencia.
String accessibility_name = "" 🔗
El nombre del nodo legible por humanos que se informa a las apps de asistencia.
Si es true, la ventana estará encima de todas las demás ventanas. No funciona si transient está habilitado.
Obsoleto: Use Node.auto_translate_mode and Node.can_auto_translate() instead.
Activa o desactiva si algún texto debe cambiar automáticamente a su versión traducida dependiendo de la configuración regional actual.
Si es true, la ventana no tendrá bordes.
ContentScaleAspect content_scale_aspect = 0 🔗
void set_content_scale_aspect(value: ContentScaleAspect)
ContentScaleAspect get_content_scale_aspect()
Especifica cómo se comporta el aspecto del contenido cuando se redimensiona la Window. El aspecto base está determinado por content_scale_size.
float content_scale_factor = 1.0 🔗
Especifica la escala base del contenido de Window cuando su size es igual a content_scale_size. Véase también Viewport.get_stretch_transform().
ContentScaleMode content_scale_mode = 0 🔗
void set_content_scale_mode(value: ContentScaleMode)
ContentScaleMode get_content_scale_mode()
Especifica cómo se escala el contenido cuando se redimensiona la Window.
Vector2i content_scale_size = Vector2i(0, 0) 🔗
Tamaño base del contenido (es decir, los nodos que se dibujan dentro de la ventana). Si es distinto de cero, el contenido de Window se escalará cuando la ventana se redimensione a un tamaño diferente.
ContentScaleStretch content_scale_stretch = 0 🔗
void set_content_scale_stretch(value: ContentScaleStretch)
ContentScaleStretch get_content_scale_stretch()
La política a utilizar para determinar el factor de escala final para los elementos 2D. Esto afecta a cómo se aplica content_scale_factor, además del factor de escala automático determinado por content_scale_size.
La pantalla en la que se encuentra actualmente la ventana.
bool exclude_from_capture = false 🔗
Si es true, la Window se excluye de las capturas de pantalla tomadas por DisplayServer.screen_get_image(), DisplayServer.screen_get_image_rect() y DisplayServer.screen_get_pixel().
Nota: Esta propiedad se implementa en macOS y Windows.
Nota: Habilitar esta configuración evitará que los métodos estándar de captura de pantalla capturen una imagen de la ventana, pero NO garantiza que otras aplicaciones no puedan capturar una imagen. No debe utilizarse como medida de DRM o seguridad.
Si es true, la Window estará en modo exclusivo. Las ventanas exclusivas siempre están encima de su padre y bloquearán toda la entrada dirigida a la Window padre.
Necesita transient habilitado para funcionar.
bool extend_to_title = false 🔗
Si es true, el contenido de la Window se expande al tamaño completo de la ventana, la barra de título de la ventana es transparente.
Nota: Esta propiedad solo se implementa en macOS.
Nota: Esta propiedad solo funciona con ventanas nativas.
Si es true, se utilizará la ventana nativa independientemente del viewport principal y de la configuración del proyecto.
WindowInitialPosition initial_position = 0 🔗
void set_initial_position(value: WindowInitialPosition)
WindowInitialPosition get_initial_position()
Especifica el tipo de posición inicial para la Window.
bool keep_title_visible = false 🔗
Si es true, el ancho de la Window se expande para mantener el texto de la barra de título completamente visible.
Vector2i max_size = Vector2i(0, 0) 🔗
Si es distinto de cero, la Window no se puede redimensionar para que sea más grande que este tamaño.
Nota: Esta propiedad se ignorará si el valor es inferior a min_size.
bool maximize_disabled = false 🔗
Si es true, el botón de maximizar de la Window está deshabilitado.
Nota: Si tanto el botón de minimizar como el de maximizar están deshabilitados, los botones están completamente ocultos y solo el botón de cerrar está visible.
Nota: Esta propiedad solo se implementa en macOS y Windows.
Vector2i min_size = Vector2i(0, 0) 🔗
Si es distinto de cero, la Window no se puede redimensionar para que sea más pequeña que este tamaño.
Nota: Esta propiedad se ignorará en favor de get_contents_minimum_size() si wrap_controls está habilitado y si su tamaño es mayor.
bool minimize_disabled = false 🔗
Si es true, el botón de minimizar de la Window está deshabilitado.
Nota: Si tanto el botón de minimizar como el de maximizar están deshabilitados, los botones están completamente ocultos y solo el botón de cerrar está visible.
Nota: Esta propiedad solo se implementa en macOS y Windows.
Establece el modo actual de la ventana.
Nota: El modo de pantalla completa no es pantalla completa exclusiva en Windows y Linux.
Nota: Este método solo funciona con ventanas nativas, es decir, la ventana principal y los nodos derivados de Window cuando Viewport.gui_embed_subwindows está deshabilitado en el viewport principal.
bool mouse_passthrough = false 🔗
Si es true, todos los eventos del ratón se pasarán a la ventana subyacente de la misma aplicación. Véase también mouse_passthrough_polygon.
Nota: Esta propiedad está implementada en Linux (X11), macOS y Windows.
Nota: Esta propiedad solo funciona con ventanas nativas.
PackedVector2Array mouse_passthrough_polygon = PackedVector2Array() 🔗
void set_mouse_passthrough_polygon(value: PackedVector2Array)
PackedVector2Array get_mouse_passthrough_polygon()
Establece una región poligonal de la ventana que acepta eventos del ratón. Los eventos del ratón fuera de la región se pasarán a través de ella.
Pasar un array vacío desactivará el soporte de paso (todos los eventos del ratón serán interceptados por la ventana, que es el comportamiento por defecto).
# Establecer la región, usando el nodo Path2D.
$Window.mouse_passthrough_polygon = $Path2D.curve.get_baked_points()
# Establecer la región, usando el nodo Polygon2D.
$Window.mouse_passthrough_polygon = $Polygon2D.polygon
# Restablecer la región a su valor por defecto.
$Window.mouse_passthrough_polygon = []
// Establecer la región, usando el nodo Path2D.
GetNode<Window>("Window").MousePassthroughPolygon = GetNode<Path2D>("Path2D").Curve.GetBakedPoints();
// Establecer la región, usando el nodo Polygon2D.
GetNode<Window>("Window").MousePassthroughPolygon = GetNode<Polygon2D>("Polygon2D").Polygon;
// Restablecer la región a su valor por defecto.
GetNode<Window>("Window").MousePassthroughPolygon = [];
Nota: Esta propiedad se ignora si mouse_passthrough se establece en true.
Nota: En Windows, la parte de una ventana que se encuentra fuera de la región no se dibuja, mientras que en Linux (X11) y macOS sí.
Nota: Esta propiedad está implementada en Linux (X11), macOS y Windows.
Note: The returned array is copied and any changes to it will not update the original property value. See PackedVector2Array for more details.
Si es true, la Window se considerará un popup. Los popups son subventanas que no se muestran como ventanas separadas en la lista de ventanas del gestor de ventanas del sistema y enviarán una solicitud de cierre cuando se haga clic fuera de ellas (a menos que exclusive esté habilitado).
Si es true, la Window le indicará al administrador de ventanas que se supone que es un "popup" definido por la implementación (normalmente una ventana secundaria flotante, sin bordes, no apilable e inamovible).
Vector2i position = Vector2i(0, 0) 🔗
La posición de la ventana en píxeles.
Si ProjectSettings.display/window/subwindows/embed_subwindows es false, la posición está en coordenadas de pantalla absolutas. Esto se aplica normalmente a los plugins del editor. Si el ajuste es true, la posición de la ventana está en las coordenadas de su Viewport padre.
Nota: Esta propiedad solo funciona si initial_position está establecido en WINDOW_INITIAL_POSITION_ABSOLUTE.
Si es true, la Window anulará el estilo de ventana del SO para mostrar esquinas afiladas.
Nota: Esta propiedad solo se implementa en Windows (11).
Nota: Esta propiedad solo funciona con ventanas nativas.
Vector2i size = Vector2i(100, 100) 🔗
El tamaño de la ventana en píxeles.
El recurso Theme que este nodo y todos sus hijos Control y Window usan. Si un nodo hijo tiene su propio recurso Theme establecido, los elementos del tema se fusionan con las definiciones del hijo, teniendo este mayor prioridad.
Nota: Los estilos de Window no tendrán efecto a menos que la ventana esté integrada.
StringName theme_type_variation = &"" 🔗
void set_theme_type_variation(value: StringName)
StringName get_theme_type_variation()
El nombre de una variación de tipo de tema utilizada por esta Window para buscar sus propios elementos de tema. Véase Control.theme_type_variation para obtener más detalles.
El título de la ventana. Si la Window es nativa, los estilos de título establecidos en Theme no tendrán efecto.
Si es true, la Window es transitoria, es decir, se considera un hijo de otra Window. La ventana transitoria se destruirá con su padre transitorio y devolverá el foco a su padre cuando se cierre. La ventana transitoria se muestra encima de una ventana padre de pantalla completa no exclusiva. Las ventanas transitorias no pueden entrar en modo de pantalla completa.
Ten en cuenta que el comportamiento puede ser diferente dependiendo de la plataforma.
bool transient_to_focused = false 🔗
Si es true, y la Window es transient, esta ventana (en el momento de hacerse visible) se volverá transitoria a la ventana actualmente enfocada en lugar de la ventana padre inmediata en la jerarquía. Ten en cuenta que el padre transitorio se asigna en el momento en que esta ventana se hace visible, por lo que cambiarlo después no tiene ningún efecto hasta que se vuelva a mostrar.
Si es true, el fondo de la Window puede ser transparente. Esto se utiliza mejor con ventanas incrustadas.
Nota: El soporte de transparencia está implementado en Linux, macOS y Windows, pero la disponibilidad puede variar dependiendo del controlador de la GPU, el administrador de la pantalla y las capacidades del compositor.
Nota: Esta propiedad no tiene efecto si ProjectSettings.display/window/per_pixel_transparency/allowed se establece en false.
Si es true, no se puede enfocar ni interactuar con la Window. Aún puede ser visible.
Si es true, no se puede cambiar el tamaño de la ventana.
Si es true, la ventana es visible.
Si es true, el tamaño de la ventana se actualizará automáticamente cuando se añada o se elimine un nodo hijo, ignorando min_size si el nuevo tamaño es mayor.
Si es false, debes llamar a child_controls_changed() manualmente.
Descripciones de Métodos
Vector2 _get_contents_minimum_size() virtual const 🔗
Método virtual que implementará el usuario. Sobrescribe el valor devuelto por get_contents_minimum_size().
void add_theme_color_override(name: StringName, color: Color) 🔗
Crea una sobrescritura local para un tema Color con el name especificado. Las anulaciones locales siempre tienen prioridad al obtener elementos del tema para el control. Una sobrescritura se puede eliminar con remove_theme_color_override().
Véase también get_theme_color() y Control.add_theme_color_override() para obtener más información.
void add_theme_constant_override(name: StringName, constant: int) 🔗
Creates a local override for a theme constant with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with remove_theme_constant_override().
See also get_theme_constant().
void add_theme_font_override(name: StringName, font: Font) 🔗
Creates a local override for a theme Font with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with remove_theme_font_override().
See also get_theme_font().
void add_theme_font_size_override(name: StringName, font_size: int) 🔗
Creates a local override for a theme font size with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with remove_theme_font_size_override().
See also get_theme_font_size().
void add_theme_icon_override(name: StringName, texture: Texture2D) 🔗
Creates a local override for a theme icon with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with remove_theme_icon_override().
See also get_theme_icon().
void add_theme_stylebox_override(name: StringName, stylebox: StyleBox) 🔗
Crea una sobrescritura local para un StyleBox de tema con el name especificado. Las anulaciones locales siempre tienen prioridad al obtener elementos de tema para el control. Una sobrescritura se puede eliminar con remove_theme_stylebox_override().
Véase también get_theme_stylebox() y Control.add_theme_stylebox_override() para más detalles.
void begin_bulk_theme_override() 🔗
Prevents *_theme_*_override methods from emitting NOTIFICATION_THEME_CHANGED until end_bulk_theme_override() is called.
Devuelve si la ventana se está dibujando en la pantalla.
void child_controls_changed() 🔗
Solicita una actualización del tamaño de la Window para que se ajuste a los nodos Control subyacentes.
void end_bulk_theme_override() 🔗
Ends a bulk theme override update. See begin_bulk_theme_override().
Vector2 get_contents_minimum_size() const 🔗
Devuelve el tamaño mínimo combinado de los nodos Control secundarios de la ventana. Usa child_controls_changed() para actualizarlo cuando los nodos secundarios hayan cambiado.
El valor devuelto por este método puede ser anulado con _get_contents_minimum_size().
bool get_flag(flag: Flags) const 🔗
Devuelve true si la flag está configurado.
Window get_focused_window() static 🔗
Devuelve la ventana enfocada.
LayoutDirection get_layout_direction() const 🔗
Devuelve la dirección del diseño y la dirección de escritura del texto.
Vector2i get_position_with_decorations() const 🔗
Devuelve la posición de la ventana incluyendo su borde.
Nota: Si visible es false, este método devuelve el mismo valor que position.
Vector2i get_size_with_decorations() const 🔗
Devuelve el tamaño de la ventana incluyendo su borde.
Nota: Si visible es false, este método devuelve el mismo valor que size.
Color get_theme_color(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve un Color del primer Theme coincidente en el árbol si ese Theme tiene un elemento de color con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
int get_theme_constant(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve una constante del primer Theme coincidente en el árbol si ese Theme tiene un elemento constante con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
float get_theme_default_base_scale() const 🔗
Devuelve el valor de escala base predeterminado del primer Theme coincidente en el árbol si ese Theme tiene un valor Theme.default_base_scale válido.
Véase Control.get_theme_color() para obtener más detalles.
Font get_theme_default_font() const 🔗
Devuelve la fuente predeterminada del primer Theme coincidente en el árbol si ese Theme tiene un valor Theme.default_font válido.
Véase Control.get_theme_color() para obtener más detalles.
int get_theme_default_font_size() const 🔗
Devuelve el valor de tamaño de fuente predeterminado del primer Theme coincidente en el árbol si ese Theme tiene un valor Theme.default_font_size válido.
Véase Control.get_theme_color() para obtener más detalles.
Font get_theme_font(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve una Font del primer Theme coincidente en el árbol si ese Theme tiene un elemento de fuente con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
int get_theme_font_size(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve un tamaño de fuente del primer Theme coincidente en el árbol si ese Theme tiene un elemento de tamaño de fuente con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
Texture2D get_theme_icon(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve un icono del primer Theme coincidente en el árbol si ese Theme tiene un elemento de icono con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
StyleBox get_theme_stylebox(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve un StyleBox del primer Theme coincidente en el árbol si ese Theme tiene un elemento de stylebox con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
Devuelve el ID de la ventana.
void grab_focus() 🔗
Hace que la ventana tome el foco, permitiéndole recibir la entrada del usuario.
Devuelve true si la ventana está enfocada.
bool has_theme_color(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve true si hay un Theme coincidente en el árbol que tiene un elemento de color con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
bool has_theme_color_override(name: StringName) const 🔗
Devuelve true si hay una sobrescritura local para un Color de tema con el name especificado en este nodo Control.
Véase add_theme_color_override().
bool has_theme_constant(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve true si hay un Theme coincidente en el árbol que tiene un elemento constante con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
bool has_theme_constant_override(name: StringName) const 🔗
Devuelve true si existe una sobrescritura local para una constante de tema con el name especificado en este nodo Control.
Véase add_theme_constant_override().
bool has_theme_font(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve true si hay un Theme coincidente en el árbol que tiene un elemento de fuente con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
bool has_theme_font_override(name: StringName) const 🔗
Devuelve true si hay una sobrescritura local para una Font de tema con el name especificado en este nodo Control.
Véase add_theme_font_override().
bool has_theme_font_size(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve true si hay un Theme coincidente en el árbol que tiene un elemento de tamaño de fuente con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
bool has_theme_font_size_override(name: StringName) const 🔗
Devuelve true si hay una sobrescritura local para un tamaño de fuente de tema con el name especificado en este nodo Control.
Véase add_theme_font_size_override().
bool has_theme_icon(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve true si hay un Theme coincidente en el árbol que tiene un elemento de icono con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
bool has_theme_icon_override(name: StringName) const 🔗
Devuelve true si hay una sobrescritura local para un icono de tema con el name especificado en este nodo Control.
Véase add_theme_icon_override().
bool has_theme_stylebox(name: StringName, theme_type: StringName = &"") const 🔗
Devuelve true si hay un Theme coincidente en el árbol que tiene un elemento de stylebox con el name y el theme_type especificados.
Véase Control.get_theme_color() para obtener más detalles.
bool has_theme_stylebox_override(name: StringName) const 🔗
Devuelve true si hay una sobrescritura local para un StyleBox de tema con el name especificado en este nodo Control.
Véase add_theme_stylebox_override().
void hide() 🔗
Oculta la ventana. No es lo mismo que el estado minimizado. No se puede interactuar con una ventana oculta y debe hacerse visible con show().
Devuelve true si la ventana está actualmente incrustada en otra ventana.
Devuelve true si el diseño es de derecha a izquierda.
bool is_maximize_allowed() const 🔗
Devuelve true si la ventana se puede maximizar (el botón de maximizar está habilitado).
bool is_using_font_oversampling() const 🔗
Devuelve true si el sobremuestreo de fuentes está habilitado. Véase set_use_font_oversampling().
void move_to_center() 🔗
Centra una ventana nativa en la pantalla actual y una ventana incrustada en su Viewport incrustado.
void move_to_foreground() 🔗
Obsoleto: Use grab_focus() instead.
Hace que la ventana tome el foco, permitiéndole recibir la entrada del usuario.
void popup(rect: Rect2i = Rect2i(0, 0, 0, 0)) 🔗
Muestra la Window y la hace transitoria (ver transient). Si se proporciona rect, se establecerá como el tamaño de la Window. Falla si se llama en la ventana principal.
Si ProjectSettings.display/window/subwindows/embed_subwindows es true (modo de ventana única), las coordenadas de rect son globales y relativas a la esquina superior izquierda de la ventana principal (excluyendo las decoraciones de la ventana). Si las coordenadas de posición de rect son negativas, la ventana se ubicará fuera de la ventana principal y puede que no sea visible como resultado.
Si ProjectSettings.display/window/subwindows/embed_subwindows es false (modo de múltiples ventanas), las coordenadas de rect son globales y relativas a la esquina superior izquierda de la pantalla más a la izquierda. Si las coordenadas de posición de rect son negativas, la ventana se colocará en la esquina superior izquierda de la pantalla.
Nota: rect debe estar en coordenadas globales si se especifica.
void popup_centered(minsize: Vector2i = Vector2i(0, 0)) 🔗
Muestra la Window en el centro de la pantalla actual, con un tamaño mínimo dado opcionalmente. Si la Window está incrustada, se centrará en el Viewport padre en su lugar.
Nota: Llamarlo con el valor predeterminado de minsize es equivalente a llamarlo con size.
void popup_centered_clamped(minsize: Vector2i = Vector2i(0, 0), fallback_ratio: float = 0.75) 🔗
Muestra la Window centrada dentro de su Window padre. fallback_ratio determina el tamaño máximo de la Window, en relación con su padre.
Nota: Llamarlo con el valor predeterminado de minsize es equivalente a llamarlo con size.
void popup_centered_ratio(ratio: float = 0.8) 🔗
Si Window está incrustada, muestra la Window centrada dentro de su incrustador y establece su tamaño como una ratio del tamaño del incrustador.
Si Window es una ventana nativa, muestra la Window centrada dentro de la pantalla de su Window padre y establece su tamaño como una ratio del tamaño de la pantalla.
void popup_exclusive(from_node: Node, rect: Rect2i = Rect2i(0, 0, 0, 0)) 🔗
Intenta asignar esta ventana emergente a la última ventana exclusiva relativa a from_node y, a continuación, llama a popup() en ella. El diálogo no debe tener un padre actual, de lo contrario, el método falla.
Véase también set_unparent_when_invisible() y Node.get_last_exclusive_window().
void popup_exclusive_centered(from_node: Node, minsize: Vector2i = Vector2i(0, 0)) 🔗
Intenta asignar esta ventana emergente a la última ventana exclusiva relativa a from_node y, a continuación, llama a popup_centered() en ella. El diálogo no debe tener un padre actual, de lo contrario, el método falla.
Véase también set_unparent_when_invisible() y Node.get_last_exclusive_window().
void popup_exclusive_centered_clamped(from_node: Node, minsize: Vector2i = Vector2i(0, 0), fallback_ratio: float = 0.75) 🔗
Intenta asignar esta ventana emergente a la última ventana exclusiva relativa a from_node y, a continuación, llama a popup_centered_clamped() en ella. El diálogo no debe tener un padre actual, de lo contrario, el método falla.
Véase también set_unparent_when_invisible() y Node.get_last_exclusive_window().
void popup_exclusive_centered_ratio(from_node: Node, ratio: float = 0.8) 🔗
Intenta asignar esta ventana emergente a la última ventana exclusiva relativa a from_node y, a continuación, llama a popup_centered_ratio() en ella. El diálogo no debe tener un padre actual, de lo contrario, el método falla.
Véase también set_unparent_when_invisible() y Node.get_last_exclusive_window().
void popup_exclusive_on_parent(from_node: Node, parent_rect: Rect2i) 🔗
Intenta asignar esta ventana emergente a la última ventana exclusiva relativa a from_node y, a continuación, llama a popup_on_parent() en ella. El diálogo no debe tener un padre actual, de lo contrario, el método falla.
Véase también set_unparent_when_invisible() y Node.get_last_exclusive_window().
void popup_on_parent(parent_rect: Rect2i) 🔗
Muestra la Window con una posición desplazada por la posición de la Window padre. Si la Window está incrustada, tiene el mismo efecto que popup().
void remove_theme_color_override(name: StringName) 🔗
Removes a local override for a theme Color with the specified name previously added by add_theme_color_override() or via the Inspector dock.
void remove_theme_constant_override(name: StringName) 🔗
Removes a local override for a theme constant with the specified name previously added by add_theme_constant_override() or via the Inspector dock.
void remove_theme_font_override(name: StringName) 🔗
Removes a local override for a theme Font with the specified name previously added by add_theme_font_override() or via the Inspector dock.
void remove_theme_font_size_override(name: StringName) 🔗
Removes a local override for a theme font size with the specified name previously added by add_theme_font_size_override() or via the Inspector dock.
void remove_theme_icon_override(name: StringName) 🔗
Removes a local override for a theme icon with the specified name previously added by add_theme_icon_override() or via the Inspector dock.
void remove_theme_stylebox_override(name: StringName) 🔗
Removes a local override for a theme StyleBox with the specified name previously added by add_theme_stylebox_override() or via the Inspector dock.
void request_attention() 🔗
Indica al sistema operativo que la Window necesita atención. Esto hace que la ventana destaque de alguna manera dependiendo del sistema, por ejemplo, podría parpadear en la barra de tareas.
void reset_size() 🔗
Restablece el tamaño al tamaño mínimo, que es el máximo de min_size y (si wrap_controls está habilitado) get_contents_minimum_size(). Esto equivale a llamar a set_size(Vector2i()) (o cualquier tamaño por debajo del mínimo).
void set_flag(flag: Flags, enabled: bool) 🔗
Establece una bandera de ventana específica.
void set_ime_active(active: bool) 🔗
Si active es true, habilita el IME (Editor de métodos de entrada) nativo del sistema.
void set_ime_position(position: Vector2i) 🔗
Mueve IME a la posición indicada.
void set_layout_direction(direction: LayoutDirection) 🔗
Establece la dirección del diseño y la dirección de escritura del texto. Los diseños de derecha a izquierda son necesarios para ciertos idiomas (por ejemplo, árabe y hebreo).
void set_unparent_when_invisible(unparent: bool) 🔗
Si unparent es true, la ventana se desvincula automáticamente al volverse invisible.
Nota: Asegúrate de mantener una referencia al nodo, de lo contrario, quedará huérfano. También debes llamar manualmente a Node.queue_free() para liberar la ventana si no está vinculada.
void set_use_font_oversampling(enable: bool) 🔗
Activa el sobremuestreo de fuentes. Esto hace que las fuentes se vean mejor cuando se escalan.
void show() 🔗
Hace que la Window aparezca. Esto permite las interacciones con la Window y no cambia ninguna de sus propiedades aparte de la visibilidad (a diferencia de, por ejemplo, popup()).
void start_drag() 🔗
Inicia una operación de arrastre interactiva en la ventana, utilizando la posición actual del ratón. Llama a este método al manejar la presión de un botón del ratón para simular un evento de presión en la barra de título de la ventana. El uso de este método permite que la ventana participe en el cambio de espacio, el mosaico y otras características del sistema.
void start_resize(edge: WindowResizeEdge) 🔗
Inicia una operación de redimensionamiento interactiva en la ventana, utilizando la posición actual del ratón. Llama a este método al manejar la presión de un botón del ratón para simular un evento de presión en el borde de la ventana.
Descripciones de las propiedades del tema
Color title_color = Color(0.875, 0.875, 0.875, 1) 🔗
El color del texto del título.
Color title_outline_modulate = Color(0, 0, 0, 1) 🔗
El color del contorno del texto del título.
Desplazamiento de la posición horizontal del botón de cierre, relativo al final de la barra de título, hacia el principio de la barra de título.
Desplazamiento de la posición vertical del botón de cierre, relativo a la parte inferior de la barra de título, hacia la parte superior de la barra de título.
Define el margen exterior en el que el borde de la ventana puede ser agarrado con el ratón y redimensionado.
Altura de la barra de título.
El tamaño del contorno del título.
La fuente utilizada para dibujar el título.
El tamaño de la fuente del título.
El icono del botón de cierre.
El icono del botón de cierre cuando se presiona.
El estilo de fondo utilizado cuando la Window está incrustada. Ten en cuenta que esto se dibuja solo debajo del contenido de la ventana, excluyendo el título. Para obtener bordes y un estilo de barra de título adecuados, puedes usar las propiedades expand_margin_* de StyleBoxFlat.
Nota: El fondo del contenido no será visible a menos que transparent esté habilitado.
StyleBox embedded_unfocused_border 🔗
El estilo de fondo utilizado cuando la Window está incrustada y desenfocada.