stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with 3.2 branch

Browse Source
This commit is contained in:
Rémi Verschelde
2020-06-05 17:19:14 +02:00
parent f3d374ebf1
commit bd97d9ecbf
9 changed files with 50 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_animationtree.rst
+11
View File
@@ -13,6 +13,11 @@ AnimationTree
A node to be used for advanced animation transitions in an :ref:`AnimationPlayer<class_AnimationPlayer>`.
Description
-----------
Note: When linked with an :ref:`AnimationPlayer<class_AnimationPlayer>`, several properties and methods of the corresponding :ref:`AnimationPlayer<class_AnimationPlayer>` will not function as expected. Playback and transitions should be handled using only the ``AnimationTree`` and its constituent :ref:`AnimationNode<class_AnimationNode>`\ (s). The :ref:`AnimationPlayer<class_AnimationPlayer>` node should be used solely for adding, deleting, and editing animations.
Tutorials
---------
@@ -128,6 +133,10 @@ The process mode of this ``AnimationTree``. See :ref:`AnimationProcessMode<enum_
| *Getter* | get_root_motion_track() |
+-----------+------------------------------+
The path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by ``":"``. For example, ``"character/skeleton:ankle"`` or ``"character/mesh:transform/local"``.
If the track has type :ref:`Animation.TYPE_TRANSFORM<class_Animation_constant_TYPE_TRANSFORM>`, the transformation will be cancelled visually, and the animation will appear to stay in place.
----
.. _class_AnimationTree_property_tree_root:
@@ -157,6 +166,8 @@ Manually advance the animations by the specified time (in seconds).
- :ref:`Transform<class_Transform>` **get_root_motion_transform** **(** **)** const
Retrieve the motion of the :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` as a :ref:`Transform<class_Transform>` that can be used elsewhere. If :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` is not a path to a track of type :ref:`Animation.TYPE_TRANSFORM<class_Animation_constant_TYPE_TRANSFORM>`, returns an identity transformation.
----
.. _class_AnimationTree_method_rename_parameter:
classes/class_bitmapfont.rst
-10
View File
@@ -47,8 +47,6 @@ Methods
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`create_from_fnt<class_BitmapFont_method_create_from_fnt>` **(** :ref:`String<class_String>` path **)** |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_char_size<class_BitmapFont_method_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_method_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`get_texture<class_BitmapFont_method_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
@@ -162,14 +160,6 @@ Creates a BitmapFont from the ``*.fnt`` file at ``path``.
----
.. _class_BitmapFont_method_get_char_size:
- :ref:`Vector2<class_Vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
Returns the size of a character, optionally taking kerning into account if the next character is provided.
----
.. _class_BitmapFont_method_get_kerning_pair:
- :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
classes/class_directionallight.rst
+4 -4
View File
@@ -61,11 +61,11 @@ Enumerations
enum **ShadowMode**:
- **SHADOW_ORTHOGONAL** = **0** --- Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects.
- **SHADOW_ORTHOGONAL** = **0** --- Renders the entire scene's shadow map from an orthogonal point of view. This is the fastest directional shadow mode. May result in blurrier shadows on close objects.
- **SHADOW_PARALLEL_2_SPLITS** = **1** --- Splits the view frustum in 2 areas, each with its own shadow map.
- **SHADOW_PARALLEL_2_SPLITS** = **1** --- Splits the view frustum in 2 areas, each with its own shadow map. This shadow mode is a compromise between :ref:`SHADOW_ORTHOGONAL<class_DirectionalLight_constant_SHADOW_ORTHOGONAL>` and :ref:`SHADOW_PARALLEL_4_SPLITS<class_DirectionalLight_constant_SHADOW_PARALLEL_4_SPLITS>` in terms of performance.
- **SHADOW_PARALLEL_4_SPLITS** = **2** --- Splits the view frustum in 4 areas, each with its own shadow map.
- **SHADOW_PARALLEL_4_SPLITS** = **2** --- Splits the view frustum in 4 areas, each with its own shadow map. This is the slowest directional shadow mode.
----
@@ -79,7 +79,7 @@ enum **ShadowDepthRange**:
- **SHADOW_DEPTH_RANGE_STABLE** = **0** --- Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution.
- **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges.
- **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. This mode typically works best in games where the camera will often move at high speeds, such as most racing games.
Property Descriptions
---------------------
classes/class_dynamicfontdata.rst
+1 -1
View File
@@ -63,7 +63,7 @@ Property Descriptions
| *Getter* | is_antialiased() |
+-----------+------------------------+
If ``true``, the font is rendered with anti-aliasing.
If ``true``, the font is rendered with anti-aliasing. This property applies both to the main font and its outline (if it has one).
----
classes/class_editorinterface.rst
+20 -8
View File
@@ -20,6 +20,13 @@ EditorInterface gives you control over Godot editor's window. It allows customiz
**Note:** This class shouldn't be instantiated directly. Instead, access the singleton using :ref:`EditorPlugin.get_editor_interface<class_EditorPlugin_method_get_editor_interface>`.
Properties
----------
+-------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`distraction_free_mode<class_EditorInterface_property_distraction_free_mode>` |
+-------------------------+------------------------------------------------------------------------------------+
Methods
-------
@@ -68,13 +75,24 @@ Methods
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select_file<class_EditorInterface_method_select_file>` **(** :ref:`String<class_String>` file **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_distraction_free_mode<class_EditorInterface_method_set_distraction_free_mode>` **(** :ref:`bool<class_bool>` enter **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_main_screen_editor<class_EditorInterface_method_set_main_screen_editor>` **(** :ref:`String<class_String>` name **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_plugin_enabled<class_EditorInterface_method_set_plugin_enabled>` **(** :ref:`String<class_String>` plugin, :ref:`bool<class_bool>` enabled **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_EditorInterface_property_distraction_free_mode:
- :ref:`bool<class_bool>` **distraction_free_mode**
+----------+------------------------------------+
| *Setter* | set_distraction_free_mode(value) |
+----------+------------------------------------+
| *Getter* | is_distraction_free_mode_enabled() |
+----------+------------------------------------+
Method Descriptions
-------------------
@@ -246,12 +264,6 @@ Selects the file, with the path provided by ``file``, in the FileSystem dock.
----
.. _class_EditorInterface_method_set_distraction_free_mode:
- void **set_distraction_free_mode** **(** :ref:`bool<class_bool>` enter **)**
----
.. _class_EditorInterface_method_set_main_screen_editor:
- void **set_main_screen_editor** **(** :ref:`String<class_String>` name **)**
classes/class_font.rst
+10
View File
@@ -30,6 +30,8 @@ Methods
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ascent<class_Font_method_get_ascent>` **(** **)** const |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_char_size<class_Font_method_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_descent<class_Font_method_get_descent>` **(** **)** const |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_Font_method_get_height>` **(** **)** const |
@@ -72,6 +74,14 @@ Returns the font ascent (number of pixels above the baseline).
----
.. _class_Font_method_get_char_size:
- :ref:`Vector2<class_Vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
Returns the size of a character, optionally taking kerning into account if the next character is provided.
----
.. _class_Font_method_get_descent:
- :ref:`float<class_float>` **get_descent** **(** **)** const
classes/class_projectsettings.rst
+1 -1
View File
@@ -4689,7 +4689,7 @@ Saves the configuration to the ``project.godot`` file.
- :ref:`Error<enum_@GlobalScope_Error>` **save_custom** **(** :ref:`String<class_String>` file **)**
Saves the configuration to a custom file.
Saves the configuration to a custom file. The file extension must be ``.godot`` (to save in text-based :ref:`ConfigFile<class_ConfigFile>` format) or ``.binary`` (to save in binary format).
----
classes/class_viewport.rst
+2
View File
@@ -534,6 +534,8 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly.
If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm. High Dynamic Range allows the viewport to receive values that are outside the 0-1 range. In Godot HDR uses 16 bits, meaning it does not store the full range of a floating point number.
**Note:** Requires :ref:`usage<class_Viewport_property_usage>` to be set to :ref:`USAGE_3D<class_Viewport_constant_USAGE_3D>` or :ref:`USAGE_3D_NO_EFFECTS<class_Viewport_constant_USAGE_3D_NO_EFFECTS>`, since HDR is not supported for 2D.
----
.. _class_Viewport_property_keep_3d_linear:
classes/class_webrtcpeerconnection.rst
+1 -1
View File
@@ -215,7 +215,7 @@ Call this method frequently (e.g. in :ref:`Node._process<class_Node_method__proc
Sets the SDP description of the local peer. This should be called in response to :ref:`session_description_created<class_WebRTCPeerConnection_signal_session_description_created>`.
If ``type`` is ``answer`` the peer will start emitting :ref:`ice_candidate_created<class_WebRTCPeerConnection_signal_ice_candidate_created>`.
After calling this function the peer will start emitting :ref:`ice_candidate_created<class_WebRTCPeerConnection_signal_ice_candidate_created>` (unless an :ref:`Error<enum_@GlobalScope_Error>` different from :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` is returned).
----