summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Basis.xml8
-rw-r--r--doc/classes/MissingNode.xml17
-rw-r--r--doc/classes/MissingResource.xml17
-rw-r--r--doc/classes/NavigationRegion3D.xml3
-rw-r--r--doc/classes/Transform2D.xml8
-rw-r--r--doc/classes/Transform3D.xml8
-rw-r--r--doc/classes/Vector2.xml4
-rw-r--r--doc/classes/Vector3.xml6
8 files changed, 53 insertions, 18 deletions
diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml
index 3b703884a5..0af482d654 100644
--- a/doc/classes/Basis.xml
+++ b/doc/classes/Basis.xml
@@ -35,9 +35,9 @@
<constructor name="Basis">
<return type="Basis" />
<argument index="0" name="axis" type="Vector3" />
- <argument index="1" name="phi" type="float" />
+ <argument index="1" name="angle" type="float" />
<description>
- Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector.
+ Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]angle[/code] (in radians). The axis must be a normalized vector.
</description>
</constructor>
<constructor name="Basis">
@@ -136,9 +136,9 @@
<method name="rotated" qualifiers="const">
<return type="Basis" />
<argument index="0" name="axis" type="Vector3" />
- <argument index="1" name="phi" type="float" />
+ <argument index="1" name="angle" type="float" />
<description>
- Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector.
+ Introduce an additional rotation around the given axis by [code]angle[/code] (in radians). The axis must be a normalized vector.
</description>
</method>
<method name="scaled" qualifiers="const">
diff --git a/doc/classes/MissingNode.xml b/doc/classes/MissingNode.xml
new file mode 100644
index 0000000000..b5aa02cfd6
--- /dev/null
+++ b/doc/classes/MissingNode.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="MissingNode" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ This is an internal editor class intended for keeping data of nodes of unknown type.
+ </brief_description>
+ <description>
+ This is an internal editor class intended for keeping data of nodes of unknown type (most likely this type was supplied by an extension that is no longer loaded). It can´t be manually instantiated or placed in the scene. Ignore it if you don't know what it is.
+ </description>
+ <tutorials>
+ </tutorials>
+ <members>
+ <member name="original_class" type="String" setter="set_original_class" getter="get_original_class">
+ </member>
+ <member name="recording_properties" type="bool" setter="set_recording_properties" getter="is_recording_properties">
+ </member>
+ </members>
+</class>
diff --git a/doc/classes/MissingResource.xml b/doc/classes/MissingResource.xml
new file mode 100644
index 0000000000..eede6350d8
--- /dev/null
+++ b/doc/classes/MissingResource.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="MissingResource" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ This is an internal editor class intended for keeping data of resources of unknown type.
+ </brief_description>
+ <description>
+ This is an internal editor class intended for keeping data of resources of unknown type (most likely this type was supplied by an extension that is no longer loaded). It can´t be manually instantiated or placed in the scene. Ignore it if you don't know what it is.
+ </description>
+ <tutorials>
+ </tutorials>
+ <members>
+ <member name="original_class" type="String" setter="set_original_class" getter="get_original_class">
+ </member>
+ <member name="recording_properties" type="bool" setter="set_recording_properties" getter="is_recording_properties">
+ </member>
+ </members>
+</class>
diff --git a/doc/classes/NavigationRegion3D.xml b/doc/classes/NavigationRegion3D.xml
index b27410ed74..60f1020286 100644
--- a/doc/classes/NavigationRegion3D.xml
+++ b/doc/classes/NavigationRegion3D.xml
@@ -12,8 +12,9 @@
<methods>
<method name="bake_navigation_mesh">
<return type="void" />
+ <argument index="0" name="on_thread" type="bool" default="true" />
<description>
- Bakes the [NavigationMesh]. The baking is done in a separate thread because navigation baking is not a cheap operation. This can be done at runtime. When it is completed, it automatically sets the new [NavigationMesh].
+ Bakes the [NavigationMesh]. If [code]on_thread[/code] is set to [code]true[/code] (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new [NavigationMesh]. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization.
</description>
</method>
<method name="get_region_rid" qualifiers="const">
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml
index 3ad21ee809..8c2a5aa6d9 100644
--- a/doc/classes/Transform2D.xml
+++ b/doc/classes/Transform2D.xml
@@ -139,16 +139,16 @@
</method>
<method name="rotated" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="phi" type="float" />
+ <argument index="0" name="angle" type="float" />
<description>
- Rotates the transform by the given angle (in radians), using matrix multiplication.
+ Returns a copy of the transform rotated by the given [code]angle[/code] (in radians), using matrix multiplication.
</description>
</method>
<method name="scaled" qualifiers="const">
<return type="Transform2D" />
<argument index="0" name="scale" type="Vector2" />
<description>
- Scales the transform by the given scale factor, using matrix multiplication.
+ Returns a copy of the transform scaled by the given [code]scale[/code] factor, using matrix multiplication.
</description>
</method>
<method name="set_rotation">
@@ -176,7 +176,7 @@
<return type="Transform2D" />
<argument index="0" name="offset" type="Vector2" />
<description>
- Translates the transform by the given offset, relative to the transform's basis vectors.
+ Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
</description>
</method>
diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml
index 5a72dc223c..afd11b6c77 100644
--- a/doc/classes/Transform3D.xml
+++ b/doc/classes/Transform3D.xml
@@ -94,16 +94,16 @@
<method name="rotated" qualifiers="const">
<return type="Transform3D" />
<argument index="0" name="axis" type="Vector3" />
- <argument index="1" name="phi" type="float" />
+ <argument index="1" name="angle" type="float" />
<description>
- Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector.
+ Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians), using matrix multiplication. The [code]axis[/code] must be a normalized vector.
</description>
</method>
<method name="scaled" qualifiers="const">
<return type="Transform3D" />
<argument index="0" name="scale" type="Vector3" />
<description>
- Scales basis and origin of the transform by the given scale factor, using matrix multiplication.
+ Returns a copy of the transform with its basis and origin scaled by the given [code]scale[/code] factor, using matrix multiplication.
</description>
</method>
<method name="sphere_interpolate_with" qualifiers="const">
@@ -118,7 +118,7 @@
<return type="Transform3D" />
<argument index="0" name="offset" type="Vector3" />
<description>
- Translates the transform by the given offset, relative to the transform's basis vectors.
+ Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
</description>
</method>
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml
index f9ef126658..6ccc0fc6a6 100644
--- a/doc/classes/Vector2.xml
+++ b/doc/classes/Vector2.xml
@@ -278,9 +278,9 @@
</method>
<method name="rotated" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="phi" type="float" />
+ <argument index="0" name="angle" type="float" />
<description>
- Returns the vector rotated by [code]phi[/code] radians. See also [method @GlobalScope.deg2rad].
+ Returns the vector rotated by [code]angle[/code] (in radians). See also [method @GlobalScope.deg2rad].
</description>
</method>
<method name="round" qualifiers="const">
diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml
index 18204943fd..d907ceb52b 100644
--- a/doc/classes/Vector3.xml
+++ b/doc/classes/Vector3.xml
@@ -258,10 +258,10 @@
</method>
<method name="rotated" qualifiers="const">
<return type="Vector3" />
- <argument index="0" name="by_axis" type="Vector3" />
- <argument index="1" name="phi" type="float" />
+ <argument index="0" name="axis" type="Vector3" />
+ <argument index="1" name="angle" type="float" />
<description>
- Rotates this vector around a given axis by [code]phi[/code] radians. The axis must be a normalized vector.
+ Rotates this vector around a given axis by [code]angle[/code] (in radians). The axis must be a normalized vector.
</description>
</method>
<method name="round" qualifiers="const">