diff options
Diffstat (limited to 'doc/classes')
28 files changed, 80 insertions, 34 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/ColorPicker.xml b/doc/classes/ColorPicker.xml index 4d52eacba8..554e6b5632 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -26,7 +26,7 @@ The currently selected color. </member> <member name="deferred_mode" type="bool" setter="set_deferred_mode" getter="is_deferred_mode"> - If [code]true[/code] the color will apply only after the user releases the mouse button, otherwise it will apply immediatly even in mouse motion event (which can cause performance issues). + If [code]true[/code] the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). </member> <member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha"> If [code]true[/code] shows an alpha channel slider (transparency). diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 6ac2911c11..8bc6d05bd4 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -4,7 +4,7 @@ Button that pops out a [ColorPicker]. </brief_description> <description> - Encapsulates a [ColorPicker] making it accesible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility. + Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility. </description> <tutorials> </tutorials> 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/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index bb3ff91639..9dd28d2400 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.1"> <brief_description> - A diretory for the resource filesystem. + A directory for the resource filesystem. </brief_description> <description> A more generalized, low-level variation of the directory concept. 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/Object.xml b/doc/classes/Object.xml index f4ad196ad2..fcd105d66b 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -185,7 +185,7 @@ </argument> <description> Get indexed object property by String. - Property indices get accessed with colon seperation, for example: [code]position:x[/code] + Property indices get accessed with colon separation, for example: [code]position:x[/code] </description> </method> <method name="get_instance_id" qualifiers="const"> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 120d80ba39..765e68a623 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -81,7 +81,7 @@ </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array. </description> </method> <method name="push_back"> diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index 0c93a565f5..021d5f5089 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -47,7 +47,7 @@ </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array. </description> </method> <method name="push_back"> diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 43cb5d77de..347dcb09f2 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -47,7 +47,7 @@ </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array. </description> </method> <method name="push_back"> diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index 0808b44104..c0c6ef8700 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -47,7 +47,7 @@ </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array. </description> </method> <method name="push_back"> diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index 9f6c4306cb..8b3ac4c16a 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -47,7 +47,7 @@ </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array. </description> </method> <method name="join"> diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index 072281158c..ecf8f5a6ba 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -47,7 +47,7 @@ </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array. </description> </method> <method name="push_back"> diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index 7aa5dfc090..456b54d209 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -47,7 +47,7 @@ </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array. </description> </method> <method name="push_back"> diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index df0519b2ad..090b626433 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -5,7 +5,7 @@ </brief_description> <description> ProceduralSky provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky. - The ProceduralSky is updated on the CPU after the parameters change and stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for realtime updates during gameplay. But with a small texture size it is still feasible to update relatively frequently becuase it is updated on a background thread when multi-threading is available. + The ProceduralSky is updated on the CPU after the parameters change and stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for realtime updates during gameplay. But with a small texture size it is still feasible to update relatively frequently because it is updated on a background thread when multi-threading is available. </description> <tutorials> </tutorials> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index ad8c5f68da..1bf2e6d83c 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -208,7 +208,7 @@ <member name="audio/output_latency" type="int" setter="" getter=""> </member> <member name="audio/video_delay_compensation_ms" type="int" setter="" getter=""> - Setting to harcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. + Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. </member> <member name="compression/formats/gzip/compression_level" type="int" setter="" getter=""> Default compression level for gzip. Affects compressed scenes and resources. 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/SceneTree.xml b/doc/classes/SceneTree.xml index 11362ee680..a447294fea 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -271,7 +271,7 @@ </member> <member name="multiplayer_poll" type="bool" setter="set_multiplayer_poll_enabled" getter="is_multiplayer_poll_enabled"> If [code]true[/code] (default) enable the automatic polling of the [MultiplayerAPI] for this SceneTree during [signal idle_frame]. - When [code]false[/code] you need to manually call [method MultiplayerAPI.poll] for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protecion when accessing the [MultiplayerAPI] from threads. + When [code]false[/code] you need to manually call [method MultiplayerAPI.poll] for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protection when accessing the [MultiplayerAPI] from threads. </member> <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 76049d8947..7f9a124683 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -24,7 +24,7 @@ <return type="int" enum="Shader.Mode"> </return> <description> - Returns the shader mode for the shader, eiter [code]MODE_CANVAS_ITEM[/code], [code]MODE_SPATIAL[/code] or [code]MODE_PARTICLES[/code] + Returns the shader mode for the shader, either [code]MODE_CANVAS_ITEM[/code], [code]MODE_SPATIAL[/code] or [code]MODE_PARTICLES[/code] </description> </method> <method name="has_param" qualifiers="const"> 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/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 5fc8e99ced..e1f1dcb8fa 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -78,7 +78,7 @@ A status representing a [code]StreamPeerTCP[/code] that is connected to a host. </constant> <constant name="STATUS_ERROR" value="3" enum="Status"> - A staus representing a [code]StreamPeerTCP[/code] in error state. + A status representing a [code]StreamPeerTCP[/code] in error state. </constant> </constants> </class> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 5c24df5be2..ae8bdace73 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -37,7 +37,7 @@ </description> </method> <method name="create_item"> - <return type="Object"> + <return type="TreeItem"> </return> <argument index="0" name="parent" type="Object" default="null"> </argument> |