godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2018-12-04 22:02:35 +01:00
parent 17f94a8b4f
commit e4f01ce829
21 changed files with 315 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
classes/class_@globalscope.rst
View File

@@ -28,8 +28,6 @@ Properties
+-----------------------------------------------------+------------------------------------------------------------------+
| :ref:`Geometry<class_Geometry>` | :ref:`Geometry<class_@GlobalScope_Geometry>` |
+-----------------------------------------------------+------------------------------------------------------------------+
| :ref:`GodotSharp<class_GodotSharp>` | :ref:`GodotSharp<class_@GlobalScope_GodotSharp>` |
+-----------------------------------------------------+------------------------------------------------------------------+
| :ref:`IP<class_IP>` | :ref:`IP<class_@GlobalScope_IP>` |
+-----------------------------------------------------+------------------------------------------------------------------+
| :ref:`Input<class_Input>` | :ref:`Input<class_@GlobalScope_Input>` |
@@ -1147,10 +1145,6 @@ Property Descriptions
:ref:`Geometry<class_Geometry>` singleton
.. _class_@GlobalScope_GodotSharp:
- :ref:`GodotSharp<class_GodotSharp>` **GodotSharp**
.. _class_@GlobalScope_IP:
- :ref:`IP<class_IP>` **IP**

2
classes/class_animation.rst
View File

@@ -193,7 +193,7 @@ An Animation resource contains data used to animate everything in the engine. An
::
# This creates an animation that makes the node "Enemy" move to the right by
# 100 pixels in 1 second.
# 100 pixels in 1 second.
var animation = Animation.new()
var track_index = animation.add_track(Animation.TYPE_VALUE)
animation.track_set_path(track_index, "Enemy:position.x")

147
classes/class_animationnode.rst
View File

@@ -16,7 +16,7 @@ AnimationNode
Brief Description
-----------------
Base resource for :ref:`AnimationTree<class_AnimationTree>` nodes.
Properties
----------
@@ -28,35 +28,43 @@ Properties
Methods
-------
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_input<class_AnimationNode_add_input>` **(** :ref:`String<class_String>` name **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend_animation<class_AnimationNode_blend_animation>` **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend_input<class_AnimationNode_blend_input>` **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend_node<class_AnimationNode_blend_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_caption<class_AnimationNode_get_caption>` **(** **)** virtual |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_input_count<class_AnimationNode_get_input_count>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_input_name<class_AnimationNode_get_input_name>` **(** :ref:`int<class_int>` input **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_parameter<class_AnimationNode_get_parameter>` **(** :ref:`String<class_String>` name **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`has_filter<class_AnimationNode_has_filter>` **(** **)** virtual |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_path_filtered<class_AnimationNode_is_path_filtered>` **(** :ref:`NodePath<class_NodePath>` path **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`process<class_AnimationNode_process>` **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_input<class_AnimationNode_remove_input>` **(** :ref:`int<class_int>` index **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_filter_path<class_AnimationNode_set_filter_path>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_parameter<class_AnimationNode_set_parameter>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_input<class_AnimationNode_add_input>` **(** :ref:`String<class_String>` name **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend_animation<class_AnimationNode_blend_animation>` **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend_input<class_AnimationNode_blend_input>` **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend_node<class_AnimationNode_blend_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_caption<class_AnimationNode_get_caption>` **(** **)** virtual |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`get_child_by_name<class_AnimationNode_get_child_by_name>` **(** :ref:`String<class_String>` name **)** virtual |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_child_nodes<class_AnimationNode_get_child_nodes>` **(** **)** virtual |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_input_count<class_AnimationNode_get_input_count>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_input_name<class_AnimationNode_get_input_name>` **(** :ref:`int<class_int>` input **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_parameter<class_AnimationNode_get_parameter>` **(** :ref:`String<class_String>` name **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_parameter_default_value<class_AnimationNode_get_parameter_default_value>` **(** :ref:`String<class_String>` name **)** virtual |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_parameter_list<class_AnimationNode_get_parameter_list>` **(** **)** virtual |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`has_filter<class_AnimationNode_has_filter>` **(** **)** virtual |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_path_filtered<class_AnimationNode_is_path_filtered>` **(** :ref:`NodePath<class_NodePath>` path **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`process<class_AnimationNode_process>` **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_input<class_AnimationNode_remove_input>` **(** :ref:`int<class_int>` index **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_filter_path<class_AnimationNode_set_filter_path>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_parameter<class_AnimationNode_set_parameter>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -65,6 +73,8 @@ Signals
- **removed_from_graph** **(** **)**
Called when the node was removed from the graph.
.. _class_AnimationNode_tree_changed:
- **tree_changed** **(** **)**
@@ -76,13 +86,20 @@ Enumerations
enum **FilterAction**:
- **FILTER_IGNORE** = **0**
- **FILTER_IGNORE** = **0** --- Do not use filtering.
- **FILTER_PASS** = **1**
- **FILTER_PASS** = **1** --- Paths matching the filter will be allowed to pass.
- **FILTER_STOP** = **2**
- **FILTER_STOP** = **2** --- Paths matching the filter will be discarded.
- **FILTER_BLEND** = **3**
- **FILTER_BLEND** = **3** --- Paths matching the filter will be blended (by the blend value).
Description
-----------
Base resource for :ref:`AnimationTree<class_AnimationTree>` nodes. In general it's not used directly but you can create custom ones with custom blending formulas.
Inherit this when creating nodes mainly for use in :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`, otherwise :ref:`AnimationRootNode<class_AnimationRootNode>` should be used instead.
Property Descriptions
---------------------
@@ -97,6 +114,8 @@ Property Descriptions
| *Getter* | is_filter_enabled() |
+----------+---------------------------+
Return whether filtering is enabled.
Method Descriptions
-------------------
@@ -104,55 +123,115 @@ Method Descriptions
- void **add_input** **(** :ref:`String<class_String>` name **)**
Add an input to the node. This is only useful for nodes created for use in an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`
.. _class_AnimationNode_blend_animation:
- void **blend_animation** **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)**
Blend an animation by "blend" amount (name must be valid in the linked :ref:`AnimationPlayer<class_AnimationPlayer>`). A time and delta mas be passed, as well as whether seek happened.
.. _class_AnimationNode_blend_input:
- :ref:`float<class_float>` **blend_input** **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)**
Blend an input. This is only useful for nodes created for an AnimationBlendTree. Time is a delta, unless "seek" is true, in which case it is absolute. A filter mode may be optionally passed.
.. _class_AnimationNode_blend_node:
- :ref:`float<class_float>` **blend_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)**
Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode<class_AnimationRootNode>` instead, else editors will not display your node for addition.
.. _class_AnimationNode_get_caption:
- :ref:`String<class_String>` **get_caption** **(** **)** virtual
Get the text caption for this node (used by some editors)
.. _class_AnimationNode_get_child_by_name:
- :ref:`Object<class_Object>` **get_child_by_name** **(** :ref:`String<class_String>` name **)** virtual
Get the a child node by index (used by editors inheriting from :ref:`AnimationRootNode<class_AnimationRootNode>`).
.. _class_AnimationNode_get_child_nodes:
- :ref:`Dictionary<class_Dictionary>` **get_child_nodes** **(** **)** virtual
Get all children nodes, in order as a name:node dictionary. Only useful when inheriting :ref:`AnimationRootNode<class_AnimationRootNode>`.
.. _class_AnimationNode_get_input_count:
- :ref:`int<class_int>` **get_input_count** **(** **)** const
Amount of inputs in this node, only useful for nodes that go into AnimationBlendTree.
.. _class_AnimationNode_get_input_name:
- :ref:`String<class_String>` **get_input_name** **(** :ref:`int<class_int>` input **)**
Get the name of an input by index.
.. _class_AnimationNode_get_parameter:
- :ref:`Variant<class_Variant>` **get_parameter** **(** :ref:`String<class_String>` name **)** const
Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
.. _class_AnimationNode_get_parameter_default_value:
- :ref:`Variant<class_Variant>` **get_parameter_default_value** **(** :ref:`String<class_String>` name **)** virtual
Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
.. _class_AnimationNode_get_parameter_list:
- :ref:`Array<class_Array>` **get_parameter_list** **(** **)** virtual
Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
Format is similar to Object.get_property_list
.. _class_AnimationNode_has_filter:
- :ref:`String<class_String>` **has_filter** **(** **)** virtual
Return true whether you want the blend tree editor to display filter editing on this node.
.. _class_AnimationNode_is_path_filtered:
- :ref:`bool<class_bool>` **is_path_filtered** **(** :ref:`NodePath<class_NodePath>` path **)** const
Return true wether a given path is filtered.
.. _class_AnimationNode_process:
- void **process** **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual
Called when a custom node is processed. The argument "time" is relative, unless "seek" is true (in which case it is absolute).
Here, call the :ref:`blend_input<class_AnimationNode_blend_input>`, :ref:`blend_node<class_AnimationNode_blend_node>` or :ref:`blend_animation<class_AnimationNode_blend_animation>` functions.
You can also use :ref:`get_parameter<class_AnimationNode_get_parameter>` and :ref:`set_parameter<class_AnimationNode_set_parameter>` to modify local memory.
This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called).
.. _class_AnimationNode_remove_input:
- void **remove_input** **(** :ref:`int<class_int>` index **)**
Remove an input, call this only when inactive.
.. _class_AnimationNode_set_filter_path:
- void **set_filter_path** **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
Add/Remove a path for the filter.
.. _class_AnimationNode_set_parameter:
- void **set_parameter** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)**
Set a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes.

51
classes/class_animationnodeblendspace2d.rst
View File

@@ -19,19 +19,21 @@ Brief Description
Properties
----------
+-------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_auto_triangles>` |
+-------------------------------+-----------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`max_space<class_AnimationNodeBlendSpace2D_max_space>` |
+-------------------------------+-----------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`min_space<class_AnimationNodeBlendSpace2D_min_space>` |
+-------------------------------+-----------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`snap<class_AnimationNodeBlendSpace2D_snap>` |
+-------------------------------+-----------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`x_label<class_AnimationNodeBlendSpace2D_x_label>` |
+-------------------------------+-----------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`y_label<class_AnimationNodeBlendSpace2D_y_label>` |
+-------------------------------+-----------------------------------------------------------------------+
+------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_auto_triangles>` |
+------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` | :ref:`blend_mode<class_AnimationNodeBlendSpace2D_blend_mode>` |
+------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`max_space<class_AnimationNodeBlendSpace2D_max_space>` |
+------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`min_space<class_AnimationNodeBlendSpace2D_min_space>` |
+------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`snap<class_AnimationNodeBlendSpace2D_snap>` |
+------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`x_label<class_AnimationNodeBlendSpace2D_x_label>` |
+------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`y_label<class_AnimationNodeBlendSpace2D_y_label>` |
+------------------------------------------------------------+-----------------------------------------------------------------------+
Methods
-------
@@ -60,6 +62,19 @@ Methods
| void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace2D_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)** |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
.. _enum_AnimationNodeBlendSpace2D_BlendMode:
enum **BlendMode**:
- **BLEND_MODE_INTERPOLATED** = **0**
- **BLEND_MODE_DISCRETE** = **1**
- **BLEND_MODE_DISCRETE_CARRY** = **2**
Property Descriptions
---------------------
@@ -73,6 +88,16 @@ Property Descriptions
| *Getter* | get_auto_triangles() |
+----------+---------------------------+
.. _class_AnimationNodeBlendSpace2D_blend_mode:
- :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` **blend_mode**
+----------+-----------------------+
| *Setter* | set_blend_mode(value) |
+----------+-----------------------+
| *Getter* | get_blend_mode() |
+----------+-----------------------+
.. _class_AnimationNodeBlendSpace2D_max_space:
- :ref:`Vector2<class_Vector2>` **max_space**

6
classes/class_animationplayer.rst
View File

@@ -67,6 +67,8 @@ Methods
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_playing_speed<class_AnimationPlayer_get_playing_speed>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_queue<class_AnimationPlayer_get_queue>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_String>` name **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
@@ -326,6 +328,10 @@ Get the blend time (in seconds) between two animations, referenced by their name
Get the actual playing speed of current animation or 0 if not playing. This speed is the ``playback_speed`` property multiplied by ``custom_speed`` argument specified when calling the ``play`` method.
.. _class_AnimationPlayer_get_queue:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_queue** **(** **)**
.. _class_AnimationPlayer_has_animation:
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_String>` name **)** const

4
classes/class_arvrinterface.rst
View File

@@ -168,9 +168,9 @@ If supported, returns the status of our tracking. This will allow you to provide
Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output.
After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence.
After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence.
Note that you must enable the AR/VR mode on the main viewport for any device that uses the main output of Godot such as for mobile VR.
Note that you must enable the AR/VR mode on the main viewport for any device that uses the main output of Godot such as for mobile VR.
If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively you can add a separate viewport node to your scene and enable AR/VR on that viewport and it will be used to output to the HMD leaving you free to do anything you like in the main window such as using a separate camera as a spectator camera or render out something completely different.

48
classes/class_basebutton.rst
View File

@@ -21,23 +21,25 @@ Base class for different kinds of buttons.
Properties
----------
+-----------------------------------------------+----------------------------------------------------------------+
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_action_mode>` |
+-----------------------------------------------+----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`button_mask<class_BaseButton_button_mask>` |
+-----------------------------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_disabled>` |
+-----------------------------------------------+----------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_enabled_focus_mode>` |
+-----------------------------------------------+----------------------------------------------------------------+
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_group>` |
+-----------------------------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_pressed>` |
+-----------------------------------------------+----------------------------------------------------------------+
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_shortcut>` |
+-----------------------------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_toggle_mode>` |
+-----------------------------------------------+----------------------------------------------------------------+
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_action_mode>` |
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`button_mask<class_BaseButton_button_mask>` |
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_disabled>` |
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_enabled_focus_mode>` |
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_group>` |
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_pressed>` |
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_shortcut>` |
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_shortcut_in_tooltip>` |
+-----------------------------------------------+------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_toggle_mode>` |
+-----------------------------------------------+------------------------------------------------------------------+
Methods
-------
@@ -198,6 +200,18 @@ If ``true`` the button's state is pressed. Means the button is pressed down or t
Shortcut associated to the button.
.. _class_BaseButton_shortcut_in_tooltip:
- :ref:`bool<class_bool>` **shortcut_in_tooltip**
+----------+----------------------------------+
| *Setter* | set_shortcut_in_tooltip(value) |
+----------+----------------------------------+
| *Getter* | is_shortcut_in_tooltip_enabled() |
+----------+----------------------------------+
If ``true`` the button will add information about its shortcut in the tooltip.
.. _class_BaseButton_toggle_mode:
- :ref:`bool<class_bool>` **toggle_mode**

18
classes/class_cpuparticles.rst
View File

@@ -122,11 +122,11 @@ Properties
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles_randomness>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`scale<class_CPUParticles_scale>` |
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles_scale_amount>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_curve<class_CPUParticles_scale_curve>` |
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles_scale_amount_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`scale_random<class_CPUParticles_scale_random>` |
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles_scale_amount_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles_speed_scale>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
@@ -726,9 +726,9 @@ Property Descriptions
| *Getter* | get_randomness_ratio() |
+----------+-----------------------------+
.. _class_CPUParticles_scale:
.. _class_CPUParticles_scale_amount:
- :ref:`float<class_float>` **scale**
- :ref:`float<class_float>` **scale_amount**
+----------+------------------+
| *Setter* | set_param(value) |
@@ -736,9 +736,9 @@ Property Descriptions
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_scale_curve:
.. _class_CPUParticles_scale_amount_curve:
- :ref:`Curve<class_Curve>` **scale_curve**
- :ref:`Curve<class_Curve>` **scale_amount_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
@@ -746,9 +746,9 @@ Property Descriptions
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_scale_random:
.. _class_CPUParticles_scale_amount_random:
- :ref:`float<class_float>` **scale_random**
- :ref:`float<class_float>` **scale_amount_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |

18
classes/class_cpuparticles2d.rst
View File

@@ -118,11 +118,11 @@ Properties
+---------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles2D_randomness>` |
+---------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`scale<class_CPUParticles2D_scale>` |
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles2D_scale_amount>` |
+---------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_curve<class_CPUParticles2D_scale_curve>` |
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles2D_scale_amount_curve>` |
+---------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`scale_random<class_CPUParticles2D_scale_random>` |
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles2D_scale_amount_random>` |
+---------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles2D_speed_scale>` |
+---------------------------------------------------------+------------------------------------------------------------------------------+
@@ -702,9 +702,9 @@ Property Descriptions
| *Getter* | get_randomness_ratio() |
+----------+-----------------------------+
.. _class_CPUParticles2D_scale:
.. _class_CPUParticles2D_scale_amount:
- :ref:`float<class_float>` **scale**
- :ref:`float<class_float>` **scale_amount**
+----------+------------------+
| *Setter* | set_param(value) |
@@ -712,9 +712,9 @@ Property Descriptions
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles2D_scale_curve:
.. _class_CPUParticles2D_scale_amount_curve:
- :ref:`Curve<class_Curve>` **scale_curve**
- :ref:`Curve<class_Curve>` **scale_amount_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
@@ -722,9 +722,9 @@ Property Descriptions
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles2D_scale_random:
.. _class_CPUParticles2D_scale_amount_random:
- :ref:`float<class_float>` **scale_random**
- :ref:`float<class_float>` **scale_amount_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |

24
classes/class_dynamicfontdata.rst
View File

@@ -19,11 +19,13 @@ Used with :ref:`DynamicFont<class_DynamicFont>` to describe the location of a fo
Properties
----------
+----------------------------------------------+---------------------------------------------------+
| :ref:`String<class_String>` | :ref:`font_path<class_DynamicFontData_font_path>` |
+----------------------------------------------+---------------------------------------------------+
| :ref:`Hinting<enum_DynamicFontData_Hinting>` | :ref:`hinting<class_DynamicFontData_hinting>` |
+----------------------------------------------+---------------------------------------------------+
+----------------------------------------------+-------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`antialiased<class_DynamicFontData_antialiased>` |
+----------------------------------------------+-------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`font_path<class_DynamicFontData_font_path>` |
+----------------------------------------------+-------------------------------------------------------+
| :ref:`Hinting<enum_DynamicFontData_Hinting>` | :ref:`hinting<class_DynamicFontData_hinting>` |
+----------------------------------------------+-------------------------------------------------------+
Enumerations
------------
@@ -46,6 +48,18 @@ Used with :ref:`DynamicFont<class_DynamicFont>` to describe the location of a ve
Property Descriptions
---------------------
.. _class_DynamicFontData_antialiased:
- :ref:`bool<class_bool>` **antialiased**
+----------+------------------------+
| *Setter* | set_antialiased(value) |
+----------+------------------------+
| *Getter* | is_antialiased() |
+----------+------------------------+
Controls whether the font should be rendered with anti-aliasing.
.. _class_DynamicFontData_font_path:
- :ref:`String<class_String>` **font_path**

4
classes/class_editorfilesystem.rst
View File

@@ -54,6 +54,10 @@ Emitted if the filesystem changed.
Remitted if a resource is reimported.
.. _class_EditorFileSystem_resources_reload:
- **resources_reload** **(** :ref:`PoolStringArray<class_PoolStringArray>` resources **)**
.. _class_EditorFileSystem_sources_changed:
- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**

12
classes/class_environment.rst
View File

@@ -114,6 +114,8 @@ Properties
+--------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`glow_enabled<class_Environment_glow_enabled>` |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`glow_hdr_luminance_cap<class_Environment_glow_hdr_luminance_cap>` |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`glow_hdr_scale<class_Environment_glow_hdr_scale>` |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`glow_hdr_threshold<class_Environment_glow_hdr_threshold>` |
@@ -841,6 +843,16 @@ Bloom value (global glow).
Enables glow rendering.
.. _class_Environment_glow_hdr_luminance_cap:
- :ref:`float<class_float>` **glow_hdr_luminance_cap**
+----------+-----------------------------------+
| *Setter* | set_glow_hdr_luminance_cap(value) |
+----------+-----------------------------------+
| *Getter* | get_glow_hdr_luminance_cap() |
+----------+-----------------------------------+
.. _class_Environment_glow_hdr_scale:
- :ref:`float<class_float>` **glow_hdr_scale**

12
classes/class_generic6dofjoint.rst
View File

@@ -188,6 +188,8 @@ Properties
+---------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`linear_spring_z/stiffness<class_Generic6DOFJoint_linear_spring_z/stiffness>` |
+---------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`precision<class_Generic6DOFJoint_precision>` |
+---------------------------+------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -1182,3 +1184,13 @@ The speed that the linear motor will attempt to reach on the z-axis.
| *Getter* | get_param_z() |
+----------+--------------------+
.. _class_Generic6DOFJoint_precision:
- :ref:`int<class_int>` **precision**
+----------+----------------------+
| *Setter* | set_precision(value) |
+----------+----------------------+
| *Getter* | get_precision() |
+----------+----------------------+

2
classes/class_orientedpathfollow.rst
View File

@@ -36,7 +36,7 @@ Properties
Description
-----------
This node behaves like :ref:`PathFollow<class_PathFollow>`, except it uses its parent :ref:`Path<class_Path>` up vector information to enforce orientation.
This node behaves like :ref:`PathFollow<class_PathFollow>`, except it uses its parent :ref:`Path<class_Path>` up vector information to enforce orientation.
Make sure to check if the curve of this node's parent :ref:`Path<class_Path>` has up vectors enabled. See :ref:`PathFollow<class_PathFollow>` and :ref:`Curve3D<class_Curve3D>` for further information.

24
classes/class_projectsettings.rst
View File

@@ -392,14 +392,6 @@ Properties
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc<class_ProjectSettings_memory/limits/multithreaded_server/rid_pool_prealloc>` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`mono/debugger_agent/port<class_ProjectSettings_mono/debugger_agent/port>` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`mono/debugger_agent/wait_for_debugger<class_ProjectSettings_mono/debugger_agent/wait_for_debugger>` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`mono/debugger_agent/wait_timeout<class_ProjectSettings_mono/debugger_agent/wait_timeout>` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`mono/export/include_scripts_content<class_ProjectSettings_mono/export/include_scripts_content>` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`network/limits/debugger_stdout/max_chars_per_second<class_ProjectSettings_network/limits/debugger_stdout/max_chars_per_second>` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`network/limits/debugger_stdout/max_errors_per_frame<class_ProjectSettings_network/limits/debugger_stdout/max_errors_per_frame>` |
@@ -1434,22 +1426,6 @@ Godot uses a message queue to defer some function calls. If you run out of space
This is used by servers when used in multi threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number.
.. _class_ProjectSettings_mono/debugger_agent/port:
- :ref:`int<class_int>` **mono/debugger_agent/port**
.. _class_ProjectSettings_mono/debugger_agent/wait_for_debugger:
- :ref:`bool<class_bool>` **mono/debugger_agent/wait_for_debugger**
.. _class_ProjectSettings_mono/debugger_agent/wait_timeout:
- :ref:`int<class_int>` **mono/debugger_agent/wait_timeout**
.. _class_ProjectSettings_mono/export/include_scripts_content:
- :ref:`bool<class_bool>` **mono/export/include_scripts_content**
.. _class_ProjectSettings_network/limits/debugger_stdout/max_chars_per_second:
- :ref:`int<class_int>` **network/limits/debugger_stdout/max_chars_per_second**

50
classes/class_skeletonik.rst
View File

@@ -19,25 +19,27 @@ Brief Description
Properties
----------
+-----------------------------------+--------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`interpolation<class_SkeletonIK_interpolation>` |
+-----------------------------------+--------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`magnet<class_SkeletonIK_magnet>` |
+-----------------------------------+--------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`max_iterations<class_SkeletonIK_max_iterations>` |
+-----------------------------------+--------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`min_distance<class_SkeletonIK_min_distance>` |
+-----------------------------------+--------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`root_bone<class_SkeletonIK_root_bone>` |
+-----------------------------------+--------------------------------------------------------+
| :ref:`Transform<class_Transform>` | :ref:`target<class_SkeletonIK_target>` |
+-----------------------------------+--------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`target_node<class_SkeletonIK_target_node>` |
+-----------------------------------+--------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`tip_bone<class_SkeletonIK_tip_bone>` |
+-----------------------------------+--------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_magnet<class_SkeletonIK_use_magnet>` |
+-----------------------------------+--------------------------------------------------------+
+-----------------------------------+----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`interpolation<class_SkeletonIK_interpolation>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`magnet<class_SkeletonIK_magnet>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`max_iterations<class_SkeletonIK_max_iterations>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`min_distance<class_SkeletonIK_min_distance>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`override_tip_basis<class_SkeletonIK_override_tip_basis>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`root_bone<class_SkeletonIK_root_bone>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`Transform<class_Transform>` | :ref:`target<class_SkeletonIK_target>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`target_node<class_SkeletonIK_target_node>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`tip_bone<class_SkeletonIK_tip_bone>` |
+-----------------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_magnet<class_SkeletonIK_use_magnet>` |
+-----------------------------------+----------------------------------------------------------------+
Methods
-------
@@ -95,6 +97,16 @@ Property Descriptions
| *Getter* | get_min_distance() |
+----------+-------------------------+
.. _class_SkeletonIK_override_tip_basis:
- :ref:`bool<class_bool>` **override_tip_basis**
+----------+-------------------------------+
| *Setter* | set_override_tip_basis(value) |
+----------+-------------------------------+
| *Getter* | is_override_tip_basis() |
+----------+-------------------------------+
.. _class_SkeletonIK_root_bone:
- :ref:`String<class_String>` **root_bone**

14
classes/class_splitcontainer.rst
View File

@@ -29,6 +29,13 @@ Properties
| :ref:`int<class_int>` | :ref:`split_offset<class_SplitContainer_split_offset>` |
+-----------------------------------------------------------------+--------------------------------------------------------------------+
Methods
-------
+-------+--------------------------------------------------------------------------------+
| void | :ref:`clamp_split_offset<class_SplitContainer_clamp_split_offset>` **(** **)** |
+-------+--------------------------------------------------------------------------------+
Signals
-------
@@ -91,3 +98,10 @@ Determines whether the dragger is visible.
| *Getter* | get_split_offset() |
+----------+-------------------------+
Method Descriptions
-------------------
.. _class_SplitContainer_clamp_split_offset:
- void **clamp_split_offset** **(** **)**

4
classes/class_textedit.rst
View File

@@ -263,7 +263,9 @@ enum **MenuItems**:
- **MENU_UNDO** = **5** --- Undoes the previous action.
- **MENU_MAX** = **6**
- **MENU_REDO** = **6**
- **MENU_MAX** = **7**
.. _enum_TextEdit_SearchFlags:

6
classes/class_theme.rst
View File

@@ -26,6 +26,8 @@ Properties
Methods
-------
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Theme_clear>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_color<class_Theme_clear_color>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -109,6 +111,10 @@ The theme's default font.
Method Descriptions
-------------------
.. _class_Theme_clear:
- void **clear** **(** **)**
.. _class_Theme_clear_color:
- void **clear_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)**

4
classes/class_tree.rst
View File

@@ -240,13 +240,13 @@ Emitted when an item is edited using the right mouse button.
- **item_rmb_selected** **(** :ref:`Vector2<class_Vector2>` position **)**
Emitted when an item is selected with right mouse button.
Emitted when an item is selected with the right mouse button.
.. _class_Tree_item_selected:
- **item_selected** **(** **)**
Emitted when an item is selected with right mouse button.
Emitted when an item is selected.
.. _class_Tree_multi_selected:

4
classes/class_visualserver.rst
View File

@@ -202,7 +202,7 @@ Methods
+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`environment_set_fog_height<class_VisualServer_environment_set_fog_height>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` min_height, :ref:`float<class_float>` max_height, :ref:`float<class_float>` height_curve **)** |
+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`environment_set_glow<class_VisualServer_environment_set_glow>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` level_flags, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_VisualServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`bool<class_bool>` bicubic_upscale **)** |
| void | :ref:`environment_set_glow<class_VisualServer_environment_set_glow>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` level_flags, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_VisualServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`float<class_float>` hdr_luminance_cap, :ref:`bool<class_bool>` bicubic_upscale **)** |
+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`environment_set_sky<class_VisualServer_environment_set_sky>` **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)** |
+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -1838,7 +1838,7 @@ Modulates all colors in the given canvas.
.. _class_VisualServer_environment_set_glow:
- void **environment_set_glow** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` level_flags, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_VisualServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`bool<class_bool>` bicubic_upscale **)**
- void **environment_set_glow** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` level_flags, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_VisualServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`float<class_float>` hdr_luminance_cap, :ref:`bool<class_bool>` bicubic_upscale **)**
.. _class_VisualServer_environment_set_sky: