From e4f01ce8299437d3433f4012c5fb6d605e4906d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 4 Dec 2018 22:02:35 +0100 Subject: [PATCH] Sync classref with current source --- classes/class_@globalscope.rst | 6 - classes/class_animation.rst | 2 +- classes/class_animationnode.rst | 147 +++++++++++++++----- classes/class_animationnodeblendspace2d.rst | 51 +++++-- classes/class_animationplayer.rst | 6 + classes/class_arvrinterface.rst | 4 +- classes/class_basebutton.rst | 48 ++++--- classes/class_cpuparticles.rst | 18 +-- classes/class_cpuparticles2d.rst | 18 +-- classes/class_dynamicfontdata.rst | 24 +++- classes/class_editorfilesystem.rst | 4 + classes/class_environment.rst | 12 ++ classes/class_generic6dofjoint.rst | 12 ++ classes/class_orientedpathfollow.rst | 2 +- classes/class_projectsettings.rst | 24 ---- classes/class_skeletonik.rst | 50 ++++--- classes/class_splitcontainer.rst | 14 ++ classes/class_textedit.rst | 4 +- classes/class_theme.rst | 6 + classes/class_tree.rst | 4 +- classes/class_visualserver.rst | 4 +- 21 files changed, 315 insertions(+), 145 deletions(-) diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index c007fa613..b4c3de70b 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -28,8 +28,6 @@ Properties +-----------------------------------------------------+------------------------------------------------------------------+ | :ref:`Geometry` | :ref:`Geometry` | +-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`GodotSharp` | :ref:`GodotSharp` | -+-----------------------------------------------------+------------------------------------------------------------------+ | :ref:`IP` | :ref:`IP` | +-----------------------------------------------------+------------------------------------------------------------------+ | :ref:`Input` | :ref:`Input` | @@ -1147,10 +1145,6 @@ Property Descriptions :ref:`Geometry` singleton -.. _class_@GlobalScope_GodotSharp: - -- :ref:`GodotSharp` **GodotSharp** - .. _class_@GlobalScope_IP: - :ref:`IP` **IP** diff --git a/classes/class_animation.rst b/classes/class_animation.rst index f07420ddf..d1d98f927 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -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") diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 3069d1b83..f7c5edef5 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -16,7 +16,7 @@ AnimationNode Brief Description ----------------- - +Base resource for :ref:`AnimationTree` nodes. Properties ---------- @@ -28,35 +28,43 @@ Properties Methods ------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_input` **(** :ref:`String` name **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_animation` **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_caption` **(** **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_input_count` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`String` name **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`has_filter` **(** **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_input` **(** :ref:`int` index **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_parameter` **(** :ref:`String` name, :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_input` **(** :ref:`String` name **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_animation` **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_caption` **(** **)** virtual | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_child_by_name` **(** :ref:`String` name **)** virtual | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_child_nodes` **(** **)** virtual | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_input_count` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`String` name **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_parameter_default_value` **(** :ref:`String` name **)** virtual | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_parameter_list` **(** **)** virtual | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`has_filter` **(** **)** virtual | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_input` **(** :ref:`int` index **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_parameter` **(** :ref:`String` name, :ref:`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` 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`, otherwise :ref:`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` name **)** +Add an input to the node. This is only useful for nodes created for use in an :ref:`AnimationNodeBlendTree` + .. _class_AnimationNode_blend_animation: - void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** +Blend an animation by "blend" amount (name must be valid in the linked :ref:`AnimationPlayer`). A time and delta mas be passed, as well as whether seek happened. + .. _class_AnimationNode_blend_input: - :ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`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` **blend_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`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` instead, else editors will not display your node for addition. + .. _class_AnimationNode_get_caption: - :ref:`String` **get_caption** **(** **)** virtual +Get the text caption for this node (used by some editors) + +.. _class_AnimationNode_get_child_by_name: + +- :ref:`Object` **get_child_by_name** **(** :ref:`String` name **)** virtual + +Get the a child node by index (used by editors inheriting from :ref:`AnimationRootNode`). + +.. _class_AnimationNode_get_child_nodes: + +- :ref:`Dictionary` **get_child_nodes** **(** **)** virtual + +Get all children nodes, in order as a name:node dictionary. Only useful when inheriting :ref:`AnimationRootNode`. + .. _class_AnimationNode_get_input_count: - :ref:`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` **get_input_name** **(** :ref:`int` input **)** +Get the name of an input by index. + .. _class_AnimationNode_get_parameter: - :ref:`Variant` **get_parameter** **(** :ref:`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` **get_parameter_default_value** **(** :ref:`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` **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` **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` **is_path_filtered** **(** :ref:`NodePath` path **)** const +Return true wether a given path is filtered. + .. _class_AnimationNode_process: - void **process** **(** :ref:`float` time, :ref:`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`, :ref:`blend_node` or :ref:`blend_animation` functions. + +You can also use :ref:`get_parameter` and :ref:`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` index **)** +Remove an input, call this only when inactive. + .. _class_AnimationNode_set_filter_path: - void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** +Add/Remove a path for the filter. + .. _class_AnimationNode_set_parameter: - void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** +Set a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes. + diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 3f8d7c6e0..00fd4f10d 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -19,19 +19,21 @@ Brief Description Properties ---------- -+-------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_triangles` | -+-------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`max_space` | -+-------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`min_space` | -+-------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`snap` | -+-------------------------------+-----------------------------------------------------------------------+ -| :ref:`String` | :ref:`x_label` | -+-------------------------------+-----------------------------------------------------------------------+ -| :ref:`String` | :ref:`y_label` | -+-------------------------------+-----------------------------------------------------------------------+ ++------------------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`auto_triangles` | ++------------------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`BlendMode` | :ref:`blend_mode` | ++------------------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`max_space` | ++------------------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`min_space` | ++------------------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`snap` | ++------------------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`String` | :ref:`x_label` | ++------------------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`String` | :ref:`y_label` | ++------------------------------------------------------------+-----------------------------------------------------------------------+ Methods ------- @@ -60,6 +62,19 @@ Methods | void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`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` **blend_mode** + ++----------+-----------------------+ +| *Setter* | set_blend_mode(value) | ++----------+-----------------------+ +| *Getter* | get_blend_mode() | ++----------+-----------------------+ + .. _class_AnimationNodeBlendSpace2D_max_space: - :ref:`Vector2` **max_space** diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 46a437dde..4bd6a0653 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -67,6 +67,8 @@ Methods +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playing_speed` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_queue` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`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` **get_queue** **(** **)** + .. _class_AnimationPlayer_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` name **)** const diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 677503ce7..ca671d6e6 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -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. diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index ad2f0f906..aec1ee69c 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -21,23 +21,25 @@ Base class for different kinds of buttons. Properties ---------- -+-----------------------------------------------+----------------------------------------------------------------+ -| :ref:`ActionMode` | :ref:`action_mode` | -+-----------------------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`button_mask` | -+-----------------------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-----------------------------------------------+----------------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`enabled_focus_mode` | -+-----------------------------------------------+----------------------------------------------------------------+ -| :ref:`ButtonGroup` | :ref:`group` | -+-----------------------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-----------------------------------------------+----------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`shortcut` | -+-----------------------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`toggle_mode` | -+-----------------------------------------------+----------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`ActionMode` | :ref:`action_mode` | ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`button_mask` | ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`FocusMode` | :ref:`enabled_focus_mode` | ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`ButtonGroup` | :ref:`group` | ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`shortcut` | ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shortcut_in_tooltip` | ++-----------------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`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` **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` **toggle_mode** diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index a8f88862d..f399da619 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -122,11 +122,11 @@ Properties +-------------------------------------------------------+----------------------------------------------------------------------------+ | :ref:`float` | :ref:`randomness` | +-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale` | +| :ref:`float` | :ref:`scale_amount` | +-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`scale_curve` | +| :ref:`Curve` | :ref:`scale_amount_curve` | +-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_random` | +| :ref:`float` | :ref:`scale_amount_random` | +-------------------------------------------------------+----------------------------------------------------------------------------+ | :ref:`float` | :ref:`speed_scale` | +-------------------------------------------------------+----------------------------------------------------------------------------+ @@ -726,9 +726,9 @@ Property Descriptions | *Getter* | get_randomness_ratio() | +----------+-----------------------------+ -.. _class_CPUParticles_scale: +.. _class_CPUParticles_scale_amount: -- :ref:`float` **scale** +- :ref:`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` **scale_curve** +- :ref:`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` **scale_random** +- :ref:`float` **scale_amount_random** +----------+-----------------------------+ | *Setter* | set_param_randomness(value) | diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 982c42063..c0102443b 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -118,11 +118,11 @@ Properties +---------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | :ref:`randomness` | +---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale` | +| :ref:`float` | :ref:`scale_amount` | +---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`scale_curve` | +| :ref:`Curve` | :ref:`scale_amount_curve` | +---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_random` | +| :ref:`float` | :ref:`scale_amount_random` | +---------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | :ref:`speed_scale` | +---------------------------------------------------------+------------------------------------------------------------------------------+ @@ -702,9 +702,9 @@ Property Descriptions | *Getter* | get_randomness_ratio() | +----------+-----------------------------+ -.. _class_CPUParticles2D_scale: +.. _class_CPUParticles2D_scale_amount: -- :ref:`float` **scale** +- :ref:`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` **scale_curve** +- :ref:`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` **scale_random** +- :ref:`float` **scale_amount_random** +----------+-----------------------------+ | *Setter* | set_param_randomness(value) | diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index 126d7ba01..a2be7c199 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -19,11 +19,13 @@ Used with :ref:`DynamicFont` to describe the location of a fo Properties ---------- -+----------------------------------------------+---------------------------------------------------+ -| :ref:`String` | :ref:`font_path` | -+----------------------------------------------+---------------------------------------------------+ -| :ref:`Hinting` | :ref:`hinting` | -+----------------------------------------------+---------------------------------------------------+ ++----------------------------------------------+-------------------------------------------------------+ +| :ref:`bool` | :ref:`antialiased` | ++----------------------------------------------+-------------------------------------------------------+ +| :ref:`String` | :ref:`font_path` | ++----------------------------------------------+-------------------------------------------------------+ +| :ref:`Hinting` | :ref:`hinting` | ++----------------------------------------------+-------------------------------------------------------+ Enumerations ------------ @@ -46,6 +48,18 @@ Used with :ref:`DynamicFont` to describe the location of a ve Property Descriptions --------------------- +.. _class_DynamicFontData_antialiased: + +- :ref:`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` **font_path** diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index a4b0a6076..a2cdc62b9 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -54,6 +54,10 @@ Emitted if the filesystem changed. Remitted if a resource is reimported. +.. _class_EditorFileSystem_resources_reload: + +- **resources_reload** **(** :ref:`PoolStringArray` resources **)** + .. _class_EditorFileSystem_sources_changed: - **sources_changed** **(** :ref:`bool` exist **)** diff --git a/classes/class_environment.rst b/classes/class_environment.rst index f8f3de312..f58797e13 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -114,6 +114,8 @@ Properties +--------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`glow_enabled` | +--------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_luminance_cap` | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`glow_hdr_scale` | +--------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`glow_hdr_threshold` | @@ -841,6 +843,16 @@ Bloom value (global glow). Enables glow rendering. +.. _class_Environment_glow_hdr_luminance_cap: + +- :ref:`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` **glow_hdr_scale** diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 554883ff2..99ef237c1 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -188,6 +188,8 @@ Properties +---------------------------+------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_z/stiffness` | +---------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`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` **precision** + ++----------+----------------------+ +| *Setter* | set_precision(value) | ++----------+----------------------+ +| *Getter* | get_precision() | ++----------+----------------------+ + diff --git a/classes/class_orientedpathfollow.rst b/classes/class_orientedpathfollow.rst index 12713eb2b..bcc852113 100644 --- a/classes/class_orientedpathfollow.rst +++ b/classes/class_orientedpathfollow.rst @@ -36,7 +36,7 @@ Properties Description ----------- -This node behaves like :ref:`PathFollow`, except it uses its parent :ref:`Path` up vector information to enforce orientation. +This node behaves like :ref:`PathFollow`, except it uses its parent :ref:`Path` up vector information to enforce orientation. Make sure to check if the curve of this node's parent :ref:`Path` has up vectors enabled. See :ref:`PathFollow` and :ref:`Curve3D` for further information. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index c5a40ddc1..d7cf969d3 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -392,14 +392,6 @@ Properties +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mono/debugger_agent/port` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`mono/debugger_agent/wait_for_debugger` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mono/debugger_agent/wait_timeout` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`mono/export/include_scripts_content` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`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` **mono/debugger_agent/port** - -.. _class_ProjectSettings_mono/debugger_agent/wait_for_debugger: - -- :ref:`bool` **mono/debugger_agent/wait_for_debugger** - -.. _class_ProjectSettings_mono/debugger_agent/wait_timeout: - -- :ref:`int` **mono/debugger_agent/wait_timeout** - -.. _class_ProjectSettings_mono/export/include_scripts_content: - -- :ref:`bool` **mono/export/include_scripts_content** - .. _class_ProjectSettings_network/limits/debugger_stdout/max_chars_per_second: - :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index f07444abd..e1e2c3a1b 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -19,25 +19,27 @@ Brief Description Properties ---------- -+-----------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`interpolation` | -+-----------------------------------+--------------------------------------------------------+ -| :ref:`Vector3` | :ref:`magnet` | -+-----------------------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`max_iterations` | -+-----------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`min_distance` | -+-----------------------------------+--------------------------------------------------------+ -| :ref:`String` | :ref:`root_bone` | -+-----------------------------------+--------------------------------------------------------+ -| :ref:`Transform` | :ref:`target` | -+-----------------------------------+--------------------------------------------------------+ -| :ref:`NodePath` | :ref:`target_node` | -+-----------------------------------+--------------------------------------------------------+ -| :ref:`String` | :ref:`tip_bone` | -+-----------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`use_magnet` | -+-----------------------------------+--------------------------------------------------------+ ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolation` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`magnet` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`max_iterations` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`min_distance` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`override_tip_basis` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`String` | :ref:`root_bone` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`Transform` | :ref:`target` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`target_node` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`String` | :ref:`tip_bone` | ++-----------------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_magnet` | ++-----------------------------------+----------------------------------------------------------------+ Methods ------- @@ -95,6 +97,16 @@ Property Descriptions | *Getter* | get_min_distance() | +----------+-------------------------+ +.. _class_SkeletonIK_override_tip_basis: + +- :ref:`bool` **override_tip_basis** + ++----------+-------------------------------+ +| *Setter* | set_override_tip_basis(value) | ++----------+-------------------------------+ +| *Getter* | is_override_tip_basis() | ++----------+-------------------------------+ + .. _class_SkeletonIK_root_bone: - :ref:`String` **root_bone** diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index da967be0f..3fa512fc2 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -29,6 +29,13 @@ Properties | :ref:`int` | :ref:`split_offset` | +-----------------------------------------------------------------+--------------------------------------------------------------------+ +Methods +------- + ++-------+--------------------------------------------------------------------------------+ +| void | :ref:`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** **(** **)** + diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index cc7a746f5..fc38b63dd 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -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: diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 64e8536ee..017712a32 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -26,6 +26,8 @@ Properties Methods ------- ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_color` **(** :ref:`String` name, :ref:`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` name, :ref:`String` type **)** diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 963b4c5c8..3654799e5 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -240,13 +240,13 @@ Emitted when an item is edited using the right mouse button. - **item_rmb_selected** **(** :ref:`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: diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index dea416572..17bf4e52a 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -202,7 +202,7 @@ Methods +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** | +| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1838,7 +1838,7 @@ Modulates all colors in the given canvas. .. _class_VisualServer_environment_set_glow: -- void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** +- void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** .. _class_VisualServer_environment_set_sky: