DisplayServer
Eredita: Object
Un'interfaccia server per la gestione delle finestre di basso livello.
Descrizione
DisplayServer gestisce tutto ciò che riguarda la gestione delle finestre. È separato da OS poiché un singolo sistema operativo può supportare più server di visualizzazione.
Modalità headless: Avviare il motore con l'argomento della riga di comando --headless Tutorial sulla riga di comando disabilita tutte le funzioni di rendering e gestione delle finestre. La maggior parte delle funzioni di DisplayServer restituirà valori fittizi in questo caso.
Metodi
Enumerazioni
enum Feature: 🔗
Deprecato: Use NativeMenu or PopupMenu instead.
Il server di visualizzazione supporta il menu globale. Ciò consente all'applicazione di visualizzare le voci del menu nella barra superiore del sistema operativo. macOS
Feature FEATURE_SUBWINDOWS = 1
Il server di visualizzazione supporta più finestre che possono essere spostate all'esterno della finestra principale. Windows, macOS, Linux (X11)
Feature FEATURE_TOUCHSCREEN = 2
Il server di visualizzazione supporta gli input da touchscreen. Windows, Linux (X11), Android, iOS, Web
Feature FEATURE_MOUSE = 3
Il server di visualizzazione supporta l'input dal mouse. Windows, macOS, Linux (X11/Wayland), Android, Web
Feature FEATURE_MOUSE_WARP = 4
Il server di visualizzazione supporta la deformazione delle coordinate del mouse per restringere il cursore del mouse in un'area, ma avvolgendo la posizione quando viene raggiunto uno dei bordi. Windows, macOS, Linux (X11/Wayland)
Feature FEATURE_CLIPBOARD = 5
Il server di visualizzazione supporta l'impostazione e l'ottenimento dei dati degli appunti. Vedi anche FEATURE_CLIPBOARD_PRIMARY. Windows, macOS, Linux (X11/Wayland), Android, iOS, Web
Feature FEATURE_VIRTUAL_KEYBOARD = 6
Il server di visualizzazione supporta l'apertura di una tastiera virtuale quando viene richiesto di immettere testo senza una tastiera fisica. Android, iOS, Web
Feature FEATURE_CURSOR_SHAPE = 7
Il server di visualizzazione supporta l'impostazione della forma del cursore del mouse in modo che sia diversa da quella predefinita. Windows, macOS, Linux (X11/Wayland), Android, Web
Feature FEATURE_CUSTOM_CURSOR_SHAPE = 8
Il server di visualizzazione supporta l'impostazione della forma del cursore del mouse su un'immagine personalizzata. Windows, macOS, Linux (X11/Wayland), Web
Feature FEATURE_NATIVE_DIALOG = 9
Il server di visualizzazione supporta la generazione di finestre di dialogo di testo utilizzando l'aspetto nativo del sistema operativo. Vedi dialog_show(). Windows, macOS
Feature FEATURE_IME = 10
Il server di visualizzazione supporta l'Input Method Editor, che è comunemente utilizzato per l'inserimento di testo cinese/giapponese/coreano. Questo è gestito dal sistema operativo, anziché da Godot. Windows, macOS, Linux (X11)
Feature FEATURE_WINDOW_TRANSPARENCY = 11
Il server di visualizzazione supporta finestre che possono utilizzare la trasparenza per pixel per rendere le finestre dietro di esse parzialmente o completamente visibili. Windows, macOS, Linux (X11/Wayland), Android
Feature FEATURE_HIDPI = 12
Il server di visualizzazione supporta la richiesta al sistema operativo del fattore di scala del display. Ciò consente di rilevare automaticamente e affidabilmente l'hiDPI del display, anziché fare assunzioni in base alla risoluzione dello schermo e al DPI segnalato dal display (il che può essere inaffidabile a causa dell'EDID del monitor non funzionante). Windows, Linux (Wayland), macOS
Feature FEATURE_ICON = 13
Il server di visualizzazione supporta la modifica dell'icona della finestra (solitamente visualizzata nell'angolo in alto a sinistra). Windows, macOS, Linux (X11)
Feature FEATURE_NATIVE_ICON = 14
Il server di visualizzazione supporta la modifica dell'icona della finestra (solitamente visualizzata nell'angolo in alto a sinistra). Windows, macOS
Feature FEATURE_ORIENTATION = 15
Il server di visualizzazione supporta la modifica dell'orientamento dello schermo. Android, iOS
Feature FEATURE_SWAP_BUFFERS = 16
Il server di visualizzazione supporta lo stato V-Sync che può essere modificato rispetto a quello predefinito (che è forzato a essere abilitato sulle piattaforme che non supportano questa funzionalità). Windows, macOS, Linux (X11/Wayland)
Feature FEATURE_CLIPBOARD_PRIMARY = 18
Il server di visualizzazione supporta gli appunti primari. Questi sono appunti diversi da FEATURE_CLIPBOARD. Linux (X11/Wayland)
Feature FEATURE_TEXT_TO_SPEECH = 19
Il server di visualizzazione supporta la conversione da testo a voce. Vedi i metodi tts_*. Windows, macOS, Linux (X11/Wayland), Android, iOS, Web
Feature FEATURE_EXTEND_TO_TITLE = 20
Il server di visualizzazione supporta l'espansione del contenuto della finestra al titolo. Vedi WINDOW_FLAG_EXTEND_TO_TITLE. macOS
Feature FEATURE_SCREEN_CAPTURE = 21
Il server di visualizzazione supporta la lettura dei pixel nello schermo. Vedi screen_get_pixel().
Feature FEATURE_STATUS_INDICATOR = 22
Il server di visualizzazione supporta gli indicatori di stato dell'applicazione.
Feature FEATURE_NATIVE_HELP = 23
Il server di visualizzazione supporta i callback di ricerca nativa del sistema di aiuto. Vedere help_set_search_callbacks().
Feature FEATURE_NATIVE_DIALOG_INPUT = 24
Il server di visualizzazione supporta la generazione di finestre di dialogo di inserimento di testo utilizzando l'aspetto nativo del sistema operativo. Vedi dialog_input_text(). Windows, macOS
Feature FEATURE_NATIVE_DIALOG_FILE = 25
Il server di visualizzazione supporta la generazione di finestre di dialogo per la selezione di file o cartelle utilizzando l'aspetto nativo del sistema operativo. Vedi file_dialog_show(). Windows, macOS, Linux (X11/Wayland)
Feature FEATURE_NATIVE_DIALOG_FILE_EXTRA = 26
Il server di visualizzazione supporta tutte le funzionalità di FEATURE_NATIVE_DIALOG_FILE, con l'aggiunta di "opzioni" e accesso ai file per la finestra di dialogo nativa per i percorsi res:// e user:// . Vedi file_dialog_show() e file_dialog_with_options_show(). Windows, macOS, Linux (X11/Wayland)
Feature FEATURE_WINDOW_DRAG = 27
Il server di visualizzazione supporta l'avvio di operazioni di trascinamento e ridimensionamento delle finestre su richiesta. Vedi window_start_drag() e window_start_resize().
Feature FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE = 28
Il server di visualizzazione supporta il flag di finestra WINDOW_FLAG_EXCLUDE_FROM_CAPTURE. Windows, macOS
Feature FEATURE_WINDOW_EMBEDDING = 29
Il server di visualizzazione supporta l'incoporamento di una finestra proveniente da un altro processo. Windows, Linux (X11)
Feature FEATURE_NATIVE_DIALOG_FILE_MIME = 30
La finestra di dialogo nativa di selezione dei file supporta i tipi MIME come filtri.
Feature FEATURE_EMOJI_AND_SYMBOL_PICKER = 31
Il server di visualizzazione supporta il selettore di emoji e simboli del sistema. Windows, macOS
Feature FEATURE_NATIVE_COLOR_PICKER = 32
Il server di visualizzazione supporta un selettore di colore nativo. Linux (X11/Wayland)
Feature FEATURE_SELF_FITTING_WINDOWS = 33
Il server di visualizzazione adatta automaticamente i popup in base ai limiti dello schermo. I nodi Window non dovrebbero tentare di farlo autonomamente.
Feature FEATURE_ACCESSIBILITY_SCREEN_READER = 34
Il server di visualizzazione supporta l'interazione con i lettori dello schermo o i display Braille. Linux (X11/Wayland), macOS, Windows
enum AccessibilityRole: 🔗
AccessibilityRole ROLE_UNKNOWN = 0
Ruolo sconosciuto o personalizzato.
AccessibilityRole ROLE_DEFAULT_BUTTON = 1
Elemento pulsante di dialogo predefinito.
AccessibilityRole ROLE_AUDIO = 2
Elemento riproduttore audio.
AccessibilityRole ROLE_VIDEO = 3
Elemento riproduttore video.
AccessibilityRole ROLE_STATIC_TEXT = 4
Etichetta di testo non modificabile.
AccessibilityRole ROLE_CONTAINER = 5
Elemento contenitore. Gli elementi con questo ruolo sono utilizzati per la struttura interna e ignorati dai lettori dello schermo.
AccessibilityRole ROLE_PANEL = 6
Elemento contenitore di pannello.
AccessibilityRole ROLE_BUTTON = 7
Elemento pulsante.
AccessibilityRole ROLE_LINK = 8
Elemento collegamento.
AccessibilityRole ROLE_CHECK_BOX = 9
Elemento casella di spunta.
AccessibilityRole ROLE_RADIO_BUTTON = 10
Elemento pulsante di opzione (radio).
AccessibilityRole ROLE_CHECK_BUTTON = 11
Elemento pulsante di spunta.
AccessibilityRole ROLE_SCROLL_BAR = 12
Elemento barra di scorrimento.
AccessibilityRole ROLE_SCROLL_VIEW = 13
Elemento contenitore di scorrimento.
AccessibilityRole ROLE_SPLITTER = 14
Container splitter handle element.
AccessibilityRole ROLE_SLIDER = 15
Elemento slider.
AccessibilityRole ROLE_SPIN_BUTTON = 16
Elemento casella numerica.
AccessibilityRole ROLE_PROGRESS_INDICATOR = 17
Elemento indicatore di progresso.
AccessibilityRole ROLE_TEXT_FIELD = 18
Elemento campo di testo modificabile.
AccessibilityRole ROLE_MULTILINE_TEXT_FIELD = 19
Elemento campo di testo modificabile su più righe.
AccessibilityRole ROLE_COLOR_PICKER = 20
Elemento selettore di colore.
AccessibilityRole ROLE_TABLE = 21
Elemento tabella.
AccessibilityRole ROLE_CELL = 22
Elemento cella di albero/tabella.
AccessibilityRole ROLE_ROW = 23
Elemento riga di albero/tabella.
AccessibilityRole ROLE_ROW_GROUP = 24
Elemento gruppo di righe di albero/tabella.
AccessibilityRole ROLE_ROW_HEADER = 25
Elemento intestazione di riga di tabella/albero.
AccessibilityRole ROLE_COLUMN_HEADER = 26
Elemento intestazione di colonna di tabella/albero.
AccessibilityRole ROLE_TREE = 27
Elemento vista di albero.
AccessibilityRole ROLE_TREE_ITEM = 28
Elemento elemento di vista di albero.
AccessibilityRole ROLE_LIST = 29
Elemento lista.
AccessibilityRole ROLE_LIST_ITEM = 30
Elemento elemento di lista.
AccessibilityRole ROLE_LIST_BOX = 31
Elemento vista di lista.
AccessibilityRole ROLE_LIST_BOX_OPTION = 32
Elemento elemento di vista di lista.
AccessibilityRole ROLE_TAB_BAR = 33
Elemento barra di schede.
AccessibilityRole ROLE_TAB = 34
Elemento elemento di barra di schede.
AccessibilityRole ROLE_TAB_PANEL = 35
Elemento pannello di scheda.
Elemento barra di menu.
Elemento menu popup.
Elemento voce di menu popup.
Elemento elemento di pulsante di spunta di menu popup.
Elemento elemento di pulsante di opzione (radio) di menu popup.
AccessibilityRole ROLE_IMAGE = 41
Elemento immagine.
AccessibilityRole ROLE_WINDOW = 42
Elemento finestra.
AccessibilityRole ROLE_TITLE_BAR = 43
Elemento barra del titolo incorporata nella finestra.
AccessibilityRole ROLE_DIALOG = 44
Elemento finestra di dialogo.
AccessibilityRole ROLE_TOOLTIP = 45
Elemento suggerimento.
enum AccessibilityPopupType: 🔗
Elemento popup.
AccessibilityPopupType POPUP_LIST = 1
Lista popup.
AccessibilityPopupType POPUP_TREE = 2
Vista di albero popup.
AccessibilityPopupType POPUP_DIALOG = 3
Finestra di dialogo popup.
enum AccessibilityFlags: 🔗
L'elemento è nascosto per gli strumenti di accessibilità.
AccessibilityFlags FLAG_MULTISELECTABLE = 1
L'elemento supporta la selezione di più elementi.
AccessibilityFlags FLAG_REQUIRED = 2
L'elemento richiede l'input dell'utente.
AccessibilityFlags FLAG_VISITED = 3
L'elemento è un link visitato.
AccessibilityFlags FLAG_BUSY = 4
Il contenuto dell'elemento non è pronto (ad esempio, in caricamento).
AccessibilityFlags FLAG_MODAL = 5
L'elemento è una finestra modale.
AccessibilityFlags FLAG_TOUCH_PASSTHROUGH = 6
L'elemento permette di trasmettere i tocchi quando un lettore dello schermo è in modalità di esplorazione tattile.
AccessibilityFlags FLAG_READONLY = 7
L'elemento è un campo di testo, con testo selezionabile ma di sola lettura.
AccessibilityFlags FLAG_DISABLED = 8
L'elemento è disabilitato.
AccessibilityFlags FLAG_CLIPS_CHILDREN = 9
L'elemento ritaglia i figli.
enum AccessibilityAction: 🔗
AccessibilityAction ACTION_CLICK = 0
Azione di solo clic, l'argomento del callback non è impostato.
AccessibilityAction ACTION_FOCUS = 1
Azione di focalizzazione, l'argomento del callback non è impostato.
AccessibilityAction ACTION_BLUR = 2
Azione di sfocatura, l'argomento del callback non è impostato.
AccessibilityAction ACTION_COLLAPSE = 3
Azione di compressione, l'argomento del callback non è impostato.
AccessibilityAction ACTION_EXPAND = 4
Azione di espansione, l'argomento del callback non è impostato.
AccessibilityAction ACTION_DECREMENT = 5
Azione di decremento, l'argomento del callback non è impostato.
AccessibilityAction ACTION_INCREMENT = 6
Azione di incremento, l'argomento del callback non è impostato.
AccessibilityAction ACTION_HIDE_TOOLTIP = 7
Azione per nascondere un suggerimento, l'argomento del callback non è impostato.
AccessibilityAction ACTION_SHOW_TOOLTIP = 8
Azione per mostrare un suggerimento, l'argomento del callback non è impostato.
AccessibilityAction ACTION_SET_TEXT_SELECTION = 9
Azione di selezione testo, l'argomento del callback è impostato su un Dictionary con le seguenti chiavi:
"start_element"elemento di accessibilità dell'inizio della selezione."start_char"offset di carattere relativo all'elemento di accessibilità dell'inizio della selezione."end_element"elemento di accessibilità della fine della selezione."end_char"offset di carattere relativo all'elemento di accessibilità della fine della selezione.
AccessibilityAction ACTION_REPLACE_SELECTED_TEXT = 10
Azione di sostituzione testo, l'argomento del callback è impostato su una String con il testo sostitutivo.
AccessibilityAction ACTION_SCROLL_BACKWARD = 11
Azione di scorrimento indietro, l'argomento del callback non è impostato.
AccessibilityAction ACTION_SCROLL_DOWN = 12
Azione di scorrimento in basso, l'argomento del callback è impostato su AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_FORWARD = 13
Azione di scorrimento in avanti, l'argomento del callback non è impostato.
AccessibilityAction ACTION_SCROLL_LEFT = 14
Azione di scorrimento a sinistra, l'argomento del callback è impostato su AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_RIGHT = 15
Azione di scorrimento a destra, l'argomento del callback è impostato su AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_UP = 16
Azione di scorrimento in alto, l'argomento del callback è impostato su AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_INTO_VIEW = 17
Azione di scorrimento in vista, l'argomento del callback è impostato su AccessibilityScrollHint.
AccessibilityAction ACTION_SCROLL_TO_POINT = 18
Azione di scorrimento fino a un punto, l'argomento del callback è impostato su un Vector2 con le coordinate relative del punto.
AccessibilityAction ACTION_SET_SCROLL_OFFSET = 19
Azione di offset dello scorrimento, l'argomento del callback è impostato su un Vector2 con l'offset.
AccessibilityAction ACTION_SET_VALUE = 20
Azione di impostazione di un valore, l'argomento del callback è impostato su una String o su un numero con il nuovo valore.
Azione per mostrare il menu contestuale, l'argomento del callback non è impostato.
AccessibilityAction ACTION_CUSTOM = 22
Azione personalizzata, l'argomento del callback è impostato sull'ID intero dell'azione.
enum AccessibilityLiveMode: 🔗
AccessibilityLiveMode LIVE_OFF = 0
Indica che gli aggiornamenti alla regione attiva non devono presentarsi.
AccessibilityLiveMode LIVE_POLITE = 1
Indica che gli aggiornamenti alla regione attiva devono presentarsi alla prossima occasione (ad esempio alla fine della frase attuale).
AccessibilityLiveMode LIVE_ASSERTIVE = 2
Indica che gli aggiornamenti alla regione attiva hanno la massima priorità e devono presentarsi immediatamente.
enum AccessibilityScrollUnit: 🔗
AccessibilityScrollUnit SCROLL_UNIT_ITEM = 0
La quantità da scorrere. Un singolo elemento di un elenco, una riga di testo.
AccessibilityScrollUnit SCROLL_UNIT_PAGE = 1
La quantità da scorrere. Una singola pagina.
enum AccessibilityScrollHint: 🔗
AccessibilityScrollHint SCROLL_HINT_TOP_LEFT = 0
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo superiore sinistro del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_BOTTOM_RIGHT = 1
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo inferiore destro del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_TOP_EDGE = 2
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo superiore del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_BOTTOM_EDGE = 3
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo inferiore del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_LEFT_EDGE = 4
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo sinistro del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_RIGHT_EDGE = 5
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo destro del contenitore di scorrimento.
enum MouseMode: 🔗
MouseMode MOUSE_MODE_VISIBLE = 0
Rende visibile il cursore del mouse se è nascosto.
Nasconde il cursore del mouse se è visibile.
MouseMode MOUSE_MODE_CAPTURED = 2
Cattura il mouse. Il mouse sarà nascosto e la sua posizione sarà ristretta al centro della finestra del gestore delle finestre.
Nota: Se si desidera elaborare il movimento del mouse in questa modalità, bisogna usare InputEventMouseMotion.relative.
MouseMode MOUSE_MODE_CONFINED = 3
Restringe il cursore del mouse alla finestra del gioco e lo rende visibile.
Restringe il cursore del mouse alla finestra del gioco e lo rende nascosto.
MouseMode MOUSE_MODE_MAX = 5
Valore massimo di MouseMode.
enum ScreenOrientation: 🔗
ScreenOrientation SCREEN_LANDSCAPE = 0
Orientamento orizzontale predefinito.
ScreenOrientation SCREEN_PORTRAIT = 1
Orientamento verticale predefinito.
ScreenOrientation SCREEN_REVERSE_LANDSCAPE = 2
Orientamento orizzontale predefinito.
ScreenOrientation SCREEN_REVERSE_PORTRAIT = 3
Orientamento verticale inverso (capovolto).
ScreenOrientation SCREEN_SENSOR_LANDSCAPE = 4
Orientamento orizzontale automatico (predefinito o invertito a seconda del sensore).
ScreenOrientation SCREEN_SENSOR_PORTRAIT = 5
Orientamento verticale automatico (predefinito o invertito a seconda del sensore).
ScreenOrientation SCREEN_SENSOR = 6
Orientamento automatico orizzontale o verticale (predefinito o inverso a seconda del sensore).
enum VirtualKeyboardType: 🔗
VirtualKeyboardType KEYBOARD_TYPE_DEFAULT = 0
Tastiera virtuale di testo predefinita.
VirtualKeyboardType KEYBOARD_TYPE_MULTILINE = 1
Tastiera virtuale multilinea.
VirtualKeyboardType KEYBOARD_TYPE_NUMBER = 2
Tastierino numerico virtuale, utile per l'inserimento del PIN.
VirtualKeyboardType KEYBOARD_TYPE_NUMBER_DECIMAL = 3
Tastierino numerico virtuale, utile per inserire numeri frazionari.
VirtualKeyboardType KEYBOARD_TYPE_PHONE = 4
Tastiera virtuale per numeri di telefono.
VirtualKeyboardType KEYBOARD_TYPE_EMAIL_ADDRESS = 5
Tastiera virtuale con tasti aggiuntivi per facilitare la digitazione degli indirizzi e-mail.
VirtualKeyboardType KEYBOARD_TYPE_PASSWORD = 6
Tastiera virtuale per immettere una password. Sulla maggior parte delle piattaforme, questo dovrebbe disattivare il completamento automatico e l'autocapitalizzazione.
Nota: Questo non è supportato sul Web. Invece, si comporta in modo identico a KEYBOARD_TYPE_DEFAULT.
VirtualKeyboardType KEYBOARD_TYPE_URL = 7
Tastiera virtuale con tasti aggiuntivi per facilitare la digitazione degli URL.
enum CursorShape: 🔗
CursorShape CURSOR_ARROW = 0
Forma del cursore a freccia. Questa è la forma predefinita quando non si punta nulla che sovrascriva il cursore del mouse, come un LineEdit o un TextEdit.
CursorShape CURSOR_IBEAM = 1
Forma del cursore a I. Viene utilizzato come predefinito quando si passa il cursore su un controllo che accetta input di testo, come LineEdit o TextEdit.
CursorShape CURSOR_POINTING_HAND = 2
Forma del cursore di mano che punta. Viene utilizzato come predefinito quando si passa il cursore su un LinkButton o un tag URL in un RichTextLabel.
CursorShape CURSOR_CROSS = 3
Cursore a croce. È pensato per essere visualizzato quando l'utente ha bisogno di una mira precisa su un elemento, come uno strumento di selezione rettangolare o un selettore di colori.
CursorShape CURSOR_WAIT = 4
Cursore di attesa. Nella maggior parte dei temi del cursore, questo visualizza un'icona rotante accanto alla freccia. Pensato per essere utilizzato per operazioni non bloccanti (quando l'utente può fare qualcos'altro al momento). Vedi anche CURSOR_BUSY.
CursorShape CURSOR_BUSY = 5
Cursore di attesa. Nella maggior parte dei temi del cursore, questo sostituisce la freccia con un'icona rotante. Pensato per essere utilizzato per operazioni bloccanti (quando l'utente non può fare altro al momento). Vedi anche CURSOR_WAIT.
CursorShape CURSOR_DRAG = 6
Forma del cursore di mano che trascina. Viene visualizzato durante le operazioni di trascinamento e rilascio. Vedi anche CURSOR_CAN_DROP.
CursorShape CURSOR_CAN_DROP = 7
Cursore "Rilasciabile". Viene visualizzato durante le operazioni di trascinamento e rilascio se si passa il cursore su un Control che può accettare l'evento di trascinamento e rilascio. Nella maggior parte dei temi del cursore, viene visualizzata una mano che trascina con un simbolo di freccia accanto. Vedi anche CURSOR_DRAG.
CursorShape CURSOR_FORBIDDEN = 8
Cursore non consentito. Viene visualizzato durante le operazioni di trascinamento e rilascio se il Control su cui si passa il cursore non può accettare l'evento di trascinamento e rilascio.
CursorShape CURSOR_VSIZE = 9
Cursore di ridimensionamento verticale. Progettato per essere visualizzato quando il Control su cui si passa il cursore può essere ridimensionato verticalmente tramite il mouse. Vedi anche CURSOR_VSPLIT.
CursorShape CURSOR_HSIZE = 10
Cursore di ridimensionamento orizzontale. Progettato per essere visualizzato quando il Control su cui si passa il cursore può essere ridimensionato orizzontalmente tramite il mouse. Vedi anche CURSOR_HSPLIT.
CursorShape CURSOR_BDIAGSIZE = 11
Cursore di ridimensionamento diagonale secondario (in alto a destra/in basso a sinistra). Progettato per essere visualizzato quando il Control su cui si passa il cursore può essere ridimensionato su entrambi gli assi allo stesso tempo tramite il mouse.
CursorShape CURSOR_FDIAGSIZE = 12
Cursore di ridimensionamento diagonale principale (in alto a sinistra/in basso a destra). Progettato per essere visualizzato quando il Control su cui si passa il cursore può essere ridimensionato su entrambi gli assi allo stesso tempo tramite il mouse.
CursorShape CURSOR_MOVE = 13
Cursore di spostamento. Progettato per essere visualizzato quando il Control su cui si passa il mouse può essere spostato tramite il mouse.
CursorShape CURSOR_VSPLIT = 14
Cursore di divisione verticale. Viene visualizzato quando si passa il cursore su un Control con divisioni che possono essere ridimensionate verticalmente tramite il mouse, come VSplitContainer. In alcuni temi del cursore, questo cursore può avere lo stesso aspetto di CURSOR_VSIZE.
CursorShape CURSOR_HSPLIT = 15
Cursore di divisione orizzontale. Viene visualizzato quando si passa il cursore su un Control con divisioni che possono essere ridimensionate orizzontalmente tramite il mouse, come HSplitContainer. In alcuni temi del cursore, questo cursore può avere lo stesso aspetto di CURSOR_HSIZE.
CursorShape CURSOR_HELP = 16
Cursore di aiuto. Nella maggior parte dei temi del cursore, visualizza un'icona a forma di punto interrogativo al posto del cursore del mouse. Da utilizzare quando l'utente ha richiesto aiuto per l'elemento successivo che verrà cliccato.
CursorShape CURSOR_MAX = 17
Rappresenta la dimensione dell'enumerazione CursorShape.
enum FileDialogMode: 🔗
FileDialogMode FILE_DIALOG_MODE_OPEN_FILE = 0
La finestra di dialogo nativa dei file consente di selezionare solamente un file.
FileDialogMode FILE_DIALOG_MODE_OPEN_FILES = 1
La finestra di dialogo nativa dei file consente di selezionare più file.
FileDialogMode FILE_DIALOG_MODE_OPEN_DIR = 2
La finestra di dialogo nativa dei file consente solo la selezione di una cartella, non consentendo la selezione di alcun file.
FileDialogMode FILE_DIALOG_MODE_OPEN_ANY = 3
La finestra di dialogo nativa dei file consente di selezionare un file o una cartella.
FileDialogMode FILE_DIALOG_MODE_SAVE_FILE = 4
La finestra di dialogo nativa dei file avviserà quando esiste un file.
enum WindowMode: 🔗
WindowMode WINDOW_MODE_WINDOWED = 0
Modalità finestra, ovvero il Window non occupa l'intero schermo (a meno che non sia impostato sulla dimensione dello schermo).
WindowMode WINDOW_MODE_MINIMIZED = 1
Modalità finestra minimizzata, ovvero la Window non è visibile e disponibile nella lista finestre del gestore finestre. Normalmente accade quando si preme il pulsante di minimizzazione.
WindowMode WINDOW_MODE_MAXIMIZED = 2
Modalità finestra massimizzata, ovvero la Window occuperà l'intera area dello schermo, tranne la barra delle applicazioni, e visualizzerà comunque i suoi bordi. Normalmente accade quando si preme il pulsante di massimizzazione.
WindowMode WINDOW_MODE_FULLSCREEN = 3
Modalità a schermo intero con supporto multi-finestra completo.
La finestra a schermo intero copre l'intera area di visualizzazione di uno schermo e non ha decorazioni. La modalità video del display non cambia.
Su Android: Questo abilita la modalità immersiva.
Su macOS: È utilizzato un nuovo desktop per visualizzare il progetto in esecuzione.
Nota: A prescindere dalla piattaforma, abilitando lo schermo intero si modificheranno le dimensioni della finestra in modo che corrispondano alle dimensioni del monitor. Pertanto, assicurati che il tuo progetto supporti diverse risoluzioni quando abiliti la modalità a schermo intero.
WindowMode WINDOW_MODE_EXCLUSIVE_FULLSCREEN = 4
Modalità a schermo intero con una sola finestra. Questa modalità è più efficiente, ma può essere aperta solo una finestra alla volta su un determinato schermo (l'apertura di una finestra secondaria o il cambio dell'applicazione attiverà una transizione dallo schermo intero).
La finestra a schermo intero copre l'intera area di visualizzazione di uno schermo e non ha bordi o decorazioni. La modalità video del display non cambia.
Nota: Questa modalità potrebbe non funzionare con i software di registrazione dello schermo.
Su Android: Questo abilita la modalità immersiva.
Su Windows: A seconda del driver video, la transizione allo schermo intero potrebbe causare lo spegnimento momentaneo dello schermo.
Su macOS: È utilizzato un nuovo desktop per visualizzare il progetto in esecuzione. La modalità a schermo intero esclusiva impedisce che Dock e Menu vengano visualizzati quando il puntatore del mouse passa sul bordo dello schermo.
Su Linux (X11): La modalità a schermo intero esclusiva ignora il compositore.
Su Linux (Wayland): Equivalente a WINDOW_MODE_FULLSCREEN.
Nota: A prescindere dalla piattaforma, abilitando lo schermo intero si modificheranno le dimensioni della finestra in modo che corrispondano alle dimensioni del monitor. Pertanto, assicurati che il tuo progetto supporti diverse risoluzioni quando abiliti la modalità a schermo intero.
enum WindowFlags: 🔗
WindowFlags WINDOW_FLAG_RESIZE_DISABLED = 0
La finestra non può essere ridimensionata trascinando la sua impugnatura di ridimensionamento. È ancora possibile ridimensionare la finestra attraverso window_set_size(). Questo flag è ignorato per le finestre a schermo intero.
WindowFlags WINDOW_FLAG_BORDERLESS = 1
La finestra non ha la barra del titolo nativa e altre decorazioni. Questo flag è ignorato per le finestre a schermo intero.
WindowFlags WINDOW_FLAG_ALWAYS_ON_TOP = 2
La finestra è fluttuante sopra tutte le altre finestre. Questo flag è ignorato per le finestre a schermo intero.
WindowFlags WINDOW_FLAG_TRANSPARENT = 3
Lo sfondo della finestra può essere trasparente.
Nota: Questo flag non ha effetto se is_window_transparency_available() restituisce false.
Nota: Il supporto per la trasparenza è implementato su Linux (X11/Wayland), macOS e Windows, ma la disponibilità potrebbe variare a seconda del driver GPU, del gestore di visualizzazione e delle capacità del compositore.
Nota: Il supporto per la trasparenza è implementato su Android, ma può essere abilitato solo tramite ProjectSettings.display/window/per_pixel_transparency/allowed. Questo flag non ha effetto su Android.
WindowFlags WINDOW_FLAG_NO_FOCUS = 4
La finestra non può essere focalizzata. Una finestra impossibile da focalizzare ignorerà tutti gli input, tranne i clic del mouse.
WindowFlags WINDOW_FLAG_POPUP = 5
La finestra fa parte di un menu o del menu a tendina di un OptionButton. Questo flag non può essere cambiato quando la finestra è visibile. Una finestra popup attiva riceverà esclusivamente tutti gli input, senza rubare il focus dal suo genitore. Le finestre popup vengono chiuse automaticamente quando si clicca al di fuori di essa o quando si cambia applicazione. La finestra popup deve avere un genitore transitorio impostato (vedi window_set_transient()).
WindowFlags WINDOW_FLAG_EXTEND_TO_TITLE = 6
Il contenuto della finestra è esteso fino alle dimensioni massime della finestra. A differenza di una finestra senza bordi, la cornice è lasciata intatta e può essere utilizzata per ridimensionare la finestra, la barra del titolo è trasparente, ma ha pulsanti minimizza/massimizza/chiudi.
Utilizza window_set_window_buttons_offset() per regolare lo scostamento dei pulsanti minimizza/massimizza/chiudi.
Utilizza window_get_safe_title_margins() per determinare l'area sotto la barra del titolo che non è coperta da decorazioni.
Nota: Questo flag è implementato solo su macOS.
WindowFlags WINDOW_FLAG_MOUSE_PASSTHROUGH = 7
Tutti gli eventi del mouse vengono passati alla finestra sottostante della stessa applicazione.
WindowFlags WINDOW_FLAG_SHARP_CORNERS = 8
Lo stile della finestra è sostituito, forzando angoli acuti.
Nota: Questo flag è implementato solo su Windows (11).
WindowFlags WINDOW_FLAG_EXCLUDE_FROM_CAPTURE = 9
La finestra è esclusa dagli screenshot acquisiti da screen_get_image(), screen_get_image_rect() e screen_get_pixel().
Nota: Questo flag è implementato su macOS e Windows (10, 20H1).
Nota: L'impostazione di questo flag impedirà ai metodi standard di catturare un'immagine della finestra, ma NON garantisce che altre app non siano in grado di catturare un'immagine. Non si dovrebbe utilizzare come DRM o misura di sicurezza.
WindowFlags WINDOW_FLAG_POPUP_WM_HINT = 10
Segnala al gestore delle finestre che questa finestra dovrebbe essere un "popup" definito dall'implementazione (solitamente una finestra figlia mobile, senza bordi, non ordinabile e non modificabile).
WindowFlags WINDOW_FLAG_MINIMIZE_DISABLED = 11
Il pulsante di minimizzazione della finestra è disabilitato.
Nota: Questo metodo è implementato su macOS e Windows.
WindowFlags WINDOW_FLAG_MAXIMIZE_DISABLED = 12
Il pulsante di massimizzazione della finestra è disabilitato.
Nota: Questo metodo è implementato su macOS e Windows.
WindowFlags WINDOW_FLAG_MAX = 13
Valore massimo per l'enumerazione WindowFlags.
enum WindowEvent: 🔗
WindowEvent WINDOW_EVENT_MOUSE_ENTER = 0
Inviato quando il puntatore del mouse entra nella finestra.
WindowEvent WINDOW_EVENT_MOUSE_EXIT = 1
Inviato quando il puntatore del mouse esce dalla finestra.
WindowEvent WINDOW_EVENT_FOCUS_IN = 2
Inviato quando la finestra cattura il focus.
WindowEvent WINDOW_EVENT_FOCUS_OUT = 3
Inviato quando la finestra perde il focus.
WindowEvent WINDOW_EVENT_CLOSE_REQUEST = 4
Inviato quando l'utente ha tentato di chiudere la finestra (ad esempio premendo il pulsante Chiudi).
WindowEvent WINDOW_EVENT_GO_BACK_REQUEST = 5
Inviato quando il pulsante "Indietro" del dispositivo viene premuto.
Nota: Questo evento è implementato solo su Android.
WindowEvent WINDOW_EVENT_DPI_CHANGE = 6
Inviato quando la finestra viene spostata su un display con un DPI diverso, o il DPI del display viene cambiato.
Nota: Questo flag è implementata solo su macOS e Linux (Wayland).
WindowEvent WINDOW_EVENT_TITLEBAR_CHANGE = 7
Inviato quando la decorazione della barra del titolo della finestra viene modificata (ad esempio, il flag WINDOW_FLAG_EXTEND_TO_TITLE è impostato o la finestra è entrata/uscita dalla modalità a schermo intero).
Nota: Questo flag è implementato solo su macOS.
WindowEvent WINDOW_EVENT_FORCE_CLOSE = 8
Inviato quando la finestra è stata chiusa forzatamente dal server di visualizzazione. La finestra deve nascondere e pulire immediatamente tutti i riferimenti interni di rendering.
Nota: Questo flag è implementato solo su Linux (Wayland).
enum WindowResizeEdge: 🔗
WindowResizeEdge WINDOW_EDGE_TOP_LEFT = 0
Bordo superiore sinistro di una finestra.
WindowResizeEdge WINDOW_EDGE_TOP = 1
Bordo superiore di una finestra.
WindowResizeEdge WINDOW_EDGE_TOP_RIGHT = 2
Bordo superiore destro di una finestra.
WindowResizeEdge WINDOW_EDGE_LEFT = 3
Bordo sinistro di una finestra.
WindowResizeEdge WINDOW_EDGE_RIGHT = 4
Bordo destro di una finestra.
WindowResizeEdge WINDOW_EDGE_BOTTOM_LEFT = 5
Bordo inferiore sinistro di una finestra.
WindowResizeEdge WINDOW_EDGE_BOTTOM = 6
Bordo inferiore di una finestra.
WindowResizeEdge WINDOW_EDGE_BOTTOM_RIGHT = 7
Bordo inferiore destro di una finestra.
WindowResizeEdge WINDOW_EDGE_MAX = 8
Rappresenta la dimensione dell'enumerazione WindowResizeEdge.
enum VSyncMode: 🔗
VSyncMode VSYNC_DISABLED = 0
Nessuna sincronizzazione verticale, il che significa che il motore visualizzerà i frame il più velocemente possibile (potrebbe essere visibile un tearing). Il frame rate è illimitato (a prescindere da Engine.max_fps).
VSyncMode VSYNC_ENABLED = 1
Modalità di sincronizzazione verticale predefinita, l'immagine viene visualizzata solo su intervalli di oscuramento verticale (non è visibile alcun tearing). Il frame rate è limitato dalla frequenza di aggiornamento del monitor (a prescindere da Engine.max_fps).
VSyncMode VSYNC_ADAPTIVE = 2
Si comporta come VSYNC_DISABLED quando il frame rate scende sotto la frequenza di aggiornamento dello schermo per ridurre lo stuttering (potrebbe essere visibile il tearing). Altrimenti, la sincronizzazione verticale è abilitata per evitare il tearing. Il frame rate è limitato dalla frequenza di aggiornamento del monitor (a prescindere da Engine.max_fps). Si comporta come VSYNC_ENABLED quando si utilizza il metodo di rendering Compatibilità.
VSyncMode VSYNC_MAILBOX = 3
Visualizza l'immagine più recente nella coda su intervalli di oscuramento verticale, mentre renderizza sulle altre immagini (non è visibile alcun tearing). Il frame rate è illimitato (a prescindere da Engine.max_fps).
Sebbene non sia garantito, le immagini possono essere renderizzate il più velocemente possibile, il che può ridurre il ritardo degli input (chiamato anche modalità V-Sync "veloce"). VSYNC_MAILBOX funziona meglio quando vengono renderizzati almeno il doppio dei frame rispetto alla frequenza di aggiornamento del display. Si comporta come VSYNC_ENABLED quando si utilizza il metodo di rendering Compatibilità.
enum HandleType: 🔗
HandleType DISPLAY_HANDLE = 0
Gestore del display:
Linux (X11):
X11::Display*per il display.Linux (Wayland):
wl_displayper il display.Android:
EGLDisplayper il display.
HandleType WINDOW_HANDLE = 1
Gestore della finestra:
Windows:
HWNDper la finestra.Linux (X11):
X11::Window*per la finestra.Linux (Wayland):
wl_surfaceper la finestra.macOS:
NSWindow*per la finestra.iOS:
UIViewController*per il view controller.Android:
jObjectper l'attività.
HandleType WINDOW_VIEW = 2
Vista della finestra:
Windows:
HDCper la finestra (solo con il renderer Compatibilità).macOS:
NSView*per la vista principale della finestra.iOS:
UIView*per la vista principale della finestra.
HandleType OPENGL_CONTEXT = 3
Contesto OpenGL (solo con il renderer Compatibilità):
Windows:
HGLRCper la finestra (GL nativo) oEGLContextper la finestra (ANGLE).Linux (X11):
GLXContext*per la finestra.Linux (Wayland):
EGLContextper la finestra.macOS:
NSOpenGLContext*per la finestra (GL nativo) oEGLContextper la finestra (ANGLE).Android:
EGLContextper la finestra.
HandleType EGL_DISPLAY = 4
Windows:
EGLDisplayper la finestra (ANGLE).macOS:
EGLDisplayper la finestra (ANGLE).Linux (Wayland):
EGLDisplayper la finestra.
HandleType EGL_CONFIG = 5
Windows:
EGLConfigper la finestra (ANGLE).macOS:
EGLConfigper la finestra (ANGLE).Linux (Wayland):
EGLConfigper la finestra.
enum TTSUtteranceEvent: 🔗
TTSUtteranceEvent TTS_UTTERANCE_STARTED = 0
L'enunciazione ha cominciato a essere pronunciata.
TTSUtteranceEvent TTS_UTTERANCE_ENDED = 1
L'enunciazione è stata conclusa correttamente.
TTSUtteranceEvent TTS_UTTERANCE_CANCELED = 2
L'enunciazione è stata annullata oppure il servizio TTS non è riuscito a elaborarla.
TTSUtteranceEvent TTS_UTTERANCE_BOUNDARY = 3
L'enunciazione ha raggiunto il limite di una parola o di una frase.
Costanti
INVALID_SCREEN = -1 🔗
L'ID che fa riferimento a uno schermo inesistente. Questo è restituito da alcuni metodi del DisplayServer se nessuno schermo corrisponde al risultato richiesto.
SCREEN_WITH_MOUSE_FOCUS = -4 🔗
Rappresenta lo schermo contenente il puntatore del mouse.
Nota: Su Android, iOS, Web e Linux (Wayland), questa costante rappresenta sempre lo schermo all'indice 0.
SCREEN_WITH_KEYBOARD_FOCUS = -3 🔗
Rappresenta lo schermo contenente la finestra con il focus della tastiera.
Nota: Su Android, iOS, Web e Linux (Wayland), questa costante rappresenta sempre lo schermo all'indice 0.
SCREEN_PRIMARY = -2 🔗
Rappresenta lo schermo primario.
Nota: Su Android, iOS, Web e Linux (Wayland), questa costante rappresenta sempre lo schermo all'indice 0.
SCREEN_OF_MAIN_WINDOW = -1 🔗
Rappresenta lo schermo in cui si trova la finestra principale. Questo è solitamente il valore predefinito nelle funzioni che consentono di specificare uno dei diversi schermi.
Nota: Su Android, iOS, Web e Linux (Wayland), questa costante rappresenta sempre lo schermo all'indice 0.
MAIN_WINDOW_ID = 0 🔗
ID della finestra principale generata dal motore, che può essere passato ai metodi che si aspettano un window_id.
INVALID_WINDOW_ID = -1 🔗
L'ID che fa riferimento a una finestra inesistente. Questo viene restituito da alcuni metodi del DisplayServer se nessuna finestra corrisponde al risultato richiesto.
INVALID_INDICATOR_ID = -1 🔗
ID che fa riferimento a un indicatore di stato inesistente dell'applicazione.
Descrizioni dei metodi
RID accessibility_create_element(window_id: int, role: AccessibilityRole) 🔗
Crea una nuova risorsa vuota per gli elementi di accessibilità.
Nota: Un elemento di accessibilità viene creato e liberato automaticamente per ogni Node. In generale, questa funzione non si dovrebbe chiamare manualmente.
RID accessibility_create_sub_element(parent_rid: RID, role: AccessibilityRole, insert_pos: int = -1) 🔗
Crea una nuova risorsa vuota per i sotto-elementi di accessibilità. I sotto-elementi si possono utilizzare per fornire informazioni di accessibilità per oggetti che non sono Node, come voci di un elenco, celle di una tabella o voci di un menu. I sotto-elementi vengono liberati automaticamente quando l'elemento padre viene liberato, oppure si possono liberare in anticipo attraverso il metodo accessibility_free_element().
RID accessibility_create_sub_text_edit_elements(parent_rid: RID, shaped_text: RID, min_height: float, insert_pos: int = -1) 🔗
Crea un nuovo sotto-elemento di accessibilità vuoto dal buffer di testo sagomato. I sotto-elementi sono liberati automaticamente quando l'elemento padre è liberato, oppure si possono liberare in anticipo attraverso il metodo accessibility_free_element().
Variant accessibility_element_get_meta(id: RID) const 🔗
Restituisce i metadati dell'elemento di accessibilità.
void accessibility_element_set_meta(id: RID, meta: Variant) 🔗
Imposta i metadati dell'elemento di accessibilità.
void accessibility_free_element(id: RID) 🔗
Libera un oggetto creato da accessibility_create_element(), accessibility_create_sub_element() o accessibility_create_sub_text_edit_elements().
RID accessibility_get_window_root(window_id: int) const 🔗
Restituisce l'elemento principale di accessibilità della finestra nativa del sistema operativo.
bool accessibility_has_element(id: RID) const 🔗
Restituisce true se id è un elemento di accessibilità valido.
int accessibility_screen_reader_active() const 🔗
Restituisce 1 se è attivo un lettore dello schermo, un display Braille o un'altra applicazione assistiva, 0 in caso contrario. Restituisce -1 se lo stato è sconosciuto.
Nota: Questo metodo è implementato su Linux, macOS e Windows.
Nota: Gli strumenti di debug per l'accessibilità, come Accessibility Insights per Windows, Accessibility Inspector (macOS) o AT-SPI Browser (Linux/BSD), non contano come applicazioni assistive e non influiscono su questo valore. Per testare la tua applicazione con questi strumenti, imposta ProjectSettings.accessibility/general/accessibility_support su 1.
void accessibility_set_window_focused(window_id: int, focused: bool) 🔗
Imposta lo stato di focalizzazione della finestra per le app assistive.
Nota: Questo metodo è implementato su macOS e Windows.
Nota: Questo metodo non è supportato dalle voci di menu del Dock di macOS.
void accessibility_set_window_rect(window_id: int, rect_out: Rect2, rect_in: Rect2) 🔗
Imposta i limiti esterni (con decorazioni) e interni (senza decorazioni) della finestra per le applicazioni assistive.
Nota: Questo metodo è implementato su Linux, macOS e Windows.
Nota: Solo per utenti avanzati! Gli oggetti Window chiamano questo metodo automaticamente.
int accessibility_should_increase_contrast() const 🔗
Restituisce 1 se si dovrebbe utilizzare un tema ad alto contrasto per l'interfaccia utente, 0 altrimenti. Restituisce -1 se lo stato è sconosciuto.
Nota: Questo metodo è implementato su Linux (X11/Wayland, GNOME), macOS e Windows.
int accessibility_should_reduce_animation() const 🔗
Restituisce 1 se si dovrebbero disabilitare flash, lampeggi e altri contenuti in movimento che possono causare crisi epilettiche negli utenti con epilessia fotosensibile, 0 altrimenti. Restituisce -1 se lo stato è sconosciuto.
Nota: Questo metodo è implementato su macOS e Windows.
int accessibility_should_reduce_transparency() const 🔗
Restituisce 1 se si dovrebbero disabilitare le immagini di sfondo, la trasparenza e altre funzionalità che potrebbero ridurre il contrasto tra primo piano e sfondo, 0 altrimenti. Restituisce -1 se lo stato è sconosciuto.
Nota: Questo metodo è implementato su macOS e Windows.
void accessibility_update_add_action(id: RID, action: AccessibilityAction, callable: Callable) 🔗
Aggiunge un callback per l'azione di accessibilità (azione che si può effettuare attraverso un comando speciale in un lettore dello schermo o i pulsanti su un display Braille) e contrassegna questa azione come supportata. Il callback dell'azione riceve un argomento Variant, il cui valore dipende dal tipo di azione.
void accessibility_update_add_child(id: RID, child_id: RID) 🔗
Aggiunge un elemento di accessibilità figlio.
Nota: I figli Node e i sotto-elementi sono aggiunti automaticamente all'elenco degli elementi figlio.
void accessibility_update_add_custom_action(id: RID, action_id: int, action_description: String) 🔗
Aggiunge supporto per un'azione di accessibilità personalizzata. action_id è passato come argomento al callback dell'azione ACTION_CUSTOM.
Aggiunge un elemento che è controllato da questo elemento.
Aggiunge un elemento che descrive questo elemento.
Aggiunge un elemento che descrive in dettaglio questo elemento.
Aggiunge un elemento in cui fluisce questo elemento.
Aggiunge un elemento che etichetta questo elemento.
Aggiunge un elemento che fa parte dello stesso gruppo di opzioni (radio).
Nota: Questo metodo si dovrebbe chiamare su ogni elemento del gruppo, utilizzando tutti gli altri elementi come related_id.
void accessibility_update_set_active_descendant(id: RID, other_id: RID) 🔗
Aggiunge un elemento che è un discendente attivo di questo elemento.
void accessibility_update_set_background_color(id: RID, color: Color) 🔗
Imposta il colore di sfondo dell'elemento.
void accessibility_update_set_bounds(id: RID, p_rect: Rect2) 🔗
Restituisce la bounding box dell'elemento, relativa alla posizione del nodo.
void accessibility_update_set_checked(id: RID, checekd: bool) 🔗
Imposta lo stato di spunta dell'elemento.
void accessibility_update_set_classname(id: RID, classname: String) 🔗
Imposta il nome della classe dell'elemento.
void accessibility_update_set_color_value(id: RID, color: Color) 🔗
Imposta il valore di colore dell'elemento.
void accessibility_update_set_description(id: RID, description: String) 🔗
Imposta la descrizione d'accessibilità dell'elemento.
void accessibility_update_set_error_message(id: RID, other_id: RID) 🔗
Imposta un elemento che contiene un messaggio di errore per questo elemento.
void accessibility_update_set_extra_info(id: RID, name: String) 🔗
Imposta ulteriori informazioni d'accessibilità dell'elemento aggiunte al nome dell'elemento.
void accessibility_update_set_flag(id: RID, flag: AccessibilityFlags, value: bool) 🔗
Imposta il flag dell'elemento.
void accessibility_update_set_focus(id: RID) 🔗
Imposta l'elemento attualmente focalizzato.
void accessibility_update_set_foreground_color(id: RID, color: Color) 🔗
Imposta il colore di primo piano dell'elemento.
void accessibility_update_set_in_page_link_target(id: RID, other_id: RID) 🔗
Imposta l'elemento di destinazione per il collegamento.
void accessibility_update_set_language(id: RID, language: String) 🔗
Imposta la lingua di testo dell'elemento.
void accessibility_update_set_list_item_count(id: RID, size: int) 🔗
Imposta il numero di elementi nell'elenco.
void accessibility_update_set_list_item_expanded(id: RID, expanded: bool) 🔗
Imposta lo stato espanso dell'elemento elenco/albero.
void accessibility_update_set_list_item_index(id: RID, index: int) 🔗
Imposta la posizione dell'elemento nell'elenco.
void accessibility_update_set_list_item_level(id: RID, level: int) 🔗
Imposta il livello gerarchico dell'elemento nell'elenco.
void accessibility_update_set_list_item_selected(id: RID, selected: bool) 🔗
Imposta lo stato di spunta dell'elemento nell'elenco/albero.
void accessibility_update_set_list_orientation(id: RID, vertical: bool) 🔗
Imposta l'orientazione degli elementi nell'elenco.
void accessibility_update_set_live(id: RID, live: AccessibilityLiveMode) 🔗
Imposta la priorità degli aggiornamenti della regione attiva.
void accessibility_update_set_member_of(id: RID, group_id: RID) 🔗
Imposta l'elemento come membro del gruppo.
void accessibility_update_set_name(id: RID, name: String) 🔗
Imposta il nome di accessibilità dell'elemento.
void accessibility_update_set_next_on_line(id: RID, other_id: RID) 🔗
Imposta l'elemento successivo sulla riga.
void accessibility_update_set_num_jump(id: RID, jump: float) 🔗
Imposta il salto del valore numerico.
void accessibility_update_set_num_range(id: RID, min: float, max: float) 🔗
Imposta l'intervallo del valore numerico.
void accessibility_update_set_num_step(id: RID, step: float) 🔗
Imposta il passo del valore numerico.
void accessibility_update_set_num_value(id: RID, position: float) 🔗
Imposta il valore numerico.
void accessibility_update_set_placeholder(id: RID, placeholder: String) 🔗
Imposta il testo segnaposto.
void accessibility_update_set_popup_type(id: RID, popup: AccessibilityPopupType) 🔗
Imposta il tipo di popup per i pulsanti popup.
void accessibility_update_set_previous_on_line(id: RID, other_id: RID) 🔗
Imposta l'elemento precedente sulla riga.
void accessibility_update_set_role(id: RID, role: AccessibilityRole) 🔗
Imposta il ruolo dell'elemento di accessibilità.
void accessibility_update_set_role_description(id: RID, description: String) 🔗
Imposta il testo descrittivo per il ruolo dell'elemento di accessibilità.
void accessibility_update_set_scroll_x(id: RID, position: float) 🔗
Imposta la posizione in x della barra di scorrimento.
void accessibility_update_set_scroll_x_range(id: RID, min: float, max: float) 🔗
Imposta l'intervallo in x della barra di scorrimento.
void accessibility_update_set_scroll_y(id: RID, position: float) 🔗
Imposta la posizione in y della barra di scorrimento.
void accessibility_update_set_scroll_y_range(id: RID, min: float, max: float) 🔗
Imposta l'intervallo in y della barra di scorrimento.
void accessibility_update_set_shortcut(id: RID, shortcut: String) 🔗
Imposta la lista delle scorciatoie da tastiera utilizzate dall'elemento.
void accessibility_update_set_state_description(id: RID, description: String) 🔗
Imposta una descrizione leggibile in chiaro dello stato di spunta attuale.
void accessibility_update_set_table_cell_position(id: RID, row_index: int, column_index: int) 🔗
Imposta la posizione nella tabella.
void accessibility_update_set_table_cell_span(id: RID, row_span: int, column_span: int) 🔗
Imposta la spaziatura tra righe/colonne delle celle.
void accessibility_update_set_table_column_count(id: RID, count: int) 🔗
Imposta il numero di colonne nella tabella.
void accessibility_update_set_table_column_index(id: RID, index: int) 🔗
Imposta la posizione della colonna.
void accessibility_update_set_table_row_count(id: RID, count: int) 🔗
Imposta il numero di righe nella tabella.
void accessibility_update_set_table_row_index(id: RID, index: int) 🔗
Imposta la posizione della colonna nella tabella.
void accessibility_update_set_text_align(id: RID, align: HorizontalAlignment) 🔗
Imposta l'allineamento del testo dell'elemento.
void accessibility_update_set_text_decorations(id: RID, underline: bool, strikethrough: bool, overline: bool) 🔗
Imposta il testo sottolineato/sopralineato/barrato.
void accessibility_update_set_text_orientation(id: RID, vertical: bool) 🔗
Imposta l'orientazione del testo.
void accessibility_update_set_text_selection(id: RID, text_start_id: RID, start_char: int, text_end_id: RID, end_char: int) 🔗
Imposta la selezione del testo sul campo di testo. text_start_id e text_end_id devono essere elementi creati da accessibility_create_sub_text_edit_elements(). Gli offset dei caratteri sono relativi all'elemento corrispondente.
void accessibility_update_set_tooltip(id: RID, tooltip: String) 🔗
Imposta il testo del tooltip.
void accessibility_update_set_transform(id: RID, transform: Transform2D) 🔗
Imposta la trasformazione 2D dell'elemento.
void accessibility_update_set_url(id: RID, url: String) 🔗
Imposta l'URL di un collegamento.
void accessibility_update_set_value(id: RID, value: String) 🔗
Imposta il valore del testo dell'elemento.
void beep() const 🔗
Riproduce il suono del beep dal sistema operativo, se possibile. Poiché proviene dal sistema operativo, il segnale acustico sarà udibile anche se l'applicazione è silenziata. Potrebbe anche essere disabilitato per l'intero sistema operativo dall'utente.
Nota: Questo metodo è implementato su macOS, Linux (X11/Wayland) e Windows.
String clipboard_get() const 🔗
Restituisce gli appunti dell'utente come stringa, se possibile.
Image clipboard_get_image() const 🔗
Restituisce gli appunti dell'utente come immagine, se possibile.
Nota: Questo metodo utilizza i dati dei pixel copiati, ad esempio da un software per modificare immagini o da un browser web, non un file di immagine copiato da Esplora file.
String clipboard_get_primary() const 🔗
Restituisce gli appunti primari dell'utente come stringa, se possibile. Questi sono gli apponti che vengono impostati quando l'utente seleziona del testo in qualsiasi applicazione, anziché quando preme Ctrl + C. I dati degli appunti possono quindi essere incollati cliccando con il tasto centrale del mouse in qualsiasi applicazione che supporti il meccanismo degli appunti primari.
Nota: Questo metodo è implementato solo su Linux (X11/Wayland).
Restituisce true se è presente un contenuto di testo negli appunti dell'utente.
bool clipboard_has_image() const 🔗
Restituisce true se è presente un contenuto di immagine negli appunti dell'utente.
void clipboard_set(clipboard: String) 🔗
Imposta il contenuto negli appunti dell'utente alla stringa specificata.
void clipboard_set_primary(clipboard_primary: String) 🔗
Imposta gli appunti primari dell'utente come stringa, se possibile. Questi sono gli apponti che vengono impostati quando l'utente seleziona del testo in qualsiasi applicazione, anziché quando preme Ctrl + C. I dati degli appunti possono quindi essere incollati cliccando con il tasto centrale del mouse in qualsiasi applicazione che supporti il meccanismo degli appunti primari.
Nota: Questo metodo è implementato solo su Linux (X11/Wayland).
bool color_picker(callback: Callable) 🔗
Visualizza il selettore colori nativo del sistema operativo.
I callback hanno i seguenti argomenti: status: bool, color: Color.
Nota: Questo metodo è implementato se il server di visualizzazione ha la funzionalità FEATURE_NATIVE_COLOR_PICKER.
Nota: Questo metodo è implementato solo su Linux (X11/Wayland).
int create_status_indicator(icon: Texture2D, tooltip: String, callback: Callable) 🔗
Crea un nuovo indicatore di stato dell'applicazione con l'icona, il tooltip e il callback di attivazione specificati.
callback dovrebbe accettare due argomenti: il pulsante del mouse premuto (una delle costanti di MouseButton) e la posizione del clic nelle coordinate dello schermo (un Vector2i).
CursorShape cursor_get_shape() const 🔗
Restituisce la forma predefinita del cursore del mouse come impostata da cursor_set_shape().
void cursor_set_custom_image(cursor: Resource, shape: CursorShape = 0, hotspot: Vector2 = Vector2(0, 0)) 🔗
Imposta un'immagine personalizzata del cursore del mouse per la forma shape. Ciò significa che il sistema operativo dell'utente e il tema del cursore del mouse non influenzeranno più l'aspetto del cursore del mouse.
cursor può essere una Texture2D o un'Image e non dovrebbe essere più grande di 256×256 per essere visualizzato correttamente. Facoltativamente, hotspot può essere impostato per compensare la posizione dell'immagine rispetto al punto di clic. Per impostazione predefinita, hotspot è impostato sull'angolo in alto a sinistra dell'immagine. Vedi anche cursor_set_shape().
void cursor_set_shape(shape: CursorShape) 🔗
Imposta la forma predefinita del cursore del mouse. L'aspetto del cursore varierà a seconda del sistema operativo dell'utente e del tema del cursore del mouse. Vedi anche cursor_get_shape() e cursor_set_custom_image().
void delete_status_indicator(id: int) 🔗
Rimuove l'indicatore di stato dell'applicazione.
Error dialog_input_text(title: String, description: String, existing_text: String, callback: Callable) 🔗
Mostra una finestra di dialogo con campo di testo che utilizza l'aspetto nativo del sistema operativo. callback dovrebbe accettare un singolo parametro String che contiene il contenuto del campo di testo.
Nota: Questo metodo è implementato se il server di visualizzazione ha la funzionalità FEATURE_NATIVE_DIALOG_INPUT. Le piattaforme supportate includono macOS, Windows e Android.
Error dialog_show(title: String, description: String, buttons: PackedStringArray, callback: Callable) 🔗
Mostra una finestra di dialogo con testo che utilizza l'aspetto nativo del sistema operativo. callback dovrebbe accettare un singolo parametro String che contiene il contenuto del campo di testo.
Nota: Questo metodo è implementato se il server di visualizzazione ha la funzionalità FEATURE_NATIVE_DIALOG. Le piattaforme supportate includono macOS, Windows e Android.
void enable_for_stealing_focus(process_id: int) 🔗
Consente al PID process_id di rubare lo stato attivo da questa finestra. In altre parole, questo disabilita la protezione del sistema operativo contro il furto dello stato attivo per il PID specificato.
Nota: Questo metodo è implementato solo su Windows.
Error file_dialog_show(title: String, current_directory: String, filename: String, show_hidden: bool, mode: FileDialogMode, filters: PackedStringArray, callback: Callable, parent_window_id: int = 0) 🔗
Visualizza la finestra di dialogo nativa del sistema operativo per selezionare file o cartelle nel file system.
Ogni stringa di filtro nell'array filters deve essere formattata in questo modo: *.txt,*.doc;Text Files. Il testo descrittivo del filtro è facoltativo e può essere omesso. È consigliato impostare sia l'estensione file sia il tipo MIME. Vedi anche FileDialog.filters.
I callback hanno i seguenti argomenti: status: bool, selected_paths: PackedStringArray, selected_filter_index: int. Su Android, il terzo argomento (selected_filter_index) del callback è sempre 0.
Nota: Questo metodo è implementato se il server di visualizzazione ha la funzionalità FEATURE_NATIVE_DIALOG_FILE. Le piattaforme supportate includono Linux (X11/Wayland), Windows, macOS e Android (livello API 29+).
Nota: current_directory potrebbe essere ignorato.
Nota: Sia le finestre di dialogo incorporate, sia le finestre di dialogo su Windows supportano solo le estensioni dei file, mentre su Android, Linux e macOS esse supportano anche i tipi MIME.
Nota: Su Android e Linux, show_hidden viene ignorato.
Nota: Su Android e macOS, le finestre di dialogo native dei file non hanno titolo.
Nota: Su macOS, le app in sandbox salveranno segnalibri con ambito di sicurezza per mantenere l'accesso alle cartelle aperte in più sessioni. Usa OS.get_granted_permissions() per ottenere una lista dei segnalibri salvati.
Error file_dialog_with_options_show(title: String, current_directory: String, root: String, filename: String, show_hidden: bool, mode: FileDialogMode, filters: PackedStringArray, options: Array[Dictionary], callback: Callable, parent_window_id: int = 0) 🔗
Visualizza la finestra di dialogo nativa del sistema operativo per selezionare file o cartelle nel file system con opzioni aggiuntive selezionabili dall'utente.
Ogni stringa di filtro nell'array filters deve essere formattata in questo modo: *.txt,*.doc;Text Files. Il testo descrittivo del filtro è facoltativo e può essere omesso. È consigliato impostare sia l'estensione file sia il tipo MIME. Vedi anche FileDialog.filters.
options è un array di Dictionary con le seguenti chiavi:
"name"- nome dell'opzione String."values"- PackedStringArray di valori. Se vuoto, viene utilizzata un'opzione booleana (casella di spunta)."default"- indice dell'opzione selezionata predefinita (int) o valore booleano predefinito (bool).
I callback hanno i seguenti argomenti: status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary.
Nota: Questo metodo è implementato se il server di visualizzazione ha la funzionalità FEATURE_NATIVE_DIALOG_FILE. Le piattaforme supportate includono Linux (X11/Wayland), Windows e macOS.
Nota: current_directory potrebbe essere ignorato.
Nota: Sia le finestre di dialogo incorporate, sia le finestre di dialogo su Windows supportano solo le estensioni dei file, mentre su Android, Linux e macOS esse supportano anche i tipi MIME.
Nota: Su Linux (X11), show_hidden viene ignorato.
Nota: Su macOS, le finestre di dialogo dei file nativi non hanno titolo.
Nota: Su macOS, le app in sandbox salveranno segnalibri con ambito di sicurezza per mantenere l'accesso alle cartelle aperte in più sessioni. Usa OS.get_granted_permissions() per ottenere una lista dei segnalibri salvati.
void force_process_and_drop_events() 🔗
Forza l'elaborazione del gestore delle finestre ignorando tutti gli InputEvent. Vedi anche process_events().
Nota: Questo metodo è implementato su Windows e macOS.
Color get_accent_color() const 🔗
Restituisce il colore d'accento del tema del sistema operativo. Restituisce Color(0, 0, 0, 0), se il colore d'accento è sconosciuto.
Nota: Questo metodo è implementato su macOS, Windows, Android e Linux (X11/Wayland).
Color get_base_color() const 🔗
Restituisce il colore di base del tema del sistema operativo (colore predefinito di sfondo). Restituisce Color(0, 0, 0, 0), se il colore di base è sconosciuto.
Nota: Questo metodo è implementato su macOS, Windows e Android.
Array[Rect2] get_display_cutouts() const 🔗
Restituisce un Array di Rect2, ognuno dei quali è il rettangolo di delimitazione per un ritaglio o una tacca sul display. Si trattano di aree non funzionali su schermi edge-to-edge utilizzate da fotocamere e sensori. Restituisce un array vuoto se il dispositivo non ha ritagli. Vedi anche get_display_safe_area().
Nota: Attualmente implementato solo su Android. Altre piattaforme restituiranno un array vuoto anche se hanno ritagli o tacche sul display.
Rect2i get_display_safe_area() const 🔗
Restituisce l'area non oscurata del display in cui si dovrebbero renderizzare i controlli interattivi. Vedi anche get_display_cutouts().
Nota: Attualmente implementato solo su Android e iOS. Su altre piattaforme, screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW) verrà restituito come alternativa. Vedi anche screen_get_usable_rect().
int get_keyboard_focus_screen() const 🔗
Restituisce l'indice dello schermo contenente la finestra con il focus sulla tastiera, oppure lo schermo primario se non c'è alcuna finestra con il focus.
Nota: Questo metodo è implementato su Linux/X11, macOS e Windows. Su altre piattaforme, questo metodo restituisce sempre la schermata principale.
Restituisce il nome del DisplayServer attualmente in uso. La maggior parte dei sistemi operativi ha soltanto un DisplayServer, ma Linux ha accesso a più di un DisplayServer (attualmente X11 e Wayland).
I nomi dei server di visualizzazione integrati sono Windows, macOS, X11 (Linux), Wayland (Linux), Android, iOS, web (HTML5) e headless (quando avviato con l'argomento della riga di comando --headless).
int get_primary_screen() const 🔗
Restituisce l'indice dello schermo principale.
Nota: Questo metodo è implementato su Linux/X11, macOS e Windows. Su altre piattaforme, questo metodo restituisce sempre 0.
int get_screen_count() const 🔗
Restituisce il numero di schermi disponibili.
Nota: Questo metodo è implementato su Linux (X11 e Wayland), macOS e Windows. Su altre piattaforme, questo metodo restituisce sempre 1.
int get_screen_from_rect(rect: Rect2) const 🔗
Restituisce l'indice dello schermo che si sovrappone di più al rettangolo fornito. Restituisce INVALID_SCREEN se il rettangolo non si sovrappone ad alcuno schermo o non ha area.
Restituisce true se le posizioni dei pulsanti OK e Annulla sono scambiate nelle finestre di dialogo. Questa opzione è abilitata per impostazione predefinita su Windows per seguire le convenzioni d'interfaccia e può essere cambiata attraverso ProjectSettings.gui/common/swap_cancel_ok.
Nota: Questa opzione non influisce sulle finestre di dialogo native come quelle generate da dialog_show().
int get_window_at_screen_position(position: Vector2i) const 🔗
Restituisce l'ID della finestra nella posizione position (in pixel) sullo schermo. Nelle configurazioni multi-monitor, la posizione sullo schermo è relativa all'area del desktop virtuale. Nelle configurazioni multi-monitor con diverse risoluzioni o orientamenti dello schermo, l'origine potrebbe essere posizionata all'esterno di qualsiasi display in questo modo:
* (0, 0) +-------+
| |
+-------------+ | |
| | | |
| | | |
+-------------+ +-------+
PackedInt32Array get_window_list() const 🔗
Restituisce la lista degli ID delle finestre Godot appartenenti a questo processo.
Nota: Le finestre di dialogo native non sono incluse in questa lista.
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge una nuova voce spuntabile con il testo label al menu globale con l'ID menu_root.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
È possibile definire un accelerator, ovvero una scorciatoia da tastiera che può essere premuta per attivare il pulsante del menu anche se non è attualmente aperto. Il accelerator è generalmente una combinazione di KeyModifierMask e Key che utilizzano OR bit a bit come KEY_MASK_CTRL | KEY_A (Ctrl + A).
Nota: I chiamabili callback e key_callback devono accettare soltanto un parametro variante, il parametro passato ai chiamabili sarà il valore passato a tag.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge una nuova voce spuntabile con il testo label e l'icona icon al menu globale con l'ID menu_root.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
È possibile definire un accelerator, ovvero una scorciatoia da tastiera che può essere premuta per attivare il pulsante del menu anche se non è attualmente aperto. Il accelerator è generalmente una combinazione di KeyModifierMask e Key che utilizzano OR bit a bit come KEY_MASK_CTRL | KEY_A (Ctrl + A).
Nota: I chiamabili callback e key_callback devono accettare soltanto un parametro variante, il parametro passato ai chiamabili sarà il valore passato a tag.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge una nuova voce con il testo label e l'icona icon al menu globale con l'ID menu_root.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
È possibile definire un accelerator, ovvero una scorciatoia da tastiera che può essere premuta per attivare il pulsante del menu anche se non è attualmente aperto. Il accelerator è generalmente una combinazione di KeyModifierMask e Key che utilizzano OR bit a bit come KEY_MASK_CTRL | KEY_A (Ctrl + A).
Nota: I chiamabili callback e key_callback devono accettare soltanto un parametro variante, il parametro passato ai chiamabili sarà il valore passato a tag.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge una nuova voce spuntabile di opzione (radio) con il testo label e l'icona icon al menu globale con l'ID menu_root.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
È possibile definire un accelerator, ovvero una scorciatoia da tastiera che può essere premuta per attivare il pulsante del menu anche se non è attualmente aperto. Il accelerator è generalmente una combinazione di KeyModifierMask e Key che utilizzano OR bit a bit come KEY_MASK_CTRL | KEY_A (Ctrl + A).
Nota: Le voci spuntabili mostrano solo un segno di spunta, ma non hanno alcun comportamento di spunta incorporato e devono essere selezionate e deselezionate manualmente. Consulta global_menu_set_item_checked() per ulteriori informazioni su come controllarle.
Nota: I chiamabili callback e key_callback devono accettare soltanto un parametro variante, il parametro passato ai chiamabili sarà il valore passato a tag.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge una nuova voce con il testo label al menu globale con l'ID menu_root.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
È possibile definire un accelerator, ovvero una scorciatoia da tastiera che può essere premuta per attivare il pulsante del menu anche se non è attualmente aperto. Il accelerator è generalmente una combinazione di KeyModifierMask e Key che utilizzano OR bit a bit come KEY_MASK_CTRL | KEY_A (Ctrl + A).
Nota: I chiamabili callback e key_callback devono accettare soltanto un parametro variante, il parametro passato ai chiamabili sarà il valore passato a tag.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge una nuova voce con il testo label al menu globale con l'ID menu_root.
Contrariamente alle normali voci binarie, le voci multistato possono avere più di due stati, come definito da max_states. Ogni pressione o attivazione della voce aumenterà lo stato di uno. Il valore predefinito è definito da default_state.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
È possibile definire un accelerator, ovvero una scorciatoia da tastiera che può essere premuta per attivare il pulsante del menu anche se non è attualmente aperto. Il accelerator è generalmente una combinazione di KeyModifierMask e Key che utilizzano OR bit a bit come KEY_MASK_CTRL | KEY_A (Ctrl + A).
Nota: Come predefinito, non c'è alcuna indicazione sullo stato attuale della voce, la quale dovrebbe essere modificata manualmente.
Nota: I chiamabili callback e key_callback devono accettare soltanto un parametro variante, il parametro passato ai chiamabili sarà il valore passato a tag.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge una nuova voce spuntabile di opzione (radio) con il testo label al menu globale con l'ID menu_root.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
È possibile definire un accelerator, ovvero una scorciatoia da tastiera che può essere premuta per attivare il pulsante del menu anche se non è attualmente aperto. Il accelerator è generalmente una combinazione di KeyModifierMask e Key che utilizzano OR bit a bit come KEY_MASK_CTRL | KEY_A (Ctrl + A).
Nota: Le voci spuntabili mostrano solo un segno di spunta, ma non hanno alcun comportamento di spunta incorporato e devono essere selezionate e deselezionate manualmente. Consulta global_menu_set_item_checked() per ulteriori informazioni su come controllarle.
Nota: I chiamabili callback e key_callback devono accettare soltanto un parametro variante, il parametro passato ai chiamabili sarà il valore passato a tag.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge un separatore tra le voci del menu globale con l'ID menu_root. Anche i separatori occupano un indice.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Aggiunge una voce che fungerà da sottomenu del menu globale menu_root. L'argomento submenu è l'ID della radice del menu globale che verrà visualizzata quando si clicca sulla voce.
Restituisce l'indice della voce inserita, non è garantito che sia lo stesso del valore index.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Rimuove tutte le voci dal menu globale con l'ID menu_root.
Nota: Questo metodo è implementato solo su macOS.
ID di menu di sistema supportati:
"_main" - Menu principale (macOS).
"_dock" - Menu popup Dock (macOS).
"_apple" - Menu Apple (macOS, voci personalizzate aggiunte prima di "Servizi").
"_window" - Menu Finestra (macOS, voci personalizzate aggiunte dopo "Porta tutto in primo piano").
"_help" - Menu Aiuto (macOS).
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce l'acceleratore dell'elemento all'indice idx. Gli acceleratori sono combinazioni speciali di tasti che attivano l'elemento, indifferentemente da quale controllo è focalizzato.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce il callback dell'elemento all'indice idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce il numero di voci nel menù globale con l'ID menu_root.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce l'icona dell'elemento all'indice idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce l'offset orizzontale dell'elemento al dato indice idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce l'indice dell'elemento con la tag specificata. Gli indici sono automaticamente assegnati a ogni elemento dal motore, e non possono essere impostati manualmente.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce l'indice dell'elemento con il testo specificato. Gli indici sono automaticamente assegnati a ogni elemento dal motore, e non possono essere impostati manualmente.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce il callback dell'acceleratore dell'elemento all'indice idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce il numero di stati di una voce multistato. Vedi global_menu_add_multistate_item() per i dettagli.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce lo stato di una voce multistato. Vedi global_menu_add_multistate_item() per i dettagli.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce l'ID del sottomenù dalla voce all'indice idx. Vedi global_menu_add_submenu_item() per più informazioni su come aggiungere un sottomenu.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce i metadati della voce specificata, che potrebbero essere di qualsiasi tipo. È possibile impostarli con global_menu_set_item_tag(), il quale fornisce un modo semplice per assegnare dati di contesto alle voci.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce il testo dell'elemento all'indice idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce il tooltip associato all'indice specificato idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce un Dictionary di ID di menu del sistema supportati e nomi.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce true se l'elemento all'indice idx è spuntabile in qualche modo, ad esempio se ha una casella di spunta o un pulsante di scelta (radio).
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce true se l'elemento all'indice idx è spuntato.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce true se la voce all'indice idx è disabilitata. Quando è disabilitata, non è possibile selezionare la voce o invocare la sua azione.
Vedi global_menu_set_item_disabled() per ulteriori informazioni su come disabilitare una voce.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce true se la voce all'indice idx è nascosta.
Vedi global_menu_set_item_hidden() per ulteriori informazioni su come nascondere una voce.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Restituisce true se la voce all'indice idx può essere spuntata come un pulsante radio.
Nota: Questo è puramente cosmetico; bisogna implementare manualmente la logica per spuntare le voci nei gruppi radio
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Rimuove la voce all'indice idx dal menu globale menu_root.
Nota: Gli indici delle voci dopo la voce rimossa saranno spostati di uno.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta l'acceleratore della voce all'indice idx. keycode può essere un solo valore da Key oppure una combinazione di KeyModifierMask e Key tramite OR bit a bit come KEY_MASK_CTRL | KEY_A (Ctrl + A).
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta il callback della voce all'indice idx. Il callback viene emesso quando viene premuto una voce.
Nota: Il chiamabile callback deve accettare soltanto un parametro variante, il parametro passato al chiamabile sarà il valore passato al parametro tag quando la voce del menu è stata creata.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta se l'elemento all'indice idx ha una casella di spunta. Se false, imposta il tipo dell'elemento a testo semplice.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta lo stato della spunta dell'elemento all'indice idx.
Nota: Questa proprietà è implementata su Linux, macOS e Windows.
Deprecato: Use NativeMenu or PopupMenu instead.
Attiva o disattiva l'elemento all'indice idx. Quando è disattivato, non può essere selezionato e la sua azione non può essere richiamata.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Nasconde o mostra la voce all'indice idx. Quando è nascosta, una voce non appare in un menù e la sua azione non può essere richiamata.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta il callback della voce all'indice idx. Il callback viene emesso al passaggio del cursore.
Nota: Il chiamabile callback deve accettare soltanto un parametro variante, il parametro passato al chiamabile sarà il valore passato al parametro tag quando la voce del menu è stata creata.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Sostituisce l'icona Texture2D dell'indice idx.
Nota: Questo metodo è implementato solo su macOS.
Nota: Questo metodo è non è supportato dalle voci di menu "_dock" di macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta l'offset orizzontale dell'elemento all'indice idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta il callback della voce all'indice idx. Il callback viene emesso quando il suo acceleratore viene attivato.
Nota: Il chiamabile key_callback deve accettare soltanto un parametro variante, il parametro passato al chiamabile sarà il valore passato al parametro tag quando la voce del menu è stata creata.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta il numero di stati di una voce multistato. Vedi global_menu_add_multistate_item() per i dettagli.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta il tipo della voce all'indice idx su pulsante di scelta (radio). Se false, imposta il tipo della voce su testo semplice.
Nota: Questo è puramente cosmetico; bisogna implementare manualmente la logica per spuntare le voci in gruppi radio
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta lo stato di una voce multistato. Vedi global_menu_add_multistate_item() per i dettagli.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta il sottomenù della voce all'indice idx. Il sottomenù è l'ID di una radice di menu globale che dovrebbe essere mostrata quando la voce è cliccato.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta il metadati di una voce, che può essere di qualunque tipo. Puoi successivamente ricavarli con global_menu_get_item_tag(), che fornisce un modo semplice per assegnare dati di contesto alle voci.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta il testo dell'elemento all'indice idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Imposta una String tooltip dell'elemento all'indice idx.
Nota: Questo metodo è implementato solo su macOS.
Deprecato: Use NativeMenu or PopupMenu instead.
Registra i chiamabili da emettere quando il menù sta per mostrarsi o chiudersi, rispettivamente. I metodi di callback devono avere zero argomenti.
bool has_additional_outputs() const 🔗
Restituisce true se sono stati registrati output aggiuntivi tramite register_additional_output().
bool has_feature(feature: Feature) const 🔗
Restituisce true se la funzionalità feature specificata è supportata dal DisplayServer attuale, altrimenti false.
bool has_hardware_keyboard() const 🔗
Restituisce true se una tastiera hardware è connessa.
Nota: Questo metodo è implementato su Android e iOS. Su altre piattaforme, questo metodo restituisce sempre true.
void help_set_search_callbacks(search_callback: Callable, action_callback: Callable) 🔗
Imposta i callback di ricerca del sistema nativo di aiuto.
search_callback ha i seguenti argomenti: String search_string, int result_limit e restituisce un Dictionary con coppie di "key, display name" per i risultati della ricerca. Chiamato quando l'utente inserisci i termini di ricerca nel menu Help (aiuto).
action_callback ha i seguenti argomenti: String key. Chiamato quando l'utente seleziona un risultato di ricerca nel menu Help (aiuto).
Nota: Questo metodo è implementato solo su macOS.
Vector2i ime_get_selection() const 🔗
Restituisce la selezione di testo nella stringa di composizione nell'Input Method Editor, con il componente x del Vector2i che rappresenta la posizione del cursore e y che rappresenta la lunghezza della selezione.
Nota: Questo metodo è implementato solo su macOS.
Restituisce la stringa di composizione contenuta nella finestra del Input Method Editor.
Nota: Questo metodo è implementato solo su macOS.
Restituisce true se il sistema operativo sta usando la modalità oscura.
Nota: Questo metodo è implementato su Android, iOS, macOS, Windows, e Linux (X11/Wayland).
bool is_dark_mode_supported() const 🔗
Restituisce true se il sistema operativo supporta la modalità oscura.
Nota: Questo metodo è implementato su Android, iOS, macOS, Windows, e Linux (X11/Wayland).
bool is_touchscreen_available() const 🔗
Restituisce true se sono disponibili gli eventi di tocco (Android o iOS), la capacità è rilevata sulla piattaforma Web o se ProjectSettings.input_devices/pointing/emulate_touch_from_mouse è true.
bool is_window_transparency_available() const 🔗
Restituisce true se lo sfondo della finestra può essere reso trasparente. Questo metodo restituisce false se ProjectSettings.display/window/per_pixel_transparency/allowed è impostato su false, o se la trasparenza non è supportata dal renderer o dal compositore del sistema operativo.
int keyboard_get_current_layout() const 🔗
Restituisce l'indice del layout di tastiera attivo.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS, e Windows.
Key keyboard_get_keycode_from_physical(keycode: Key) const 🔗
Converte un keycode fisico (US QWERTY) a uno nel layout di tastiera attivo.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS, e Windows.
Key keyboard_get_label_from_physical(keycode: Key) const 🔗
Converte un keycode fisico (US QWERTY) a un'etichetta localizzata sul tasto nel layout di tastiera attivo.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS, e Windows.
int keyboard_get_layout_count() const 🔗
Restituisce il numero di layout di tastiera.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS, e Windows.
String keyboard_get_layout_language(index: int) const 🔗
Restituisce il codice lingua con lo standard ISO-639/BCP-4 del layout di tastiera all'indice index.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS, e Windows.
String keyboard_get_layout_name(index: int) const 🔗
Restituisce il nome localizzato del layout di tastiera all'indice index.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS, e Windows.
void keyboard_set_current_layout(index: int) 🔗
Imposta il layout di tastiera attivo.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS, e Windows.
BitField[MouseButtonMask] mouse_get_button_state() const 🔗
Restituisce lo stato attuale dei pulsanti del mouse (se ogni pulsante è premuto) come maschera di bit. Se più pulsanti del mouse vengono premuti allo stesso tempo, i bit vengono sommati. Equivale a Input.get_mouse_button_mask().
MouseMode mouse_get_mode() const 🔗
Restituisce la modalità attuale del mouse. Vedi anche mouse_set_mode().
Vector2i mouse_get_position() const 🔗
Restituisce la posizione attuale del cursore del mouse nelle coordinate dello schermo.
void mouse_set_mode(mouse_mode: MouseMode) 🔗
Imposta la modalità attuale del mouse. Vedi anche mouse_get_mode().
void process_events() 🔗
Esegue l'elaborazione del gestore delle finestre, incluso lo svuotamento degli input. Vedi anche force_process_and_drop_events(), Input.flush_buffered_events() e Input.use_accumulated_input.
void register_additional_output(object: Object) 🔗
Registra un Object che rappresenta un'uscita aggiuntiva che verrà renderizzata, oltre alle finestre normali. L'Object è utilizzato solo come identificatore, che può essere successivamente passato a unregister_additional_output().
Questo può essere utilizzato per impedire a Godot di tralasciare il rendering quando non sono visibili finestre normali.
int screen_get_dpi(screen: int = -1) const 🔗
Restituisce la densità di punti per pollice dello schermo specificato. Restituisce un valore predefinito specifico della piattaforma se screen non è valido.
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Nota: Su macOS, il valore restituito è impreciso se si usa la modalità frazionaria di scala della visualizzazione.
Nota: Sui dispositivi Android, le densità effettive dello schermo sono raggruppate in sei densità generalizzate:
ldpi - 120 dpi
mdpi - 160 dpi
hdpi - 240 dpi
xhdpi - 320 dpi
xxhdpi - 480 dpi
xxxhdpi - 640 dpi
Nota: Questo metodo è implementato su Android, iOS, Linux (X11/Wayland), macOS, Web e Windows. Su altre piattaforme, questo metodo restituisce sempre 72.
Image screen_get_image(screen: int = -1) const 🔗
Restituisce uno screenshot dello schermo screen. Restituisce null se screen non è valido o se DisplayServer non riesce a catturare lo screenshot.
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Nota: Questo metodo è implementato su Linux (X11, escluso XWayland), macOS e Windows. Su altre piattaforme, questo metodo restituisce sempre null.
Nota: Su macOS, questo metodo richiede l'autorizzazione "Registrazione schermo". Se l'autorizzazione non viene concessa, questo metodo restituisce uno screenshot che non includerà altre finestre dell'applicazione o elementi del sistema operativo che non riguardano l'applicazione.
Image screen_get_image_rect(rect: Rect2i) const 🔗
Restituisce uno screenshot dell'area dello schermo definita da rect. Restituisce null se rect è fuori i limiti dello schermo o se DisplayServer non riesce ad acquisire lo screenshot.
Nota: Questo metodo è implementato su macOS e Windows. Su altre piattaforme, questo metodo restituisce sempre null.
Nota: Su macOS, questo metodo richiede l'autorizzazione "Registrazione schermo". Se l'autorizzazione non viene concessa, questo metodo restituisce uno screenshot che non includerà altre finestre dell'applicazione o elementi del sistema operativo che non riguardano l'applicazione.
float screen_get_max_scale() const 🔗
Restituisce il fattore di scala più grande tra tutti gli schermi.
Nota: Su macOS il valore restituito è 2.0 se nel sistema è presente almeno uno schermo hiDPI (Retina) e 1.0 in tutti gli altri casi.
Nota: Questo metodo è implementato solo su macOS.
ScreenOrientation screen_get_orientation(screen: int = -1) const 🔗
Restituisce l'orientamento attuale dello schermo screen. Vedi anche screen_set_orientation(). Restituisce SCREEN_LANDSCAPE se screen non è valido.
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Nota: Questo metodo è implementato su Android e iOS. Su altre piattaforme, questo metodo restituisce sempre SCREEN_LANDSCAPE.
Color screen_get_pixel(position: Vector2i) const 🔗
Restituisce il colore del pixel del display alla posizione position.
Nota: Questo metodo è implementato su Linux (X11, escludendo XWayland), macOS e Windows. Su altre piattaforme, questo metodo restituisce sempre Color.
Nota: Su macOS, questo metodo richiede l'autorizzazione "Registrazione schermo". Se l'autorizzazione non viene concessa, questo metodo restituisce uno screenshot che conterrà solo lo sfondo del desktop, la finestra dell'applicazione attuale e altri elementi riguardo l'interfaccia utente.
Vector2i screen_get_position(screen: int = -1) const 🔗
Restituisce la posizione dell'angolo in alto a sinistra dello schermo in pixel. Restituisce Vector2i.ZERO se screen non è valido. Nelle configurazioni multi-monitor, la posizione dello schermo è relativa all'area del desktop virtuale. Nelle configurazioni multi-monitor con diverse risoluzioni o orientamenti dello schermo, l'origine può essere posizionata all'esterno di qualsiasi display in questo modo:
* (0, 0) +-------+
| |
+-------------+ | |
| | | |
| | | |
+-------------+ +-------+
Vedi anche screen_get_size().
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
float screen_get_refresh_rate(screen: int = -1) const 🔗
Restituisce la frequenza di aggiornamento attuale dello schermo specificato. Restituisce -1.0 se screen non è valido o se il DisplayServer non riesce a trovare la frequenza di aggiornamento per lo schermo specificato.
Per tornare a una frequenza di aggiornamento predefinita se il metodo fallisce, provare:
var refresh_rate = DisplayServer.screen_get_refresh_rate()
if refresh_rate < 0:
refresh_rate = 60.0
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Nota: Questo metodo è implementato su Android, iOS, macOS, Linux (X11 e Wayland) e Windows. Su altre piattaforme, questo metodo restituisce sempre -1.0.
float screen_get_scale(screen: int = -1) const 🔗
Restituisce il fattore di scala dello schermo specificato per indice. Restituisce 1.0 se screen non è valido.
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Nota: Su macOS, il valore restituito è 2.0 per gli schermi hiDPI (Retina) e 1.0 per tutti gli altri casi.
Nota: Su Linux (Wayland), il valore restituito è accurato solo quando screen è SCREEN_OF_MAIN_WINDOW. A causa delle limitazioni dell'API, il passaggio di un indice diretto restituirà un intero arrotondato per eccesso, se lo schermo ha una scala frazionaria (ad esempio, 1.25 verrebbe arrotondato per eccesso a 2.0).
Nota: Questo metodo è implementato su Android, iOS, Web, macOS e Linux (Wayland). Su altre piattaforme, questo metodo restituisce sempre 1.0.
Vector2i screen_get_size(screen: int = -1) const 🔗
Restituisce la dimensione dello schermo in pixel. Vedi anche screen_get_position() e screen_get_usable_rect(). Restituisce Vector2i.ZERO se screen non è valido.
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Rect2i screen_get_usable_rect(screen: int = -1) const 🔗
Restituisce la porzione dello schermo non ostruita dalla barra di stato, in pixel. Vedi anche screen_get_size().
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Nota: Questo metodo è implementato su Linux/X11, macOS e Windows. Su altre piattaforme, questo metodo restituisce sempre Rect2i(screen_get_position(screen), screen_get_size(screen)).
bool screen_is_kept_on() const 🔗
Restituisce true se lo schermo non dovrebbe mai essere spento dalle misure di risparmio energetico del sistema operativo. Vedi anche screen_set_keep_on().
void screen_set_keep_on(enable: bool) 🔗
Imposta se lo schermo non dovrebbe mai essere spento dalle misure di risparmio energetico del sistema operativo. Vedi anche screen_is_kept_on().
void screen_set_orientation(orientation: ScreenOrientation, screen: int = -1) 🔗
Imposta l'orientamento dello schermo all'indice screen su orientation. Vedi anche screen_get_orientation().
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Nota: Questo metodo è implementato su Android e iOS.
Nota: Su iOS, questo metodo non ha effetto se ProjectSettings.display/window/handheld/orientation non è impostato su SCREEN_SENSOR.
void set_hardware_keyboard_connection_change_callback(callable: Callable) 🔗
Imposta il chiamabile callable che deve essere richiamato quando la tastiera hardware è connessa/disconnessa. Il callable deve accettare un singolo parametro bool che indica se la tastiera è connessa (true) o disconnessa (false).
Nota: Questo metodo è implementato solo su Android.
Imposta l'icona della finestra (solitamente visualizzata nell'angolo in alto a sinistra) con un'Image. Per usare le icone nel formato nativo del sistema operativo, usa invece set_native_icon().
Nota: Richiede il supporto per FEATURE_ICON.
void set_native_icon(filename: String) 🔗
Imposta l'icona della finestra (solitamente visualizzata nell'angolo in alto a sinistra) nel formato nativo del sistema operativo. Il file nel percorso filename deve essere in formato .ico su Windows o .icns su macOS. Utilizzando icone .ico o .icns appositamente create, set_native_icon() consente di specificare icone diverse a seconda delle dimensioni in cui l'icona viene visualizzata. Questa dimensione è determinata dal sistema operativo e dalle preferenze dell'utente (incluso il fattore di scala di visualizzazione). Per utilizzare icone in altri formati, utilizzare invece set_icon().
Nota: Richiede il supporto per FEATURE_NATIVE_ICON.
void set_system_theme_change_callback(callable: Callable) 🔗
Imposta il Callable che verrà chiamato quando le impostazioni del tema di sistema sono cambiate. callable dovrebbe avere zero argomenti.
Nota: Questo metodo è implementato su Android, iOS, macOS, Windows, e Linux (X11/Wayland).
void show_emoji_and_symbol_picker() const 🔗
Apre il selettore di emoji e simboli del sistema.
Nota: Questo metodo è implementato su macOS e Windows.
Rect2 status_indicator_get_rect(id: int) const 🔗
Restituisce il rettangolo per il dato indicatore di stato id in coordinate di schermo. Se l'indicatore di stato non è visibile, restituisce un Rect2 vuoto.
Nota: Questo metodo è implementato su macOS e Windows.
void status_indicator_set_callback(id: int, callback: Callable) 🔗
Imposta il callback di attivazione dell'indicatore di stato dell'applicazione. callback dovrebbe accettare due argomenti: Un int che è l'indice del pulsante del mouse (uno dei valori di MouseButton) e un Vector2i che è la posizione del clic nelle coordinate dello schermo.
Nota: Questo metodo è implementato su macOS e Windows.
void status_indicator_set_icon(id: int, icon: Texture2D) 🔗
Imposta l'icona dell'applicazione nell'indicatore di stato.
Nota: Questo metodo è implementato su macOS e Windows.
Imposta il menu popup nativo dell'indicatore di stato dell'applicazione.
Nota: Su macOS, il menu viene attivato da qualsiasi pulsante del mouse. Il suo callback di attivazione non viene attivato.
Nota: Su Windows, il menu viene attivato dal pulsante destro del mouse, selezionando l'icona di stato e premendo Shift + F10, oppure il tasto applicazioni. Il callback di attivazione del menu per gli altri pulsanti del mouse viene comunque attivato.
Nota: Il popup nativo è supportato solo se NativeMenu supporta la funzionalità NativeMenu.FEATURE_POPUP_MENU.
void status_indicator_set_tooltip(id: int, tooltip: String) 🔗
Imposta il tooltip dell'applicazione nell'indicatore di stato.
Nota: Questo metodo è implementato su macOS e Windows.
String tablet_get_current_driver() const 🔗
Restituisce il nome del driver del tablet attualmente attivo.
Nota: Questo metodo è implementato solo su Windows.
int tablet_get_driver_count() const 🔗
Restituisce il numero totale di driver di tablet disponibili.
Nota: Questo metodo è implementato solo su Windows.
String tablet_get_driver_name(idx: int) const 🔗
Restituisce il nome del driver del tablet per il dato indice.
Nota: Questo metodo è implementato solo su Windows.
void tablet_set_current_driver(name: String) 🔗
Imposta il nome del driver del tablet attivo.
Driver supportati:
winink: API Windows Ink, predefinita.wintab: API Wacom Wintab (necessario driver dispositivo compatibile).dummy: Driver fittizio, l'input del tablet è disabilitato.
Nota: Questo metodo è implementato solo su Windows.
Array[Dictionary] tts_get_voices() const 🔗
Restituisce un Array di dizionari di informazioni vocali.
Ogni Dictionary contiene due voci String:
nameè il nome della voce.idè l'identificativo della voce.languageè il codice della lingua nel formatolang_Variant. La partelangè un codice di 2 o 3 lettere basato sullo standard ISO-639, in minuscolo. La parteVariantè una stringa dipendente dal motore che descrive paese, regione e/o dialetto.
Nota che Godot dipende dalle librerie di sistema per la funzionalità di conversione da testo a voce. Queste librerie sono installate di default su Windows e macOS, ma non su tutte le distribuzioni Linux. Se non sono presenti, questo metodo restituirà un elenco vuoto. Questo vale sia per gli utenti Godot su Linux, sia per gli utenti finali su Linux che eseguono giochi in Godot che utilizzano la conversione da testo a voce.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
PackedStringArray tts_get_voices_for_language(language: String) const 🔗
Restituisce un PackedStringArray di identificatori di voce per la lingua language.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
Restituisce true se il sintetizzatore è in pausa.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
bool tts_is_speaking() const 🔗
Restituisce true se il sintetizzatore sta generando un'espressione, o ha un'enunciazione in coda.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
void tts_pause() 🔗
Mette il sintetizzatore in pausa.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
void tts_resume() 🔗
Riprende il sintetizzatore se era in pausa.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
void tts_set_utterance_callback(event: TTSUtteranceEvent, callable: Callable) 🔗
Aggiunge un callback, che viene richiamato quando l'enunciazione è iniziata, terminata, annullata o ha raggiunto un riquadro di testo.
Per TTS_UTTERANCE_STARTED, TTS_UTTERANCE_ENDED e TTS_UTTERANCE_CANCELED, il metodo del chiamabile dovrebbe accettare un parametro int, l'ID dell'enunciazione.
Per TTS_UTTERANCE_BOUNDARY, il metodo del chiamabile dovrebbe accettare due parametri int, l'indice del carattere e l'ID dell'enunciazione.
Nota: La granularità dei callback di riquadro dipende dal motore.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
void tts_speak(text: String, voice: String, volume: int = 50, pitch: float = 1.0, rate: float = 1.0, utterance_id: int = 0, interrupt: bool = false) 🔗
Aggiunge un'enunciazione alla coda. Se interrupt è true, la coda viene prima ripulita.
voiceè uno dei valori"id"restituiti da tts_get_voices() o uno dei valori restituiti da tts_get_voices_for_language().volumevaria da0(il più basso) a100(il più alto).pitchvaria da0.0(il più basso) a2.0(il più alto),1.0è il tono predefinito per la voce attuale.ratevaria da0.1(minimo) a10.0(massimo),1.0è una velocità di parlato normale. Altri valori agiscono come percentuale relativa.utterance_idviene passato come parametro alle funzioni di callback.
Nota: Su Windows e Linux (X11/Wayland), il testo (text) dell'enunciazione può usare il markup SSML. Il supporto SSML dipende dal motore e dalla voce. Se il motore non supporta SSML, dovresti eliminare tutto il markup XML prima di chiamare tts_speak().
Nota: La granularità del tono, della velocità e del volume dipende dal motore e dalla voce. I valori potrebbero essere troncati.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
void tts_stop() 🔗
Ferma la sintesi in sviluppo e rimuove tutte le enunciazioni dalla coda.
Nota: Questo metodo è implementato su Android, iOS, Web, Linux (X11/Wayland), macOS e Windows.
void unregister_additional_output(object: Object) 🔗
Annulla la registrazione di un Object che rappresenta un'uscita aggiuntiva, registrato tramite register_additional_output().
int virtual_keyboard_get_height() const 🔗
Restituisce l'altezza della tastiera su schermo in pixel. Restituisce 0 se nessuna tastiera è presente o se è attualmente nascosta.
Nota: Su Android 7 e 8, l'altezza della tastiera potrebbe restituire 0 la prima volta che la tastiera viene aperta in modalità non immersiva. Questo comportamento non si verifica in modalità immersiva.
void virtual_keyboard_hide() 🔗
Nasconde la tastiera virtuale se viene mostrata, altrimenti non fa nulla.
void virtual_keyboard_show(existing_text: String, position: Rect2 = Rect2(0, 0, 0, 0), type: VirtualKeyboardType = 0, max_length: int = -1, cursor_start: int = -1, cursor_end: int = -1) 🔗
Mostra la tastiera virtuale se la piattaforma ne ha una.
Il parametro existing_text è utile per implementare il tuo LineEdit o TextEdit, poiché indica alla tastiera virtuale quale testo è già stato digitato (la tastiera virtuale lo usa per la correzione automatica e le previsioni).
Il parametro position è lo spazio sullo schermo Rect2 del testo modificato.
Il parametro type consente di configurare il tipo di tastiera virtuale da mostrare.
max_length limita il numero di caratteri che possono essere inseriti se diverso da -1.
cursor_start può facoltativamente definire la posizione attuale del cursore del testo se cursor_end non è impostato.
cursor_start e cursor_end possono facoltativamente definire la selezione attuale del testo.
Nota: Questo metodo è implementato su Android, iOS e Web.
void warp_mouse(position: Vector2i) 🔗
Imposta la posizione del cursore del mouse sulla posizione position relativa a un'origine nell'angolo in alto a sinistra della finestra del Gestore finestre del gioco attualmente in primo piano.
Nota: warp_mouse() è supportato solo su Windows, macOS e Linux (X11/Wayland). Non ha effetto su Android, iOS e Web.
bool window_can_draw(window_id: int = 0) const 🔗
Restituisce true se è possibile disegnare qualcosa nella finestra specificata da window_id, altrimenti false. Utilizzando l'argomento della riga di comando --disable-render-loop o una build headless verrà restituito false.
int window_get_active_popup() const 🔗
Restituisce l'ID della finestra popup attiva o INVALID_WINDOW_ID se non ce n'è alcuna.
int window_get_attached_instance_id(window_id: int = 0) const 🔗
Restituisce l'ID d'istanza (Object.get_instance_id()) della Window a cui è associato il window_id.
int window_get_current_screen(window_id: int = 0) const 🔗
Restituisce lo schermo su cui è attualmente posizionata la finestra specificata da window_id. Se lo schermo si sovrappone a più display, viene restituito lo schermo in cui si trova il centro della finestra. Vedi anche window_set_current_screen(). Restituisce INVALID_SCREEN se window_id non è valido.
Nota: Questo metodo è implementato su Linux/X11, macOS e Windows. Su altre piattaforme, questo metodo restituisce sempre 0.
bool window_get_flag(flag: WindowFlags, window_id: int = 0) const 🔗
Restituisce il valore attuale del flag della finestra specificata.
Vector2i window_get_max_size(window_id: int = 0) const 🔗
Restituisce le dimensioni massime della finestra (in pixel). Vedi anche window_set_max_size().
Vector2i window_get_min_size(window_id: int = 0) const 🔗
Restituisce le dimensioni minime della finestra (in pixel). Vedi anche window_set_min_size().
WindowMode window_get_mode(window_id: int = 0) const 🔗
Restituisce la modalità della finestra specificata.
int window_get_native_handle(handle_type: HandleType, window_id: int = 0) const 🔗
Restituisce i puntatori di strutture interne per l'uso nelle estensioni.
Nota: Questo metodo è implementato su Android, Linux (X11/Wayland), macOS, e Windows.
Rect2i window_get_popup_safe_rect(window: int) const 🔗
Restituisce il riquadro di delimitazione del controllo o della voce di menu utilizzata per aprire la finestra popup nel sistema di coordinate dello schermo.
Vector2i window_get_position(window_id: int = 0) const 🔗
Restituisce la posizione dell'area client della finestra specificata sullo schermo.
Vector2i window_get_position_with_decorations(window_id: int = 0) const 🔗
Restituisce la posizione della finestra specificata sullo schermo, includendo i bordi disegnati dal sistema operativo. Vedi anche window_get_position().
Vector3i window_get_safe_title_margins(window_id: int = 0) const 🔗
Restituisce i margini sinistri (x), i margini destri (y) e l'altezza (z) del titolo che sono sicuri da usare (non contengono pulsanti o altri elementi) quando è impostato il flag WINDOW_FLAG_EXTEND_TO_TITLE.
Vector2i window_get_size(window_id: int = 0) const 🔗
Restituisce le dimensioni della finestra specificata da window_id (in pixel), escludendo i bordi disegnati dal sistema operativo. Questa è anche chiamata "client area". Vedi anche window_get_size_with_decorations(), window_set_size() e window_get_position().
Vector2i window_get_size_with_decorations(window_id: int = 0) const 🔗
Restituisce le dimensioni della finestra specificata da window_id (in pixel), includendo i bordi disegnati dal sistema operativo. Vedi anche window_get_size().
Vector2i window_get_title_size(title: String, window_id: int = 0) const 🔗
Restituisce le dimensioni stimate della barra del titolo della finestra (inclusi testo e pulsanti della finestra) per la finestra specificata da window_id (in pixel). Questo metodo non modifica il titolo della finestra.
Nota: Questo metodo è implementato su macOS e Windows.
VSyncMode window_get_vsync_mode(window_id: int = 0) const 🔗
Restituisce la modalità di sincronizzazione verticale della finestra specificata.
bool window_is_focused(window_id: int = 0) const 🔗
Restituisce true se la finestra specificata da window_id è focalizzata.
bool window_is_maximize_allowed(window_id: int = 0) const 🔗
Restituisce true se la finestra specificata può essere massimizzata (il pulsante di ingrandimento è abilitato).
bool window_maximize_on_title_dbl_click() const 🔗
Restituisce true, se il doppio clic sul titolo di una finestra dovrebbe massimizzarla.
Nota: Questo metodo è implementato solo su macOS.
bool window_minimize_on_title_dbl_click() const 🔗
Restituisce true, se il doppio clic sul titolo di una finestra dovrebbe minimizzarla.
Nota: Questo metodo è implementato solo su macOS.
void window_move_to_foreground(window_id: int = 0) 🔗
Sposta la finestra specificata da window_id in primo piano, in modo che sia visibile sopra le altre finestre.
void window_request_attention(window_id: int = 0) 🔗
Fa in modo che la finestra specificata da window_id richieda l'attenzione, il che provoca il titolo della finestra e la voce della barra delle applicazioni a lampeggiare finché la finestra non è focalizzata. Di solito questo non ha alcun effetto visibile se la finestra è attualmente focalizzata. Il comportamento esatto varia a seconda del sistema operativo.
void window_set_current_screen(screen: int, window_id: int = 0) 🔗
Sposta la finestra specificata da window_id nello schermo screen. Vedi anche window_get_current_screen().
Nota: È possibile utilizzare una delle seguenti costanti per screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS o SCREEN_WITH_KEYBOARD_FOCUS.
Nota: Questo metodo è implementato su Linux/X11, macOS e Windows.
void window_set_drop_files_callback(callback: Callable, window_id: int = 0) 🔗
Imposta il callback che deve essere richiamato quando i file vengono eliminati dal gestore di file del sistema operativo alla finestra specificata da window_id. callback deve accettare un argomento PackedStringArray, che è la lista dei file eliminati.
Attenzione: Solo per utenti avanzati! L'aggiunta di tale callback a un nodo Window sovrascriverà la sua implementazione predefinita, il che può introdurre bug.
Nota: Questo metodo è implementato su Windows, macOS, Linux (X11/Wayland) e Web.
void window_set_exclusive(window_id: int, exclusive: bool) 🔗
Se impostato su true, questa finestra rimarrà sempre in cima alla finestra padre, la finestra padre ignorerà gli input mentre questa finestra è aperta.
Nota: Su macOS, le finestre esclusive sono confinate nello stesso spazio (desktop virtuale o schermo) della finestra padre.
Nota: Questo metodo è implementato su macOS e Windows.
void window_set_flag(flag: WindowFlags, enabled: bool, window_id: int = 0) 🔗
Attiva o disattiva il flag specificato della finestra specificata.
void window_set_ime_active(active: bool, window_id: int = 0) 🔗
Imposta se l'Input Method Editor deve essere abilitato per la finestra specificata da window_id. Vedi anche window_set_ime_position().
void window_set_ime_position(position: Vector2i, window_id: int = 0) 🔗
Imposta la posizione del popup Input Method Editor per la finestra specificata da window_id. Efficace solo se window_set_ime_active() è stato impostato su true per la finestra specificata da window_id.
void window_set_input_event_callback(callback: Callable, window_id: int = 0) 🔗
Imposta il callback che deve essere richiamato quando un InputEvent viene inviato alla finestra specificata da window_id.
Attenzione: Solo per utenti avanzati! L'aggiunta di tale callback a un nodo Window sovrascriverà la sua implementazione predefinita, il che può introdurre bug.
void window_set_input_text_callback(callback: Callable, window_id: int = 0) 🔗
Imposta il callback che deve essere richiamato quando si inserisce testo tramite la tastiera virtuale sulla finestra specificata da window_id.
Attenzione: Solo per utenti avanzati! L'aggiunta di tale callback a un nodo Window sovrascriverà la sua implementazione predefinita, il che può introdurre bug.
void window_set_max_size(max_size: Vector2i, window_id: int = 0) 🔗
Imposta le dimensioni massime della finestra specificata da window_id in pixel. Normalmente, l'utente non sarà in grado di trascinare la finestra per renderla più grande della dimensione specificata. Vedi anche window_get_max_size().
Nota: Si consiglia di modificare questo valore utilizzando invece Window.max_size.
Nota: Utilizzando strumenti di terze parti, per gli utenti è possibile disabilitare le restrizioni della geometria della finestra e quindi aggirare questo limite.
void window_set_min_size(min_size: Vector2i, window_id: int = 0) 🔗
Imposta le dimensioni minime della finestra specificata da window_id in pixel. Normalmente, l'utente non sarà in grado di trascinare la finestra per renderla più grande della dimensione specificata. Vedi anche window_get_min_size().
Nota: Si consiglia di modificare questo valore utilizzando invece Window.min_size.
Nota: Per impostazione predefinita, la finestra principale ha dimensioni minime di Vector2i(64, 64). Ciò impedisce eventuali problemi che possono sorgere quando le dimensioni della finestra sono quasi uguali a zero.
Nota: Utilizzando strumenti di terze parti, per gli utenti è possibile disabilitare le restrizioni della geometria della finestra e quindi aggirare questo limite.
void window_set_mode(mode: WindowMode, window_id: int = 0) 🔗
Imposta la modalità di finestra per la finestra specificata su mode.
Nota: su Android, impostandola su WINDOW_MODE_FULLSCREEN o WINDOW_MODE_EXCLUSIVE_FULLSCREEN verrà abilitata la modalità immersiva.
Nota: Impostando la finestra a schermo intero, il flag borderless (senza bordi) viene forzato su true, quindi assicurarsi di reimpostarlo su false se non desiderato.
void window_set_mouse_passthrough(region: PackedVector2Array, window_id: int = 0) 🔗
Imposta una regione poligonale della finestra che accetta eventi dal mouse. Gli eventi dal mouse al di fuori della regione passeranno attraverso (passthrough).
Impostando un array vuoto il supporto per il passthrough verrà disabilitato (tutti gli eventi del mouse saranno intercettati dalla finestra, il che è il comportamento predefinito).
# Imposta la regione, usando il nodo Path2D.
DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
# Imposta la regione, usando il nodo Polygon2D.
DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
# Reimposta la regione sul valore predefinito.
DisplayServer.window_set_mouse_passthrough([])
// Imposta la regione, usando il nodo Path2D.
DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
// Imposta la regione, usando il nodo Polygon2D.
DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
// Reimposta la regione sul valore predefinito.
DisplayServer.WindowSetMousePassthrough(new Vector2[] {});
Nota: Su Windows, la parte di una finestra che si trova all'esterno della regione non è disegnata, mentre su Linux (X11) e macOS lo è.
Nota: Questo metodo è implementato su Linux (X11), macOS e Windows.
void window_set_popup_safe_rect(window: int, rect: Rect2i) 🔗
Imposta il riquadro di delimitazione del controllo o della voce di menu utilizzata per aprire la finestra popup nel sistema di coordinate dello schermo. Cliccando su quest'area questo popup non verrà chiuso automaticamente.
void window_set_position(position: Vector2i, window_id: int = 0) 🔗
Imposta la posizione della finestra specificata su position. Nelle configurazioni multi-monitor, la posizione dello schermo è relativa all'area del desktop virtuale. Nelle configurazioni multi-monitor con diverse risoluzioni o orientamenti dello schermo, l'origine può essere posizionata all'esterno di qualsiasi display in questo modo:
* (0, 0) +-------+
| |
+-------------+ | |
| | | |
| | | |
+-------------+ +-------+
Vedi anche window_get_position() e window_set_size().
Nota: Si consiglia di modificare questo valore utilizzando invece Window.position.
Nota: Su Linux (Wayland): questo metodo è un no-op.
void window_set_rect_changed_callback(callback: Callable, window_id: int = 0) 🔗
Imposta il callback che verrà richiamato quando la finestra specificata da window_id viene spostata o ridimensionata.
Attenzione: Solo per utenti avanzati! L'aggiunta di tale callback a un nodo Window sovrascriverà la sua implementazione predefinita, il che può introdurre bug.
void window_set_size(size: Vector2i, window_id: int = 0) 🔗
Imposta le dimensioni della finestra specificata su size (in pixel). Vedi anche window_get_size() e window_get_position().
Nota: Si consiglia di modificare questo valore utilizzando invece Window.size.
void window_set_title(title: String, window_id: int = 0) 🔗
Imposta il titolo della finestra specificata su title.
Nota: Si consiglia di modificare questo valore utilizzando invece Window.title.
Nota: Evitare di modificare il titolo della finestra a ogni frame, poiché ciò può causare problemi di prestazioni su alcuni gestori di finestre. Cerca di modificare il titolo della finestra solo poche volte al secondo al massimo.
void window_set_transient(window_id: int, parent_window_id: int) 🔗
Imposta la finestra transitoria genitore. La finestra transitoria verrà distrutta con il suo genitore transitorio e tornerà il focus sul suo genitore quando verrà chiusa. La finestra transitoria è visualizzata sopra una finestra padre a schermo intero non esclusivo. Le finestre transitorie non possono entrare in modalità a schermo intero.
Nota: Si consiglia invece di modificare questo valore tramite Window.transient.
Nota: Il comportamento potrebbe essere diverso a seconda della piattaforma.
void window_set_vsync_mode(vsync_mode: VSyncMode, window_id: int = 0) 🔗
Imposta la modalità di V-Sync della finestra specificata. Vedi anche ProjectSettings.display/window/vsync/vsync_mode.
A seconda della piattaforma e del renderer utilizzato, il motore ricadrà a VSYNC_ENABLED se la modalità desiderata non è supportata.
Nota: Le modalità di V-Sync diverse da VSYNC_ENABLED sono supportate solo nei metodi di rendering Forward+ e Mobile, non Compatibilità.
void window_set_window_buttons_offset(offset: Vector2i, window_id: int = 0) 🔗
Quando il flag WINDOW_FLAG_EXTEND_TO_TITLE è impostato, imposta lo scostamento al centro del primo pulsante della barra del titolo.
Nota: Questo flag è implementato solo su macOS.
void window_set_window_event_callback(callback: Callable, window_id: int = 0) 🔗
Imposta il callback che verrà richiamato quando si verifica un evento nella finestra specificata da window_id.
Attenzione: Solo per utenti avanzati! L'aggiunta di tale callback a un nodo Window sovrascriverà la sua implementazione predefinita, il che può introdurre bug.
void window_start_drag(window_id: int = 0) 🔗
Avvia un'operazione di trascinamento interattiva sulla finestra con l'ID window_id, usando la posizione attuale del mouse. Chiama questo metodo quando gestisci un pulsante del mouse premuto per simulare un evento di pressione sulla barra del titolo della finestra. Usando questo metodo, la finestra può partecipare al cambio di spazio, all'affiancamento e ad altre funzionalità di sistema.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS e Windows.
void window_start_resize(edge: WindowResizeEdge, window_id: int = 0) 🔗
Avvia un'operazione di ridimensionamento interattiva sulla finestra con l'ID window_id, usando la posizione attuale del mouse. Chiama questo metodo quando gestisci un pulsante del mouse premuto per simulare un evento di pressione sul bordo della finestra.
Nota: Questo metodo è implementato su Linux (X11/Wayland), macOS e Windows.