diff options
Diffstat (limited to 'doc/classes')
146 files changed, 1572 insertions, 441 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index e31d815063..63b9ef13fd 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -92,7 +92,7 @@ <argument index="0" name="condition" type="bool"> </argument> <description> - Assert that the [code]condition[/code] is true. If the [code]condition[/code] is false a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always true. + Assert that the [code]condition[/code] is [code]true[/code] . If the [code]condition[/code] is [code]false[/code] a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always [code]true[/code]. [codeblock] # Speed should always be between 0 and 20 speed = -10 @@ -259,16 +259,12 @@ </description> </method> <method name="decimals"> - <return type="float"> + <return type="int"> </return> <argument index="0" name="step" type="float"> </argument> <description> - Returns the position of the first non-zero digit, after the decimal point. - [codeblock] - # n is 2 - n = decimals(0.035) - [/codeblock] + Deprecated alias for "[method step_decimals]". </description> </method> <method name="dectime"> @@ -498,6 +494,17 @@ [/codeblock] </description> </method> + <method name="is_equal_approx"> + <return type="bool"> + </return> + <argument index="0" name="a" type="float"> + </argument> + <argument index="1" name="b" type="float"> + </argument> + <description> + Returns True/False whether [code]a[/code] and [code]b[/code] are approximately equal to each other. + </description> + </method> <method name="is_inf"> <return type="bool"> </return> @@ -525,6 +532,15 @@ Returns whether [code]s[/code] is a NaN (Not-A-Number) value. </description> </method> + <method name="is_zero_approx"> + <return type="bool"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns True/False whether [code]s[/code] is zero or almost zero. + </description> + </method> <method name="len"> <return type="int"> </return> @@ -1003,6 +1019,23 @@ [/codeblock] </description> </method> + <method name="step_decimals"> + <return type="int"> + </return> + <argument index="0" name="step" type="float"> + </argument> + <description> + Returns the position of the first non-zero digit, after the decimal point. + [codeblock] + # n is 0 + n = step_decimals(5) + # n is 4 + n = step_decimals(1.0005) + # n is 9 + n = step_decimals(0.000000005) + [/codeblock] + </description> + </method> <method name="stepify"> <return type="float"> </return> diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index d1e2a9c910..760287e1b8 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -45,6 +45,8 @@ <member name="Marshalls" type="Reference" setter="" getter=""> [Marshalls] singleton </member> + <member name="NavigationMeshGenerator" type="EditorNavigationMeshGenerator" setter="" getter=""> + </member> <member name="OS" type="OS" setter="" getter=""> [OS] singleton </member> diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml index 092d5e2916..91f44151fa 100644 --- a/doc/classes/ARVRAnchor.xml +++ b/doc/classes/ARVRAnchor.xml @@ -22,7 +22,7 @@ <return type="bool"> </return> <description> - Returns true if the anchor is being tracked and false if no anchor with this id is currently known. + Returns [code]true[/code] if the anchor is being tracked and [code]false[/code] if no anchor with this id is currently known. </description> </method> <method name="get_mesh" qualifiers="const"> diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index bb03c50be9..11084fb98e 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -53,7 +53,7 @@ <return type="bool"> </return> <description> - Returns true if the current output of this interface is in stereo. + Returns [code]true[/code] if the current output of this interface is in stereo. </description> </method> <method name="uninitialize"> diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index b828d45cbe..6f5a76943f 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -54,7 +54,7 @@ <return type="int"> </return> <description> - Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. + Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns [code]true[/code]. </description> </method> <method name="get_interfaces" qualifiers="const"> diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 4adf515abc..db35b2f352 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -36,14 +36,14 @@ <return type="Label"> </return> <description> - Return the label used for built-in text. + Returns the label used for built-in text. </description> </method> <method name="get_ok"> <return type="Button"> </return> <description> - Return the OK Button. + Returns the OK Button. </description> </method> <method name="register_text_enter"> diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index a5202dc612..da85f91367 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -13,7 +13,7 @@ <return type="bool"> </return> <description> - Return true if an animation if currently being played. + Returns [code]true[/code] if an animation if currently being played. </description> </method> <method name="play"> @@ -61,6 +61,7 @@ If [code]true[/code], the [member animation] is currently playing. </member> <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> + The animation speed is multiplied by this value. </member> </members> <signals> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 1607a2e105..96196f7601 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -13,7 +13,7 @@ <return type="bool"> </return> <description> - Return true if an animation if currently being played. + Returns [code]true[/code] if an animation if currently being played. </description> </method> <method name="play"> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 23227c7404..9885f30883 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -263,14 +263,14 @@ <argument index="0" name="path" type="NodePath"> </argument> <description> - Return the index of the specified track. If the track is not found, return -1. + Returns the index of the specified track. If the track is not found, return -1. </description> </method> <method name="get_track_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of tracks in the animation. + Returns the amount of tracks in the animation. </description> </method> <method name="method_track_get_key_indices" qualifiers="const"> @@ -283,7 +283,7 @@ <argument index="2" name="delta" type="float"> </argument> <description> - Return all the key indices of a method track, given a position and delta time. + Returns all the key indices of a method track, given a position and delta time. </description> </method> <method name="method_track_get_name" qualifiers="const"> @@ -294,7 +294,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the method name of a method track. + Returns the method name of a method track. </description> </method> <method name="method_track_get_params" qualifiers="const"> @@ -305,7 +305,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the arguments values to be called on a method track for a given key in a given track. + Returns the arguments values to be called on a method track for a given key in a given track. </description> </method> <method name="remove_track"> @@ -345,7 +345,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the interpolation type of a given track, from the INTERPOLATION_* enum. + Returns the interpolation type of a given track, from the INTERPOLATION_* enum. </description> </method> <method name="track_get_key_count" qualifiers="const"> @@ -354,7 +354,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the amount of keys in a given track. + Returns the amount of keys in a given track. </description> </method> <method name="track_get_key_time" qualifiers="const"> @@ -365,7 +365,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the time at which the key is located. + Returns the time at which the key is located. </description> </method> <method name="track_get_key_transition" qualifiers="const"> @@ -376,7 +376,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the transition curve (easing) for a specific key (see built-in math function "ease"). + Returns the transition curve (easing) for a specific key (see built-in math function "ease"). </description> </method> <method name="track_get_key_value" qualifiers="const"> @@ -387,7 +387,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the value of a given key in a given track. + Returns the value of a given key in a given track. </description> </method> <method name="track_get_path" qualifiers="const"> @@ -438,7 +438,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return true if the given track is imported. Else, return false. + Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code]. </description> </method> <method name="track_move_down"> @@ -450,6 +450,17 @@ Move a track down. </description> </method> + <method name="track_move_to"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="to_idx" type="int"> + </argument> + <description> + Changes the index position of track [code]idx[/code] to the one defined in [code]to_idx[/code]. + </description> + </method> <method name="track_move_up"> <return type="void"> </return> @@ -571,6 +582,7 @@ <argument index="1" name="with_idx" type="int"> </argument> <description> + Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code]. </description> </method> <method name="transform_track_insert_key"> @@ -598,7 +610,7 @@ <argument index="1" name="time_sec" type="float"> </argument> <description> - Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]). + Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]). </description> </method> <method name="value_track_get_key_indices" qualifiers="const"> @@ -611,7 +623,7 @@ <argument index="2" name="delta" type="float"> </argument> <description> - Return all the key indices of a value track, given a position and delta time. + Returns all the key indices of a value track, given a position and delta time. </description> </method> <method name="value_track_get_update_mode" qualifiers="const"> @@ -620,7 +632,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the update mode of a value track. + Returns the update mode of a value track. </description> </method> <method name="value_track_set_update_mode"> diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 7ce4aae4fd..9854d4c27e 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -52,7 +52,7 @@ <argument index="5" name="optimize" type="bool" default="true"> </argument> <description> - Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. Time is a delta, unless "seek" is true, in which case it is absolute. A filter mode may be optionally passed. + Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. Time is a delta, unless "seek" is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed. </description> </method> <method name="blend_node"> @@ -144,7 +144,7 @@ <return type="String"> </return> <description> - Return true whether you want the blend tree editor to display filter editing on this node. + Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node. </description> </method> <method name="is_path_filtered" qualifiers="const"> @@ -153,7 +153,7 @@ <argument index="0" name="path" type="NodePath"> </argument> <description> - Return true wether a given path is filtered. + Returns [code]true[/code] whether a given path is filtered. </description> </method> <method name="process" qualifiers="virtual"> @@ -164,7 +164,7 @@ <argument index="1" name="seek" type="bool"> </argument> <description> - Called when a custom node is processed. The argument "time" is relative, unless "seek" is true (in which case it is absolute). + Called when a custom node is processed. The argument "time" is relative, unless "seek" is [code]true[/code] (in which case it is absolute). Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory. This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called). @@ -204,7 +204,7 @@ </methods> <members> <member name="filter_enabled" type="bool" setter="set_filter_enabled" getter="is_filter_enabled"> - Return whether filtering is enabled. + Returns whether filtering is enabled. </member> </members> <signals> diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index b80069095b..2834f83d2f 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -1,13 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AnimationNodeStateMachine" inherits="AnimationRootNode" category="Core" version="3.2"> <brief_description> + State machine for control of animations. </brief_description> <description> - Contains multiple root nodes as children in a graph. Each node is used as a state, and provides multiple functions to alternate between states. Retrieve the AnimationNodeStateMachinePlayback object from the [AnimationTree] node to control it programatically. - [codeblock] - var state_machine = anim_tree["parameters/StateMachine/playback"] - state_machine.travel("SomeState") + Contains multiple nodes representing animation states, connected in a graph. Nodes transitions can be configured to happen automatically or via code, using a shortest-path algorithm. Retrieve the AnimationNodeStateMachinePlayback object from the [AnimationTree] node to control it programatically. Example: [codeblock] + var state_machine = $AnimationTree.get("parameters/playback") + state_machine.travel("some_state") + [/codeblock] </description> <tutorials> </tutorials> @@ -22,6 +23,7 @@ <argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> + Adds a new node to the graph. The [code]position[/code] is used for display in the editor. </description> </method> <method name="add_transition"> @@ -34,18 +36,21 @@ <argument index="2" name="transition" type="AnimationNodeStateMachineTransition"> </argument> <description> + Adds a transition between the given nodes. </description> </method> <method name="get_end_node" qualifiers="const"> <return type="String"> </return> <description> + Returns the graph's end node. </description> </method> <method name="get_graph_offset" qualifiers="const"> <return type="Vector2"> </return> <description> + Returns the draw offset of the graph. Used for display in the editor. </description> </method> <method name="get_node" qualifiers="const"> @@ -54,6 +59,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the animation node with the given name. </description> </method> <method name="get_node_name" qualifiers="const"> @@ -62,6 +68,7 @@ <argument index="0" name="node" type="AnimationNode"> </argument> <description> + Returns the given animation node's name. </description> </method> <method name="get_node_position" qualifiers="const"> @@ -70,12 +77,14 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the given node's coordinates. Used for display in the editor. </description> </method> <method name="get_start_node" qualifiers="const"> <return type="String"> </return> <description> + Returns the graph's end node. </description> </method> <method name="get_transition" qualifiers="const"> @@ -84,12 +93,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the given transition. </description> </method> <method name="get_transition_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of connections in the graph. </description> </method> <method name="get_transition_from" qualifiers="const"> @@ -98,6 +109,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the given transition's start node. </description> </method> <method name="get_transition_to" qualifiers="const"> @@ -106,6 +118,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the given transition's end node. </description> </method> <method name="has_node" qualifiers="const"> @@ -114,6 +127,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns [code]true[/code] if the graph contains the given node. </description> </method> <method name="has_transition" qualifiers="const"> @@ -124,6 +138,7 @@ <argument index="1" name="to" type="String"> </argument> <description> + Returns [code]true[/code] if there is a transition between the given nodes. </description> </method> <method name="remove_node"> @@ -132,6 +147,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Deletes the given node from the graph. </description> </method> <method name="remove_transition"> @@ -142,6 +158,7 @@ <argument index="1" name="to" type="String"> </argument> <description> + Deletes the given transition. </description> </method> <method name="remove_transition_by_index"> @@ -150,6 +167,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Deletes the given transition. </description> </method> <method name="rename_node"> @@ -160,6 +178,7 @@ <argument index="1" name="new_name" type="String"> </argument> <description> + Renames the given node. </description> </method> <method name="set_end_node"> @@ -168,6 +187,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Sets the given node as the graph end point. </description> </method> <method name="set_graph_offset"> @@ -176,6 +196,7 @@ <argument index="0" name="offset" type="Vector2"> </argument> <description> + Sets the draw offset of the graph. Used for display in the editor. </description> </method> <method name="set_node_position"> @@ -186,6 +207,7 @@ <argument index="1" name="position" type="Vector2"> </argument> <description> + Sets the node's coordinates. Used for display in the editor. </description> </method> <method name="set_start_node"> @@ -194,6 +216,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Sets the given node as the graph start point. </description> </method> </methods> diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index fd38c28b16..796d92d7d6 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -1,8 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AnimationNodeStateMachinePlayback" inherits="Resource" category="Core" version="3.2"> <brief_description> + Playback control for AnimationNodeStateMachine. </brief_description> <description> + Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code]. Example: + [codeblock] + var state_machine = $AnimationTree.get("parameters/playback") + state_machine.travel("some_state") + [/codeblock] </description> <tutorials> </tutorials> @@ -11,6 +17,7 @@ <return type="String"> </return> <description> + Returns the currently playing animation state. </description> </method> <method name="get_travel_path" qualifiers="const"> @@ -23,6 +30,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if an animation is playing. </description> </method> <method name="start"> @@ -31,12 +39,14 @@ <argument index="0" name="node" type="String"> </argument> <description> + Starts playing the given animation. </description> </method> <method name="stop"> <return type="void"> </return> <description> + Stops the currently playing animation. </description> </method> <method name="travel"> @@ -45,7 +55,7 @@ <argument index="0" name="to_node" type="String"> </argument> <description> - Transition from the current state to another one, while visiting all the intermediate ones. This is done via the A* algorithm. + Transitions from the current state to another one, following the shortest path. </description> </method> </methods> diff --git a/doc/classes/AnimationNodeStateMachineTransition.xml b/doc/classes/AnimationNodeStateMachineTransition.xml index a21ee50949..aeb44a789b 100644 --- a/doc/classes/AnimationNodeStateMachineTransition.xml +++ b/doc/classes/AnimationNodeStateMachineTransition.xml @@ -10,7 +10,10 @@ </methods> <members> <member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition"> - Turn on auto advance when this condition is set. This is a custom text field that can be filled with a variable name. The variable can be modified from code. + Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to "idle": + [codeblock] + $animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0 + [/codeblock] </member> <member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance"> Turn on the transition automatically when this state is reached. This works best with [code]SWITCH_MODE_AT_END[/code]. diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 509285cdb8..5ea993f83d 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -142,7 +142,7 @@ <argument index="3" name="from_end" type="bool" default="false"> </argument> <description> - Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. + Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being [code]true[/code] can play the animation backwards. If the animation has been paused by [code]stop(true)[/code] it will be resumed. Calling [code]play()[/code] without arguments will also resume the animation. </description> </method> diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index 6160b44076..818565e0dc 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -256,7 +256,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Return the input count for a given node. Different types of nodes have different amount of inputs. + Returns the input count for a given node. Different types of nodes have different amount of inputs. </description> </method> <method name="node_get_input_source" qualifiers="const"> @@ -267,7 +267,7 @@ <argument index="1" name="idx" type="int"> </argument> <description> - Return the input source for a given node input. + Returns the input source for a given node input. </description> </method> <method name="node_get_position" qualifiers="const"> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 2400efe0d3..8d28ddc889 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -15,7 +15,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. + Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -24,7 +24,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. + Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. </description> </method> <method name="get_overlapping_areas" qualifiers="const"> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 73ca6ab5b3..75194fbf76 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -103,7 +103,7 @@ <argument index="1" name="before" type="bool" default="True"> </argument> <description> - Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. </description> </method> <method name="bsearch_custom"> @@ -118,7 +118,7 @@ <argument index="3" name="before" type="bool" default="True"> </argument> <description> - Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. </description> </method> <method name="clear"> @@ -291,7 +291,7 @@ </method> <method name="shuffle"> <description> - Shuffles the array such that the items will have a random order. + Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as [method @GDScript.randi]. Call [method @GDScript.randomize] to ensure that a new seed will be used each time if you want non-reproducible shuffling. </description> </method> <method name="size"> @@ -312,7 +312,7 @@ <argument index="1" name="func" type="String"> </argument> <description> - Sorts the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. + Sorts the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise. [b]Note:[/b] you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. [codeblock] class MyCustomSorter: diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 00bd72d4a5..1707ea07e0 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -98,7 +98,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Return the index of the first surface with this name held within this [ArrayMesh]. If none are found -1 is returned. + Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found -1 is returned. </description> </method> <method name="surface_get_array_index_len" qualifiers="const"> @@ -107,7 +107,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). + Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_array_len" qualifiers="const"> @@ -116,7 +116,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). + Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_format" qualifiers="const"> @@ -125,7 +125,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the format mask of the requested surface (see [method add_surface_from_arrays]). + Returns the format mask of the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_name" qualifiers="const"> @@ -143,7 +143,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the primitive type of the requested surface (see [method add_surface_from_arrays]). + Returns the primitive type of the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_remove"> @@ -205,31 +205,31 @@ Amount of weights/bone indices per vertex (always 4). </constant> <constant name="ARRAY_VERTEX" value="0" enum="ArrayType"> - Vertex array (array of [Vector3] vertices). + [PoolVector3Array], [PoolVector2Array], or [Array] of vertex positions. </constant> <constant name="ARRAY_NORMAL" value="1" enum="ArrayType"> - Normal array (array of [Vector3] normals). + [PoolVector3Array] of vertex normals. </constant> <constant name="ARRAY_TANGENT" value="2" enum="ArrayType"> - Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. + [PoolRealArray] of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. </constant> <constant name="ARRAY_COLOR" value="3" enum="ArrayType"> - Vertex array (array of [Color] colors). + [PoolColorArray] of vertex colors. </constant> <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> - UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). + [PoolVector2Array] for UV coordinates. </constant> <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> - Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). + [PoolVector2Array] for second UV coordinates. </constant> <constant name="ARRAY_BONES" value="6" enum="ArrayType"> - Array of bone indices, as a float array. Each element in groups of 4 floats. + [PoolRealArray] or [PoolIntArray] of bone indices. Each element in groups of 4 floats. </constant> <constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType"> - Array of bone weights, as a float array. Each element in groups of 4 floats. + [PoolRealArray] of bone weights. Each element in groups of 4 floats. </constant> <constant name="ARRAY_INDEX" value="8" enum="ArrayType"> - [Array] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. + [PoolIntArray] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line. </constant> <constant name="ARRAY_MAX" value="9" enum="ArrayType"> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 83fbd28152..6dc1600cf2 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -184,6 +184,12 @@ Returns the sample rate at the output of the audioserver. </description> </method> + <method name="get_output_latency" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_speaker_mode" qualifiers="const"> <return type="int" enum="AudioServer.SpeakerMode"> </return> @@ -191,6 +197,18 @@ Returns the speaker configuration. </description> </method> + <method name="get_time_since_last_mix" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_time_to_next_mix" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="is_bus_bypassing_effects" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 6083372b72..2bd3ac1eaa 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -60,7 +60,7 @@ Amount how much the filter affects the loudness, in dB. </member> <member name="attenuation_model" type="int" setter="set_attenuation_model" getter="get_attenuation_model" enum="AudioStreamPlayer3D.AttenuationModel"> - Decides if audio should get quieter with distance linearly, quadratically or logarithmically. + Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation. </member> <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled"> If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code]. @@ -124,6 +124,9 @@ <constant name="ATTENUATION_LOGARITHMIC" value="2" enum="AttenuationModel"> Logarithmic dampening of loudness according to distance. </constant> + <constant name="ATTENUATION_DISABLED" value="3" enum="AttenuationModel"> + No dampening of loudness according to distance. + </constant> <constant name="OUT_OF_RANGE_MIX" value="0" enum="OutOfRangeMode"> Mix this audio in, even when it's out of range. </constant> diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 3c8d4ea0d8..6d1a7a8f87 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -29,14 +29,14 @@ <return type="int" enum="BaseButton.DrawMode"> </return> <description> - Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. + Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. </description> </method> <method name="is_hovered" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the mouse has entered the button and has not left it yet. + Returns [code]true[/code] if the mouse has entered the button and has not left it yet. </description> </method> </methods> @@ -57,6 +57,9 @@ <member name="group" type="ButtonGroup" setter="set_button_group" getter="get_button_group"> [ButtonGroup] associated to the button. </member> + <member name="keep_pressed_outside" type="bool" setter="set_keep_pressed_outside" getter="is_keep_pressed_outside"> + If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it. Default value: [code]false[/code]. + </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). </member> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index cee3035eab..ae7a3ff323 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -57,7 +57,7 @@ <return type="float"> </return> <description> - Return the determinant of the matrix. + Returns the determinant of the matrix. </description> </method> <method name="get_euler"> @@ -91,7 +91,7 @@ <return type="Basis"> </return> <description> - Return the inverse of the matrix. + Returns the inverse of the matrix. </description> </method> <method name="is_equal_approx"> @@ -108,7 +108,7 @@ <return type="Basis"> </return> <description> - Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. + Returns the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. </description> </method> <method name="rotated"> @@ -173,7 +173,7 @@ <return type="Basis"> </return> <description> - Return the transposed version of the matrix. + Returns the transposed version of the matrix. </description> </method> <method name="xform"> @@ -182,7 +182,7 @@ <argument index="0" name="v" type="Vector3"> </argument> <description> - Return a vector transformed (multiplied) by the matrix. + Returns a vector transformed (multiplied) by the matrix. </description> </method> <method name="xform_inv"> @@ -191,7 +191,7 @@ <argument index="0" name="v" type="Vector3"> </argument> <description> - Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. + Returns a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. </description> </method> </methods> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 2e4aaed099..7f03c22b70 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -15,7 +15,7 @@ <argument index="0" name="size" type="Vector2"> </argument> <description> - Creates a bitmap with the specified size, filled with false. + Creates a bitmap with the specified size, filled with [code]false[/code]. </description> </method> <method name="create_from_image_alpha"> @@ -26,7 +26,7 @@ <argument index="1" name="threshold" type="float" default="0.1"> </argument> <description> - Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and true in other case. + Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to [code]false[/code] if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and [code]true[/code] in other case. </description> </method> <method name="get_bit" qualifiers="const"> @@ -49,7 +49,7 @@ <return type="int"> </return> <description> - Returns the amount of bitmap elements that are set to true. + Returns the amount of bitmap elements that are set to [code]true[/code]. </description> </method> <method name="grow_mask"> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index 2716bee0f3..bbe85b81cc 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -15,7 +15,14 @@ <argument index="0" name="enable_next" type="bool" default="true"> </argument> <description> - If this is the current Camera, remove it from being current. If [code]enable_next[/code] is true, request to make the next Camera current, if any. + If this is the current Camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next Camera current, if any. + </description> + </method> + <method name="get_camera_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + Returns the camera's RID from the [VisualServer]. </description> </method> <method name="get_camera_transform" qualifiers="const"> @@ -101,6 +108,20 @@ <description> </description> </method> + <method name="set_frustum"> + <return type="void"> + </return> + <argument index="0" name="size" type="float"> + </argument> + <argument index="1" name="offset" type="Vector2"> + </argument> + <argument index="2" name="z_near" type="float"> + </argument> + <argument index="3" name="z_far" type="float"> + </argument> + <description> + </description> + </method> <method name="set_orthogonal"> <return type="void"> </return> @@ -156,6 +177,8 @@ <member name="fov" type="float" setter="set_fov" getter="get_fov"> The camera's field of view angle (in degrees). Only applicable in perspective mode. Since [member keep_aspect] locks one axis, [code]fov[/code] sets the other axis' field of view angle. </member> + <member name="frustum_offset" type="Vector2" setter="set_frustum_offset" getter="get_frustum_offset"> + </member> <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> The horizontal (X) offset of the Camera viewport. </member> @@ -180,7 +203,9 @@ Perspective Projection (object's size on the screen becomes smaller when far away). </constant> <constant name="PROJECTION_ORTHOGONAL" value="1" enum="Projection"> - Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). + Orthogonal Projection (objects remain the same size on the screen no matter how far away they are; also known as orthographic projection). + </constant> + <constant name="PROJECTION_FRUSTUM" value="2" enum="Projection"> </constant> <constant name="KEEP_WIDTH" value="0" enum="KeepAspect"> Preserves the horizontal aspect ratio. diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index e5d1649c29..fcc99123d2 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -35,7 +35,7 @@ <return type="Vector2"> </return> <description> - Return the camera position. + Returns the camera position. </description> </method> <method name="get_camera_screen_center" qualifiers="const"> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index f3e598c17d..2426471a49 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -4,10 +4,10 @@ Base class of anything 2D. </brief_description> <description> - Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related. - Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though. - Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). - Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. + Base class of anything 2D. Canvas items are laid out in a tree; children inherit and extend their parent's transform. CanvasItem is extended by [Control] for anything GUI-related, and by [Node2D] for anything related to the 2D engine. + Any CanvasItem can draw. For this, [method update] must be called, then [constant NOTIFICATION_DRAW] will be received on idle time to request redraw. Because of this, canvas items don't need to be redrawn on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see [code]draw_*[/code] functions). However, they can only be used inside the [method Object._notification], signal or [method _draw] virtual functions. + Canvas items are drawn in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything. This behavior can be changed on a per-item basis. + A CanvasItem can also be hidden, which will also hide its children. It provides many ways to change parameters such as modulation (for itself and its children) and self modulation (only for itself), as well as its blend mode. Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed. </description> <tutorials> @@ -36,7 +36,7 @@ <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> <description> - Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. + Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character. </description> </method> <method name="draw_circle"> @@ -97,6 +97,10 @@ </argument> <argument index="2" name="normal_map" type="Texture" default="null"> </argument> + <argument index="3" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> + </argument> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> <description> </description> </method> @@ -112,7 +116,7 @@ <argument index="3" name="antialiased" type="bool" default="false"> </argument> <description> - Draws multiple, parallel lines with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. + Draws multiple, parallel lines with a uniform [code]color[/code]. [code]width[/code] and [code]antialiased[/code] are currently not implemented and have no effect. </description> </method> <method name="draw_multiline_colors"> @@ -207,7 +211,7 @@ <argument index="5" name="normal_map" type="Texture" default="null"> </argument> <description> - Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. + Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. </description> </method> <method name="draw_rect"> @@ -304,7 +308,7 @@ <argument index="5" name="normal_map" type="Texture" default="null"> </argument> <description> - Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. + Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. </description> </method> <method name="draw_texture_rect_region"> @@ -325,7 +329,7 @@ <argument index="6" name="clip_uv" type="bool" default="true"> </argument> <description> - 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. + Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. </description> </method> <method name="force_update_transform"> @@ -338,14 +342,14 @@ <return type="RID"> </return> <description> - Return the [RID] of the [World2D] canvas where this item is in. + Returns the [RID] of the [World2D] canvas where this item is in. </description> </method> <method name="get_canvas_item" qualifiers="const"> <return type="RID"> </return> <description> - Return the canvas item RID used by [VisualServer] for this item. + Returns the canvas item RID used by [VisualServer] for this item. </description> </method> <method name="get_canvas_transform" qualifiers="const"> @@ -415,7 +419,7 @@ <return type="void"> </return> <description> - Hide the CanvasItem currently visible. + Hide the CanvasItem if it's currently visible. </description> </method> <method name="is_local_transform_notification_enabled" qualifiers="const"> @@ -429,7 +433,7 @@ <return type="bool"> </return> <description> - Return if set as toplevel. See [method set_as_toplevel]. + Returns [code]true[/code] if the node is set as top-level. See [method set_as_toplevel]. </description> </method> <method name="is_transform_notification_enabled" qualifiers="const"> @@ -470,7 +474,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Sets as top level. This means that it will not inherit transform from parent canvas items. + If [code]enable[/code] is [code]true[/code], the node won't inherit its transform from parent canvas items. </description> </method> <method name="set_notify_local_transform"> @@ -495,14 +499,14 @@ <return type="void"> </return> <description> - Show the CanvasItem currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple popup*() functions instead. + Show the CanvasItem if it's currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead. </description> </method> <method name="update"> <return type="void"> </return> <description> - Queue the CanvasItem for update. [code]NOTIFICATION_DRAW[/code] will be called on idle time to request redraw. + Queue the CanvasItem for update. [constant NOTIFICATION_DRAW] will be called on idle time to request redraw. </description> </method> </methods> @@ -529,7 +533,7 @@ If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. Default value: [code]false[/code]. </member> <member name="visible" type="bool" setter="set_visible" getter="is_visible"> - If [code]true[/code], this [CanvasItem] is drawn. Default value: [code]true[/code]. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple popup*() functions instead. + If [code]true[/code], this [CanvasItem] is drawn. Default value: [code]true[/code]. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead. </member> </members> <signals> @@ -571,22 +575,22 @@ Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. </constant> <constant name="BLEND_MODE_DISABLED" value="5" enum="BlendMode"> - Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied. + Disable blending mode. Colors including alpha are written as-is. Only applicable for render targets with a transparent background. No lighting will be applied. </constant> <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="2000"> - Canvas item transform has changed. Notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform]. + The CanvasItem's transform has changed. This notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform]. </constant> <constant name="NOTIFICATION_DRAW" value="30"> - CanvasItem is requested to draw. + The CanvasItem is requested to draw. </constant> <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31"> - Canvas item visibility has changed. + The CanvasItem's visibility has changed. </constant> <constant name="NOTIFICATION_ENTER_CANVAS" value="32"> - Canvas item has entered the canvas. + The CanvasItem has entered the canvas. </constant> <constant name="NOTIFICATION_EXIT_CANVAS" value="33"> - Canvas item has exited the canvas. + The CanvasItem has exited the canvas. </constant> </constants> </class> diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index 94e4eececd..04344c1834 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -41,8 +41,12 @@ </theme_item> <theme_item name="off" type="Texture"> </theme_item> + <theme_item name="off_disabled" type="Texture"> + </theme_item> <theme_item name="on" type="Texture"> </theme_item> + <theme_item name="on_disabled" type="Texture"> + </theme_item> <theme_item name="pressed" type="StyleBox"> </theme_item> </theme_items> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index a37dd28d72..ddbe66380a 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -15,7 +15,7 @@ <argument index="0" name="class" type="String"> </argument> <description> - Returns true if you can instance objects from the specified 'class', false in other case. + Returns [code]true[/code] if you can instance objects from the specified 'class', [code]false[/code] in other case. </description> </method> <method name="class_exists" qualifiers="const"> @@ -66,7 +66,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a [Dictionary] with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). + Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). </description> </method> <method name="class_get_property" qualifiers="const"> @@ -88,7 +88,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false. + Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is [code]false[/code]. </description> </method> <method name="class_get_signal" qualifiers="const"> @@ -110,7 +110,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a [Dictionary] as described in [method class_get_signal]. + Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal]. </description> </method> <method name="class_has_integer_constant" qualifiers="const"> @@ -121,7 +121,7 @@ <argument index="1" name="name" type="String"> </argument> <description> - Return whether 'class' or its ancestry has an integer constant called 'name' or not. + Returns whether 'class' or its ancestry has an integer constant called 'name' or not. </description> </method> <method name="class_has_method" qualifiers="const"> @@ -134,7 +134,7 @@ <argument index="2" name="no_inheritance" type="bool" default="false"> </argument> <description> - Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. + Returns whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. </description> </method> <method name="class_has_signal" qualifiers="const"> @@ -145,7 +145,7 @@ <argument index="1" name="signal" type="String"> </argument> <description> - Return whether 'class' or its ancestry has a signal called 'signal' or not. + Returns whether 'class' or its ancestry has a signal called 'signal' or not. </description> </method> <method name="class_set_property" qualifiers="const"> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 1467812e4d..f847893a39 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -215,7 +215,7 @@ </methods> <members> <member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable"> - If [code]true[/code], this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. + If [code]true[/code], this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one [code]collision_layer[/code] bit to be set. </member> </members> <signals> @@ -227,17 +227,17 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> - Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. See [method _input_event] for details. + Emitted when an input event occurs. Requires [code]input_pickable[/code] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. See [method _input_event] for details. </description> </signal> <signal name="mouse_entered"> <description> - Emitted when the mouse pointer enters any of this object's shapes. + Emitted when the mouse pointer enters any of this object's shapes. Requires [code]input_pickable[/code] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. </description> </signal> <signal name="mouse_exited"> <description> - Emitted when the mouse pointer exits all this object's shapes. + Emitted when the mouse pointer exits all this object's shapes. Requires [code]input_pickable[/code] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. </description> </signal> </signals> diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml index c40c8a82c3..85eb17cae7 100644 --- a/doc/classes/CollisionPolygon.xml +++ b/doc/classes/CollisionPolygon.xml @@ -15,7 +15,7 @@ Length that the resulting collision extends in either direction perpendicular to its polygon. </member> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> - If true, no collision will be produced. + If [code]true[/code], no collision will be produced. </member> <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> Array of vertices which define the polygon. Note that the returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 9f48f6e018..ab5d7a0a5d 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -566,6 +566,8 @@ </constant> <constant name="tomato" value="Color( 1, 0.39, 0.28, 1 )"> </constant> + <constant name="transparent" value="Color( 1, 1, 1, 0 )"> + </constant> <constant name="turquoise" value="Color( 0.25, 0.88, 0.82, 1 )"> </constant> <constant name="violet" value="Color( 0.93, 0.51, 0.93, 1 )"> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index d0a81ad8ae..32e6014c75 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -31,7 +31,7 @@ <return type="PoolColorArray"> </return> <description> - Return the list of colors in the presets of the color picker. + Returns the list of colors in the presets of the color picker. </description> </method> </methods> @@ -45,6 +45,10 @@ <member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha"> If [code]true[/code], shows an alpha channel slider (transparency). </member> + <member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled"> + </member> + <member name="presets_visible" type="bool" setter="set_presets_visible" getter="are_presets_visible"> + </member> <member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode"> If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). </member> diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml index afc6ce74a5..62d42f4eb4 100644 --- a/doc/classes/ConcavePolygonShape.xml +++ b/doc/classes/ConcavePolygonShape.xml @@ -13,7 +13,7 @@ <return type="PoolVector3Array"> </return> <description> - Return the faces (an array of triangles). + Returns the faces (an array of triangles). </description> </method> <method name="set_faces"> diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index f39915f4b7..6124bc29b0 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -13,7 +13,7 @@ <return type="Button"> </return> <description> - Return the cancel button. + Returns the cancel button. </description> </method> </methods> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 224efeb3f5..22061322c8 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -221,7 +221,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return null if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. + Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns null if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. [codeblock] extends Control @@ -512,7 +512,7 @@ </return> <argument index="0" name="preset" type="int" enum="Control.LayoutPreset"> </argument> - <argument index="1" name="keep_margin" type="bool" default="false"> + <argument index="1" name="keep_margins" type="bool" default="false"> </argument> <description> </description> @@ -574,6 +574,16 @@ Sets [member margin_right] and [member margin_bottom] at the same time. </description> </method> + <method name="set_global_position"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <argument index="1" name="keep_margins" type="bool" default="false"> + </argument> + <description> + </description> + </method> <method name="set_margins_preset"> <return type="void"> </return> @@ -586,6 +596,16 @@ <description> </description> </method> + <method name="set_position"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <argument index="1" name="keep_margins" type="bool" default="false"> + </argument> + <description> + </description> + </method> <method name="set_rotation"> <return type="void"> </return> @@ -595,6 +615,16 @@ Sets the rotation (in radians). </description> </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <argument index="1" name="keep_margins" type="bool" default="false"> + </argument> + <description> + </description> + </method> <method name="show_modal"> <return type="void"> </return> @@ -682,7 +712,7 @@ Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Also controls whether the control can receive the [signal mouse_entered], and [signal mouse_exited] signals. See the constants to learn what each does. </member> <member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents"> - Enables whether rendering of children should be clipped to this control's rectangle. If true, parts of a child which would be visibly outside of this control's rectangle will not be rendered. + Enables whether rendering of children should be clipped to this control's rectangle. If [code]true[/code], parts of a child which would be visibly outside of this control's rectangle will not be rendered. </member> <member name="rect_global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> The node's global position, relative to the world (usually to the top-left corner of the window). diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index d4aaa24b8c..3631711a8f 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -122,7 +122,7 @@ </argument> <description> Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve. - To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to true, or linear if set to false. + To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). </description> </method> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 1d9761407d..7fda8aaa93 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -146,7 +146,7 @@ </argument> <description> Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve. - To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to true, or linear if set to false. + To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). </description> </method> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index b0a3b1ac75..ec70fd311b 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -38,7 +38,7 @@ <return type="bool"> </return> <description> - Return true if the dictionary is empty. + Returns [code]true[/code] if the dictionary is empty. </description> </method> <method name="erase"> @@ -47,7 +47,7 @@ <argument index="0" name="key" type="Variant"> </argument> <description> - Erase a dictionary key/value pair by key. Do not erase elements while iterating over the dictionary. + Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. Do not erase elements while iterating over the dictionary. </description> </method> <method name="get"> @@ -67,7 +67,7 @@ <argument index="0" name="key" type="Variant"> </argument> <description> - Return true if the dictionary has a given key. + Returns [code]true[/code] if the dictionary has a given key. </description> </method> <method name="has_all"> @@ -76,35 +76,35 @@ <argument index="0" name="keys" type="Array"> </argument> <description> - Return true if the dictionary has all of the keys in the given array. + Returns [code]true[/code] if the dictionary has all of the keys in the given array. </description> </method> <method name="hash"> <return type="int"> </return> <description> - Return a hashed integer value representing the dictionary contents. + Returns a hashed integer value representing the dictionary contents. </description> </method> <method name="keys"> <return type="Array"> </return> <description> - Return the list of keys in the [Dictionary]. + Returns the list of keys in the [Dictionary]. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the size of the dictionary (in pairs). + Returns the size of the dictionary (in pairs). </description> </method> <method name="values"> <return type="Array"> </return> <description> - Return the list of values in the [Dictionary]. + Returns the list of values in the [Dictionary]. </description> </method> </methods> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index 8a81695198..54aac33652 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -52,7 +52,7 @@ <return type="bool"> </return> <description> - Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). + Returns whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). </description> </method> <method name="dir_exists"> @@ -61,7 +61,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. + Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. </description> </method> <method name="file_exists"> @@ -70,14 +70,14 @@ <argument index="0" name="path" type="String"> </argument> <description> - Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. + Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. </description> </method> <method name="get_current_dir"> <return type="String"> </return> <description> - Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). + Returns the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). </description> </method> <method name="get_current_drive"> @@ -107,7 +107,7 @@ <return type="String"> </return> <description> - Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]). + Returns the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case). </description> </method> @@ -155,7 +155,7 @@ </argument> <description> Create a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. - Return one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). + Returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). </description> </method> <method name="open"> @@ -175,7 +175,7 @@ </argument> <description> Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. - Return one of the error code constants defined in [@GlobalScope] (OK or FAILED). + Returns one of the error code constants defined in [@GlobalScope] (OK or FAILED). </description> </method> <method name="rename"> @@ -187,7 +187,7 @@ </argument> <description> Rename (move) the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. - Return one of the error code constants defined in [@GlobalScope] (OK or FAILED). + Returns one of the error code constants defined in [@GlobalScope] (OK or FAILED). </description> </method> </methods> diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index 99ba5143e3..5fdc1ebb75 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -5,6 +5,12 @@ </brief_description> <description> DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths. + [codeblock] + var dynamic_font = DynamicFont.new() + dynamic_font.font_data = load("res://BarlowCondensed-Bold.ttf") + dynamic_font.size = 64 + $"Label".set("custom_fonts/font", dynamic_font) + [/codeblock] </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index 998b05d495..4e4e29dc4e 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -21,6 +21,12 @@ <description> </description> </method> + <method name="_export_end" qualifiers="virtual"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="_export_file" qualifiers="virtual"> <return type="void"> </return> diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index f110183081..1c7a68fc0b 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -38,14 +38,14 @@ <return type="float"> </return> <description> - Return the scan progress for 0 to 1 if the FS is being scanned. + Returns the scan progress for 0 to 1 if the FS is being scanned. </description> </method> <method name="is_scanning" qualifiers="const"> <return type="bool"> </return> <description> - Return true of the filesystem is being scanned. + Returns [code]true[/code] of the filesystem is being scanned. </description> </method> <method name="scan"> diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index 49efee49f4..c2b13ff89e 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -1,8 +1,16 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorInspectorPlugin" inherits="Reference" category="Core" version="3.2"> <brief_description> + Plugin for adding custom property editors on inspector. </brief_description> <description> + This plugins allows adding custom property editors to [EditorInspector]. + Plugins are registered via [method EditorPlugin.add_inspector_plugin]. + When an object is edited, the [method can_handle] function is called and must return true if the object type is supported. + If supported, the function [method parse_begin] will be called, allowing to place custom controls at the beginning of the class. + Subsequently, the [method parse_category] and [method parse_property] are called for every category and property. They offer the ability to add custom controls to the inspector too. + Finally [method parse_end] will be called. + On each of these calls, the "add" functions can be called. </description> <tutorials> </tutorials> @@ -13,6 +21,7 @@ <argument index="0" name="control" type="Control"> </argument> <description> + Add a custom control, not necessarily a property editor. </description> </method> <method name="add_property_editor"> @@ -23,6 +32,7 @@ <argument index="1" name="editor" type="Control"> </argument> <description> + Add a property editor, this must inherit [EditorProperty]. </description> </method> <method name="add_property_editor_for_multiple_properties"> @@ -35,6 +45,7 @@ <argument index="2" name="editor" type="Control"> </argument> <description> + Add am editor that allows modifying multiple properties, this must inherit [EditorProperty]. </description> </method> <method name="can_handle" qualifiers="virtual"> @@ -43,6 +54,7 @@ <argument index="0" name="object" type="Object"> </argument> <description> + Returns true if this object can be handled by this plugin. </description> </method> <method name="parse_begin" qualifiers="virtual"> @@ -51,6 +63,7 @@ <argument index="0" name="object" type="Object"> </argument> <description> + Called to allow adding controls at the beginning of the list. </description> </method> <method name="parse_category" qualifiers="virtual"> @@ -61,12 +74,14 @@ <argument index="1" name="category" type="String"> </argument> <description> + Called to allow adding controls at the beginning of the category. </description> </method> <method name="parse_end" qualifiers="virtual"> <return type="void"> </return> <description> + Called to allow adding controls at the end of the list. </description> </method> <method name="parse_property" qualifiers="virtual"> @@ -85,6 +100,7 @@ <argument index="5" name="usage" type="int"> </argument> <description> + Called to allow adding property specific editors to the inspector. Usually these inherit [EditorProperty] </description> </method> </methods> diff --git a/doc/classes/EditorNavigationMeshGenerator.xml b/doc/classes/EditorNavigationMeshGenerator.xml new file mode 100644 index 0000000000..3956e12509 --- /dev/null +++ b/doc/classes/EditorNavigationMeshGenerator.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorNavigationMeshGenerator" inherits="Object" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="bake"> + <return type="void"> + </return> + <argument index="0" name="nav_mesh" type="NavigationMesh"> + </argument> + <argument index="1" name="root_node" type="Node"> + </argument> + <description> + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <argument index="0" name="nav_mesh" type="NavigationMesh"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 829563c8ac..97ad4f6829 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -241,7 +241,7 @@ <return type="EditorInterface"> </return> <description> - Return the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. + Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. </description> </method> <method name="get_plugin_icon" qualifiers="virtual"> @@ -292,14 +292,14 @@ <argument index="0" name="object" type="Object"> </argument> <description> - Implement this function if your plugin edits a specific type of object (Resource or Node). If you return true, then you will get the functions [method EditorPlugin.edit] and [method EditorPlugin.make_visible] called when the editor requests them. If you have declared the methods [method forward_canvas_gui_input] and [method forward_spatial_gui_input] these will be called too. + Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method EditorPlugin.edit] and [method EditorPlugin.make_visible] called when the editor requests them. If you have declared the methods [method forward_canvas_gui_input] and [method forward_spatial_gui_input] these will be called too. </description> </method> <method name="has_main_screen" qualifiers="virtual"> <return type="bool"> </return> <description> - Return true if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). + Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). </description> </method> <method name="hide_bottom_panel"> @@ -471,6 +471,7 @@ <return type="int"> </return> <description> + Updates the overlays of the editor (2D/3D) viewport. </description> </method> </methods> diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 2fd7f18461..735c270279 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -1,12 +1,23 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorProperty" inherits="Container" category="Core" version="3.2"> <brief_description> + Custom control to edit properties for adding into the inspector </brief_description> <description> + This control allows property editing for one or multiple properties into [EditorInspector]. It is added via [EditorInspectorPlugin]. </description> <tutorials> </tutorials> <methods> + <method name="add_focusable"> + <return type="void"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <description> + If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. + </description> + </method> <method name="emit_changed"> <return type="void"> </return> @@ -19,45 +30,65 @@ <argument index="3" name="changing" type="bool" default="false"> </argument> <description> + If one (or many properties) changed, this must be called. "Field" is used in case your editor can modify fields separately (as an example, Vector3.x). The "changing" argument avoids the editor requesting this property to be refreshed (leave as false if unsure). </description> </method> <method name="get_edited_object"> <return type="Object"> </return> <description> + Get the edited object. </description> </method> <method name="get_edited_property"> <return type="String"> </return> <description> + Get the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return it.. </description> </method> <method name="get_tooltip_text" qualifiers="const"> <return type="String"> </return> <description> + Override if you want to allow a custom tooltip over your property. + </description> + </method> + <method name="set_bottom_editor"> + <return type="void"> + </return> + <argument index="0" name="editor" type="Control"> + </argument> + <description> + Add controls with this function if you want them on the bottom (below the label). </description> </method> <method name="update_property" qualifiers="virtual"> <return type="void"> </return> <description> + When this virtual function is called, you must update your editor. </description> </method> </methods> <members> <member name="checkable" type="bool" setter="set_checkable" getter="is_checkable"> + Used by the inspector, set when property is checkable. </member> <member name="checked" type="bool" setter="set_checked" getter="is_checked"> + Used by the inspector, when the property is checked. </member> <member name="draw_red" type="bool" setter="set_draw_red" getter="is_draw_red"> + Used by the inspector, when the property must draw with error color. </member> <member name="keying" type="bool" setter="set_keying" getter="is_keying"> + Used by the inspector, when the property can add keys for animation/ </member> <member name="label" type="String" setter="set_label" getter="get_label"> + Set this property to change the label (if you want to show one) </member> <member name="read_only" type="bool" setter="set_read_only" getter="is_read_only"> + Used by the inspector, when the property is read-only. </member> </members> <signals> @@ -67,6 +98,7 @@ <argument index="1" name="value" type="Array"> </argument> <description> + Emit yourself if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin.parse_property] </description> </signal> <signal name="object_id_selected"> @@ -75,6 +107,7 @@ <argument index="1" name="id" type="int"> </argument> <description> + Used by sub-inspectors. Emit if what was selected was an Object ID. </description> </signal> <signal name="property_changed"> @@ -83,6 +116,7 @@ <argument index="1" name="value" type="Nil"> </argument> <description> + Do not emit this manually, use the [method emit_changed] method instead. </description> </signal> <signal name="property_checked"> @@ -91,12 +125,14 @@ <argument index="1" name="bool" type="String"> </argument> <description> + Used internally, when a property was checked. </description> </signal> <signal name="property_keyed"> <argument index="0" name="property" type="String"> </argument> <description> + Emit if you want to add this value as an animation key (check keying being enabled first). </description> </signal> <signal name="property_keyed_with_value"> @@ -105,6 +141,7 @@ <argument index="1" name="value" type="Nil"> </argument> <description> + Emit if you want to key a property with a single value. </description> </signal> <signal name="resource_selected"> @@ -113,6 +150,7 @@ <argument index="1" name="resource" type="Resource"> </argument> <description> + If you want a sub-resource to be edited, emit this signal with the resource. </description> </signal> <signal name="selected"> @@ -121,6 +159,7 @@ <argument index="1" name="focusable_idx" type="int"> </argument> <description> + Internal, used when selected. </description> </signal> </signals> diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index 6592ffd1a8..156cc62941 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -9,6 +9,14 @@ <tutorials> </tutorials> <methods> + <method name="can_generate_small_preview" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + If this function returns true the generator will call [method generate] or [method generate_from_path] for small previews too. + By default it returns false. + </description> + </method> <method name="generate" qualifiers="virtual"> <return type="Texture"> </return> @@ -35,13 +43,21 @@ Care must be taken because this function is always called from a thread (not the main thread). </description> </method> + <method name="generate_small_preview_automatically" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + If this function returns true the generator will automatically generate the small previews from the normal preview texture generated by the methods [method generate] or [method generate_from_path]. + By default it returns false. + </description> + </method> <method name="handles" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="type" type="String"> </argument> <description> - Return if your generator supports this resource type. + Returns if your generator supports this resource type. </description> </method> </methods> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index 58d04e2bbf..5d5c37b212 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -97,7 +97,7 @@ </argument> <description> Commit a handle being edited (handles must have been previously added by [method add_handles]). - If the cancel parameter is true, an option to restore the edited value to the original is provided. + If the cancel parameter is [code]true[/code], an option to restore the edited value to the original is provided. </description> </method> <method name="get_handle_name" qualifiers="virtual"> @@ -123,7 +123,7 @@ <return type="EditorSpatialGizmoPlugin"> </return> <description> - Return the [EditorSpatialGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorSpatialGizmoPlugin.get_material]. + Returns the [EditorSpatialGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorSpatialGizmoPlugin.get_material]. </description> </method> <method name="get_spatial_node" qualifiers="const"> diff --git a/doc/classes/EditorSpatialGizmoPlugin.xml b/doc/classes/EditorSpatialGizmoPlugin.xml index 8700c1cff9..40d6376ca3 100644 --- a/doc/classes/EditorSpatialGizmoPlugin.xml +++ b/doc/classes/EditorSpatialGizmoPlugin.xml @@ -25,7 +25,7 @@ <return type="bool"> </return> <description> - Override this method to define whether the gizmo can be hidden or not. Defaults to true. + Override this method to define whether the gizmo can be hidden or not. Defaults to [code]true[/code]. </description> </method> <method name="commit_handle" qualifiers="virtual"> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 17fdc59c6f..5f8dc552d7 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -28,7 +28,7 @@ Global contrast value of the rendered scene (default value is 1). </member> <member name="adjustment_enabled" type="bool" setter="set_adjustment_enable" getter="is_adjustment_enabled"> - Enables the adjustment_* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene. + Enables the adjustment_* options provided by this resource. If [code]false[/code], adjustments modifications will have no effect on the rendered scene. </member> <member name="adjustment_saturation" type="float" setter="set_adjustment_saturation" getter="get_adjustment_saturation"> Global color saturation value of the rendered scene (default value is 1). diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 66e6fa5314..953f364bdb 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -43,7 +43,7 @@ <return type="VBoxContainer"> </return> <description> - Return the vertical box container of the dialog, custom controls can be added to it. + Returns the vertical box container of the dialog, custom controls can be added to it. </description> </method> <method name="invalidate"> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index bd189928b0..d65dad9fe1 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -51,21 +51,21 @@ <return type="float"> </return> <description> - Return the font ascent (number of pixels above the baseline). + Returns the font ascent (number of pixels above the baseline). </description> </method> <method name="get_descent" qualifiers="const"> <return type="float"> </return> <description> - Return the font descent (number of pixels below the baseline). + Returns the font descent (number of pixels below the baseline). </description> </method> <method name="get_height" qualifiers="const"> <return type="float"> </return> <description> - Return the total font height (ascent plus descent) in pixels. + Returns the total font height (ascent plus descent) in pixels. </description> </method> <method name="get_string_size" qualifiers="const"> @@ -74,7 +74,17 @@ <argument index="0" name="string" type="String"> </argument> <description> - Return the size of a string, taking kerning and advance into account. + Returns the size of a string, taking kerning and advance into account. + </description> + </method> + <method name="get_wordwrap_string_size" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="string" type="String"> + </argument> + <argument index="1" name="p_width" type="float"> + </argument> + <description> </description> </method> <method name="has_outline" qualifiers="const"> diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index 3f84316503..e35d7a68c5 100644 --- a/doc/classes/FuncRef.xml +++ b/doc/classes/FuncRef.xml @@ -17,6 +17,12 @@ Calls the referenced function previously set by [method set_function] or [method @GDScript.funcref]. </description> </method> + <method name="is_valid" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_function"> <return type="void"> </return> diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 68539d7ecb..e2ba3fb7b0 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -59,6 +59,29 @@ Clips the polygon defined by the points in [code]points[/code] against the [code]plane[/code] and returns the points of the clipped polygon. </description> </method> + <method name="clip_polygons_2d"> + <return type="Array"> + </return> + <argument index="0" name="polygon_a" type="PoolVector2Array"> + </argument> + <argument index="1" name="polygon_b" type="PoolVector2Array"> + </argument> + <description> + Clips [code]polygon_a[/code] against [code]polygon_b[/code] and returns an array of clipped polygons. This performs [code]OPERATION_DIFFERENCE[/code] between polygons. Returns an empty array if [code]polygon_b[/code] completely overlaps [code]polygon_a[/code]. + If [code]polygon_b[/code] is enclosed by [code]polygon_a[/code], returns an outer polygon (boundary) and inner polygon (hole) which could be distiguished by calling [method is_polygon_clockwise]. + </description> + </method> + <method name="clip_polyline_with_polygon_2d"> + <return type="Array"> + </return> + <argument index="0" name="polyline" type="PoolVector2Array"> + </argument> + <argument index="1" name="polygon" type="PoolVector2Array"> + </argument> + <description> + Clips [code]polyline[/code] against [code]polygon[/code] and returns an array of clipped polylines. This performs [code]OPERATION_DIFFERENCE[/code] between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape. + </description> + </method> <method name="convex_hull_2d"> <return type="PoolVector2Array"> </return> @@ -68,6 +91,18 @@ Given an array of [Vector2]s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. </description> </method> + <method name="exclude_polygons_2d"> + <return type="Array"> + </return> + <argument index="0" name="polygon_a" type="PoolVector2Array"> + </argument> + <argument index="1" name="polygon_b" type="PoolVector2Array"> + </argument> + <description> + Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons_2d]) and returns an array of excluded polygons. This performs [code]OPERATION_XOR[/code] between polygons. In other words, returns all but common area between polygons. + The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise]. + </description> + </method> <method name="get_closest_point_to_segment"> <return type="Vector3"> </return> @@ -158,6 +193,38 @@ <description> </description> </method> + <method name="intersect_polygons_2d"> + <return type="Array"> + </return> + <argument index="0" name="polygon_a" type="PoolVector2Array"> + </argument> + <argument index="1" name="polygon_b" type="PoolVector2Array"> + </argument> + <description> + Intersects [code]polygon_a[/code] with [code]polygon_b[/code] and returns an array of intersected polygons. This performs [code]OPERATION_INTERSECTION[/code] between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs. + The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise]. + </description> + </method> + <method name="intersect_polyline_with_polygon_2d"> + <return type="Array"> + </return> + <argument index="0" name="polyline" type="PoolVector2Array"> + </argument> + <argument index="1" name="polygon" type="PoolVector2Array"> + </argument> + <description> + Intersects [code]polyline[/code] with [code]polygon[/code] and returns an array of intersected polylines. This performs [code]OPERATION_INTERSECTION[/code] between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. + </description> + </method> + <method name="is_polygon_clockwise"> + <return type="bool"> + </return> + <argument index="0" name="polygon" type="PoolVector2Array"> + </argument> + <description> + Returns [code]true[/code] if [code]polygon[/code]'s vertices are ordered in clockwise order, otherwise returns [code]false[/code]. + </description> + </method> <method name="line_intersects_line_2d"> <return type="Variant"> </return> @@ -182,6 +249,51 @@ Given an array of [Vector2]s representing tiles, builds an atlas. The returned dictionary has two keys: [code]points[/code] is a vector of [Vector2] that specifies the positions of each tile, [code]size[/code] contains the overall size of the whole atlas as [Vector2]. </description> </method> + <method name="merge_polygons_2d"> + <return type="Array"> + </return> + <argument index="0" name="polygon_a" type="PoolVector2Array"> + </argument> + <argument index="1" name="polygon_b" type="PoolVector2Array"> + </argument> + <description> + Merges (combines) [code]polygon_a[/code] and [code]polygon_b[/code] and returns an array of merged polygons. This performs [code]OPERATION_UNION[/code] between polygons. + The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise]. + </description> + </method> + <method name="offset_polygon_2d"> + <return type="Array"> + </return> + <argument index="0" name="polygon" type="PoolVector2Array"> + </argument> + <argument index="1" name="delta" type="float"> + </argument> + <argument index="2" name="join_type" type="int" enum="Geometry.PolyJoinType" default="0"> + </argument> + <description> + Inflates or deflates [code]polygon[/code] by [code]delta[/code] units (pixels). If [code]delta[/code] is positive, makes the polygon grow outward. If [code]delta[/code] is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if [code]delta[/code] is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. + Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum Geometry.PolyJoinType]. + The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise]. + </description> + </method> + <method name="offset_polyline_2d"> + <return type="Array"> + </return> + <argument index="0" name="polyline" type="PoolVector2Array"> + </argument> + <argument index="1" name="delta" type="float"> + </argument> + <argument index="2" name="join_type" type="int" enum="Geometry.PolyJoinType" default="0"> + </argument> + <argument index="3" name="end_type" type="int" enum="Geometry.PolyEndType" default="3"> + </argument> + <description> + Inflates or deflates [code]polyline[/code] by [code]delta[/code] units (pixels), producing polygons. If [code]delta[/code] is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If [code]delta[/code] is negative, returns an empty array. + Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum Geometry.PolyJoinType]. + Each polygon's endpoints will be rounded as determined by [code]end_type[/code], see [enum Geometry.PolyEndType]. + The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise]. + </description> + </method> <method name="point_is_inside_triangle" qualifiers="const"> <return type="bool"> </return> @@ -304,6 +416,27 @@ Tests if the segment ([code]from[/code], [code]to[/code]) intersects the triangle [code]a[/code], [code]b[/code], [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, an empty [Variant] is returned. </description> </method> + <method name="transform_points_2d"> + <return type="PoolVector2Array"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + Transforms an array of points by [code]transform[/code] and returns the result. + Can be useful in conjuction with performing polygon boolean operations in CSG manner, see [method merge_polygons_2d], [method clip_polygons_2d], [method intersect_polygons_2d], [method exclude_polygons_2d]. + </description> + </method> + <method name="triangulate_delaunay_2d"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <description> + Triangulates the area specified by discrete set of [code]points[/code] such that no point is inside the circumcircle of any resulting triangle. Returns a [PoolIntArray] where each triangle consists of three consecutive point indices into [code]points[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PoolIntArray] is returned. + </description> + </method> <method name="triangulate_polygon"> <return type="PoolIntArray"> </return> @@ -315,5 +448,41 @@ </method> </methods> <constants> + <constant name="OPERATION_UNION" value="0" enum="PolyBooleanOperation"> + Create regions where either subject or clip polygons (or both) are filled. + </constant> + <constant name="OPERATION_DIFFERENCE" value="1" enum="PolyBooleanOperation"> + Create regions where subject polygons are filled except where clip polygons are filled. + </constant> + <constant name="OPERATION_INTERSECTION" value="2" enum="PolyBooleanOperation"> + Create regions where both subject and clip polygons are filled. + </constant> + <constant name="OPERATION_XOR" value="3" enum="PolyBooleanOperation"> + Create regions where either subject or clip polygons are filled but not where both are filled. + </constant> + <constant name="JOIN_SQUARE" value="0" enum="PolyJoinType"> + Squaring is applied uniformally at all convex edge joins at [code]1 * delta[/code]. + </constant> + <constant name="JOIN_ROUND" value="1" enum="PolyJoinType"> + While flattened paths can never perfectly trace an arc, they are approximated by a series of arc chords. + </constant> + <constant name="JOIN_MITER" value="2" enum="PolyJoinType"> + There's a necessary limit to mitered joins since offsetting edges that join at very acute angles will produce excessively long and narrow 'spikes'. For any given edge join, when miter offsetting would exceed that maximum distance, 'square' joining is applied. + </constant> + <constant name="END_POLYGON" value="0" enum="PolyEndType"> + Endpoints are joined using the [enum PolyJoinType] value and the path filled as a polygon. + </constant> + <constant name="END_JOINED" value="1" enum="PolyEndType"> + Endpoints are joined using the [enum PolyJoinType] value and the path filled as a polyline. + </constant> + <constant name="END_BUTT" value="2" enum="PolyEndType"> + Endpoints are squared off with no extension. + </constant> + <constant name="END_SQUARE" value="3" enum="PolyEndType"> + Endpoints are squared off and extended by [code]delta[/code] units. + </constant> + <constant name="END_ROUND" value="4" enum="PolyEndType"> + Endpoints are rounded off and extended by [code]delta[/code] units. + </constant> </constants> </class> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 86504b2c98..db186eab35 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -80,7 +80,7 @@ <return type="Array"> </return> <description> - Return an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } + Returns an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } </description> </method> <method name="get_zoom_hbox"> @@ -101,7 +101,7 @@ <argument index="3" name="to_port" type="int"> </argument> <description> - Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. + Returns [code]true[/code] if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. </description> </method> <method name="is_valid_connection_type" qualifiers="const"> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 845fc35a7a..a19676798b 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -31,14 +31,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the color of the input connection 'idx'. + Returns the color of the input connection 'idx'. </description> </method> <method name="get_connection_input_count"> <return type="int"> </return> <description> - Return the number of enabled input slots (connections) to the GraphNode. + Returns the number of enabled input slots (connections) to the GraphNode. </description> </method> <method name="get_connection_input_position"> @@ -47,7 +47,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the position of the input connection 'idx'. + Returns the position of the input connection 'idx'. </description> </method> <method name="get_connection_input_type"> @@ -56,7 +56,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the type of the input connection 'idx'. + Returns the type of the input connection 'idx'. </description> </method> <method name="get_connection_output_color"> @@ -65,14 +65,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the color of the output connection 'idx'. + Returns the color of the output connection 'idx'. </description> </method> <method name="get_connection_output_count"> <return type="int"> </return> <description> - Return the number of enabled output slots (connections) of the GraphNode. + Returns the number of enabled output slots (connections) of the GraphNode. </description> </method> <method name="get_connection_output_position"> @@ -81,7 +81,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the position of the output connection 'idx'. + Returns the position of the output connection 'idx'. </description> </method> <method name="get_connection_output_type"> @@ -90,7 +90,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the type of the output connection 'idx'. + Returns the type of the output connection 'idx'. </description> </method> <method name="get_slot_color_left" qualifiers="const"> @@ -99,7 +99,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the color set to 'idx' left (input) slot. + Returns the color set to 'idx' left (input) slot. </description> </method> <method name="get_slot_color_right" qualifiers="const"> @@ -108,7 +108,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the color set to 'idx' right (output) slot. + Returns the color set to 'idx' right (output) slot. </description> </method> <method name="get_slot_type_left" qualifiers="const"> @@ -117,7 +117,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the (integer) type of left (input) 'idx' slot. + Returns the (integer) type of left (input) 'idx' slot. </description> </method> <method name="get_slot_type_right" qualifiers="const"> @@ -126,7 +126,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the (integer) type of right (output) 'idx' slot. + Returns the (integer) type of right (output) 'idx' slot. </description> </method> <method name="is_slot_enabled_left" qualifiers="const"> @@ -135,7 +135,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return true if left (input) slot 'idx' is enabled. False otherwise. + Returns [code]true[/code] if left (input) slot 'idx' is enabled, [code]false[/code] otherwise. </description> </method> <method name="is_slot_enabled_right" qualifiers="const"> @@ -144,7 +144,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return true if right (output) slot 'idx' is enabled. False otherwise. + Returns [code]true[/code] if right (output) slot 'idx' is enabled, [code]false[/code] otherwise. </description> </method> <method name="set_slot"> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 13e018f88f..8ae0120a34 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -295,7 +295,7 @@ HTTP status code [code]303 See Other[/code]. The server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request. </constant> <constant name="RESPONSE_NOT_MODIFIED" value="304" enum="ResponseCode"> - HTTP status code [code]304 Not Modified[/code]. A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to false. + HTTP status code [code]304 Not Modified[/code]. A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to [code]false[/code]. </constant> <constant name="RESPONSE_USE_PROXY" value="305" enum="ResponseCode"> HTTP status code [code]305 Use Proxy[/code]. Deprecated. Do not use. @@ -346,7 +346,7 @@ HTTP status code [code]411 Length Required[/code]. The server refuses to accept the request without a defined Content-Length header. </constant> <constant name="RESPONSE_PRECONDITION_FAILED" value="412" enum="ResponseCode"> - HTTP status code [code]412 Precondition Failed[/code]. One or more conditions given in the request header fields evaluated to false when tested on the server. + HTTP status code [code]412 Precondition Failed[/code]. One or more conditions given in the request header fields evaluated to [code]false[/code] when tested on the server. </constant> <constant name="RESPONSE_REQUEST_ENTITY_TOO_LARGE" value="413" enum="ResponseCode"> HTTP status code [code]413 Entity Too Large[/code]. The server is refusing to process a request because the request payload is larger than the server is willing or able to process. diff --git a/doc/classes/HeightMapShape.xml b/doc/classes/HeightMapShape.xml index 5ffeda1c10..22896535b9 100644 --- a/doc/classes/HeightMapShape.xml +++ b/doc/classes/HeightMapShape.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="HeightMapShape" inherits="Shape" category="Core" version="3.2"> <brief_description> - Height map shape for 3D physics (bullet only) + Height map shape for 3D physics (Bullet only). </brief_description> <description> Height map shape resource, which can be added to a [PhysicsBody] or [Area]. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 2abc3af8c5..8dfabdd884 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -123,7 +123,7 @@ <argument index="3" name="format" type="int" enum="Image.Format"> </argument> <description> - Creates an empty image of given size and format. See [code]FORMAT_*[/code] constants. If [code]use_mipmaps[/code] is true then generate mipmaps for this image. See the [code]generate_mipmaps[/code] method. + Creates an empty image of given size and format. See [code]FORMAT_*[/code] constants. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [code]generate_mipmaps[/code] method. </description> </method> <method name="create_from_data"> @@ -140,7 +140,7 @@ <argument index="4" name="data" type="PoolByteArray"> </argument> <description> - Creates a new image of given size and format. See [code]FORMAT_*[/code] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is true then generate mipmaps for this image. See the [code]generate_mipmaps[/code] method. + Creates a new image of given size and format. See [code]FORMAT_*[/code] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [code]generate_mipmaps[/code] method. </description> </method> <method name="crop"> @@ -603,6 +603,8 @@ If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image. (Note that if you intend to scale multiple copies of the original image, it's better to call [code]generate_mipmaps[/code] on it in advance, to avoid wasting processing power in generating them again and again.) On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. </constant> + <constant name="INTERPOLATE_LANCZOS" value="4" enum="Interpolation"> + </constant> <constant name="ALPHA_NONE" value="0" enum="AlphaMode"> </constant> <constant name="ALPHA_BIT" value="1" enum="AlphaMode"> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 15ecd4ee6d..e5a8fee767 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -40,7 +40,7 @@ <return type="int" enum="Image.Format"> </return> <description> - Return the format of the [ImageTexture], one of [enum Image.Format]. + Returns the format of the [ImageTexture], one of [enum Image.Format]. </description> </method> <method name="load"> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 4aff5dd62b..9c41e4bf1d 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -194,7 +194,7 @@ <return type="int" enum="Input.MouseMode"> </return> <description> - Return the mouse mode. See the constants for more information. + Returns the mouse mode. See the constants for more information. </description> </method> <method name="is_action_just_pressed" qualifiers="const"> @@ -203,7 +203,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns [code]true[/code] when the user starts pressing the action event, meaning it's true only on the frame that the user pressed down the button. + Returns [code]true[/code] when the user starts pressing the action event, meaning it's [code]true[/code] only on the frame that the user pressed down the button. This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. </description> </method> @@ -213,7 +213,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns [code]true[/code] when the user stops pressing the action event, meaning it's true only on the frame that the user released the button. + Returns [code]true[/code] when the user stops pressing the action event, meaning it's [code]true[/code] only on the frame that the user released the button. </description> </method> <method name="is_action_pressed" qualifiers="const"> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 1cfd9e03f7..ba3a7fe6d8 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -32,7 +32,7 @@ </argument> <description> Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. - If selectable is true the list item will be selectable. + If selectable is [code]true[/code] the list item will be selectable. </description> </method> <method name="clear"> @@ -64,7 +64,7 @@ <return type="int"> </return> <description> - Return count of items currently in the item list. + Returns count of items currently in the item list. </description> </method> <method name="get_item_custom_bg_color" qualifiers="const"> @@ -122,7 +122,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the text for specified item index. + Returns the text for specified item index. </description> </method> <method name="get_item_tooltip" qualifiers="const"> @@ -131,7 +131,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return tooltip hint for specified item index. + Returns tooltip hint for specified item index. </description> </method> <method name="get_selected_items"> diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index dae549125f..8ea3d8c188 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -91,10 +91,10 @@ Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [KinematicBody] or [RigidBody], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [code]linear_velocity[/code] is the velocity vector (typically meters per second). Unlike in [method move_and_collide], you should [i]not[/i] multiply it by [code]delta[/code] — the physics engine handles applying the velocity. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector3(0, 0, 0)[/code], everything is considered a wall. This is useful for topdown games. - If [code]stop_on_slope[/code] is true, body will not slide on slopes if you include gravity in [code]linear_velocity[/code]. + If [code]stop_on_slope[/code] is [code]true[/code], body will not slide on slopes if you include gravity in [code]linear_velocity[/code]. If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - If [code]infinite_inertia[/code] is true, body will be able to push [RigidBody] nodes, but it won't also detect any collisions with them. When false, it will interact with [RigidBody] nodes like with [StaticBody]. + If [code]infinite_inertia[/code] is [code]true[/code], body will be able to push [RigidBody] nodes, but it won't also detect any collisions with them. If [code]false[/code] it will interact with [RigidBody] nodes like with [StaticBody]. Returns the [code]linear_velocity[/code] vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index b41b5412d7..b7ff4bac84 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -9,6 +9,8 @@ Kinematic Characters: KinematicBody2D also has an API for moving objects (the [method move_and_collide] and [method move_and_slide] methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> <tutorials> + <link>https://docs.godotengine.org/en/latest/tutorials/physics/kinematic_character_2d.html</link> + <link>https://docs.godotengine.org/en/latest/tutorials/physics/using_kinematic_body_2d.html</link> </tutorials> <methods> <method name="get_floor_velocity" qualifiers="const"> @@ -95,10 +97,10 @@ Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [KinematicBody2D] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [code]linear_velocity[/code] is the velocity vector in pixels per second. Unlike in [method move_and_collide], you should [i]not[/i] multiply it by [code]delta[/code] — the physics engine handles applying the velocity. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector2(0, 0)[/code], everything is considered a wall. This is useful for topdown games. - If [code]stop_on_slope[/code] is true, body will not slide on slopes when you include gravity in [code]linear_velocity[/code] and the body is standing still. + If [code]stop_on_slope[/code] is [code]true[/code], body will not slide on slopes when you include gravity in [code]linear_velocity[/code] and the body is standing still. If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - If [code]infinite_inertia[/code] is true, body will be able to push [RigidBody2D] nodes, but it won't also detect any collisions with them. When false, it will interact with [RigidBody2D] nodes like with [StaticBody2D]. + If [code]infinite_inertia[/code] is [code]true[/code], body will be able to push [RigidBody2D] nodes, but it won't also detect any collisions with them. If [code]false[/code] it will interact with [RigidBody2D] nodes like with [StaticBody2D]. Returns the [code]linear_velocity[/code] vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 955fe6f822..8d52cae186 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -44,7 +44,7 @@ Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the [code]ALIGN_*[/code] constants. </member> <member name="autowrap" type="bool" setter="set_autowrap" getter="has_autowrap"> - If [code]true[/code], wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false. + If [code]true[/code], wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: [code]false[/code]. </member> <member name="clip_text" type="bool" setter="set_clip_text" getter="is_clipping_text"> If [code]true[/code], the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 623b23807f..c55760767a 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -14,8 +14,11 @@ </return> <argument index="0" name="position" type="Vector2"> </argument> + <argument index="1" name="at_position" type="int" default="-1"> + </argument> <description> Add a point at the [code]position[/code]. Appends the point at the end of the line. + If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position < 0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. </description> </method> <method name="clear_points"> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 6ea097ec2f..bb180b591d 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -1,10 +1,19 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="LineEdit" inherits="Control" category="Core" version="3.2"> <brief_description> - Control that provides single line string editing. + Control that provides single-line string editing. </brief_description> <description> - LineEdit provides a single line string editor, used for text fields. + LineEdit provides a single-line string editor, used for text fields. It features many built-in shortcuts which will always be available: + - Ctrl + C: Copy + - Ctrl + X: Cut + - Ctrl + V or Ctrl + Y: Paste/"yank" + - Ctrl + Z: Undo + - Ctrl + Shift + Z: Redo + - Ctrl + U: Delete text from the cursor position to the beginning of the line + - Ctrl + K: Delete text from the cursor position to the end of the line + - Ctrl + A: Select all text + - Up/Down arrow: Move the cursor to the beginning/end of the line </description> <tutorials> </tutorials> diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index 0d07d8b649..c7118a4d9f 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -15,7 +15,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> - Return [PoolByteArray] of a given base64 encoded String. + Returns [PoolByteArray] of a given base64 encoded String. </description> </method> <method name="base64_to_utf8"> @@ -24,7 +24,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> - Return utf8 String of a given base64 encoded String. + Returns utf8 String of a given base64 encoded String. </description> </method> <method name="base64_to_variant"> @@ -35,7 +35,7 @@ <argument index="1" name="allow_objects" type="bool" default="false"> </argument> <description> - Return [Variant] of a given base64 encoded String. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. + Returns [Variant] of a given base64 encoded String. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). </description> </method> @@ -45,7 +45,7 @@ <argument index="0" name="array" type="PoolByteArray"> </argument> <description> - Return base64 encoded String of a given [PoolByteArray]. + Returns base64 encoded String of a given [PoolByteArray]. </description> </method> <method name="utf8_to_base64"> @@ -54,7 +54,7 @@ <argument index="0" name="utf8_str" type="String"> </argument> <description> - Return base64 encoded String of a given utf8 String. + Returns base64 encoded String of a given utf8 String. </description> </method> <method name="variant_to_base64"> @@ -65,7 +65,7 @@ <argument index="1" name="full_objects" type="bool" default="false"> </argument> <description> - Return base64 encoded String of a given [Variant]. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). + Returns base64 encoded String of a given [Variant]. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). </description> </method> </methods> diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index dadc31b794..1043aa1087 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -13,7 +13,7 @@ <return type="PopupMenu"> </return> <description> - Return the [PopupMenu] contained in this button. + Returns the [PopupMenu] contained in this button. </description> </method> <method name="set_disable_shortcuts"> diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index ae035341f6..b8bc5cbd11 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -50,7 +50,7 @@ <return type="int"> </return> <description> - Return the amount of surfaces that the [Mesh] holds. + Returns the amount of surfaces that the [Mesh] holds. </description> </method> <method name="surface_get_arrays" qualifiers="const"> @@ -77,7 +77,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return a [Material] in a given surface. Surface is rendered using this material. + Returns a [Material] in a given surface. Surface is rendered using this material. </description> </method> </methods> diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index de4f6cdf72..ad5824640d 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -37,7 +37,7 @@ <return type="PoolIntArray"> </return> <description> - Return the list of items. + Returns the list of items. </description> </method> <method name="get_item_mesh" qualifiers="const"> @@ -46,7 +46,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the mesh of the item. + Returns the mesh of the item. </description> </method> <method name="get_item_name" qualifiers="const"> @@ -55,7 +55,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the name of the item. + Returns the name of the item. </description> </method> <method name="get_item_navmesh" qualifiers="const"> diff --git a/doc/classes/MeshTexture.xml b/doc/classes/MeshTexture.xml new file mode 100644 index 0000000000..d305cca482 --- /dev/null +++ b/doc/classes/MeshTexture.xml @@ -0,0 +1,26 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MeshTexture" inherits="Texture" category="Core" version="3.2"> + <brief_description> + Simple texture that uses a mesh to draw itself. + </brief_description> + <description> + Simple texture that uses a mesh to draw itself. It's limited because flags can't be changed and region drawing is not supported. + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="base_texture" type="Texture" setter="set_base_texture" getter="get_base_texture"> + Set the base texture that the Mesh will use to draw. + </member> + <member name="image_size" type="Vector2" setter="set_image_size" getter="get_image_size"> + Set the size of the image, needed for reference. + </member> + <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> + Set the mesh used to draw. It must be a mesh using 2D vertices. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 723ba7ea2b..0784fc3a42 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -17,7 +17,7 @@ <return type="AABB"> </return> <description> - Return the visibility AABB. + Returns the visibility AABB. </description> </method> <method name="get_instance_color" qualifiers="const"> @@ -35,7 +35,7 @@ <argument index="0" name="instance" type="int"> </argument> <description> - Return the custom data that has been set for a specific instance. + Returns the custom data that has been set for a specific instance. </description> </method> <method name="get_instance_transform" qualifiers="const"> @@ -44,7 +44,7 @@ <argument index="0" name="instance" type="int"> </argument> <description> - Return the transform of a specific instance. + Returns the [Transform] of a specific instance. </description> </method> <method name="get_instance_transform_2d" qualifiers="const"> @@ -53,6 +53,18 @@ <argument index="0" name="instance" type="int"> </argument> <description> + Returns the [Transform2D] of a specific instance. + </description> + </method> + <method name="set_as_bulk_array"> + <return type="void"> + </return> + <argument index="0" name="array" type="PoolRealArray"> + </argument> + <description> + Set all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative. + All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc... + [Transform] is stored as 12 floats, [Transform2D] is stored as 8 floats, COLOR_8BIT / CUSTOM_DATA_8BIT is stored as 1 float (4 bytes as is) and COLOR_FLOAT / CUSTOM_DATA_FLOAT is stored as 4 floats. </description> </method> <method name="set_instance_color"> @@ -86,7 +98,7 @@ <argument index="1" name="transform" type="Transform"> </argument> <description> - Set the transform for a specific instance. + Set the [Transform] for a specific instance. </description> </method> <method name="set_instance_transform_2d"> @@ -97,6 +109,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Set the [Transform2D] for a specific instance. </description> </method> </methods> @@ -108,7 +121,7 @@ Format of custom data in custom data array that gets passed to shader. </member> <member name="instance_count" type="int" setter="set_instance_count" getter="get_instance_count"> - Number of instances that will get drawn. + Number of instances that will get drawn. This clears and (re)sizes the buffers. By default all instances are drawn but you can limit this with [member visible_instance_count]. </member> <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> Mesh to be drawn. @@ -116,6 +129,9 @@ <member name="transform_format" type="int" setter="set_transform_format" getter="get_transform_format" enum="MultiMesh.TransformFormat"> Format of transform used to transform mesh, either 2D or 3D. </member> + <member name="visible_instance_count" type="int" setter="set_visible_instance_count" getter="get_visible_instance_count"> + Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers. + </member> </members> <constants> <constant name="TRANSFORM_2D" value="0" enum="TransformFormat"> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 2788eb053a..79ad7f63ae 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -29,6 +29,14 @@ <description> </description> </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> <method name="get_polygon"> <return type="PoolIntArray"> </return> @@ -49,6 +57,16 @@ <description> </description> </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_vertices"> <return type="void"> </return> @@ -85,6 +103,10 @@ </member> <member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles"> </member> + <member name="geometry/collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + </member> + <member name="geometry/parsed_geometry_type" type="int" setter="set_parsed_geometry_type" getter="get_parsed_geometry_type"> + </member> <member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly"> </member> <member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size"> @@ -101,5 +123,11 @@ </constant> <constant name="SAMPLE_PARTITION_LAYERS" value="2"> </constant> + <constant name="PARSED_GEOMETRY_MESH_INSTANCES" value="0"> + </constant> + <constant name="PARSED_GEOMETRY_STATIC_COLLIDERS" value="1"> + </constant> + <constant name="PARSED_GEOMETRY_BOTH" value="2"> + </constant> </constants> </class> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 14299cdcba..1b97f3267f 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -63,7 +63,7 @@ <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> - Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is false, normalizes the movement. + Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement. </description> </method> <method name="move_local_y"> @@ -74,7 +74,7 @@ <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> - Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is false, normalizes the movement. + Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement. </description> </method> <method name="rotate"> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 4c682f1266..554858d895 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -68,14 +68,14 @@ <return type="bool"> </return> <description> - Return true if the node path is absolute (not relative). + Returns [code]true[/code] if the node path is absolute (not relative). </description> </method> <method name="is_empty"> <return type="bool"> </return> <description> - Return true if the node path is empty. + Returns [code]true[/code] if the node path is empty. </description> </method> </methods> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index c9c83bc0e0..dd0fcd63e7 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -97,6 +97,8 @@ </argument> <argument index="3" name="output" type="Array" default="[ ]"> </argument> + <argument index="4" name="read_stderr" type="bool" default="false"> + </argument> <description> Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. The arguments are used in the given order and separated by a space, so [code]OS.execute('ping', ['-w', '3', 'godotengine.org'], false)[/code] will resolve to [code]ping -w 3 godotengine.org[/code] in the system's shell. @@ -697,7 +699,8 @@ <argument index="0" name="icon" type="Image"> </argument> <description> - Sets the game's icon. + Sets the game's icon using an [Image] resource. + The same image is used for window caption, taskbar/dock and window selection dialog. Image is scaled as needed. </description> </method> <method name="set_ime_active"> @@ -718,6 +721,17 @@ Sets position of IME suggestion list popup (in window coordinates). </description> </method> + <method name="set_native_icon"> + <return type="void"> + </return> + <argument index="0" name="filename" type="String"> + </argument> + <description> + Sets the game's icon using a multi-size platform-specific icon file ([code]*.ico[/code] on Windows and [code]*.icns[/code] on macOS). + Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog. + Note: This method is only implemented on macOS and Windows. + </description> + </method> <method name="set_thread_name"> <return type="int" enum="Error"> </return> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 4724cb9270..dbbd974b04 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -57,6 +57,14 @@ Sets a property. Returns [code]true[/code] if the [code]property[/code] exists. </description> </method> + <method name="_to_string" qualifiers="virtual"> + <return type="String"> + </return> + <description> + Returns a [String] representing the object. Default is [code]"[ClassName:RID]"[/code]. + Override this method to customize the [String] representation of the object when it's being converted to a string, for example: [code]print(obj)[/code]. + </description> + </method> <method name="add_user_signal"> <return type="void"> </return> @@ -327,6 +335,14 @@ <description> </description> </method> + <method name="remove_meta"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="set"> <return type="void"> </return> @@ -344,7 +360,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - If set to true, signal emission is blocked. + If set to [code]true[/code], signal emission is blocked. </description> </method> <method name="set_deferred"> @@ -373,7 +389,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Define whether the object can translate strings (with calls to [method tr]). Default is true. + Define whether the object can translate strings (with calls to [method tr]). Default is [code]true[/code]. </description> </method> <method name="set_meta"> @@ -396,6 +412,14 @@ Set a script into the object, scripts extend the object functionality. </description> </method> + <method name="to_string"> + <return type="String"> + </return> + <description> + Returns a [String] representing the object. Default is [code]"[ClassName:RID]"[/code]. + Override the method [method _to_string] to customize the [String] representation. + </description> + </method> <method name="tr" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 51d2cbc867..1f714656de 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -51,7 +51,7 @@ <return type="int"> </return> <description> - Return the amount of items in the OptionButton. + Returns the amount of items in the OptionButton. </description> </method> <method name="get_item_icon" qualifiers="const"> @@ -60,7 +60,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the icon of the item at index "idx". + Returns the icon of the item at index "idx". </description> </method> <method name="get_item_id" qualifiers="const"> @@ -69,7 +69,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the ID of the item at index [code]idx[/code]. + Returns the ID of the item at index [code]idx[/code]. </description> </method> <method name="get_item_index" qualifiers="const"> @@ -78,7 +78,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the index of the item with the given [code]id[/code]. + Returns the index of the item with the given [code]id[/code]. </description> </method> <method name="get_item_metadata" qualifiers="const"> @@ -95,14 +95,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the text of the item at index "idx". + Returns the text of the item at index "idx". </description> </method> <method name="get_popup" qualifiers="const"> <return type="PopupMenu"> </return> <description> - Return the [PopupMenu] contained in this button. + Returns the [PopupMenu] contained in this button. </description> </method> <method name="get_selected_id" qualifiers="const"> @@ -202,14 +202,14 @@ </members> <signals> <signal name="item_focused"> - <argument index="0" name="ID" type="int"> + <argument index="0" name="id" type="int"> </argument> <description> This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument. </description> </signal> <signal name="item_selected"> - <argument index="0" name="ID" type="int"> + <argument index="0" name="id" type="int"> </argument> <description> This signal is emitted when the current item was changed by the user. Index of the item selected is passed as argument. diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 5a54c7ba1c..4109d9d462 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -13,7 +13,7 @@ <return type="int"> </return> <description> - Return the number of packets currently available in the ring-buffer. + Returns the number of packets currently available in the ring-buffer. </description> </method> <method name="get_packet"> @@ -27,7 +27,7 @@ <return type="int" enum="Error"> </return> <description> - Return the error state of the last packet received (via [method get_packet] and [method get_var]). + Returns the error state of the last packet received (via [method get_packet] and [method get_var]). </description> </method> <method name="get_var"> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 5892eb17b7..9843c16108 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -20,21 +20,21 @@ <return type="String"> </return> <description> - Return the IP of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). + Returns the IP of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). </description> </method> <method name="get_packet_port" qualifiers="const"> <return type="int"> </return> <description> - Return the port of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). + Returns the port of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). </description> </method> <method name="is_listening" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [PacketPeerUDP] is listening. + Returns whether this [PacketPeerUDP] is listening. </description> </method> <method name="listen"> diff --git a/doc/classes/Panel.xml b/doc/classes/Panel.xml index 1cee2b5386..c9c3f80e7b 100644 --- a/doc/classes/Panel.xml +++ b/doc/classes/Panel.xml @@ -15,9 +15,5 @@ <theme_items> <theme_item name="panel" type="StyleBox"> </theme_item> - <theme_item name="panelf" type="StyleBox"> - </theme_item> - <theme_item name="panelnc" type="StyleBox"> - </theme_item> </theme_items> </class> diff --git a/doc/classes/Path2D.xml b/doc/classes/Path2D.xml index c77e00a28e..ce15b3eab2 100644 --- a/doc/classes/Path2D.xml +++ b/doc/classes/Path2D.xml @@ -5,6 +5,7 @@ </brief_description> <description> Can have [PathFollow2D] child-nodes moving along the [Curve2D]. See [PathFollow2D] for more information on this usage. + Note that the path is considered as relative to the moved nodes (children of [PathFollow2D]) - usually the curve should start with a zero vector (0, 0). </description> <tutorials> </tutorials> diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index 881e4a9d82..3860511615 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -55,58 +55,60 @@ Number of resources currently used. </constant> <constant name="OBJECT_NODE_COUNT" value="10" enum="Monitor"> - Number of nodes currently instanced. This also includes the root node, as well as any nodes not in the scene tree. + Number of nodes currently instanced in the scene tree. This also includes the root node. </constant> - <constant name="RENDER_OBJECTS_IN_FRAME" value="11" enum="Monitor"> + <constant name="OBJECT_ORPHAN_NODE_COUNT" value="11" enum="Monitor"> + </constant> + <constant name="RENDER_OBJECTS_IN_FRAME" value="12" enum="Monitor"> 3D objects drawn per frame. </constant> - <constant name="RENDER_VERTICES_IN_FRAME" value="12" enum="Monitor"> + <constant name="RENDER_VERTICES_IN_FRAME" value="13" enum="Monitor"> Vertices drawn per frame. 3D only. </constant> - <constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="13" enum="Monitor"> + <constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="14" enum="Monitor"> Material changes per frame. 3D only </constant> - <constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="14" enum="Monitor"> + <constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="15" enum="Monitor"> Shader changes per frame. 3D only. </constant> - <constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="15" enum="Monitor"> + <constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="16" enum="Monitor"> Render surface changes per frame. 3D only. </constant> - <constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16" enum="Monitor"> + <constant name="RENDER_DRAW_CALLS_IN_FRAME" value="17" enum="Monitor"> Draw calls per frame. 3D only. </constant> - <constant name="RENDER_VIDEO_MEM_USED" value="17" enum="Monitor"> + <constant name="RENDER_VIDEO_MEM_USED" value="18" enum="Monitor"> Video memory used. Includes both texture and vertex memory. </constant> - <constant name="RENDER_TEXTURE_MEM_USED" value="18" enum="Monitor"> + <constant name="RENDER_TEXTURE_MEM_USED" value="19" enum="Monitor"> Texture memory used. </constant> - <constant name="RENDER_VERTEX_MEM_USED" value="19" enum="Monitor"> + <constant name="RENDER_VERTEX_MEM_USED" value="20" enum="Monitor"> Vertex memory used. </constant> - <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20" enum="Monitor"> + <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="21" enum="Monitor"> </constant> - <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21" enum="Monitor"> + <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="22" enum="Monitor"> Number of active [RigidBody2D] nodes in the game. </constant> - <constant name="PHYSICS_2D_COLLISION_PAIRS" value="22" enum="Monitor"> + <constant name="PHYSICS_2D_COLLISION_PAIRS" value="23" enum="Monitor"> Number of collision pairs in the 2D physics engine. </constant> - <constant name="PHYSICS_2D_ISLAND_COUNT" value="23" enum="Monitor"> + <constant name="PHYSICS_2D_ISLAND_COUNT" value="24" enum="Monitor"> Number of islands in the 2D physics engine. </constant> - <constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24" enum="Monitor"> + <constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="25" enum="Monitor"> Number of active [RigidBody] and [VehicleBody] nodes in the game. </constant> - <constant name="PHYSICS_3D_COLLISION_PAIRS" value="25" enum="Monitor"> + <constant name="PHYSICS_3D_COLLISION_PAIRS" value="26" enum="Monitor"> Number of collision pairs in the 3D physics engine. </constant> - <constant name="PHYSICS_3D_ISLAND_COUNT" value="26" enum="Monitor"> + <constant name="PHYSICS_3D_ISLAND_COUNT" value="27" enum="Monitor"> Number of islands in the 3D physics engine. </constant> - <constant name="AUDIO_OUTPUT_LATENCY" value="27" enum="Monitor"> + <constant name="AUDIO_OUTPUT_LATENCY" value="28" enum="Monitor"> </constant> - <constant name="MONITOR_MAX" value="28" enum="Monitor"> + <constant name="MONITOR_MAX" value="29" enum="Monitor"> </constant> </constants> </class> diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 641e1898ff..172420e4ca 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -18,6 +18,8 @@ </argument> <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> </argument> + <argument index="3" name="disabled" type="bool" default="false"> + </argument> <description> Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> @@ -251,7 +253,7 @@ </argument> <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="2" name="disable" type="bool"> + <argument index="2" name="disabled" type="bool"> </argument> <description> Disables a given shape in an area. @@ -346,6 +348,8 @@ </argument> <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> </argument> + <argument index="3" name="disabled" type="bool" default="false"> + </argument> <description> Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> @@ -746,7 +750,7 @@ </argument> <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="2" name="disable" type="bool"> + <argument index="2" name="disabled" type="bool"> </argument> <description> Disables shape in body if [code]disable[/code] is [code]true[/code]. diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index 4d94c57ad1..fc4f2e18fd 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -32,7 +32,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Returns an individual bit on the collision mask. + Returns an individual bit on the [member collision_layer]. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -41,7 +41,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Returns an individual bit on the collision mask. + Returns an individual bit on the [member collision_mask]. </description> </method> <method name="remove_collision_exception_with"> @@ -61,7 +61,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Sets individual bits on the layer mask. Use this if you only need to change one layer's value. + Sets individual bits on the [member collision_layer] bitmask. Use this if you only need to change one layer's value. </description> </method> <method name="set_collision_mask_bit"> @@ -72,18 +72,20 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Sets individual bits on the collision mask. Use this if you only need to change one layer's value. + Sets individual bits on the [member collision_mask] bitmask. Use this if you only need to change one layer's value. </description> </method> </methods> <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> The physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. + Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the [member collision_mask] property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + Default value: 1 (the first layer/bit is enabled). </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> The physics layers this area scans for collisions. + Default value: 1 (the first layer/bit is enabled). </member> </members> <constants> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index faa992ef7a..a5024c2432 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -32,7 +32,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Returns an individual bit on the collision mask. + Returns an individual bit on the [member collision_layer]. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -41,7 +41,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Returns an individual bit on the collision mask. + Returns an individual bit on the [member collision_mask]. </description> </method> <method name="remove_collision_exception_with"> @@ -61,7 +61,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Sets individual bits on the layer mask. Use this if you only need to change one layer's value. + Sets individual bits on the [member collision_layer] bitmask. Use this if you only need to change one layer's value. </description> </method> <method name="set_collision_mask_bit"> @@ -72,18 +72,20 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Sets individual bits on the collision mask. Use this if you only need to change one layer's value. + Sets individual bits on the [member collision_mask] bitmask. Use this if you only need to change one layer's value. </description> </method> </methods> <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> The physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. + Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the [member collision_mask] property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + Default value: 1 (the first layer/bit is enabled). </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> The physics layers this area scans for collisions. + Default value: 1 (the first layer/bit is enabled). </member> <member name="layers" type="int" setter="_set_layers" getter="_get_layers"> Both [member collision_layer] and [member collision_mask]. Returns [member collision_layer] when accessed. Updates [member collision_layer] and [member collision_mask] when modified. diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 25869a853c..78a6ed8ac0 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -18,6 +18,8 @@ </argument> <argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> </argument> + <argument index="3" name="disabled" type="bool" default="false"> + </argument> <description> Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> @@ -246,6 +248,18 @@ Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> + <method name="area_set_shape_disabled"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> <method name="area_set_shape_transform"> <return type="void"> </return> @@ -334,6 +348,8 @@ </argument> <argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> </argument> + <argument index="3" name="disabled" type="bool" default="false"> + </argument> <description> Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> @@ -750,6 +766,18 @@ Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> + <method name="body_set_shape_disabled"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> <method name="body_set_shape_transform"> <return type="void"> </return> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index df76b45f9f..a5e5c7022f 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -80,7 +80,7 @@ <argument index="1" name="epsilon" type="float" default="0.00001"> </argument> <description> - Returns true if "point" is inside the plane (by a very minimum threshold). + Returns [code]true[/code] if "point" is inside the plane (by a very minimum threshold). </description> </method> <method name="intersect_3"> @@ -122,7 +122,7 @@ <argument index="0" name="point" type="Vector3"> </argument> <description> - Returns true if "point" is located above the plane. + Returns [code]true[/code] if "point" is located above the plane. </description> </method> <method name="normalized"> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 67419377e8..cb99b660ae 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -112,11 +112,18 @@ Change the byte at the given index. </description> </method> + <method name="sha256_string"> + <return type="String"> + </return> + <description> + Returns SHA256 string of the PoolByteArray. + </description> + </method> <method name="size"> <return type="int"> </return> <description> - Return the size of the array. + Returns the size of the array. </description> </method> <method name="subarray"> diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index d16029a8d7..efc3582ba4 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -82,7 +82,7 @@ <return type="int"> </return> <description> - Return the size of the array. + Returns the size of the array. </description> </method> </methods> diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 83d73c8a24..fca1083c25 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -82,7 +82,7 @@ <return type="int"> </return> <description> - Return the array size. + Returns the array size. </description> </method> </methods> diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index e1da99519c..c5f6062175 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -82,7 +82,7 @@ <return type="int"> </return> <description> - Return the size of the array. + Returns the size of the array. </description> </method> </methods> diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index 6ef4222996..01dca93be3 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -91,7 +91,7 @@ <return type="int"> </return> <description> - Return the size of the array. + Returns the size of the array. </description> </method> </methods> diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index 50ded06b90..45f619dc5d 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -82,7 +82,7 @@ <return type="int"> </return> <description> - Return the size of the array. + Returns the size of the array. </description> </method> </methods> diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index 69b4e54692..0a682e2baf 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -82,7 +82,7 @@ <return type="int"> </return> <description> - Return the size of the array. + Returns the size of the array. </description> </method> </methods> diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index c3256f2f5b..e1b51463b2 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -27,6 +27,17 @@ Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by "size". </description> </method> + <method name="popup_centered_clamped"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <argument index="1" name="fallback_ratio" type="float" default="0.75"> + </argument> + <description> + Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, clamping the size to [code]size[/code], then ensuring the popup is no larger than the viewport size multiplied by [code]fallback_ratio[/code]. + </description> + </method> <method name="popup_centered_minsize"> <return type="void"> </return> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 4924175b6e..d4f4834a66 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -178,14 +178,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. + Returns the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> <method name="get_item_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of items. + Returns the amount of items. </description> </method> <method name="get_item_icon" qualifiers="const"> @@ -194,7 +194,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the icon of the item at index "idx". + Returns the icon of the item at index "idx". </description> </method> <method name="get_item_id" qualifiers="const"> @@ -203,7 +203,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the id of the item at index "idx". + Returns the id of the item at index "idx". </description> </method> <method name="get_item_index" qualifiers="const"> @@ -221,7 +221,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. + Returns the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. </description> </method> <method name="get_item_shortcut" qualifiers="const"> @@ -238,7 +238,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the submenu name of the item at index "idx". + Returns the submenu name of the item at index "idx". </description> </method> <method name="get_item_text" qualifiers="const"> @@ -247,7 +247,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the text of the item at index "idx". + Returns the text of the item at index "idx". </description> </method> <method name="get_item_tooltip" qualifiers="const"> @@ -270,7 +270,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. + Returns whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="is_item_checked" qualifiers="const"> @@ -279,7 +279,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item at index "idx" is checked. + Returns whether the item at index "idx" is checked. </description> </method> <method name="is_item_disabled" qualifiers="const"> @@ -288,7 +288,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. + Returns whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. </description> </method> <method name="is_item_radio_checkable" qualifiers="const"> @@ -297,7 +297,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + Returns whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. </description> </method> <method name="is_item_separator" qualifiers="const"> @@ -306,7 +306,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item is a separator. If it is, it would be displayed as a line. + Returns whether the item is a separator. If it is, it would be displayed as a line. </description> </method> <method name="is_item_shortcut_disabled" qualifiers="const"> @@ -527,14 +527,14 @@ </members> <signals> <signal name="id_focused"> - <argument index="0" name="ID" type="int"> + <argument index="0" name="id" type="int"> </argument> <description> This event is emitted when user navigated to an item of some id using [code]ui_up[/code] or [code]ui_down[/code] action. </description> </signal> <signal name="id_pressed"> - <argument index="0" name="ID" type="int"> + <argument index="0" name="id" type="int"> </argument> <description> This event is emitted when an item of some id is pressed or its accelerator is activated. diff --git a/doc/classes/PrismMesh.xml b/doc/classes/PrismMesh.xml index 0d0f330647..4c282c5e8d 100644 --- a/doc/classes/PrismMesh.xml +++ b/doc/classes/PrismMesh.xml @@ -12,7 +12,7 @@ </methods> <members> <member name="left_to_right" type="float" setter="set_left_to_right" getter="get_left_to_right"> - Displacement of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). + Displacement of the upper edge along the x-axis. 0.0 positions edge straight above the bottom left edge. Defaults to 0.5 (positioned on the midpoint). </member> <member name="size" type="Vector3" setter="set_size" getter="get_size"> Size of the prism. Defaults to (2.0, 2.0, 2.0). diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index a1558c186b..ff8b702859 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -4,7 +4,7 @@ Contains global variables accessible from everywhere. </brief_description> <description> - Contains global variables accessible from everywhere. Use "ProjectSettings.get_setting(variable)", "ProjectSettings.set_setting(variable,value)" or "ProjectSettings.has_setting(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. + Contains global variables accessible from everywhere. Use [method get_setting], [method set_setting] or [method has_setting] to access them. Variables stored in [code]project.godot[/code] are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. </description> <tutorials> </tutorials> @@ -15,7 +15,7 @@ <argument index="0" name="hint" type="Dictionary"> </argument> <description> - Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String]. + Adds a custom property info to a property. The dictionary must contain: name:[String](the property's name) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String]. Example: [codeblock] ProjectSettings.set("category/property_name", 0) @@ -37,7 +37,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Clear the whole configuration (not recommended, may break things). + Clears the whole configuration (not recommended, may break things). </description> </method> <method name="get_order" qualifiers="const"> @@ -46,7 +46,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Return the order of a configuration value (influences when saved to the config file). + Returns the order of a configuration value (influences when saved to the config file). </description> </method> <method name="get_setting" qualifiers="const"> @@ -63,7 +63,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Convert a localized path (res://) to a full native OS path. + Converts a localized path ([code]res://[/code]) to a full native OS path. </description> </method> <method name="has_setting" qualifiers="const"> @@ -72,7 +72,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Return true if a configuration value is present. + Returns [code]true[/code] if a configuration value is present. </description> </method> <method name="load_resource_pack"> @@ -81,7 +81,7 @@ <argument index="0" name="pack" type="String"> </argument> <description> - Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem (res://). Returns true on success. + Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem ([code]res://[/code]). Returns [code]true[/code] on success. Note: If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code]. </description> </method> @@ -91,7 +91,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Convert a path to a localized path (res:// path). + Convert a path to a localized path ([code]res://[/code] path). </description> </method> <method name="property_can_revert"> @@ -100,7 +100,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Returns true if the specified property exists and its initial value differs from the current value. + Returns [code]true[/code] if the specified property exists and its initial value differs from the current value. </description> </method> <method name="property_get_revert"> @@ -109,14 +109,14 @@ <argument index="0" name="name" type="String"> </argument> <description> - Returns the initial value of the specified property. Returns null if the property does not exist. + Returns the specified property's initial value. Returns [code]null[/code] if the property does not exist. </description> </method> <method name="save"> <return type="int" enum="Error"> </return> <description> - Saves the configuration to the project.godot file. + Saves the configuration to the [code]project.godot[/code] file. </description> </method> <method name="save_custom"> @@ -146,7 +146,7 @@ <argument index="1" name="position" type="int"> </argument> <description> - Set the order of a configuration value (influences when saved to the config file). + Sets the order of a configuration value (influences when saved to the config file). </description> </method> <method name="set_setting"> @@ -168,62 +168,68 @@ Background color for the boot splash. </member> <member name="application/boot_splash/fullsize" type="bool" setter="" getter=""> - Scale the boot splash image to the full window length when engine starts (will leave it as default pixel size otherwise). + If [code]true[/code], scale the boot splash image to the full window length when engine starts. If [code]false[/code], the engine will leave it at the default pixel size. </member> <member name="application/boot_splash/image" type="String" setter="" getter=""> - Path to an image used for boot splash. + Path to an image used as the boot splash. </member> <member name="application/config/custom_user_dir_name" type="String" setter="" getter=""> - This user directory is used for storing persistent data ([code]user://[/code] filesystem). By default (no custom name defined), [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]). + This user directory is used for storing persistent data ([code]user://[/code] filesystem). If left empty, [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]). The [member application/config/use_custom_user_dir] setting must be enabled for this to take effect. </member> <member name="application/config/icon" type="String" setter="" getter=""> - Icon used for the project, set when project loads. Exporters will use this icon when possible to. + Icon used for the project, set when project loads. Exporters will also use this icon when possible. + </member> + <member name="application/config/macos_native_icon" type="String" setter="" getter=""> </member> <member name="application/config/name" type="String" setter="" getter=""> - Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages. + The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. </member> <member name="application/config/project_settings_override" type="String" setter="" getter=""> Specifies a file to override project settings. For example: [code]user://custom_settings.cfg[/code]. </member> <member name="application/config/use_custom_user_dir" type="bool" setter="" getter=""> - Allow the project to save to its own custom user dir (see [member application/config/custom_user_dir_name]). This setting only works for desktop platforms. A name must be set in the [member application/config/custom_user_dir_name] setting for this to take effect. + If [code]true[/code], the project will save user data to its own user directory (see [member application/config/custom_user_dir_name]). This setting is only effective on desktop platforms. A name must be set in the [member application/config/custom_user_dir_name] setting for this to take effect. If [code]false[/code], the project will save user data to [code](OS user data directory)/Godot/app_userdata/(project name)[/code]. + </member> + <member name="application/config/windows_native_icon" type="String" setter="" getter=""> </member> <member name="application/run/disable_stderr" type="bool" setter="" getter=""> - Disable printing to stderr on exported build. + If [code]true[/code], disables printing to standard error in an exported build. </member> <member name="application/run/disable_stdout" type="bool" setter="" getter=""> - Disable printing to stdout on exported build. + If [code]true[/code], disables printing to standard output in an exported build. </member> <member name="application/run/frame_delay_msec" type="int" setter="" getter=""> - Force a delay between frames in the main loop. This may be useful if you plan to disable vsync. + Forces a delay between frames in the main loop (in milliseconds). This may be useful if you plan to disable vertical synchronization. </member> <member name="application/run/low_processor_mode" type="bool" setter="" getter=""> - Turn on low processor mode. This setting only works on desktops. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) on games. + If [code]true[/code], enables low-processor usage mode. This setting only works on desktop platforms. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) in most games. </member> <member name="application/run/low_processor_mode_sleep_usec" type="int" setter="" getter=""> - Amount of sleeping between frames when the low_processor_mode is enabled. This effectively reduces CPU usage when this mode is enabled. + Amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage. </member> <member name="application/run/main_scene" type="String" setter="" getter=""> Path to the main scene file that will be loaded when the project runs. </member> <member name="audio/channel_disable_threshold_db" type="float" setter="" getter=""> - Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. + Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. </member> <member name="audio/channel_disable_time" type="float" setter="" getter=""> - Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. + Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. </member> <member name="audio/default_bus_layout" type="String" setter="" getter=""> </member> <member name="audio/driver" type="String" setter="" getter=""> + Specifies the audio driver to use. This setting is platform-dependent as each platform supports different audio drivers. If left empty, the default audio driver will be used. </member> <member name="audio/enable_audio_input" type="bool" setter="" getter=""> - This option should be enabled if project works with microphone. + If [code]true[/code], microphone input will be allowed. This requires appropriate permissions to be set when exporting to Android or iOS. </member> <member name="audio/mix_rate" type="int" setter="" getter=""> - Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system. + Mixing rate used for audio. In general, it's better to not touch this and leave it to the host operating system. </member> <member name="audio/output_latency" type="int" setter="" getter=""> + Output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. </member> <member name="audio/video_delay_compensation_ms" type="int" setter="" getter=""> Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. @@ -232,75 +238,105 @@ Default compression level for gzip. Affects compressed scenes and resources. </member> <member name="compression/formats/zlib/compression_level" type="int" setter="" getter=""> - Default compression level for zlib. Affects compressed scenes and resources. + Default compression level for Zlib. Affects compressed scenes and resources. </member> <member name="compression/formats/zstd/compression_level" type="int" setter="" getter=""> - Default compression level for zstd. Affects compressed scenes and resources. + Default compression level for Zstandard. Affects compressed scenes and resources. </member> <member name="compression/formats/zstd/long_distance_matching" type="bool" setter="" getter=""> - Enable long distance matching in zstd. + Enables long-distance matching in Zstandard. </member> <member name="compression/formats/zstd/window_log_size" type="int" setter="" getter=""> </member> <member name="debug/gdscript/completion/autocomplete_setters_and_getters" type="bool" setter="" getter=""> + If [code]true[/code], displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards. </member> <member name="debug/gdscript/warnings/constant_used_as_function" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a constant is used as a function. </member> <member name="debug/gdscript/warnings/deprecated_keyword" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when deprecated keywords such as [code]slave[/code] are used. </member> <member name="debug/gdscript/warnings/enable" type="bool" setter="" getter=""> + If [code]true[/code], enables specific GDScript warnings (see [code]debug/gdscript/warnings/*[/code] settings). If [code]false[/code], disables all GDScript warnings. </member> <member name="debug/gdscript/warnings/function_conflicts_constant" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a function is declared with the same name as a constant. </member> <member name="debug/gdscript/warnings/function_conflicts_variable" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a function is declared with the same name as a variable. This will turn into an error in a future version when first-class functions become supported in GDScript. </member> <member name="debug/gdscript/warnings/function_may_yield" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a function assigned to a variable may yield and return a function state instead of a value. </member> <member name="debug/gdscript/warnings/function_used_as_property" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when using a function as if it was a property. </member> <member name="debug/gdscript/warnings/incompatible_ternary" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a ternary operator may emit values with incompatible types. </member> <member name="debug/gdscript/warnings/integer_division" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when dividing an integer by another integer (the decimal part will be discarded). </member> <member name="debug/gdscript/warnings/narrowing_conversion" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when passing a floating-point value to a function that expects an integer (it will be converted and lose precision). </member> <member name="debug/gdscript/warnings/property_used_as_function" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when using a property as if it was a function. </member> <member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum Error] enum. </member> <member name="debug/gdscript/warnings/shadowed_variable" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when defining a local or subclass member variable that would shadow a variable at an upper level (such as a member variable). </member> <member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement. </member> <member name="debug/gdscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter=""> + If [code]true[/code], all warnings will be reported as if they were errors. </member> <member name="debug/gdscript/warnings/unassigned_variable" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when using a variable that wasn't previously assigned. </member> <member name="debug/gdscript/warnings/unassigned_variable_op_assign" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when assigning a variable using an assignment operator like [code]+=[/code] if the variable wasn't previously assigned. </member> <member name="debug/gdscript/warnings/unreachable_code" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when unreachable code is detected (such as after a [code]return[/code] statement that will always be executed). </member> <member name="debug/gdscript/warnings/unsafe_call_argument" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when using an expression whose type may not be compatible with the function parameter expected. </member> <member name="debug/gdscript/warnings/unsafe_cast" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when performing an unsafe cast. </member> <member name="debug/gdscript/warnings/unsafe_method_access" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when calling a method whose presence is not guaranteed at compile-time in the class. </member> <member name="debug/gdscript/warnings/unsafe_property_access" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when accessing a property whose presence is not guaranteed at compile-time in the class. </member> <member name="debug/gdscript/warnings/unused_argument" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a function parameter is unused. </member> <member name="debug/gdscript/warnings/unused_class_variable" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a member variable is unused. </member> <member name="debug/gdscript/warnings/unused_signal" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a signal is unused. </member> <member name="debug/gdscript/warnings/unused_variable" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a local variable is unused. </member> <member name="debug/gdscript/warnings/variable_conflicts_function" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when a variable is declared with the same name as a function. This will turn into an error in a future version when first-class functions become supported in GDScript. </member> <member name="debug/gdscript/warnings/void_assignment" type="bool" setter="" getter=""> + If [code]true[/code], enables warnings when assigning the result of a function that returns [code]void[/code] to a variable. </member> <member name="debug/settings/crash_handler/message" type="String" setter="" getter=""> + Message to be displayed before the backtrace when the engine crashes. </member> <member name="debug/settings/fps/force_fps" type="int" setter="" getter=""> </member> @@ -311,34 +347,34 @@ Maximum amount of functions per frame allowed when profiling. </member> <member name="debug/settings/stdout/print_fps" type="bool" setter="" getter=""> - Print frames per second to stdout. Not very useful in general. + Print frames per second to standard output every second. </member> <member name="debug/settings/stdout/verbose_stdout" type="bool" setter="" getter=""> - Print more information to stdout when running. It shows info such as memory leaks, which scenes and resources are being loaded, etc. + Print more information to standard output when running. It displays information such as memory leaks, which scenes and resources are being loaded, etc. </member> <member name="debug/settings/visual_script/max_call_stack" type="int" setter="" getter=""> Maximum call stack in visual scripting, to avoid infinite recursion. </member> <member name="display/mouse_cursor/custom_image" type="String" setter="" getter=""> - Custom image for the mouse cursor. + Custom image for the mouse cursor (limited to 256x256). </member> <member name="display/mouse_cursor/custom_image_hotspot" type="Vector2" setter="" getter=""> Hotspot for the custom mouse cursor image. </member> <member name="display/mouse_cursor/tooltip_position_offset" type="Vector2" setter="" getter=""> - Position offset for tooltips, relative to the hotspot of the mouse cursor. + Position offset for tooltips, relative to the mouse cursor's hotspot. </member> <member name="display/window/dpi/allow_hidpi" type="bool" setter="" getter=""> - Allow HiDPI display on Windows and OSX. On Desktop Linux, this can't be enabled or disabled. + If [code]true[/code], allows HiDPI display on Windows and macOS. This setting has no effect on desktop Linux, as DPI-awareness fallbacks are not supported there. </member> <member name="display/window/energy_saving/keep_screen_on" type="bool" setter="" getter=""> - Force keep the screen on, so the screensaver does not take over. Works on Desktop and Mobile. + If [code]true[/code], keeps the screen on (even in case of inactivity), so the screensaver does not take over. Works on desktop and mobile platforms. </member> <member name="display/window/handheld/orientation" type="String" setter="" getter=""> - Default orientation for cell phone or tablet. + Default orientation on mobile devices. </member> <member name="display/window/per_pixel_transparency/allowed" type="bool" setter="" getter=""> - Allow per pixel transparency in a Desktop window. This affects performance if not needed, so leave it off. + If [code]true[/code], allows per-pixel transparency in a desktop window. This affects performance if not needed, so leave it on [code]false[/code] unless you need it. </member> <member name="display/window/per_pixel_transparency/enabled" type="bool" setter="" getter=""> </member> @@ -357,19 +393,19 @@ Set the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. </member> <member name="display/window/size/resizable" type="bool" setter="" getter=""> - Allow the window to be resizable by default. + Allows the window to be resizable by default. </member> <member name="display/window/size/test_height" type="int" setter="" getter=""> - Test a different height for the window. The main use for this is to test with stretch modes. + If greater than zero, uses a different height for the window when running from the editor. The main use for this is to test with stretch modes. </member> <member name="display/window/size/test_width" type="int" setter="" getter=""> - Test a different width for the window. The main use for this is to test with stretch modes. + If greater than zero, uses a different width for the window when running from the editor. The main use for this is to test with stretch modes. </member> <member name="display/window/size/width" type="int" setter="" getter=""> - Set the main window width. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. + Sets the main window width. On desktop platforms, this is the default window size. Stretch mode settings use this also as a reference when enabled. </member> <member name="display/window/vsync/use_vsync" type="bool" setter="" getter=""> - Use VSync. Don't be stupid, don't turn this off. + If [code]true[/code], enables vertical synchronization. This eliminates tearing that may appear in moving scenes, at the cost of higher input latency and stuttering at lower framerates. If [code]false[/code], vertical synchronization will be disabled, however, many platforms will enforce it regardless (such as mobile platforms and HTML5). </member> <member name="editor/active" type="bool" setter="" getter=""> Internal editor setting, don't touch. @@ -377,22 +413,22 @@ <member name="gui/common/default_scroll_deadzone" type="int" setter="" getter=""> </member> <member name="gui/common/swap_ok_cancel" type="bool" setter="" getter=""> - Enable swap OK and Cancel buttons on dialogs. This is because Windows/MacOS/Desktop Linux may use them in different order, so the GUI swaps them depending on the host OS. Disable this behavior by turning this setting off. + If [code]true[/code], swaps OK and Cancel buttons in dialogs on Windows and UWP to follow interface conventions. </member> <member name="gui/theme/custom" type="String" setter="" getter=""> Use a custom theme resource, set a path to it here. </member> <member name="gui/theme/custom_font" type="String" setter="" getter=""> - USe a custom default font resource, set a path to it here. + Use a custom default font resource, set a path to it here. </member> <member name="gui/theme/use_hidpi" type="bool" setter="" getter=""> - Make sure the theme used works with hidpi. + If [code]true[/code], makes sure the theme used works with HiDPI. </member> <member name="gui/timers/incremental_search_max_interval_msec" type="int" setter="" getter=""> - Timer setting for incremental search in Tree, IntemList, etc. controls. + Timer setting for incremental search in Tree, IntemList, etc. controls (in milliseconds). </member> <member name="gui/timers/text_edit_idle_detect_sec" type="float" setter="" getter=""> - Timer for detecting idle in the editor. + Timer for detecting idle in the editor (in seconds). </member> <member name="input/ui_accept" type="Dictionary" setter="" getter=""> </member> @@ -421,8 +457,10 @@ <member name="input/ui_up" type="Dictionary" setter="" getter=""> </member> <member name="input_devices/pointing/emulate_mouse_from_touch" type="bool" setter="" getter=""> + If [code]true[/code], sends mouse input events when tapping or swiping on the touchscreen. </member> <member name="input_devices/pointing/emulate_touch_from_mouse" type="bool" setter="" getter=""> + If [code]true[/code], sends touch input events when clicking or dragging the mouse. </member> <member name="layer_names/2d_physics/layer_1" type="String" setter="" getter=""> </member> @@ -585,23 +623,25 @@ <member name="layer_names/3d_render/layer_9" type="String" setter="" getter=""> </member> <member name="locale/fallback" type="String" setter="" getter=""> + The locale to fall back to if a translation isn't available in a given language. If left empty, [code]en[/code] (English) will be used. </member> <member name="locale/test" type="String" setter="" getter=""> + If non-empty, this locale will be used when running the project from the editor. </member> <member name="logging/file_logging/enable_file_logging" type="bool" setter="" getter=""> - Log all output to a file. + If [code]true[/code], logs all output to files. </member> <member name="logging/file_logging/log_path" type="String" setter="" getter=""> - Path to logs withint he project. Using an [code]user://[/code] based path is recommended. + Path to logs within the project. Using an [code]user://[/code] path is recommended. </member> <member name="logging/file_logging/max_log_files" type="int" setter="" getter=""> - Amount of log files (used for rotation). + Specifies the maximum amount of log files allowed (used for rotation). </member> <member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter=""> Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. </member> <member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter=""> - This is used by servers when used in multi threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. + This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. </member> <member name="network/limits/debugger_stdout/max_chars_per_second" type="int" setter="" getter=""> Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. @@ -613,7 +653,7 @@ Maximum amount of messages allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. </member> <member name="network/limits/packet_peer_stream/max_buffer_po2" type="int" setter="" getter=""> - Default size of packet peer stream for deserializing godot data. Over this size, data is dropped. + Default size of packet peer stream for deserializing Godot data. Over this size, data is dropped. </member> <member name="network/limits/websocket_client/max_in_buffer_kb" type="int" setter="" getter=""> </member> @@ -632,13 +672,13 @@ <member name="network/limits/websocket_server/max_out_packets" type="int" setter="" getter=""> </member> <member name="network/remote_fs/page_read_ahead" type="int" setter="" getter=""> - Amount of read ahead used by remote filesystem. Improves latency. + Amount of read ahead used by remote filesystem. Higher values decrease the effects of latency at the cost of higher bandwidth usage. </member> <member name="network/remote_fs/page_size" type="int" setter="" getter=""> - Page size used by remote filesystem. + Page size used by remote filesystem (in bytes). </member> <member name="node/name_casing" type="int" setter="" getter=""> - When creating nodes names automatically, set the type of casing in this project. This is mostly an editor setting. + When creating node names automatically, set the type of casing in this project. This is mostly an editor setting. </member> <member name="node/name_num_separator" type="int" setter="" getter=""> What to use to separate node name from number. This is mostly an editor setting. @@ -646,20 +686,21 @@ <member name="physics/2d/physics_engine" type="String" setter="" getter=""> </member> <member name="physics/2d/thread_model" type="int" setter="" getter=""> - Set whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API Access to only physics process. + Sets whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API access to only physics process. </member> <member name="physics/3d/active_soft_world" type="bool" setter="" getter=""> </member> <member name="physics/3d/physics_engine" type="String" setter="" getter=""> + Sets which physics engine to use. </member> <member name="physics/common/physics_fps" type="int" setter="" getter=""> Frames per second used in the physics. Physics always needs a fixed amount of frames per second. </member> <member name="physics/common/physics_jitter_fix" type="float" setter="" getter=""> - Fix to improve physics jitter, specially on monitors where refresh rate is different than physics FPS. + Fix to improve physics jitter, specially on monitors where refresh rate is different than the physics FPS. </member> <member name="rendering/environment/default_clear_color" type="Color" setter="" getter=""> - Default background clear color. Overridable per [Viewport] using its [Environment]. See [member Environment.background_mode] and [member Environment.background_color] in particular. To change this default color programmatically, use [method VisualServer.set_default_clear_color]. + Default background clear color. Overriddable per [Viewport] using its [Environment]. See [member Environment.background_mode] and [member Environment.background_color] in particular. To change this default color programmatically, use [method VisualServer.set_default_clear_color]. </member> <member name="rendering/limits/buffers/blend_shape_max_buffer_size_kb" type="int" setter="" getter=""> Max buffer size for blend shapes. Any blend shape bigger than this will not work. @@ -674,68 +715,70 @@ Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. </member> <member name="rendering/limits/rendering/max_renderable_elements" type="int" setter="" getter=""> - Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not mesh themselves. + Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves. </member> <member name="rendering/limits/time/time_rollover_secs" type="float" setter="" getter=""> - Shaders have a time variable that constantly increases. At some point it needs to be rolled back to zero to avoid numerical errors on shader animations. This setting specifies when. + Shaders have a time variable that constantly increases. At some point, it needs to be rolled back to zero to avoid precision errors on shader animations. This setting specifies when (in seconds). </member> <member name="rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround" type="bool" setter="" getter=""> - Some Nvidia GPU drivers have a bug, which produces flickering issues for the [code]draw_rect[/code] method, especially as used in [TileMap]. Refer to https://github.com/godotengine/godot/issues/9913 for details. - If [code]true[/code], this option enables a "safe" code path for such Nvidia GPUs, at the cost of performance. This option only impacts the GLES2 rendering backend (so the bug stays if you use GLES3), and only desktop platforms. Default value: [code]false[/code]. + Some NVIDIA GPU drivers have a bug which produces flickering issues for the [code]draw_rect[/code] method, especially as used in [TileMap]. Refer to [url=https://github.com/godotengine/godot/issues/9913][/url] for details. + If [code]true[/code], this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend (so the bug stays if you use GLES3), and only desktop platforms. </member> <member name="rendering/quality/2d/use_pixel_snap" type="bool" setter="" getter=""> - Force snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. + If [code]true[/code], forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. </member> <member name="rendering/quality/depth_prepass/disable_for_vendors" type="String" setter="" getter=""> Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. </member> <member name="rendering/quality/depth_prepass/enable" type="bool" setter="" getter=""> - Do a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. + If [code]true[/code], performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. </member> <member name="rendering/quality/directional_shadow/size" type="int" setter="" getter=""> - Size in pixels of the directional shadow. + The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. </member> <member name="rendering/quality/directional_shadow/size.mobile" type="int" setter="" getter=""> </member> <member name="rendering/quality/driver/driver_name" type="String" setter="" getter=""> - Name of the configured video driver ("GLES2" or "GLES3"). - Note that the backend in use can be overridden at runtime via the [code]--video-driver[/code] command line argument, or by the [member rendering/quality/driver/fallback_to_gles2] option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use [method OS.get_current_video_driver] to query it at runtime. + The video driver to use ("GLES2" or "GLES3"). + Note that the backend in use can be overridden at runtime via the [code]--video-driver[/code] command line argument, or by the [member rendering/quality/driver/fallback_to_gles2] option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use [method OS.get_current_video_driver] to query it at run-time. </member> <member name="rendering/quality/driver/fallback_to_gles2" type="bool" setter="" getter=""> - Whether to allow falling back to the GLES2 driver if the GLES3 driver is not supported. Default value: [code]false[/code]. - Note that the two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the size of the game data pack. + If [code]true[/code], allows falling back to the GLES2 driver if the GLES3 driver is not supported. + Note that the two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the data pack's size. </member> <member name="rendering/quality/filters/anisotropic_filter_level" type="int" setter="" getter=""> - Maximum Anisotropic filter level used for textures when anisotropy enabled. + Maximum anisotropic filter level used for textures with anisotropy enabled. Higher values will result in sharper textures when viewed from oblique angles, at the cost of performance. Only power-of-two values are valid (2, 4, 8, 16). </member> <member name="rendering/quality/filters/use_nearest_mipmap_filter" type="bool" setter="" getter=""> - Force to use nearest mipmap filtering when using mipmaps. This may increase performance in mobile as less memory bandwidth is used. + If [code]true[/code], uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If [code]false[/code], linear mipmap filtering (also called "trilinear filtering") is used. </member> <member name="rendering/quality/intended_usage/framebuffer_allocation" type="int" setter="" getter=""> - Strategy used for framebuffer allocation. The simpler it is, the less memory it uses (but the least features it supports). + Strategy used for framebuffer allocation. The simpler it is, the less resources it uses (but the less features it supports). </member> <member name="rendering/quality/intended_usage/framebuffer_allocation.mobile" type="int" setter="" getter=""> </member> <member name="rendering/quality/reflections/high_quality_ggx" type="bool" setter="" getter=""> - For reflection probes and panorama backgrounds (sky), use a high amount of samples to create ggx blurred versions (used for roughness). + If [code]true[/code], uses a high amount of samples to create blurred variants of reflection probes and panorama backgrounds (sky). Those blurred variants are used by rough materials. </member> <member name="rendering/quality/reflections/high_quality_ggx.mobile" type="bool" setter="" getter=""> </member> <member name="rendering/quality/reflections/texture_array_reflections" type="bool" setter="" getter=""> - For reflection probes and panorama backgrounds (sky), use a texture array instead of mipmaps. This reduces jitter noise on reflections, but costs more performance and memory. + If [code]true[/code], uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise on reflections, but costs more performance and memory. </member> <member name="rendering/quality/reflections/texture_array_reflections.mobile" type="bool" setter="" getter=""> </member> <member name="rendering/quality/shading/force_blinn_over_ggx" type="bool" setter="" getter=""> + If [code]true[/code], uses faster but lower-quality Blinn model to generate blurred reflections instead of the GGX model. </member> <member name="rendering/quality/shading/force_blinn_over_ggx.mobile" type="bool" setter="" getter=""> </member> <member name="rendering/quality/shading/force_lambert_over_burley" type="bool" setter="" getter=""> + If [code]true[/code], uses faster but lower-quality Lambert material lighting model instead of Burley. </member> <member name="rendering/quality/shading/force_lambert_over_burley.mobile" type="bool" setter="" getter=""> </member> <member name="rendering/quality/shading/force_vertex_shading" type="bool" setter="" getter=""> - Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can work to optimize on very low end mobile. + If [code]true[/code], forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices. </member> <member name="rendering/quality/shading/force_vertex_shading.mobile" type="bool" setter="" getter=""> </member> @@ -752,12 +795,12 @@ Subdivision quadrant size for shadow mapping. See shadow mapping documentation. </member> <member name="rendering/quality/shadow_atlas/size" type="int" setter="" getter=""> - Size for shadow atlas (used for point and omni lights). See documentation. + Size for shadow atlas (used for OmniLights and SpotLights). See documentation. </member> <member name="rendering/quality/shadow_atlas/size.mobile" type="int" setter="" getter=""> </member> <member name="rendering/quality/shadows/filter_mode" type="int" setter="" getter=""> - Shadow filter mode. The more complex the filter, the more memory bandwidth required. + Shadow filter mode. Higher-quality settings result in smoother shadows that flicker less when moving. "Disabled" is the fastest option, but also has the lowest quality. "PCF5" is smoother but is also slower. "PCF13" is the smoothest option, but is also the slowest. </member> <member name="rendering/quality/shadows/filter_mode.mobile" type="int" setter="" getter=""> </member> @@ -773,24 +816,25 @@ Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. </member> <member name="rendering/quality/voxel_cone_tracing/high_quality" type="bool" setter="" getter=""> - Use high quality voxel cone tracing (looks better, but requires a higher end GPU). + Use high-quality voxel cone tracing. This results in better-looking reflections, but is much more expensive on the GPU. </member> <member name="rendering/threads/thread_model" type="int" setter="" getter=""> - Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc to the main thread can cause a bit more jitter. + Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter. </member> <member name="rendering/vram_compression/import_bptc" type="bool" setter="" getter=""> + If [code]true[/code], the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the GLES3 renderer. </member> <member name="rendering/vram_compression/import_etc" type="bool" setter="" getter=""> - If the project uses this compression (usually low end mobile), texture importer will import these. + If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression algorithm. This algorithm doesn't support alpha channels in textures. </member> <member name="rendering/vram_compression/import_etc2" type="bool" setter="" getter=""> - If the project uses this compression (usually high end mobile), texture importer will import these. + If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the GLES3 renderer. </member> <member name="rendering/vram_compression/import_pvrtc" type="bool" setter="" getter=""> - If the project uses this compression (usually iOS), texture importer will import these. + If [code]true[/code], the texture importer will import VRAM-compressed textures using the PowerVR Texture Compression algorithm. This texture compression algorithm is only supported on iOS. </member> <member name="rendering/vram_compression/import_s3tc" type="bool" setter="" getter=""> - If the project uses this compression (usually Desktop and Consoles), texture importer will import these. + If [code]true[/code], the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles. </member> <member name="script" type="Script" setter="" getter=""> </member> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index f7134e580d..3ef65e1edb 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -84,7 +84,7 @@ <return type="Vector3"> </return> <description> - Return Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). + Returns Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). </description> </method> <method name="inverse"> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index 1d2999a1ed..1368143b67 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -50,7 +50,7 @@ <return type="Object"> </return> <description> - Return the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). + Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). </description> </method> <method name="get_collider_shape" qualifiers="const"> @@ -87,7 +87,7 @@ <return type="bool"> </return> <description> - Return whether any object is intersecting with the ray's vector (considering the vector length). + Returns whether any object is intersecting with the ray's vector (considering the vector length). </description> </method> <method name="remove_exception"> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 7a16e9e5e0..90e0178ddb 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -49,7 +49,7 @@ <return type="Object"> </return> <description> - Return the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). + Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). </description> </method> <method name="get_collider_shape" qualifiers="const"> @@ -65,7 +65,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the collision mask. + Returns an individual bit on the collision mask. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -86,7 +86,7 @@ <return type="bool"> </return> <description> - Return whether any object is intersecting with the ray's vector (considering the vector length). + Returns whether any object is intersecting with the ray's vector (considering the vector length). </description> </method> <method name="remove_exception"> diff --git a/doc/classes/ResourceFormatSaver.xml b/doc/classes/ResourceFormatSaver.xml index 79a813bcb5..caa05dce26 100644 --- a/doc/classes/ResourceFormatSaver.xml +++ b/doc/classes/ResourceFormatSaver.xml @@ -25,7 +25,7 @@ <argument index="0" name="resource" type="Resource"> </argument> <description> - Returns true if the given resource object can be saved by this saver. + Returns [code]true[/code] if the given resource object can be saved by this saver. </description> </method> <method name="save" qualifiers="virtual"> diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml index 6b37cb25fb..bb9826999c 100644 --- a/doc/classes/ResourceInteractiveLoader.xml +++ b/doc/classes/ResourceInteractiveLoader.xml @@ -13,21 +13,21 @@ <return type="Resource"> </return> <description> - Return the loaded resource (only if loaded). Otherwise, returns null. + Returns the loaded resource (only if loaded). Otherwise, returns null. </description> </method> <method name="get_stage" qualifiers="const"> <return type="int"> </return> <description> - Return the load stage. The total amount of stages can be queried with [method get_stage_count] + Returns the load stage. The total amount of stages can be queried with [method get_stage_count] </description> </method> <method name="get_stage_count" qualifiers="const"> <return type="int"> </return> <description> - Return the total amount of stages (calls to [method poll]) needed to completely load this resource. + Returns the total amount of stages (calls to [method poll]) needed to completely load this resource. </description> </method> <method name="poll"> diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 70deb4509f..76b7c39191 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -33,7 +33,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - Return the list of recognized extensions for a resource type. + Returns the list of recognized extensions for a resource type. </description> </method> <method name="has"> diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index d9e2466182..d6c635b6eb 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -42,7 +42,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Returns true if the preloader contains a resource associated to [code]name[/code]. + Returns [code]true[/code] if the preloader contains a resource associated to [code]name[/code]. </description> </method> <method name="remove_resource"> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index 25b896ec3a..9ea6bb0fe1 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -86,7 +86,7 @@ <return type="Array"> </return> <description> - Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the [member contacts_reported] property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. + Returns a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the [member contacts_reported] property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="set_axis_velocity"> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 16ee1a444c..9a1802b515 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -7,7 +7,8 @@ This node implements simulated 2D physics. You do not control a RigidBody2D directly. Instead you apply forces to it (gravity, impulses, etc.) and the physics simulation calculates the resulting movement based on its mass, friction, and other physical properties. A RigidBody2D has 4 behavior [member mode]s: Rigid, Static, Character, and Kinematic. [b]Note:[/b] You should not change a RigidBody2D's [code]position[/code] or [code]linear_velocity[/code] every frame or even very often. If you need to directly affect the body's state, use [method _integrate_forces], which allows you to directly access the physics state. - If you need to override the default physics behavior, you can write a custom force integration. See [member custom_integrator]. + Please also keep in mind that physics bodies manage their own transform which overwrites the ones you set. So any direct or indirect transformation (including scaling of the node or its parent) will be visible in the editor only, and immediately reset at runtime. + If you need to override the default physics behavior or add a transformation at runtime, you can write a custom force integration. See [member custom_integrator]. </description> <tutorials> </tutorials> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index b9199194cd..a236d776c7 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -61,7 +61,7 @@ <argument index="1" name="pause_mode_process" type="bool" default="true"> </argument> <description> - Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this SceneTree. If [code]pause_mode_process[/code] is set to false, pausing the SceneTree will also pause the timer. + Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this SceneTree. If [code]pause_mode_process[/code] is set to [code]false[/code], pausing the SceneTree will also pause the timer. Commonly used to create a one-shot delay timer as in the following example: [codeblock] func some_function(): @@ -359,6 +359,12 @@ Emitted whenever a node is removed from the SceneTree. </description> </signal> + <signal name="node_renamed"> + <argument index="0" name="node" type="Node"> + </argument> + <description> + </description> + </signal> <signal name="physics_frame"> <description> Emitted immediately before [method Node._physics_process] is called on every node in the SceneTree. diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 666ab15802..28e1f75ac1 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -55,6 +55,15 @@ Returns an array with all [Script] objects which are currently open in editor. </description> </method> + <method name="goto_line"> + <return type="void"> + </return> + <argument index="0" name="line_number" type="int"> + </argument> + <description> + Goes to the specified line in the current script. + </description> + </method> <method name="open_script_create_dialog"> <return type="void"> </return> diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index dec3c2b43c..c887e23de0 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -52,7 +52,7 @@ <argument index="4" name="shape_motion" type="Vector2"> </argument> <description> - Return whether this shape would collide with another, if a given movement was applied. + Returns whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). </description> </method> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index 4377cf52c3..b693ee0a5e 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -44,14 +44,14 @@ <argument index="0" name="name" type="String"> </argument> <description> - Return the bone index that matches "name" as its name. + Returns the bone index that matches "name" as its name. </description> </method> <method name="get_bone_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of bones in the skeleton. + Returns the amount of bones in the skeleton. </description> </method> <method name="get_bone_custom_pose" qualifiers="const"> @@ -60,7 +60,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the custom pose of the specified bone. Custom pose is applied on top of the rest pose. + Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. </description> </method> <method name="get_bone_global_pose" qualifiers="const"> @@ -69,7 +69,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. + Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. </description> </method> <method name="get_bone_name" qualifiers="const"> @@ -78,7 +78,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the name of the bone at index "index". + Returns the name of the bone at index "index". </description> </method> <method name="get_bone_parent" qualifiers="const"> @@ -87,7 +87,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". + Returns the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". </description> </method> <method name="get_bone_pose" qualifiers="const"> @@ -96,7 +96,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. + Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. </description> </method> <method name="get_bone_rest" qualifiers="const"> @@ -105,7 +105,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the rest transform for a bone "bone_idx". + Returns the rest transform for a bone "bone_idx". </description> </method> <method name="get_bone_transform" qualifiers="const"> @@ -114,7 +114,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the combination of custom pose and pose. The returned transform is in skeleton's reference frame. + Returns the combination of custom pose and pose. The returned transform is in skeleton's reference frame. </description> </method> <method name="get_bound_child_nodes_to_bone" qualifiers="const"> @@ -134,6 +134,12 @@ <description> </description> </method> + <method name="localize_rests"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="physical_bones_add_collision_exception"> <return type="void"> </return> @@ -223,7 +229,7 @@ <argument index="1" name="pose" type="Transform"> </argument> <description> - Return the pose transform for bone "bone_idx". + Returns the pose transform for bone "bone_idx". </description> </method> <method name="set_bone_rest"> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 8e93160af9..f0df5fac4a 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -120,6 +120,8 @@ <member name="flags_use_point_size" type="bool" setter="set_flag" getter="get_flag"> If [code]true[/code], render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size]. </member> + <member name="flags_use_shadow_to_opacity" type="bool" setter="set_flag" getter="get_flag"> + </member> <member name="flags_vertex_lighting" type="bool" setter="set_flag" getter="get_flag"> If [code]true[/code], lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: [code]false[/code]. </member> @@ -390,7 +392,9 @@ </constant> <constant name="FLAG_ENSURE_CORRECT_NORMALS" value="16" enum="Flags"> </constant> - <constant name="FLAG_MAX" value="18" enum="Flags"> + <constant name="FLAG_USE_SHADOW_TO_OPACITY" value="18" enum="Flags"> + </constant> + <constant name="FLAG_MAX" value="19" enum="Flags"> </constant> <constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode"> Default diffuse scattering algorithm. diff --git a/doc/classes/SphereMesh.xml b/doc/classes/SphereMesh.xml index 01f6ee027e..0124d8a4b0 100644 --- a/doc/classes/SphereMesh.xml +++ b/doc/classes/SphereMesh.xml @@ -15,7 +15,7 @@ Full height of the sphere. Defaults to 2.0. </member> <member name="is_hemisphere" type="bool" setter="set_is_hemisphere" getter="get_is_hemisphere"> - Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to false. + Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to [code]false[/code]. </member> <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments"> Number of radial segments on the sphere. Defaults to 64. diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index cc5fe93567..26ff67cc74 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -13,7 +13,13 @@ <return type="Rect2"> </return> <description> - Returns a Rect2 representing the Sprite's boundary relative to its local coordinates. + Returns a [Rect2] representing the Sprite's boundary in local coordinates. Can be used to detect if the Sprite was clicked. Example: + [codeblock] + func _input(event): + if event is InputEventMouseButton and event.pressed and event.button_index == BUTTON_LEFT: + if get_rect().has_point(to_local(event.position)): + print("A click!") + [/codeblock] </description> </method> <method name="is_pixel_opaque" qualifiers="const"> @@ -48,7 +54,7 @@ The texture's drawing offset. </member> <member name="region_enabled" type="bool" setter="set_region" getter="is_region"> - If [code]true[/code], texture is cut from a larger atlas texture. See [code]region_rect[/code]. Default value: [code]false[/code]. + If [code]true[/code], texture is cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code]. </member> <member name="region_filter_clip" type="bool" setter="set_region_filter_clip" getter="is_region_filter_clip_enabled"> If [code]true[/code], the outermost pixels get blurred out. diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index af8e43944c..d278312fc3 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -41,7 +41,7 @@ <return type="int"> </return> <description> - Return the amount of bytes this [StreamPeer] has available. + Returns the amount of bytes this [StreamPeer] has available. </description> </method> <method name="get_data"> @@ -50,7 +50,7 @@ <argument index="0" name="bytes" type="int"> </argument> <description> - Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. </description> </method> <method name="get_double"> @@ -73,7 +73,7 @@ <argument index="0" name="bytes" type="int"> </argument> <description> - Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. </description> </method> <method name="get_string"> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 07a21a0b57..f28e6e5544 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -28,7 +28,7 @@ <argument index="2" name="for_hostname" type="String" default=""""> </argument> <description> - Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". + Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". </description> </method> <method name="disconnect_from_stream"> @@ -42,7 +42,7 @@ <return type="int" enum="StreamPeerSSL.Status"> </return> <description> - Return the status of the connection, one of STATUS_* enum. + Returns the status of the connection, one of STATUS_* enum. </description> </method> <method name="poll"> diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 16bf69110d..0edea42521 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -31,21 +31,21 @@ <return type="String"> </return> <description> - Return the IP of this peer. + Returns the IP of this peer. </description> </method> <method name="get_connected_port" qualifiers="const"> <return type="int"> </return> <description> - Return the port of this peer. + Returns the port of this peer. </description> </method> <method name="get_status"> <return type="int" enum="StreamPeerTCP.Status"> </return> <description> - Return the status of the connection, see [enum StreamPeerTCP.Status]. + Returns the status of the connection, see [enum StreamPeerTCP.Status]. </description> </method> <method name="is_connected_to_host" qualifiers="const"> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 526a9427dc..e06f0738b8 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -7,6 +7,7 @@ This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. </description> <tutorials> + <link>https://docs.godotengine.org/en/stable/getting_started/scripting/gdscript/gdscript_format_string.html</link> </tutorials> <methods> <method name="String"> diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index 40cb2632b6..a156f134e7 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -37,7 +37,7 @@ <argument index="0" name="margin" type="int" enum="Margin"> </argument> <description> - Return the content margin offset for the specified margin + Returns the content margin offset for the specified margin Positive values reduce size inwards, unlike [Control]'s margin values. </description> </method> @@ -45,14 +45,14 @@ <return type="Vector2"> </return> <description> - Return the minimum size that this stylebox can be shrunk to. + Returns the minimum size that this stylebox can be shrunk to. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. + Returns the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. </description> </method> <method name="test_mask" qualifiers="const"> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 884b52459b..ffee7366a3 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -94,7 +94,7 @@ The background color of the stylebox. </member> <member name="border_blend" type="bool" setter="set_border_blend" getter="get_border_blend"> - When set to true, the border will fade into the background color. + When set to [code]true[/code], the border will fade into the background color. </member> <member name="border_color" type="Color" setter="set_border_color" getter="get_border_color"> Sets the color of the border. diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 25188a80db..e97f9995ee 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -169,6 +169,12 @@ Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. </description> </method> + <method name="commit_to_arrays"> + <return type="Array"> + </return> + <description> + </description> + </method> <method name="create_from"> <return type="void"> </return> @@ -180,6 +186,18 @@ Creates a vertex array from an existing [Mesh]. </description> </method> + <method name="create_from_blend_shape"> + <return type="void"> + </return> + <argument index="0" name="existing" type="Mesh"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <argument index="2" name="blend_shape" type="String"> + </argument> + <description> + </description> + </method> <method name="deindex"> <return type="void"> </return> diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index 2780e39067..663d3248e8 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -13,7 +13,7 @@ <return type="bool"> </return> <description> - Return true if a connection is available for taking. + Returns [code]true[/code] if a connection is available for taking. </description> </method> <method name="listen"> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index e1260ba44e..06299d65b6 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -100,7 +100,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> - If [code]disabled[/code] is false, hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title]. + If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title]. </description> </method> <method name="set_tab_icon"> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 6e61f62f43..8c7d657b4a 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -135,7 +135,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> - If [code]disabled[/code] is false, hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title]. + If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title]. </description> </method> <method name="set_tab_icon"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index c55d4d6960..eb70d7a1c3 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -41,6 +41,7 @@ <argument index="0" name="line" type="int"> </argument> <description> + Returns if the given line is foldable, that is, it has indented lines right below it. </description> </method> <method name="clear_colors"> @@ -68,14 +69,14 @@ <return type="int"> </return> <description> - Return the column the editing cursor is at. + Returns the column the editing cursor is at. </description> </method> <method name="cursor_get_line" qualifiers="const"> <return type="int"> </return> <description> - Return the line the editing cursor is at. + Returns the line the editing cursor is at. </description> </method> <method name="cursor_set_column"> @@ -120,6 +121,7 @@ <return type="void"> </return> <description> + Folds all lines that are possible to be folded (see [method can_fold]). </description> </method> <method name="fold_line"> @@ -128,13 +130,14 @@ <argument index="0" name="line" type="int"> </argument> <description> + Folds the given line, if possible (see [method can_fold]). </description> </method> <method name="get_breakpoints" qualifiers="const"> <return type="Array"> </return> <description> - Return an array containing the line number of each breakpoint. + Returns an array containing the line number of each breakpoint. </description> </method> <method name="get_keyword_color" qualifiers="const"> @@ -151,55 +154,56 @@ <argument index="0" name="line" type="int"> </argument> <description> - Return the text of a specific line. + Returns the text of a specific line. </description> </method> <method name="get_line_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of total lines in the text. + Returns the amount of total lines in the text. </description> </method> <method name="get_menu" qualifiers="const"> <return type="PopupMenu"> </return> <description> + Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit]. </description> </method> <method name="get_selection_from_column" qualifiers="const"> <return type="int"> </return> <description> - Return the selection begin column. + Returns the selection begin column. </description> </method> <method name="get_selection_from_line" qualifiers="const"> <return type="int"> </return> <description> - Return the selection begin line. + Returns the selection begin line. </description> </method> <method name="get_selection_text" qualifiers="const"> <return type="String"> </return> <description> - Return the text inside the selection. + Returns the text inside the selection. </description> </method> <method name="get_selection_to_column" qualifiers="const"> <return type="int"> </return> <description> - Return the selection end column. + Returns the selection end column. </description> </method> <method name="get_selection_to_line" qualifiers="const"> <return type="int"> </return> <description> - Return the selection end line. + Returns the selection end line. </description> </method> <method name="get_word_under_cursor" qualifiers="const"> @@ -231,6 +235,7 @@ <argument index="0" name="line" type="int"> </argument> <description> + Returns if the given line is folded. </description> </method> <method name="is_line_hidden" qualifiers="const"> @@ -245,7 +250,7 @@ <return type="bool"> </return> <description> - Return true if the selection is active. + Returns [code]true[/code] if the selection is active. </description> </method> <method name="menu_option"> @@ -346,6 +351,7 @@ <argument index="0" name="line" type="int"> </argument> <description> + Unfolds the given line, if folded. </description> </method> <method name="unhide_all_lines"> @@ -376,6 +382,15 @@ <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled"> If [code]true[/code], a right click displays the context menu. </member> + <member name="draw_spaces" type="bool" setter="set_draw_spaces" getter="is_drawing_spaces"> + If [code]true[/code], the "space" character will have a visible representation. + </member> + <member name="draw_tabs" type="bool" setter="set_draw_tabs" getter="is_drawing_tabs"> + If [code]true[/code], the "tab" character will have a visible representation. + </member> + <member name="fold_gutter" type="bool" setter="set_fold_gutter_enabled" getter="is_fold_gutter_enabled"> + If [code]true[/code], the fold gutter is visible. This enables folding groups of indented lines. + </member> <member name="hiding_enabled" type="int" setter="set_hiding_enabled" getter="is_hiding_enabled"> </member> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled"> @@ -418,6 +433,14 @@ Emitted when the cursor changes. </description> </signal> + <signal name="info_clicked"> + <argument index="0" name="row" type="int"> + </argument> + <argument index="1" name="info" type="String"> + </argument> + <description> + </description> + </signal> <signal name="request_completion"> <description> </description> @@ -474,6 +497,8 @@ <theme_items> <theme_item name="background_color" type="Color"> </theme_item> + <theme_item name="bookmark_color" type="Color"> + </theme_item> <theme_item name="brace_mismatch_color" type="Color"> </theme_item> <theme_item name="breakpoint_color" type="Color"> @@ -504,8 +529,14 @@ </theme_item> <theme_item name="current_line_color" type="Color"> </theme_item> + <theme_item name="executing_line_color" type="Color"> + </theme_item> <theme_item name="focus" type="StyleBox"> </theme_item> + <theme_item name="fold" type="Texture"> + </theme_item> + <theme_item name="folded" type="Texture"> + </theme_item> <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> @@ -532,6 +563,8 @@ </theme_item> <theme_item name="selection_color" type="Color"> </theme_item> + <theme_item name="space" type="Texture"> + </theme_item> <theme_item name="symbol_color" type="Color"> </theme_item> <theme_item name="tab" type="Texture"> diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index 39f3ee447c..4418a6ce8f 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -74,21 +74,21 @@ <return type="int"> </return> <description> - Return the texture height. + Returns the texture height. </description> </method> <method name="get_size" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the texture size. + Returns the texture size. </description> </method> <method name="get_width" qualifiers="const"> <return type="int"> </return> <description> - Return the texture width. + Returns the texture width. </description> </method> <method name="has_alpha" qualifiers="const"> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index bc44ec161a..c14e098b12 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -8,6 +8,7 @@ Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info. </description> <tutorials> + <link>https://docs.godotengine.org/en/stable/tutorials/gui/gui_skinning.html</link> </tutorials> <methods> <method name="clear"> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index d1d19d91d7..ff8221fed3 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -20,7 +20,7 @@ <return type="bool"> </return> <description> - Returns true if this [Thread] is currently active. An active [Thread] cannot start work on a new method but can be joined with [method wait_to_finish]. + Returns [code]true[/code] if this [Thread] is currently active. An active [Thread] cannot start work on a new method but can be joined with [method wait_to_finish]. </description> </method> <method name="start"> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index a3acc2c659..05774635b8 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -27,6 +27,12 @@ Clears the server from all translations. </description> </method> + <method name="get_loaded_locales" qualifiers="const"> + <return type="Array"> + </return> + <description> + </description> + </method> <method name="get_locale" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index b60673bb5b..0272efeecb 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -271,6 +271,12 @@ Emitted when a cell with the [code]CELL_MODE_CUSTOM[/code] is clicked to be edited. </description> </signal> + <signal name="empty_rmb"> + <argument index="0" name="position" type="Vector2"> + </argument> + <description> + </description> + </signal> <signal name="empty_tree_rmb_selected"> <argument index="0" name="position" type="Vector2"> </argument> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index e6fb32a032..75221ccc82 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -216,7 +216,7 @@ <argument index="0" name="phi" type="float"> </argument> <description> - Returns the vector rotated by [code]phi[/code] radians. + Returns the vector rotated by [code]phi[/code] radians. See also [method @GDScript.deg2rad]. </description> </method> <method name="round"> diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml index 81d853090c..ab821aafdc 100644 --- a/doc/classes/VehicleBody.xml +++ b/doc/classes/VehicleBody.xml @@ -16,11 +16,11 @@ Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the [member RigidBody.mass] of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. </member> <member name="engine_force" type="float" setter="set_engine_force" getter="get_engine_force"> - Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have [member VehicleWheel.use_as_traction] set to true and are in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. + Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have [member VehicleWheel.use_as_traction] set to [code]true[/code] and are in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. A negative value will result in the vehicle reversing. </member> <member name="steering" type="float" setter="set_steering" getter="get_steering"> - The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have [member VehicleWheel.use_as_steering] set to true will automatically be rotated. + The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have [member VehicleWheel.use_as_steering] set to [code]true[/code] will automatically be rotated. </member> </members> <constants> diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index 6a507d630c..c3b668c170 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -9,6 +9,12 @@ <tutorials> </tutorials> <methods> + <method name="get_rpm" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_skidinfo" qualifiers="const"> <return type="float"> </return> @@ -20,7 +26,7 @@ <return type="bool"> </return> <description> - Returns true if this wheel is in contact with a surface. + Returns [code]true[/code] if this wheel is in contact with a surface. </description> </method> </methods> @@ -41,10 +47,10 @@ This is the distance the suspension can travel. As Godot measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car . </member> <member name="use_as_steering" type="bool" setter="set_use_as_steering" getter="is_used_as_steering"> - If true this wheel will be turned when the car steers. + If [code]true[/code] this wheel will be turned when the car steers. </member> <member name="use_as_traction" type="bool" setter="set_use_as_traction" getter="is_used_as_traction"> - If true this wheel transfers engine force to the ground to propel the vehicle forward. + If [code]true[/code] this wheel transfers engine force to the ground to propel the vehicle forward. </member> <member name="wheel_friction_slip" type="float" setter="set_friction_slip" getter="get_friction_slip"> This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index b48dc9de35..53e66cee74 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -253,6 +253,9 @@ <member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking"> If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process. Default value: [code]false[/code]. </member> + <member name="render_direct_to_screen" type="bool" setter="set_use_render_direct_to_screen" getter="is_using_render_direct_to_screen"> + If [code]true[/code], renders the Viewport directly to the screen instead of to the root viewport. Only available in GLES2. This is a low-level optimization and should not be used in most cases. If used, reading from the Viewport or from [code]SCREEN_TEXTURE[/code] becomes unavailable. For more information see [method VisualServer.viewport_set_render_direct_to_screen]. Default value: [code]false[/code]. + </member> <member name="render_target_clear_mode" type="int" setter="set_clear_mode" getter="get_clear_mode" enum="Viewport.ClearMode"> The clear mode when viewport used as a render target. Default value: [code]CLEAR_MODE_ALWAYS[/code]. </member> diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index 381679f8bb..59f0a531dd 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -14,6 +14,18 @@ Returns the [AABB] (also known as the bounding box) for this VisualInstance. </description> </method> + <method name="get_base" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_instance" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> <method name="get_layer_mask_bit" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 0030795a6b..3997798cca 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -66,6 +66,22 @@ <description> </description> </method> + <method name="camera_set_frustum"> + <return type="void"> + </return> + <argument index="0" name="camera" type="RID"> + </argument> + <argument index="1" name="size" type="float"> + </argument> + <argument index="2" name="offset" type="Vector2"> + </argument> + <argument index="3" name="z_near" type="float"> + </argument> + <argument index="4" name="z_far" type="float"> + </argument> + <description> + </description> + </method> <method name="camera_set_orthogonal"> <return type="void"> </return> @@ -173,12 +189,15 @@ </argument> <argument index="1" name="mesh" type="RID"> </argument> - <argument index="2" name="texture" type="RID"> + <argument index="2" name="texture" type="Transform2D"> </argument> - <argument index="3" name="normal_map" type="RID"> + <argument index="3" name="normal_map" type="Color"> + </argument> + <argument index="4" name="arg4" type="RID"> + </argument> + <argument index="5" name="arg5" type="RID"> </argument> <description> - Adds a [Mesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment. </description> </method> <method name="canvas_item_add_multimesh"> @@ -2066,6 +2085,17 @@ <description> </description> </method> + <method name="light_set_use_gi"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + Sets whether GI probes capture light information from this light. + </description> + </method> <method name="lightmap_capture_create"> <return type="RID"> </return> @@ -3560,7 +3590,14 @@ <argument index="2" name="screen" type="int" default="0"> </argument> <description> - Attaches a viewport to a screen. + Copies viewport to a region of the screen specified by [code]rect[/code]. If Viewport.[member Viewport.render_direct_to_screen] is [code]true[/code], then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. + For example, you can set the root viewport to not render at all with the following code: + [codeblock] + func _ready(): + get_viewport().set_attach_to_screen_rect(Rect2()) + $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600)) + [/codeblock] + Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, [method viewport_set_render_direct_to_screen]. </description> </method> <method name="viewport_create"> @@ -3759,6 +3796,17 @@ Sets the viewport's parent to another viewport. </description> </method> + <method name="viewport_set_render_direct_to_screen"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + If [code]true[/code], render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the [code]SCREEN_TEXTURE[/code]. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size. + </description> + </method> <method name="viewport_set_scenario"> <return type="void"> </return> diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index d399f69c96..6d5f53d992 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -53,6 +53,22 @@ <description> </description> </method> + <method name="connect_nodes_forced"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> <method name="disconnect_nodes"> <return type="void"> </return> @@ -129,6 +145,12 @@ <description> </description> </method> + <method name="rebuild"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="remove_node"> <return type="void"> </return> diff --git a/doc/classes/VisualShaderNodeExpression.xml b/doc/classes/VisualShaderNodeExpression.xml new file mode 100644 index 0000000000..8a5477280f --- /dev/null +++ b/doc/classes/VisualShaderNodeExpression.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeExpression" inherits="VisualShaderNodeGroupBase" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="build"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="expression" type="String" setter="set_expression" getter="get_expression"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeFresnel.xml b/doc/classes/VisualShaderNodeFresnel.xml new file mode 100644 index 0000000000..2484a44fcd --- /dev/null +++ b/doc/classes/VisualShaderNodeFresnel.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeFresnel" inherits="VisualShaderNode" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml new file mode 100644 index 0000000000..37d48956f6 --- /dev/null +++ b/doc/classes/VisualShaderNodeGroupBase.xml @@ -0,0 +1,205 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeGroupBase" inherits="VisualShaderNode" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_input_port"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_output_port"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_input_ports"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="clear_output_ports"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_control"> + <return type="Control"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_free_input_port_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_free_output_port_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_input_port_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_inputs" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_output_port_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_outputs" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="has_input_port" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_output_port" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_input_port"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_output_port"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_control"> + <return type="void"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_input_port_name"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_input_port_type"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_inputs"> + <return type="void"> + </return> + <argument index="0" name="inputs" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_output_port_name"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_output_port_type"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_outputs"> + <return type="void"> + </return> + <argument index="0" name="outputs" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeScalarFunc.xml b/doc/classes/VisualShaderNodeScalarFunc.xml index 163276b3bc..b0ee422bbd 100644 --- a/doc/classes/VisualShaderNodeScalarFunc.xml +++ b/doc/classes/VisualShaderNodeScalarFunc.xml @@ -75,5 +75,7 @@ </constant> <constant name="FUNC_TRUNC" value="30" enum="Function"> </constant> + <constant name="FUNC_ONEMINUS" value="31" enum="Function"> + </constant> </constants> </class> diff --git a/doc/classes/VisualShaderNodeVectorFunc.xml b/doc/classes/VisualShaderNodeVectorFunc.xml index 71ce32c04e..e67cb2e07f 100644 --- a/doc/classes/VisualShaderNodeVectorFunc.xml +++ b/doc/classes/VisualShaderNodeVectorFunc.xml @@ -81,5 +81,7 @@ </constant> <constant name="FUNC_TRUNC" value="33" enum="Function"> </constant> + <constant name="FUNC_ONEMINUS" value="34" enum="Function"> + </constant> </constants> </class> diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index 16b7bd84ad..c5d66af984 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -13,7 +13,7 @@ <return type="TextureButton"> </return> <description> - Return the close [TextureButton]. + Returns the close [TextureButton]. </description> </method> </methods> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 15e4146ef4..9ed029a500 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -15,7 +15,7 @@ <argument index="0" name="from" type="int"> </argument> <description> - Cast an [int] value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case. + Cast an [int] value to a boolean value, this method will return [code]true[/code] if called with an integer value different to 0 and [code]false[/code] in other case. </description> </method> <method name="bool"> @@ -24,7 +24,7 @@ <argument index="0" name="from" type="float"> </argument> <description> - Cast a [float] value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case. + Cast a [float] value to a boolean value, this method will return [code]true[/code] if called with a floating point value different to 0 and [code]false[/code] in other case. </description> </method> <method name="bool"> @@ -33,7 +33,7 @@ <argument index="0" name="from" type="String"> </argument> <description> - Cast a [String] value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: [code]bool('False')[/code] returns true, [code]bool('')[/code]. returns false + Cast a [String] value to a boolean value, this method will return [code]true[/code] if called with a non empty string and [code]false[/code] in other case. Examples: [code]bool('False')[/code] returns [code]true[/code], [code]bool('')[/code] returns [code]false[/code]. </description> </method> </methods> |