summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/@GDScript.xml2
-rw-r--r--doc/classes/Array.xml2
-rw-r--r--doc/classes/CanvasItem.xml6
-rw-r--r--doc/classes/Control.xml2
-rw-r--r--doc/classes/Curve.xml7
-rw-r--r--doc/classes/Input.xml1
-rw-r--r--doc/classes/MainLoop.xml4
-rw-r--r--doc/classes/MultiMesh.xml26
-rw-r--r--doc/classes/RemoteTransform.xml12
-rw-r--r--doc/classes/RemoteTransform2D.xml12
-rw-r--r--doc/classes/Spatial.xml6
-rw-r--r--doc/classes/SpriteFrames.xml2
12 files changed, 63 insertions, 19 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml
index 2cfdfafea1..3e46dc4e92 100644
--- a/doc/classes/@GDScript.xml
+++ b/doc/classes/@GDScript.xml
@@ -412,7 +412,7 @@
</description>
</method>
<method name="get_stack">
- <return type="void">
+ <return type="Array">
</return>
<description>
</description>
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml
index 7097fd8bf0..3bd621799a 100644
--- a/doc/classes/Array.xml
+++ b/doc/classes/Array.xml
@@ -221,7 +221,7 @@
</method>
<method name="invert">
<description>
- Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array.
+ Reverse the order of the elements in the array.
</description>
</method>
<method name="max">
diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml
index a04e38af5c..98404478f4 100644
--- a/doc/classes/CanvasItem.xml
+++ b/doc/classes/CanvasItem.xml
@@ -330,6 +330,12 @@
Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
</description>
</method>
+ <method name="force_update_transform">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="get_canvas" qualifiers="const">
<return type="RID">
</return>
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml
index bbd0441a0b..05b2c2704e 100644
--- a/doc/classes/Control.xml
+++ b/doc/classes/Control.xml
@@ -723,7 +723,7 @@
</description>
</signal>
<signal name="gui_input">
- <argument index="0" name="ev" type="InputEvent">
+ <argument index="0" name="event" type="InputEvent">
</argument>
<description>
Emitted when the node receives an [InputEvent].
diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml
index c7f2f7bb8d..490772e400 100644
--- a/doc/classes/Curve.xml
+++ b/doc/classes/Curve.xml
@@ -49,6 +49,13 @@
Removes all points from the curve.
</description>
</method>
+ <method name="get_point_count" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Returns the number of points describing the curve.
+ </description>
+ </method>
<method name="get_point_left_mode" qualifiers="const">
<return type="int" enum="Curve.TangentMode">
</return>
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml
index 1eb74446c6..a0bb585583 100644
--- a/doc/classes/Input.xml
+++ b/doc/classes/Input.xml
@@ -46,6 +46,7 @@
</return>
<description>
If the device has an accelerometer, this will return the acceleration. Otherwise, it returns an empty [Vector3].
+ Note this method returns an empty [Vector3] when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer.
</description>
</method>
<method name="get_action_strength" qualifiers="const">
diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml
index 9454a16988..ad763e6532 100644
--- a/doc/classes/MainLoop.xml
+++ b/doc/classes/MainLoop.xml
@@ -47,7 +47,7 @@
<method name="_input_event" qualifiers="virtual">
<return type="void">
</return>
- <argument index="0" name="ev" type="InputEvent">
+ <argument index="0" name="event" type="InputEvent">
</argument>
<description>
</description>
@@ -91,7 +91,7 @@
<method name="input_event">
<return type="void">
</return>
- <argument index="0" name="ev" type="InputEvent">
+ <argument index="0" name="event" type="InputEvent">
</argument>
<description>
</description>
diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml
index b78d82199c..1908fdd684 100644
--- a/doc/classes/MultiMesh.xml
+++ b/doc/classes/MultiMesh.xml
@@ -30,6 +30,14 @@
Get the color of a specific instance.
</description>
</method>
+ <method name="get_instance_custom_data" qualifiers="const">
+ <return type="Color">
+ </return>
+ <argument index="0" name="instance" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="get_instance_transform" qualifiers="const">
<return type="Transform">
</return>
@@ -50,6 +58,16 @@
Set the color of a specific instance.
</description>
</method>
+ <method name="set_instance_custom_data">
+ <return type="void">
+ </return>
+ <argument index="0" name="instance" type="int">
+ </argument>
+ <argument index="1" name="custom_data" type="Color">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="set_instance_transform">
<return type="void">
</return>
@@ -65,6 +83,8 @@
<members>
<member name="color_format" type="int" setter="set_color_format" getter="get_color_format" enum="MultiMesh.ColorFormat">
</member>
+ <member name="custom_data_format" type="int" setter="set_custom_data_format" getter="get_custom_data_format" enum="MultiMesh.CustomDataFormat">
+ </member>
<member name="instance_count" type="int" setter="set_instance_count" getter="get_instance_count">
</member>
<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">
@@ -83,5 +103,11 @@
</constant>
<constant name="COLOR_FLOAT" value="2" enum="ColorFormat">
</constant>
+ <constant name="CUSTOM_DATA_NONE" value="0" enum="CustomDataFormat">
+ </constant>
+ <constant name="CUSTOM_DATA_8BIT" value="1" enum="CustomDataFormat">
+ </constant>
+ <constant name="CUSTOM_DATA_FLOAT" value="2" enum="CustomDataFormat">
+ </constant>
</constants>
</class>
diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml
index a7deb273b6..1a5d1eb907 100644
--- a/doc/classes/RemoteTransform.xml
+++ b/doc/classes/RemoteTransform.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.1">
<brief_description>
- RemoteTransform leads the [Transform] of another [Spatial] derived Node in the scene.
+ RemoteTransform pushes its own [Transform] to another [Spatial] derived Node in the scene.
</brief_description>
<description>
- RemoteTransform leads the [Transform] of another [Spatial] derived Node (called the remote node) in the scene.
- It can be set to track another Node's position, rotation and/or scale. It can update using either global or local coordinates.
+ RemoteTransform pushes its own [Transform] to another [Spatial] derived Node (called the remote node) in the scene.
+ It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates.
</description>
<tutorials>
</tutorials>
@@ -18,13 +18,13 @@
The [NodePath] to the remote node, relative to the RemoteTransform's position in the scene.
</member>
<member name="update_position" type="bool" setter="set_update_position" getter="get_update_position">
- If [code]true[/code] the remote node's position is tracked. Default value: [code]true[/code].
+ If [code]true[/code] the remote node's position is updated. Default value: [code]true[/code].
</member>
<member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation">
- If [code]true[/code] the remote node's rotation is tracked. Default value: [code]true[/code].
+ If [code]true[/code] the remote node's rotation is updated. Default value: [code]true[/code].
</member>
<member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale">
- If [code]true[/code] the remote node's scale is tracked. Default value: [code]true[/code].
+ If [code]true[/code] the remote node's scale is updated. Default value: [code]true[/code].
</member>
<member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates">
If [code]true[/code] global coordinates are used. If [code]false[/code] local coordinates are used. Default value: [code]true[/code].
diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml
index bc562dcdad..d83ec9f6b1 100644
--- a/doc/classes/RemoteTransform2D.xml
+++ b/doc/classes/RemoteTransform2D.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.1">
<brief_description>
- RemoteTransform2D leads the [Transform2D] of another [CanvasItem] derived Node in the scene.
+ RemoteTransform2D pushes its own [Transform2D] to another [CanvasItem] derived Node in the scene.
</brief_description>
<description>
- RemoteTransform2D leads the [Transform2D] of another [CanvasItem] derived Node (called the remote node) in the scene.
- It can be set to track another Node's position, rotation and/or scale. It can update using either global or local coordinates.
+ RemoteTransform2D pushes its own [Transform2D] to another [CanvasItem] derived Node (called the remote node) in the scene.
+ It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates.
</description>
<tutorials>
</tutorials>
@@ -18,13 +18,13 @@
The [NodePath] to the remote node, relative to the RemoteTransform2D's position in the scene.
</member>
<member name="update_position" type="bool" setter="set_update_position" getter="get_update_position">
- If [code]true[/code] the remote node's position is tracked. Default value: [code]true[/code].
+ If [code]true[/code] the remote node's position is updated. Default value: [code]true[/code].
</member>
<member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation">
- If [code]true[/code] the remote node's rotation is tracked. Default value: [code]true[/code].
+ If [code]true[/code] the remote node's rotation is updated. Default value: [code]true[/code].
</member>
<member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale">
- If [code]true[/code] the remote node's scale is tracked. Default value: [code]true[/code].
+ If [code]true[/code] the remote node's scale is updated. Default value: [code]true[/code].
</member>
<member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates">
If [code]true[/code] global coordinates are used. If [code]false[/code] local coordinates are used. Default value: [code]true[/code].
diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml
index 4fa60b2e44..7fd7b5deed 100644
--- a/doc/classes/Spatial.xml
+++ b/doc/classes/Spatial.xml
@@ -13,6 +13,12 @@
<demos>
</demos>
<methods>
+ <method name="force_update_transform">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="get_parent_spatial" qualifiers="const">
<return type="Spatial">
</return>
diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml
index 0e11d797e4..4ad575b67f 100644
--- a/doc/classes/SpriteFrames.xml
+++ b/doc/classes/SpriteFrames.xml
@@ -171,8 +171,6 @@
</method>
</methods>
<members>
- <member name="frames" type="Array" setter="_set_frames" getter="_get_frames">
- </member>
</members>
<constants>
</constants>
generated by cgit v1.2.3 (git 2.25.1) at 2025-01-05 20:36:08 +0000