Theme

Refreshing Cache...

Inherits: Resource < Reference < Object

Theme for controls.

Description

A theme for skinning controls. Controls can be skinned individually, but for complex applications, it’s more practical to just create a global theme that defines everything. This theme can be applied to any Control; the Control and its children will automatically use it.

Theme resources can alternatively be loaded by writing them in a .theme file, see the documentation for more information.

Tutorials

Methods

voidclear ( )
voidclear_color ( String name, String type )
voidclear_constant ( String name, String type )
voidclear_font ( String name, String type )
voidclear_icon ( String name, String type )
voidclear_stylebox ( String name, String type )
voidcopy_default_theme ( )
voidcopy_theme ( Theme other )
Colorget_color ( String name, String type ) const
PoolStringArrayget_color_list ( String type ) const
intget_constant ( String name, String type ) const
PoolStringArrayget_constant_list ( String type ) const
Fontget_font ( String name, String type ) const
PoolStringArrayget_font_list ( String type ) const
Textureget_icon ( String name, String type ) const
PoolStringArrayget_icon_list ( String type ) const
StyleBoxget_stylebox ( String name, String type ) const
PoolStringArrayget_stylebox_list ( String type ) const
PoolStringArrayget_stylebox_types ( ) const
PoolStringArrayget_type_list ( String type ) const
boolhas_color ( String name, String type ) const
boolhas_constant ( String name, String type ) const
boolhas_font ( String name, String type ) const
boolhas_icon ( String name, String type ) const
boolhas_stylebox ( String name, String type ) const
voidset_color ( String name, String type, Color color )
voidset_constant ( String name, String type, int constant )
voidset_font ( String name, String type, Font font )
voidset_icon ( String name, String type, Texture texture )
voidset_stylebox ( String name, String type, StyleBox texture )

Property Descriptions

Setterset_default_font(value)
Getterget_default_font()

The theme’s default font.

Method Descriptions

  • void clear ( )

Clears all values on the theme.


Clears the Color at name if the theme has type.


Clears the constant at name if the theme has type.


Clears the Font at name if the theme has type.


Clears the icon at name if the theme has type.


Clears StyleBox at name if the theme has type.


  • void copy_default_theme ( )

Sets the theme’s values to a copy of the default theme values.


  • void copy_theme ( Theme other )

Sets the theme’s values to a copy of a given theme.


Returns the Color at name if the theme has type.


Returns all the Colors as a PoolStringArray filled with each Color’s name, for use in get_color, if the theme has type.


Returns the constant at name if the theme has type.


Returns all the constants as a PoolStringArray filled with each constant’s name, for use in get_constant, if the theme has type.


Returns the Font at name if the theme has type.


Returns all the Fonts as a PoolStringArray filled with each Font’s name, for use in get_font, if the theme has type.


Returns the icon Texture at name if the theme has type.


Returns all the icons as a PoolStringArray filled with each Texture’s name, for use in get_icon, if the theme has type.


Returns the icon StyleBox at name if the theme has type.


Returns all the StyleBoxs as a PoolStringArray filled with each StyleBox’s name, for use in get_stylebox, if the theme has type.


Returns all the StyleBox types as a PoolStringArray filled with each StyleBox’s type, for use in get_stylebox and/or get_stylebox_list, if the theme has type.


Returns all the types in type as a PoolStringArray for use in any of the get_* functions, if the theme has type.


Returns true if Color with name is in type.

Returns false if the theme does not have type.


Returns true if constant with name is in type.

Returns false if the theme does not have type.


Returns true if Font with name is in type.

Returns false if the theme does not have type.


Returns true if icon Texture with name is in type.

Returns false if the theme does not have type.


Returns true if StyleBox with name is in type.

Returns false if the theme does not have type.


Sets the theme’s Color to color at name in type.

Does nothing if the theme does not have type.


Sets the theme’s constant to constant at name in type.

Does nothing if the theme does not have type.


Sets the theme’s Font to font at name in type.

Does nothing if the theme does not have type.


Sets the theme’s icon Texture to texture at name in type.

Does nothing if the theme does not have type.


Sets theme’s StyleBox to stylebox at name in type.

Does nothing if the theme does not have type.

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:40:35. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.