Browse Source

classref: Sync with current master branch (c3b0a92)

Godot Organization 2 years ago
parent
commit
c084470835

+ 14 - 0
classes/class_camera3d.rst

@@ -79,6 +79,8 @@ Methods
    +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | void                                  | :ref:`clear_current<class_Camera3D_method_clear_current>` **(** :ref:`bool<class_bool>` enable_next=true **)**                                                                                            |
    +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | :ref:`Projection<class_Projection>`   | :ref:`get_camera_projection<class_Camera3D_method_get_camera_projection>` **(** **)** |const|                                                                                                             |
+   +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`RID<class_RID>`                 | :ref:`get_camera_rid<class_Camera3D_method_get_camera_rid>` **(** **)** |const|                                                                                                                           |
    +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`Transform3D<class_Transform3D>` | :ref:`get_camera_transform<class_Camera3D_method_get_camera_transform>` **(** **)** |const|                                                                                                               |
@@ -497,6 +499,18 @@ If this is the current camera, remove it from being current. If ``enable_next``
 
 ----
 
+.. _class_Camera3D_method_get_camera_projection:
+
+.. rst-class:: classref-method
+
+:ref:`Projection<class_Projection>` **get_camera_projection** **(** **)** |const|
+
+Returns the projection matrix that this camera uses to render to its associated viewport. The camera must be part of the scene tree to function.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_Camera3D_method_get_camera_rid:
 
 .. rst-class:: classref-method

+ 4 - 0
classes/class_gradient.rst

@@ -164,6 +164,8 @@ Property Descriptions
 
 Gradient's colors returned as a :ref:`PackedColorArray<class_PackedColorArray>`.
 
+\ **Note:** This property returns a copy, modifying the return value does not update the gradient. To update the gradient use :ref:`set_color<class_Gradient_method_set_color>` method (for updating colors individually) or assign to this property directly (for bulk-updating all colors at once).
+
 .. rst-class:: classref-item-separator
 
 ----
@@ -217,6 +219,8 @@ The algorithm used to interpolate between points of the gradient. See :ref:`Inte
 
 Gradient's offsets returned as a :ref:`PackedFloat32Array<class_PackedFloat32Array>`.
 
+\ **Note:** This property returns a copy, modifying the return value does not update the gradient. To update the gradient use :ref:`set_offset<class_Gradient_method_set_offset>` method (for updating offsets individually) or assign to this property directly (for bulk-updating all offsets at once).
+
 .. rst-class:: classref-section-separator
 
 ----

+ 1 - 1
classes/class_os.rst

@@ -1463,7 +1463,7 @@ If ``file_or_dir_path`` is a valid directory path, and ``open_folder`` is ``true
 
 Use :ref:`ProjectSettings.globalize_path<class_ProjectSettings_method_globalize_path>` to convert a ``res://`` or ``user://`` path into a system path for use with this method.
 
-\ **Note:** Currently this method is only implemented on Windows. On other platforms, it will fallback to :ref:`shell_open<class_OS_method_shell_open>` with a directory path for ``file_or_dir_path``.
+\ **Note:** Currently this method is only implemented on Windows and macOS. On other platforms, it will fallback to :ref:`shell_open<class_OS_method_shell_open>` with a directory path of ``file_or_dir_path`` with prefix ``file://``.
 
 .. rst-class:: classref-item-separator
 

+ 6 - 6
classes/class_string.rst

@@ -1780,11 +1780,11 @@ Converts the string representing a decimal number into a :ref:`float<class_float
 
 ::
 
-    var a = "12.35".to_float() # a is 12.35
-    var b = "1.2.3".to_float() # b is 1.2
-    var c = "12xy3".to_float() # c is 12.0
-    var d = "1e3".to_float()   # d is 1000.0
-    var e = "Hello!".to_int()  # e is 0.0
+    var a = "12.35".to_float()  # a is 12.35
+    var b = "1.2.3".to_float()  # b is 1.2
+    var c = "12xy3".to_float()  # c is 12.0
+    var d = "1e3".to_float()    # d is 1000.0
+    var e = "Hello!".to_float() # e is 0.0
 
 .. rst-class:: classref-item-separator
 
@@ -2017,7 +2017,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`i
 
 :ref:`String<class_String>` **validate_node_name** **(** **)** |const|
 
-Returns a copy of the string with all characters that are not allowed in :ref:`Node.name<class_Node_property_name>` removed (``.`` ``:`` ``@`` ``/`` ``"`` ``%``).
+Returns a copy of the string with all characters that are not allowed in :ref:`Node.name<class_Node_property_name>` (``.`` ``:`` ``@`` ``/`` ``"`` ``%``) replaced with underscores.
 
 .. rst-class:: classref-item-separator
 

+ 1 - 1
classes/class_stringname.rst

@@ -1860,7 +1860,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`i
 
 :ref:`String<class_String>` **validate_node_name** **(** **)** |const|
 
-Returns a copy of the string with all characters that are not allowed in :ref:`Node.name<class_Node_property_name>` removed (``.`` ``:`` ``@`` ``/`` ``"`` ``%``).
+Returns a copy of the string with all characters that are not allowed in :ref:`Node.name<class_Node_property_name>` (``.`` ``:`` ``@`` ``/`` ``"`` ``%``) replaced with underscores.
 
 .. rst-class:: classref-item-separator