- github_url
hide
Inherits: Resource<class_Resource> < RefCounted<class_RefCounted> < Object<class_Object>
A resource used for styling/skinning Control<class_Control>s and Window<class_Window>s.
classref-introduction-group
A resource used for styling/skinning Control<class_Control> and Window<class_Window> nodes. While individual controls can be styled using their local theme overrides (see Control.add_theme_color_override<class_Control_method_add_theme_color_override>), theme resources allow you to store and apply the same settings across all controls sharing the same type (e.g. style all Button<class_Button>s the same). One theme resource can be used for the entire project, but you can also set a separate theme resource to a branch of control nodes. A theme resource assigned to a control applies to the control itself, as well as all of its direct and indirect children (as long as a chain of controls is uninterrupted).
Use ProjectSettings.gui/theme/custom<class_ProjectSettings_property_gui/theme/custom> to set up a project-scope theme that will be available to every control in your project.
Use Control.theme<class_Control_property_theme> of any control node to set up a theme that will be available to that control and all of its direct and indirect children.
classref-introduction-group
GUI skinning <../tutorials/ui/gui_skinning>Using the theme editor <../tutorials/ui/gui_using_theme_editor>
classref-reftable-group
float<class_float> |
default_base_scale<class_Theme_property_default_base_scale> |
0.0 |
Font<class_Font> |
default_font<class_Theme_property_default_font> |
|
int<class_int> |
default_font_size<class_Theme_property_default_font_size> |
-1 |
classref-reftable-group
| void | add_type<class_Theme_method_add_type> ( StringName<class_StringName> theme_type ) |
| void | clear<class_Theme_method_clear> ( ) |
| void | clear_color<class_Theme_method_clear_color> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | clear_constant<class_Theme_method_clear_constant> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | clear_font<class_Theme_method_clear_font> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | clear_font_size<class_Theme_method_clear_font_size> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | clear_icon<class_Theme_method_clear_icon> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | clear_stylebox<class_Theme_method_clear_stylebox> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | clear_theme_item<class_Theme_method_clear_theme_item> ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | clear_type_variation<class_Theme_method_clear_type_variation> ( StringName<class_StringName> theme_type ) |
Color<class_Color> |
get_color<class_Theme_method_get_color> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_color_list<class_Theme_method_get_color_list> ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_color_type_list<class_Theme_method_get_color_type_list> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
int<class_int> |
get_constant<class_Theme_method_get_constant> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_constant_list<class_Theme_method_get_constant_list> ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_constant_type_list<class_Theme_method_get_constant_type_list> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
Font<class_Font> |
get_font<class_Theme_method_get_font> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_font_list<class_Theme_method_get_font_list> ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
int<class_int> |
get_font_size<class_Theme_method_get_font_size> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_font_size_list<class_Theme_method_get_font_size_list> ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_font_size_type_list<class_Theme_method_get_font_size_type_list> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_font_type_list<class_Theme_method_get_font_type_list> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
Texture2D<class_Texture2D> |
get_icon<class_Theme_method_get_icon> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_icon_list<class_Theme_method_get_icon_list> ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_icon_type_list<class_Theme_method_get_icon_type_list> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
StyleBox<class_StyleBox> |
get_stylebox<class_Theme_method_get_stylebox> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_stylebox_list<class_Theme_method_get_stylebox_list> ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_stylebox_type_list<class_Theme_method_get_stylebox_type_list> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
Variant<class_Variant> |
get_theme_item<class_Theme_method_get_theme_item> ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_theme_item_list<class_Theme_method_get_theme_item_list> ( DataType<enum_Theme_DataType> data_type, String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_theme_item_type_list<class_Theme_method_get_theme_item_type_list> ( DataType<enum_Theme_DataType> data_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_type_list<class_Theme_method_get_type_list> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
StringName<class_StringName> |
get_type_variation_base<class_Theme_method_get_type_variation_base> ( StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
PackedStringArray<class_PackedStringArray> |
get_type_variation_list<class_Theme_method_get_type_variation_list> ( StringName<class_StringName> base_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_color<class_Theme_method_has_color> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_constant<class_Theme_method_has_constant> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_default_base_scale<class_Theme_method_has_default_base_scale> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_default_font<class_Theme_method_has_default_font> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_default_font_size<class_Theme_method_has_default_font_size> ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_font<class_Theme_method_has_font> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_font_size<class_Theme_method_has_font_size> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_icon<class_Theme_method_has_icon> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_stylebox<class_Theme_method_has_stylebox> ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
has_theme_item<class_Theme_method_has_theme_item> ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
bool<class_bool> |
is_type_variation<class_Theme_method_is_type_variation> ( StringName<class_StringName> theme_type, StringName<class_StringName> base_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
| void | merge_with<class_Theme_method_merge_with> ( Theme<class_Theme> other ) |
| void | remove_type<class_Theme_method_remove_type> ( StringName<class_StringName> theme_type ) |
| void | rename_color<class_Theme_method_rename_color> ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | rename_constant<class_Theme_method_rename_constant> ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | rename_font<class_Theme_method_rename_font> ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | rename_font_size<class_Theme_method_rename_font_size> ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | rename_icon<class_Theme_method_rename_icon> ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | rename_stylebox<class_Theme_method_rename_stylebox> ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | rename_theme_item<class_Theme_method_rename_theme_item> ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type ) |
| void | set_color<class_Theme_method_set_color> ( StringName<class_StringName> name, StringName<class_StringName> theme_type, Color<class_Color> color ) |
| void | set_constant<class_Theme_method_set_constant> ( StringName<class_StringName> name, StringName<class_StringName> theme_type, int<class_int> constant ) |
| void | set_font<class_Theme_method_set_font> ( StringName<class_StringName> name, StringName<class_StringName> theme_type, Font<class_Font> font ) |
| void | set_font_size<class_Theme_method_set_font_size> ( StringName<class_StringName> name, StringName<class_StringName> theme_type, int<class_int> font_size ) |
| void | set_icon<class_Theme_method_set_icon> ( StringName<class_StringName> name, StringName<class_StringName> theme_type, Texture2D<class_Texture2D> texture ) |
| void | set_stylebox<class_Theme_method_set_stylebox> ( StringName<class_StringName> name, StringName<class_StringName> theme_type, StyleBox<class_StyleBox> texture ) |
| void | set_theme_item<class_Theme_method_set_theme_item> ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> name, StringName<class_StringName> theme_type, Variant<class_Variant> value ) |
| void | set_type_variation<class_Theme_method_set_type_variation> ( StringName<class_StringName> theme_type, StringName<class_StringName> base_type ) |
classref-section-separator
classref-descriptions-group
classref-enumeration
enum DataType:
classref-enumeration-constant
DataType<enum_Theme_DataType> DATA_TYPE_COLOR = 0
Theme's Color<class_Color> item type.
classref-enumeration-constant
DataType<enum_Theme_DataType> DATA_TYPE_CONSTANT = 1
Theme's constant item type.
classref-enumeration-constant
DataType<enum_Theme_DataType> DATA_TYPE_FONT = 2
Theme's Font<class_Font> item type.
classref-enumeration-constant
DataType<enum_Theme_DataType> DATA_TYPE_FONT_SIZE = 3
Theme's font size item type.
classref-enumeration-constant
DataType<enum_Theme_DataType> DATA_TYPE_ICON = 4
Theme's icon Texture2D<class_Texture2D> item type.
classref-enumeration-constant
DataType<enum_Theme_DataType> DATA_TYPE_STYLEBOX = 5
Theme's StyleBox<class_StyleBox> item type.
classref-enumeration-constant
DataType<enum_Theme_DataType> DATA_TYPE_MAX = 6
Maximum value for the DataType enum.
classref-section-separator
classref-descriptions-group
classref-property
float<class_float> default_base_scale = 0.0
classref-property-setget
- void set_default_base_scale (
float<class_float>value ) float<class_float>get_default_base_scale ( )
The default base scale factor of this theme resource. Used by some controls to scale their visual properties based on the global scale factor. If this value is set to 0.0, the global scale factor is used (see ThemeDB.fallback_base_scale<class_ThemeDB_property_fallback_base_scale>).
Use has_default_base_scale<class_Theme_method_has_default_base_scale> to check if this value is valid.
classref-item-separator
classref-property
Font<class_Font> default_font
classref-property-setget
- void set_default_font (
Font<class_Font>value ) Font<class_Font>get_default_font ( )
The default font of this theme resource. Used as the default value when trying to fetch a font resource that doesn't exist in this theme or is in invalid state. If the default font is also missing or invalid, the engine fallback value is used (see ThemeDB.fallback_font<class_ThemeDB_property_fallback_font>).
Use has_default_font<class_Theme_method_has_default_font> to check if this value is valid.
classref-item-separator
classref-property
int<class_int> default_font_size = -1
classref-property-setget
- void set_default_font_size (
int<class_int>value ) int<class_int>get_default_font_size ( )
The default font size of this theme resource. Used as the default value when trying to fetch a font size value that doesn't exist in this theme or is in invalid state. If the default font size is also missing or invalid, the engine fallback value is used (see ThemeDB.fallback_font_size<class_ThemeDB_property_fallback_font_size>).
Values below 0 are invalid and can be used to unset the property. Use has_default_font_size<class_Theme_method_has_default_font_size> to check if this value is valid.
classref-section-separator
classref-descriptions-group
classref-method
void add_type ( StringName<class_StringName> theme_type )
Adds an empty theme type for every valid data type.
Note: Empty types are not saved with the theme. This method only exists to perform in-memory changes to the resource. Use available set_* methods to add theme items.
classref-item-separator
classref-method
void clear ( )
Removes all the theme properties defined on the theme resource.
classref-item-separator
classref-method
void clear_color ( StringName<class_StringName> name, StringName<class_StringName> theme_type )
Removes the Color<class_Color> property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_color<class_Theme_method_has_color> to check for existence.
classref-item-separator
classref-method
void clear_constant ( StringName<class_StringName> name, StringName<class_StringName> theme_type )
Removes the constant property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_constant<class_Theme_method_has_constant> to check for existence.
classref-item-separator
classref-method
void clear_font ( StringName<class_StringName> name, StringName<class_StringName> theme_type )
Removes the Font<class_Font> property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_font<class_Theme_method_has_font> to check for existence.
classref-item-separator
classref-method
void clear_font_size ( StringName<class_StringName> name, StringName<class_StringName> theme_type )
Removes the font size property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_font_size<class_Theme_method_has_font_size> to check for existence.
classref-item-separator
classref-method
void clear_icon ( StringName<class_StringName> name, StringName<class_StringName> theme_type )
Removes the icon property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_icon<class_Theme_method_has_icon> to check for existence.
classref-item-separator
classref-method
void clear_stylebox ( StringName<class_StringName> name, StringName<class_StringName> theme_type )
Removes the StyleBox<class_StyleBox> property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_stylebox<class_Theme_method_has_stylebox> to check for existence.
classref-item-separator
classref-method
void clear_theme_item ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> name, StringName<class_StringName> theme_type )
Removes the theme property of data_type defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_theme_item<class_Theme_method_has_theme_item> to check for existence.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
classref-item-separator
classref-method
void clear_type_variation ( StringName<class_StringName> theme_type )
Unmarks theme_type as being a variation of another theme type. See set_type_variation<class_Theme_method_set_type_variation>.
classref-item-separator
classref-method
Color<class_Color> get_color ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the Color<class_Color> property defined by name and theme_type, if it exists.
Returns the default color value if the property doesn't exist. Use has_color<class_Theme_method_has_color> to check for existence.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_color_list ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of names for Color<class_Color> properties defined with theme_type. Use get_color_type_list<class_Theme_method_get_color_type_list> to get a list of possible theme type names.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_color_type_list ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all unique theme type names for Color<class_Color> properties. Use get_type_list<class_Theme_method_get_type_list> to get a list of all unique theme types.
classref-item-separator
classref-method
int<class_int> get_constant ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the constant property defined by name and theme_type, if it exists.
Returns 0 if the property doesn't exist. Use has_constant<class_Theme_method_has_constant> to check for existence.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_constant_list ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of names for constant properties defined with theme_type. Use get_constant_type_list<class_Theme_method_get_constant_type_list> to get a list of possible theme type names.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_constant_type_list ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all unique theme type names for constant properties. Use get_type_list<class_Theme_method_get_type_list> to get a list of all unique theme types.
classref-item-separator
classref-method
Font<class_Font> get_font ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the Font<class_Font> property defined by name and theme_type, if it exists.
Returns the default theme font if the property doesn't exist and the default theme font is set up (see default_font<class_Theme_property_default_font>). Use has_font<class_Theme_method_has_font> to check for existence of the property and has_default_font<class_Theme_method_has_default_font> to check for existence of the default theme font.
Returns the engine fallback font value, if neither exist (see ThemeDB.fallback_font<class_ThemeDB_property_fallback_font>).
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_font_list ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of names for Font<class_Font> properties defined with theme_type. Use get_font_type_list<class_Theme_method_get_font_type_list> to get a list of possible theme type names.
classref-item-separator
classref-method
int<class_int> get_font_size ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the font size property defined by name and theme_type, if it exists.
Returns the default theme font size if the property doesn't exist and the default theme font size is set up (see default_font_size<class_Theme_property_default_font_size>). Use has_font_size<class_Theme_method_has_font_size> to check for existence of the property and has_default_font_size<class_Theme_method_has_default_font_size> to check for existence of the default theme font.
Returns the engine fallback font size value, if neither exist (see ThemeDB.fallback_font_size<class_ThemeDB_property_fallback_font_size>).
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_font_size_list ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of names for font size properties defined with theme_type. Use get_font_size_type_list<class_Theme_method_get_font_size_type_list> to get a list of possible theme type names.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_font_size_type_list ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all unique theme type names for font size properties. Use get_type_list<class_Theme_method_get_type_list> to get a list of all unique theme types.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_font_type_list ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all unique theme type names for Font<class_Font> properties. Use get_type_list<class_Theme_method_get_type_list> to get a list of all unique theme types.
classref-item-separator
classref-method
Texture2D<class_Texture2D> get_icon ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the icon property defined by name and theme_type, if it exists.
Returns the engine fallback icon value if the property doesn't exist (see ThemeDB.fallback_icon<class_ThemeDB_property_fallback_icon>). Use has_icon<class_Theme_method_has_icon> to check for existence.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_icon_list ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of names for icon properties defined with theme_type. Use get_icon_type_list<class_Theme_method_get_icon_type_list> to get a list of possible theme type names.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_icon_type_list ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all unique theme type names for icon properties. Use get_type_list<class_Theme_method_get_type_list> to get a list of all unique theme types.
classref-item-separator
classref-method
StyleBox<class_StyleBox> get_stylebox ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the StyleBox<class_StyleBox> property defined by name and theme_type, if it exists.
Returns the engine fallback stylebox value if the property doesn't exist (see ThemeDB.fallback_stylebox<class_ThemeDB_property_fallback_stylebox>). Use has_stylebox<class_Theme_method_has_stylebox> to check for existence.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_stylebox_list ( String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of names for StyleBox<class_StyleBox> properties defined with theme_type. Use get_stylebox_type_list<class_Theme_method_get_stylebox_type_list> to get a list of possible theme type names.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_stylebox_type_list ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all unique theme type names for StyleBox<class_StyleBox> properties. Use get_type_list<class_Theme_method_get_type_list> to get a list of all unique theme types.
classref-item-separator
classref-method
Variant<class_Variant> get_theme_item ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the theme property of data_type defined by name and theme_type, if it exists.
Returns the engine fallback value if the property doesn't exist (see ThemeDB<class_ThemeDB>). Use has_theme_item<class_Theme_method_has_theme_item> to check for existence.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_theme_item_list ( DataType<enum_Theme_DataType> data_type, String<class_String> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of names for properties of data_type defined with theme_type. Use get_theme_item_type_list<class_Theme_method_get_theme_item_type_list> to get a list of possible theme type names.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_theme_item_type_list ( DataType<enum_Theme_DataType> data_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all unique theme type names for data_type properties. Use get_type_list<class_Theme_method_get_type_list> to get a list of all unique theme types.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_type_list ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all unique theme type names. Use the appropriate get_*_type_list method to get a list of unique theme types for a single data type.
classref-item-separator
classref-method
StringName<class_StringName> get_type_variation_base ( StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the name of the base theme type if theme_type is a valid variation type. Returns an empty string otherwise.
classref-item-separator
classref-method
PackedStringArray<class_PackedStringArray> get_type_variation_list ( StringName<class_StringName> base_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns a list of all type variations for the given base_type.
classref-item-separator
classref-method
bool<class_bool> has_color ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if the Color<class_Color> property defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_color<class_Theme_method_set_color> to define it.
classref-item-separator
classref-method
bool<class_bool> has_constant ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if the constant property defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_constant<class_Theme_method_set_constant> to define it.
classref-item-separator
classref-method
bool<class_bool> has_default_base_scale ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if default_base_scale<class_Theme_property_default_base_scale> has a valid value.
Returns false if it doesn't. The value must be greater than 0.0 to be considered valid.
classref-item-separator
classref-method
bool<class_bool> has_default_font ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if default_font<class_Theme_property_default_font> has a valid value.
Returns false if it doesn't.
classref-item-separator
classref-method
bool<class_bool> has_default_font_size ( ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if default_font_size<class_Theme_property_default_font_size> has a valid value.
Returns false if it doesn't. The value must be greater than 0 to be considered valid.
classref-item-separator
classref-method
bool<class_bool> has_font ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if the Font<class_Font> property defined by name and theme_type exists, or if the default theme font is set up (see has_default_font<class_Theme_method_has_default_font>).
Returns false if neither exist. Use set_font<class_Theme_method_set_font> to define the property.
classref-item-separator
classref-method
bool<class_bool> has_font_size ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if the font size property defined by name and theme_type exists, or if the default theme font size is set up (see has_default_font_size<class_Theme_method_has_default_font_size>).
Returns false if neither exist. Use set_font_size<class_Theme_method_set_font_size> to define the property.
classref-item-separator
classref-method
bool<class_bool> has_icon ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if the icon property defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_icon<class_Theme_method_set_icon> to define it.
classref-item-separator
classref-method
bool<class_bool> has_stylebox ( StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if the StyleBox<class_StyleBox> property defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_stylebox<class_Theme_method_set_stylebox> to define it.
classref-item-separator
classref-method
bool<class_bool> has_theme_item ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> name, StringName<class_StringName> theme_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if the theme property of data_type defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_theme_item<class_Theme_method_set_theme_item> to define it.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
classref-item-separator
classref-method
bool<class_bool> is_type_variation ( StringName<class_StringName> theme_type, StringName<class_StringName> base_type ) const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns true if theme_type is marked as a variation of base_type.
classref-item-separator
classref-method
void merge_with ( Theme<class_Theme> other )
Adds missing and overrides existing definitions with values from the other theme resource.
Note: This modifies the current theme. If you want to merge two themes together without modifying either one, create a new empty theme and merge the other two into it one after another.
classref-item-separator
classref-method
void remove_type ( StringName<class_StringName> theme_type )
Removes the theme type, gracefully discarding defined theme items. If the type is a variation, this information is also erased. If the type is a base for type variations, those variations lose their base.
classref-item-separator
classref-method
void rename_color ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type )
Renames the Color<class_Color> property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_color<class_Theme_method_has_color> to check for existence, and clear_color<class_Theme_method_clear_color> to remove the existing property.
classref-item-separator
classref-method
void rename_constant ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type )
Renames the constant property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_constant<class_Theme_method_has_constant> to check for existence, and clear_constant<class_Theme_method_clear_constant> to remove the existing property.
classref-item-separator
classref-method
void rename_font ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type )
Renames the Font<class_Font> property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_font<class_Theme_method_has_font> to check for existence, and clear_font<class_Theme_method_clear_font> to remove the existing property.
classref-item-separator
classref-method
void rename_font_size ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type )
Renames the font size property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_font_size<class_Theme_method_has_font_size> to check for existence, and clear_font_size<class_Theme_method_clear_font_size> to remove the existing property.
classref-item-separator
classref-method
void rename_icon ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type )
Renames the icon property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_icon<class_Theme_method_has_icon> to check for existence, and clear_icon<class_Theme_method_clear_icon> to remove the existing property.
classref-item-separator
classref-method
void rename_stylebox ( StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type )
Renames the StyleBox<class_StyleBox> property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_stylebox<class_Theme_method_has_stylebox> to check for existence, and clear_stylebox<class_Theme_method_clear_stylebox> to remove the existing property.
classref-item-separator
classref-method
void rename_theme_item ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> old_name, StringName<class_StringName> name, StringName<class_StringName> theme_type )
Renames the theme property of data_type defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_theme_item<class_Theme_method_has_theme_item> to check for existence, and clear_theme_item<class_Theme_method_clear_theme_item> to remove the existing property.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
classref-item-separator
classref-method
void set_color ( StringName<class_StringName> name, StringName<class_StringName> theme_type, Color<class_Color> color )
Creates or changes the value of the Color<class_Color> property defined by name and theme_type. Use clear_color<class_Theme_method_clear_color> to remove the property.
classref-item-separator
classref-method
void set_constant ( StringName<class_StringName> name, StringName<class_StringName> theme_type, int<class_int> constant )
Creates or changes the value of the constant property defined by name and theme_type. Use clear_constant<class_Theme_method_clear_constant> to remove the property.
classref-item-separator
classref-method
void set_font ( StringName<class_StringName> name, StringName<class_StringName> theme_type, Font<class_Font> font )
Creates or changes the value of the Font<class_Font> property defined by name and theme_type. Use clear_font<class_Theme_method_clear_font> to remove the property.
classref-item-separator
classref-method
void set_font_size ( StringName<class_StringName> name, StringName<class_StringName> theme_type, int<class_int> font_size )
Creates or changes the value of the font size property defined by name and theme_type. Use clear_font_size<class_Theme_method_clear_font_size> to remove the property.
classref-item-separator
classref-method
void set_icon ( StringName<class_StringName> name, StringName<class_StringName> theme_type, Texture2D<class_Texture2D> texture )
Creates or changes the value of the icon property defined by name and theme_type. Use clear_icon<class_Theme_method_clear_icon> to remove the property.
classref-item-separator
classref-method
void set_stylebox ( StringName<class_StringName> name, StringName<class_StringName> theme_type, StyleBox<class_StyleBox> texture )
Creates or changes the value of the StyleBox<class_StyleBox> property defined by name and theme_type. Use clear_stylebox<class_Theme_method_clear_stylebox> to remove the property.
classref-item-separator
classref-method
void set_theme_item ( DataType<enum_Theme_DataType> data_type, StringName<class_StringName> name, StringName<class_StringName> theme_type, Variant<class_Variant> value )
Creates or changes the value of the theme property of data_type defined by name and theme_type. Use clear_theme_item<class_Theme_method_clear_theme_item> to remove the property.
Fails if the value type is not accepted by data_type.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
classref-item-separator
classref-method
void set_type_variation ( StringName<class_StringName> theme_type, StringName<class_StringName> base_type )
Marks theme_type as a variation of base_type.
This adds theme_type as a suggested option for Control.theme_type_variation<class_Control_property_theme_type_variation> on a Control<class_Control> that is of the base_type class.
Variations can also be nested, i.e. base_type can be another variation. If a chain of variations ends with a base_type matching the class of the Control<class_Control>, the whole chain is going to be suggested as options.
Note: Suggestions only show up if this theme resource is set as the project default theme. See ProjectSettings.gui/theme/custom<class_ProjectSettings_property_gui/theme/custom>.