Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Theme
Eredita: Resource < RefCounted < Object
Una risorsa utilizzata per lo stile/l'aspetto dei nodi Control e Window.
Descrizione
Una risorsa utilizzata per lo stile/l'aspetto dei nodi Control e Window. Mentre i singoli controlli possono essere stilizzati attraverso le loro sostituzioni locali del tema (vedi Control.add_theme_color_override()), le risorse tema consentono di memorizzare e applicare le stesse impostazioni a tutti i controlli che condividono lo stesso tipo (ad esempio, applicare lo stesso stile a tutti i Button). È possibile applicare una sola risorsa tema per l'intero progetto, ma è anche possibile impostare una risorsa tema separata per un ramo di nodi di controllo. Una risorsa tema assegnata a un controllo si applica al controllo stesso, nonché a tutti i suoi figli diretti e indiretti (purché la catena di controlli non sia interrotta).
Usa ProjectSettings.gui/theme/custom per impostare un tema predefinito del progetto che sarà disponibile per ogni controllo nel progetto.
Usa Control.theme di qualsiasi nodo di controllo per impostare un tema che sarà disponibile per quel controllo e tutti i suoi figli diretti e indiretti.
Tutorial
Proprietà
|
||
|
Metodi
Enumerazioni
enum DataType: 🔗
DataType DATA_TYPE_COLOR = 0
Il tipo di Color del tema.
DataType DATA_TYPE_CONSTANT = 1
Il tipo di costante del tema.
DataType DATA_TYPE_FONT = 2
Il tipo di Font del tema.
DataType DATA_TYPE_FONT_SIZE = 3
Il tipo di dimensione del font del tema.
DataType DATA_TYPE_ICON = 4
Il tipo di icona Texture2D del tema.
DataType DATA_TYPE_STYLEBOX = 5
Il tipo di StyleBox del tema.
DataType DATA_TYPE_MAX = 6
Il valore massimo per l'enumerazione DataType.
Descrizioni delle proprietà
float default_base_scale = 0.0 🔗
Il fattore predefinito di scala base di questa risorsa tema. Utilizzato da alcuni controlli per ridimensionare le loro proprietà visive in base al fattore di scala globale. Se questo valore è impostato su 0.0, viene utilizzato il fattore di scala globale (vedi ThemeDB.fallback_base_scale).
Usa has_default_base_scale() per verificare se questo valore è valido.
Il font predefinito di questa risorsa tema. Utilizzato come valore predefinito quando si tenta di recuperare una risorsa font che non esiste in questo tema o è in stato non valido. Se anche il font predefinito è mancante o non valido, viene utilizzato il valore di riserva del motore (vedi ThemeDB.fallback_font).
Usa has_default_font() per verificare se questo valore è valido.
La dimensione predefinita del font di questa risorsa tema. Utilizzata come valore predefinito quando si tenta di recuperare un valore di dimensione del font che non esiste in questo tema o è in uno stato non valido. Se anche la dimensione predefinita del font è mancante o non valida, viene utilizzato il valore di riserva del motore (vedi ThemeDB.fallback_font_size).
I valori inferiori a 1 non sono validi e possono essere utilizzati per annullare l'impostazione della proprietà. Usa has_default_font_size() per verificare se questo valore è valido.
Descrizioni dei metodi
void add_type(theme_type: StringName) 🔗
Aggiunge un tipo di tema vuoto per ogni tipo di dati valido.
Nota: I tipi vuoti non sono salvati con il tema. Questo metodo esiste solo per eseguire modifiche in memoria alla risorsa. Usa i metodi set_* disponibili per aggiungere elementi del tema.
void clear() 🔗
Rimuove tutte le proprietà del tema definite sulla risorsa tema.
void clear_color(name: StringName, theme_type: StringName) 🔗
Rimuove la proprietà Color definita dal nome (name) e il tipo (theme_type), se esiste.
Fallisce se non esiste. Usa has_color() per verificarne l'esistenza.
void clear_constant(name: StringName, theme_type: StringName) 🔗
Rimuove la proprietà costante definita dal nome (name) e il tipo (theme_type), se esiste.
Fallisce se non esiste. Usa has_constant() per verificarne l'esistenza.
void clear_font(name: StringName, theme_type: StringName) 🔗
Rimuove la proprietà Font definita dal nome (name) e il tipo (theme_type), se esiste.
Fallisce se non esiste. Usa has_font() per verificarne l'esistenza.
void clear_font_size(name: StringName, theme_type: StringName) 🔗
Rimuove la proprietà di dimensione del font definita dal nome (name) e il tipo (theme_type), se esiste.
Fallisce se non esiste. Usa has_font_size() per verificarne l'esistenza.
void clear_icon(name: StringName, theme_type: StringName) 🔗
Rimuove la proprietà di icona definita dal nome (name) e il tipo (theme_type), se esiste.
Fallisce se non esiste. Usa has_icon() per verificarne l'esistenza.
void clear_stylebox(name: StringName, theme_type: StringName) 🔗
Rimuove la proprietà StyleBox definita dal nome (name) e il tipo (theme_type), se esiste.
Fallisce se non esiste. Usa has_stylebox() per verificarne l'esistenza.
void clear_theme_item(data_type: DataType, name: StringName, theme_type: StringName) 🔗
Rimuove la proprietà del tema con il tipo di dato data_type, definita dal nome (name) e il tipo (theme_type), se esiste.
Fallisce se non esiste. Usa has_theme_item() per verificarne l'esistenza.
Nota: Questo metodo è analogo a chiamare il metodo specifico del tipo di dato corrispondente, ma può essere usato per una logica più generalizzata.
void clear_type_variation(theme_type: StringName) 🔗
Rimuove il tipo theme_type come variazione di un altro tipo di tema. Vedi set_type_variation().
Color get_color(name: StringName, theme_type: StringName) const 🔗
Restituisce la proprietà Color definita dal nome (name) e il tipo (theme_type), se esiste.
Restituisce il valore predefinito di colore se la proprietà non esiste. Usa has_color() per verificarne l'esistenza.
PackedStringArray get_color_list(theme_type: String) const 🔗
Restituisce una lista di nomi per le proprietà Color definite con il tipo del tema theme_type. Usa get_color_type_list() per ottenere una lista di nomi disponibili per i tipi del tema.
PackedStringArray get_color_type_list() const 🔗
Restituisce una di tutti i nomi dei tipi univoci del tema per le proprietà Color. Usa get_type_list() per ottenere una lista di tutti i tipi univoci del tema.
int get_constant(name: StringName, theme_type: StringName) const 🔗
Restituisce la proprietà costante definita dal nome (name) e il tipo (theme_type), se esiste.
Restituisce 0 se la proprietà non esiste. Usa has_constant() per verificarne l'esistenza.
PackedStringArray get_constant_list(theme_type: String) const 🔗
Restituisce una lista di nomi per le proprietà costante definite con il tipo del tema theme_type. Usa get_constant_type_list() per ottenere una lista di nomi disponibili per i tipi del tema.
PackedStringArray get_constant_type_list() const 🔗
Restituisce una di tutti i nomi dei tipi univoci del tema per le proprietà costante. Usa get_type_list() per ottenere una lista di tutti i tipi univoci del tema.
Font get_font(name: StringName, theme_type: StringName) const 🔗
Restituisce la proprietà Font definita dal nome (name) e il tipo (theme_type), se esiste.
Restituisce il font predefinito del tema se la proprietà non esiste e tale font è configurato (vedi default_font). Usa has_font() per verificare l'esistenza della proprietà e has_default_font() per verificare l'esistenza del font predefinito del tema.
Restituisce il font di riserva del motore, se nessuno dei due esiste (vedi ThemeDB.fallback_font).
PackedStringArray get_font_list(theme_type: String) const 🔗
Restituisce una lista di nomi per le proprietà Font definite con il tipo del tema theme_type. Usa get_font_type_list() per ottenere una lista di nomi disponibili per i tipi del tema.
int get_font_size(name: StringName, theme_type: StringName) const 🔗
Restituisce la proprietà dimensione del font definita dal nome (name) e il tipo (theme_type), se esiste.
Restituisce la dimensione predefinita di font del tema se la proprietà non esiste e tale dimensione è configurata (vedi default_font_size). Usa has_font_size() per verificare l'esistenza della proprietà e has_default_font() per verificare l'esistenza della dimensione predefinita di font del tema.
Restituisce la dimensione di font di riserva del motore, se nessuno dei due esiste (vedi ThemeDB.fallback_font).
PackedStringArray get_font_size_list(theme_type: String) const 🔗
Restituisce una lista di nomi per le proprietà dimensione del font definite con il tipo del tema theme_type. Usa get_font_size_type_list() per ottenere una lista di nomi disponibili per i tipi del tema.
PackedStringArray get_font_size_type_list() const 🔗
Restituisce una di tutti i nomi dei tipi univoci del tema per le proprietà dimensione del font. Usa get_type_list() per ottenere una lista di tutti i tipi univoci del tema.
PackedStringArray get_font_type_list() const 🔗
Restituisce una di tutti i nomi dei tipi univoci del tema per le proprietà Font. Usa get_type_list() per ottenere una lista di tutti i tipi univoci del tema.
Texture2D get_icon(name: StringName, theme_type: StringName) const 🔗
Restituisce la proprietà icona definita dal nome (name) e il tipo (theme_type), se esiste.
Restituisce l'icona di riserva del motore se la proprietà non esiste (vedi ThemeDB.fallback_icon). Usa has_icon() per verificarne l'esistenza.
PackedStringArray get_icon_list(theme_type: String) const 🔗
Restituisce una lista di nomi per le proprietà icona definite con il tipo del tema theme_type. Usa get_icon_type_list() per ottenere una lista di nomi disponibili per i tipi del tema.
PackedStringArray get_icon_type_list() const 🔗
Restituisce una di tutti i nomi dei tipi univoci del tema per le proprietà icona. Usa get_type_list() per ottenere una lista di tutti i tipi univoci del tema.
StyleBox get_stylebox(name: StringName, theme_type: StringName) const 🔗
Restituisce la proprietà StyleBox definita dal nome (name) e il tipo (theme_type), se esiste.
Restituisce il stylebox di riserva del motore se la proprietà non esiste (vedi ThemeDB.fallback_stylebox). Usa has_stylebox() per verificarne l'esistenza.
PackedStringArray get_stylebox_list(theme_type: String) const 🔗
Restituisce una lista di nomi per le proprietà StyleBox definite con il tipo del tema theme_type. Usa get_stylebox_type_list() per ottenere una lista di nomi disponibili per i tipi del tema.
PackedStringArray get_stylebox_type_list() const 🔗
Restituisce una di tutti i nomi dei tipi univoci del tema per le proprietà StyleBox. Usa get_type_list() per ottenere una lista di tutti i tipi univoci del tema.
Variant get_theme_item(data_type: DataType, name: StringName, theme_type: StringName) const 🔗
Restituisce la proprietà del tema con il tipo di dato data_type, definita dal nome (name) e il tipo (theme_type), se esiste.
Restituisce il valore di riserva del motore se la proprietà non esiste (vedi ThemeDB). Usa has_theme_item() per verificarne l'esistenza.
Nota: Questo metodo è analogo a chiamare il metodo specifico del tipo di dato corrispondente, ma può essere usato per una logica più generalizzata.
PackedStringArray get_theme_item_list(data_type: DataType, theme_type: String) const 🔗
Restituisce una lista di nomi per le proprietà con il tipo data_type, definite con il tipo del tema theme_type. Usa get_theme_item_type_list() per ottenere una lista di nomi disponibili per i tipi del tema.
Nota: Questo metodo è analogo a chiamare il metodo specifico del tipo di dato corrispondente, ma può essere usato per una logica più generalizzata.
PackedStringArray get_theme_item_type_list(data_type: DataType) const 🔗
Restituisce una di tutti i nomi dei tipi univoci del tema per le proprietà con il tipo di dato data_type. Usa get_type_list() per ottenere una lista di tutti i tipi univoci del tema.
Nota: Questo metodo è analogo a chiamare il metodo specifico del tipo di dato corrispondente, ma può essere usato per una logica più generalizzata.
PackedStringArray get_type_list() const 🔗
Restituisce una di tutti i nomi dei tipi univoci del tema. Usa il metodo get_*_type_list appropriato per ottenere una lista dei tipi univoci del tema per un tipo specifico di dato.
StringName get_type_variation_base(theme_type: StringName) const 🔗
Restituisce il nome del tipo base del tema se theme_type è un tipo di variazione valido. Altrimenti, restituisce una stringa vuota.
PackedStringArray get_type_variation_list(base_type: StringName) const 🔗
Restituisce un'elenco di tutte le variazioni di tipo per il tipo di base fornito (base_type).
bool has_color(name: StringName, theme_type: StringName) const 🔗
Restituisce true se la proprietà Color definita da name e theme_type esiste.
Restituisce false se non esiste. Usa set_color() per definirla.
bool has_constant(name: StringName, theme_type: StringName) const 🔗
Restituisce true se la proprietà costante definita da name e theme_type esiste.
Restituisce false se non esiste. Usa set_constant() per definirla.
bool has_default_base_scale() const 🔗
Restituisce true se default_base_scale ha un valore valido.
Restituisce false in caso contrario. Il valore deve essere maggiore di 0.0 per essere considerato valido.
bool has_default_font() const 🔗
Restituisce true se default_font ha un valore valido.
Restituisce false se non lo ha.
bool has_default_font_size() const 🔗
Restituisce true se default_font_size ha un valore valido.
Restituisce false in caso contrario. Il valore deve essere maggiore di 0 per essere considerato valido.
bool has_font(name: StringName, theme_type: StringName) const 🔗
Restituisce true se la proprietà Font definita dal nome name e il tipo theme_type esiste, o se il font predefinito del tema è impostato (vedi has_default_font()).
Restituisce false se nessuno dei due esiste. Usa set_font() per definire la proprietà.
bool has_font_size(name: StringName, theme_type: StringName) const 🔗
Restituisce true se la proprietà dimensione del font definita dal nome name e il tipo theme_type esiste, o se la dimensione predefinita del font del tema è impostata (vedi has_default_font_size()).
Restituisce false se nessuna delle due esiste. Usa set_font_size() per definire la proprietà.
bool has_icon(name: StringName, theme_type: StringName) const 🔗
Restituisce true se la proprietà di icona definita da name e theme_type esiste.
Restituisce false se non esiste. Usa set_icon() per definirla.
bool has_stylebox(name: StringName, theme_type: StringName) const 🔗
Restituisce true se la proprietà StyleBox definita da name e theme_type esiste.
Restituisce false se non esiste. Usa set_stylebox() per definirla.
bool has_theme_item(data_type: DataType, name: StringName, theme_type: StringName) const 🔗
Restituisce true se la proprietà del tema con il tipo data_type, definita dal nome name e il tipo theme_type esiste.
Restituisce false se non esiste. Usa set_theme_item() per definirla.
Nota: Questo metodo è analogo a chiamare il metodo specifico del tipo di dato corrispondente, ma può essere usato per una logica più generalizzata.
bool is_type_variation(theme_type: StringName, base_type: StringName) const 🔗
Restituisce true se il theme_type è configurato come una variazione di base_type.
void merge_with(other: Theme) 🔗
Aggiunge le definizioni mancanti e sovrascrive quelle esistenti con i valori dalla risorsa tema other.
Nota: Questo modifica il tema attuale. Se si desidera unire due temi senza modificarne nessuno, crea un nuovo tema vuoto e unisci gli altri due in esso uno dopo l'altro.
void remove_type(theme_type: StringName) 🔗
Rimuove il tipo del tema, scartando graziosamente gli elementi del tema definiti. Se il tipo è una variazione, anche questa informazione viene cancellata. Se il tipo è una base per le variazioni di tipo, tali variazioni perdono la loro base.
void rename_color(old_name: StringName, name: StringName, theme_type: StringName) 🔗
Rinomina la proprietà Color definita dal nome old_name e il tipo theme_type in name, se esiste.
Fallisce se non esiste, o se una proprietà simile con il nuovo nome esiste già. Usa has_color() per verificarne l'esistenza, e clear_color() per rimuovere la proprietà esistente.
void rename_constant(old_name: StringName, name: StringName, theme_type: StringName) 🔗
Rinomina la proprietà costante definita dal nome old_name e il tipo theme_type in name, se esiste.
Fallisce se non esiste, o se una proprietà simile con il nuovo nome esiste già. Usa has_constant() per verificarne l'esistenza, e clear_constant() per rimuovere la proprietà esistente.
void rename_font(old_name: StringName, name: StringName, theme_type: StringName) 🔗
Rinomina la proprietà Font definita dal nome old_name e il tipo theme_type in name, se esiste.
Fallisce se non esiste, o se una proprietà simile con il nuovo nome esiste già. Usa has_font() per verificarne l'esistenza, e clear_font() per rimuovere la proprietà esistente.
void rename_font_size(old_name: StringName, name: StringName, theme_type: StringName) 🔗
Rinomina la proprietà dimensione del font definita dal nome old_name e il tipo theme_type in name, se esiste.
Fallisce se non esiste, o se una proprietà simile con il nuovo nome esiste già. Usa has_font_size() per verificarne l'esistenza, e clear_font_size() per rimuovere la proprietà esistente.
void rename_icon(old_name: StringName, name: StringName, theme_type: StringName) 🔗
Rinomina la proprietà icona definita dal nome old_name e il tipo theme_type in name, se esiste.
Fallisce se non esiste, o se una proprietà simile con il nuovo nome esiste già. Usa has_icon() per verificarne l'esistenza, e clear_icon() per rimuovere la proprietà esistente.
void rename_stylebox(old_name: StringName, name: StringName, theme_type: StringName) 🔗
Rinomina la proprietà StyleBox definita dal nome old_name e il tipo theme_type in name, se esiste.
Fallisce se non esiste, o se una proprietà simile con il nuovo nome esiste già. Usa has_stylebox() per verificarne l'esistenza, e clear_stylebox() per rimuovere la proprietà esistente.
void rename_theme_item(data_type: DataType, old_name: StringName, name: StringName, theme_type: StringName) 🔗
Rinomina la proprietà del tema con il tipo data_type, definita dal nome old_name e il tipo theme_type in name, se esiste.
Fallisce se non esiste, o se una proprietà simile con il nuovo nome esiste già. Usa has_theme_item() per verificarne l'esistenza, e clear_theme_item() per rimuovere la proprietà esistente.
Nota: Questo metodo è analogo a chiamare il metodo specifico del tipo di dato corrispondente, ma può essere usato per una logica più generalizzata.
void rename_type(old_theme_type: StringName, theme_type: StringName) 🔗
Rinomina il tipo di tema old_theme_type in theme_type, se il vecchio tipo esiste e quello nuovo non esiste.
Nota: Rinominare un tipo di tema con un nome vuoto o una variazione con un tipo associato a una classe integrata rimuove le connessioni alle variazioni di tipo in un modo che non si può annullare semplicemente invertendo il cambio di nome.
void set_color(name: StringName, theme_type: StringName, color: Color) 🔗
Crea o modifica il valore della proprietà Color definita dal nome (name) e il tipo (theme_type). Usa clear_color() per rimuovere la proprietà.
void set_constant(name: StringName, theme_type: StringName, constant: int) 🔗
Crea o modifica il valore della proprietà costante definita dal nome (name) e il tipo (theme_type). Usa clear_constant() per rimuovere la proprietà.
void set_font(name: StringName, theme_type: StringName, font: Font) 🔗
Crea o modifica il valore della proprietà Font definita dal nome (name) e il tipo (theme_type). Usa clear_font() per rimuovere la proprietà.
void set_font_size(name: StringName, theme_type: StringName, font_size: int) 🔗
Crea o modifica il valore della proprietà dimensione del font definita dal nome (name) e il tipo (theme_type). Usa clear_font_size() per rimuovere la proprietà.
void set_icon(name: StringName, theme_type: StringName, texture: Texture2D) 🔗
Crea o modifica il valore della proprietà icona definita dal nome (name) e il tipo (theme_type). Usa clear_icon() per rimuovere la proprietà.
void set_stylebox(name: StringName, theme_type: StringName, texture: StyleBox) 🔗
Crea o modifica il valore della proprietà StyleBox definita dal nome (name) e il tipo (theme_type). Usa clear_stylebox() per rimuovere la proprietà.
void set_theme_item(data_type: DataType, name: StringName, theme_type: StringName, value: Variant) 🔗
Crea o modifica il valore della proprietà del tema con il tipo di dato data_type, definita dal nome (name) e il tipo (theme_type). Usa clear_theme_item() per rimuovere la proprietà.
Fallisce se il tipo di value non è accettato dal tipo di dato data_type.
Nota: Questo metodo è analogo a chiamare il metodo specifico del tipo di dato corrispondente, ma può essere usato per una logica più generalizzata.
void set_type_variation(theme_type: StringName, base_type: StringName) 🔗
Contrassegna theme_type come variazione del tipo di base base_type.
Ciò aggiunge theme_type come opzione suggerita per Control.theme_type_variation su un Control che è della classe base_type.
È possibile annidare le variazioni, ovvero base_type può anche essere un'altra variazione. Se una catena di variazioni termina con un base_type che corrisponde alla classe del Control, l'intera catena sarà suggerita come opzione.
Nota: I suggerimenti sono visualizzati solo se questa risorsa tema è impostata come tema predefinito del progetto. Vedi ProjectSettings.gui/theme/custom.