godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/Theme.xml

635 lines
24 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="Theme" inherits="Resource" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Theme for controls.
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
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 [code].theme[/code] file, see the documentation for more information.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
Add link titles for all links in the class reference This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-05 12:43:40 +00:00
<link title="GUI skinning">https://docs.godotengine.org/en/latest/tutorials/gui/gui_skinning.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
doc: Sync classref with current source
2018-12-04 20:57:07 +00:00
<method name="clear">
<return type="void">
</return>
<description>
Add descriptions to clear and copy_theme.
2019-10-31 06:04:58 +00:00
Clears all values on the theme.
doc: Sync classref with current source
2018-12-04 20:57:07 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="clear_color">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Clears the [Color] at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear_constant">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Clears the constant at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear_font">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Clears the [Font] at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="clear_font_size">
<return type="void">
</return>
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="node_type" type="StringName">
</argument>
<description>
Clears the font size [code]name[/code] if the theme has [code]node_type[/code].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="clear_icon">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Clears the icon at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear_stylebox">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Clears [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<method name="clear_theme_item">
<return type="void">
</return>
<argument index="0" name="data_type" type="int" enum="Theme.DataType">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Clears the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]node_type[/code].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="copy_default_theme">
<return type="void">
</return>
<description>
doc: Markup fixes for enums and constants
2019-12-06 22:09:20 +00:00
Sets the theme's values to a copy of the default theme values.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source
2019-01-26 21:21:53 +00:00
<method name="copy_theme">
<return type="void">
</return>
<argument index="0" name="other" type="Theme">
</argument>
<description>
doc: Markup fixes for enums and constants
2019-12-06 22:09:20 +00:00
Sets the theme's values to a copy of a given theme.
doc: Sync classref with current source
2019-01-26 21:21:53 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_color" qualifiers="const">
<return type="Color">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns the [Color] at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_color_list" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
<return type="PackedStringArray">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="0" name="node_type" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns all the [Color]s as a [PackedStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_color_type_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<description>
Returns all the [Color] types as a [PackedStringArray] filled with unique type names, for use in [method get_color] and/or [method get_color_list].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_constant" qualifiers="const">
<return type="int">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns the constant at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_constant_list" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
<return type="PackedStringArray">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="0" name="node_type" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns all the constants as a [PackedStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_constant_type_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<description>
Returns all the constant types as a [PackedStringArray] filled with unique type names, for use in [method get_constant] and/or [method get_constant_list].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_font" qualifiers="const">
<return type="Font">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns the [Font] at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_font_list" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
<return type="PackedStringArray">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="0" name="node_type" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns all the [Font]s as a [PackedStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="get_font_size" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="node_type" type="StringName">
</argument>
<description>
Returns the font size at [code]name[/code] if the theme has [code]node_type[/code].
</description>
</method>
<method name="get_font_size_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<argument index="0" name="node_type" type="String">
</argument>
<description>
Returns all the font sizes as a [PackedStringArray] filled with each font size name, for use in [method get_font_size], if the theme has [code]node_type[/code].
</description>
</method>
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<method name="get_font_size_type_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<description>
Returns all the font size types as a [PackedStringArray] filled with unique type names, for use in [method get_font_size] and/or [method get_font_size_list].
</description>
</method>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_font_type_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<description>
Returns all the [Font] types as a [PackedStringArray] filled with unique type names, for use in [method get_font] and/or [method get_font_list].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_icon" qualifiers="const">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<return type="Texture2D">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns the icon [Texture2D] at [code]name[/code] if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_icon_list" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
<return type="PackedStringArray">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="0" name="node_type" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns all the icons as a [PackedStringArray] filled with each [Texture2D]'s name, for use in [method get_icon], if the theme has [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_icon_type_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<description>
Returns all the icon types as a [PackedStringArray] filled with unique type names, for use in [method get_icon] and/or [method get_icon_list].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_stylebox" qualifiers="const">
<return type="StyleBox">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
[docs] Clarification on theme's get_stylebox Remove reference to "icon" (must have been a copy-paste error) & clarify where to find out what names & node_types are valid.
2021-02-20 15:10:28 +00:00
Returns the [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code].
Valid [code]name[/code]s may be found using [method get_stylebox_list]. Valid [code]node_type[/code]s may be found using [method get_stylebox_type_list].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_stylebox_list" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
<return type="PackedStringArray">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="0" name="node_type" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns all the [StyleBox]s as a [PackedStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]node_type[/code].
[docs] Clarification on theme's get_stylebox Remove reference to "icon" (must have been a copy-paste error) & clarify where to find out what names & node_types are valid.
2021-02-20 15:10:28 +00:00
Valid [code]node_type[/code]s may be found using [method get_stylebox_type_list].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_stylebox_type_list" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
<return type="PackedStringArray">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
<description>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
Returns all the [StyleBox] types as a [PackedStringArray] filled with unique type names, for use in [method get_stylebox] and/or [method get_stylebox_list].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<method name="get_theme_item" qualifiers="const">
doc: Sync classref with current source
2021-03-29 07:51:33 +00:00
<return type="Variant">
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</return>
<argument index="0" name="data_type" type="int" enum="Theme.DataType">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Returns the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]node_type[/code].
Valid [code]name[/code]s may be found using [method get_theme_item_list] or a data type specific method. Valid [code]node_type[/code]s may be found using [method get_theme_item_type_list] or a data type specific method.
</description>
</method>
<method name="get_theme_item_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<argument index="0" name="data_type" type="int" enum="Theme.DataType">
</argument>
<argument index="1" name="node_type" type="String">
</argument>
<description>
Returns all the theme items of [code]data_type[/code] as a [PackedStringArray] filled with each theme items's name, for use in [method get_theme_item] or a data type specific method, if the theme has [code]node_type[/code].
Valid [code]node_type[/code]s may be found using [method get_theme_item_type_list] or a data type specific method.
</description>
</method>
<method name="get_theme_item_type_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<argument index="0" name="data_type" type="int" enum="Theme.DataType">
</argument>
<description>
Returns all the theme items of [code]data_type[/code] types as a [PackedStringArray] filled with unique type names, for use in [method get_theme_item], [method get_theme_item_list] or data type specific methods.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_type_list" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
<return type="PackedStringArray">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
<description>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
Returns all the theme types as a [PackedStringArray] filled with unique type names, for use in other [code]get_*[/code] functions of this theme.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_color" qualifiers="const">
<return type="bool">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_constant" qualifiers="const">
<return type="bool">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns [code]true[/code] if constant with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_font" qualifiers="const">
<return type="bool">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="has_font_size" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="node_type" type="StringName">
</argument>
<description>
Returns [code]true[/code] if font size with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="has_icon" qualifiers="const">
<return type="bool">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns [code]true[/code] if icon [Texture2D] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_stylebox" qualifiers="const">
<return type="bool">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<method name="has_theme_item" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="data_type" type="int" enum="Theme.DataType">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Returns [code]true[/code] if a theme item of [code]data_type[/code] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
</description>
</method>
<method name="rename_color">
<return type="void">
</return>
<argument index="0" name="old_name" type="StringName">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Renames the [Color] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_constant">
<return type="void">
</return>
<argument index="0" name="old_name" type="StringName">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Renames the constant at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_font">
<return type="void">
</return>
<argument index="0" name="old_name" type="StringName">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Renames the [Font] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_font_size">
<return type="void">
</return>
<argument index="0" name="old_name" type="StringName">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Renames the font size [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_icon">
<return type="void">
</return>
<argument index="0" name="old_name" type="StringName">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Renames the icon at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_stylebox">
<return type="void">
</return>
<argument index="0" name="old_name" type="StringName">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<description>
Renames [StyleBox] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_theme_item">
<return type="void">
</return>
<argument index="0" name="data_type" type="int" enum="Theme.DataType">
</argument>
<argument index="1" name="old_name" type="StringName">
</argument>
<argument index="2" name="name" type="StringName">
</argument>
<argument index="3" name="node_type" type="StringName">
</argument>
<description>
Renames the theme item of [code]data_type[/code] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_color">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="2" name="color" type="Color">
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
Creates [code]node_type[/code] if the theme does not have it.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_constant">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="2" name="constant" type="int">
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
Creates [code]node_type[/code] if the theme does not have it.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_font">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="2" name="font" type="Font">
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
Creates [code]node_type[/code] if the theme does not have it.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="set_font_size">
<return type="void">
</return>
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="node_type" type="StringName">
</argument>
<argument index="2" name="font_size" type="int">
</argument>
<description>
Sets the theme's font size to [code]font_size[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
Creates [code]node_type[/code] if the theme does not have it.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_icon">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<argument index="2" name="texture" type="Texture2D">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Sets the theme's icon [Texture2D] to [code]texture[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
Creates [code]node_type[/code] if the theme does not have it.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_stylebox">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="0" name="name" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
<argument index="1" name="node_type" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="2" name="texture" type="StyleBox">
</argument>
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 16:20:11 +00:00
Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
Creates [code]node_type[/code] if the theme does not have it.
</description>
</method>
<method name="set_theme_item">
<return type="void">
</return>
<argument index="0" name="data_type" type="int" enum="Theme.DataType">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="node_type" type="StringName">
</argument>
<argument index="3" name="value" type="Variant">
</argument>
<description>
Sets the theme item of [code]data_type[/code] to [code]value[/code] at [code]name[/code] in [code]node_type[/code].
Does nothing if the [code]value[/code] type does not match [code]data_type[/code].
Creates [code]node_type[/code] if the theme does not have it.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="default_font" type="Font" setter="set_default_font" getter="get_default_font">
Added documentation for World, Theme, StreamTexture, Sky, and ShortCut
2017-11-26 19:58:38 +00:00
The theme's default font.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<member name="default_font_size" type="int" setter="set_default_font_size" getter="get_default_font_size" default="-1">
The theme's default font size. Set to [code]-1[/code] to ignore and use global default.
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</members>
<constants>
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<constant name="DATA_TYPE_COLOR" value="0" enum="DataType">
Theme's [Color] item type.
</constant>
<constant name="DATA_TYPE_CONSTANT" value="1" enum="DataType">
Theme's constant item type.
</constant>
<constant name="DATA_TYPE_FONT" value="2" enum="DataType">
Theme's [Font] item type.
</constant>
<constant name="DATA_TYPE_FONT_SIZE" value="3" enum="DataType">
Theme's font size item type.
</constant>
<constant name="DATA_TYPE_ICON" value="4" enum="DataType">
Theme's icon [Texture2D] item type.
</constant>
<constant name="DATA_TYPE_STYLEBOX" value="5" enum="DataType">
Theme's [StyleBox] item type.
</constant>
<constant name="DATA_TYPE_MAX" value="6" enum="DataType">
Maximum value for the DataType enum.
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>