diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 9c60abeee..389eeb897 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1572,70 +1572,82 @@ Variable is of type [Vector2]. - + + + Variable is of type [Rect2]. - + + + Variable is of type [Vector3]. - + + + Variable is of type [Transform2D]. - + Variable is of type [Plane]. - + Variable is of type [Quat]. - + Variable is of type [AABB]. - + Variable is of type [Basis]. - + Variable is of type [Transform]. - + Variable is of type [Color]. - + Variable is of type [NodePath]. - + Variable is of type [RID]. - + Variable is of type [Object]. - + + + Variable is of type [Dictionary]. - + Variable is of type [Array]. - + Variable is of type [PoolByteArray]. - + Variable is of type [PoolIntArray]. - + Variable is of type [PoolRealArray]. - + Variable is of type [PoolStringArray]. - + Variable is of type [PoolVector2Array]. - + + + Variable is of type [PoolVector3Array]. - + + + Variable is of type [PoolColorArray]. - + Represents the size of the [enum Variant.Type] enum. diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index ea0e6c95e..e36da2817 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -14,10 +14,9 @@ - + - Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. If [code]backwards[/code] is [code]true[/code], the animation will be played in reverse. @@ -28,7 +27,7 @@ - + The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset. diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 849c1098f..7cc0fa265 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -18,9 +18,8 @@ - + - Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. @@ -31,7 +30,7 @@ - + The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset. diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index ee0a3d8af..a51ea4d6c 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -29,7 +29,7 @@ - + @@ -40,18 +40,16 @@ - + - Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track. - + - Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track. @@ -227,7 +225,7 @@ - + diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index c93ad12ba..fb49248cd 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -20,13 +20,12 @@ - + - Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened. @@ -43,7 +42,7 @@ - + @@ -51,7 +50,6 @@ - Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition. @@ -88,9 +86,8 @@ - + - Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. @@ -146,10 +143,9 @@ - + - Sets a custom parameter. These are used as local memory, because resources can be reused across the tree or scenes. diff --git a/doc/classes/AnimationNodeAnimation.xml b/doc/classes/AnimationNodeAnimation.xml index dcafb3cc1..286e885e0 100644 --- a/doc/classes/AnimationNodeAnimation.xml +++ b/doc/classes/AnimationNodeAnimation.xml @@ -14,7 +14,7 @@ - + Animation to use as an output. It is one of the animations provided by [member AnimationTree.anim_player]. diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index 7086dec76..80a8e9a10 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -12,72 +12,63 @@ - + - Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later. - + - + - Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code]. - + - Disconnects the node connected to the specified input. - + - Returns the sub-node with the specified [code]name[/code]. - + - Returns the position of the sub-node with the specified [code]name[/code]. - + - Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists. - + - Removes a sub-node. - - + + - Changes the name of a sub-node. - + - Modifies the position of a sub-node. diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index afd7e246c..267fcf3a6 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -17,20 +17,18 @@ - + - Adds a new node to the graph. The [code]position[/code] is used for display in the editor. - - + + - Adds a transition between the given nodes. @@ -47,13 +45,12 @@ - + - Returns the animation node with the given name. - + Returns the given animation node's name. @@ -61,9 +58,8 @@ - + - Returns the given node's coordinates. Used for display in the editor. @@ -86,14 +82,14 @@ - + Returns the given transition's start node. - + Returns the given transition's end node. @@ -101,32 +97,28 @@ - + - Returns [code]true[/code] if the graph contains the given node. - - + + - Returns [code]true[/code] if there is a transition between the given nodes. - + - Deletes the given node from the graph. - - + + - Deletes the transition between the two specified nodes. @@ -138,25 +130,22 @@ - - + + - Renames the given node. - + - Replaces the node and keeps its transitions unchanged. - + - Sets the given node as the graph end point. @@ -168,17 +157,15 @@ - + - Sets the node's coordinates. Used for display in the editor. - + - Sets the given node as the graph start point. diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index dfb04fe4e..68287f2b7 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -21,7 +21,7 @@ - + Returns the currently playing animation state. @@ -46,9 +46,8 @@ - + - Starts playing the given animation. @@ -59,9 +58,8 @@ - + - Transitions from the current state to another one, following the shortest path. diff --git a/doc/classes/AnimationNodeStateMachineTransition.xml b/doc/classes/AnimationNodeStateMachineTransition.xml index 5a422b564..92b313d23 100644 --- a/doc/classes/AnimationNodeStateMachineTransition.xml +++ b/doc/classes/AnimationNodeStateMachineTransition.xml @@ -10,7 +10,7 @@ - + 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=$DOCS_URL/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 [code]"idle"[/code]: [codeblock] $animation_tree["parameters/conditions/idle"] = is_on_floor and (linear_velocity.x == 0) diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index fb55cdf71..21d376eb6 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -16,10 +16,9 @@ - + - Adds [code]animation[/code] to the player accessible with the key [code]name[/code]. @@ -30,18 +29,16 @@ - - + + - Returns the name of the next animation in the queue. - - + + - Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. @@ -57,7 +54,7 @@ - + Returns the name of [code]animation[/code] or an empty string if not found. @@ -65,9 +62,8 @@ - + - Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found. @@ -78,10 +74,9 @@ - - + + - Gets the blend time (in seconds) between two animations, referenced by their names. @@ -98,9 +93,8 @@ - + - Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code]. @@ -111,46 +105,37 @@ - + - Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]). - The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing. - [b]Note:[/b] The animation will be updated the next time the [AnimationPlayer] is processed. If other variables are updated at the same time this is called, they may be updated too early. To perform the update immediately, call [code]advance(0)[/code]. - + - Plays the animation with key [code]name[/code] in reverse. - This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information. - + - Queues an animation for playback once the current one is done. - [b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow. - + - Removes the animation with key [code]name[/code]. - - + + - Renames an existing animation with key [code]name[/code] to [code]newname[/code]. @@ -163,11 +148,10 @@ - - + + - Specifies a blend time (in seconds) between two animations, referenced by their names. @@ -221,7 +205,7 @@ - + Emitted when a queued animation plays after the previous animation was finished. See [method queue]. @@ -229,13 +213,13 @@ - + Notifies when an animation finished playing. - + Notifies when an animation starts playing. diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index 66271ab27..b4a7e3718 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -15,9 +15,8 @@ - + - Adds a [code]type[/code] node to the graph with name [code]id[/code]. @@ -29,134 +28,112 @@ - + - Returns the [AnimationPlayer]'s [Animation] bound to the [AnimationTreePlayer]'s animation node with name [code]id[/code]. - + - Returns the name of the [member master_player]'s [Animation] bound to this animation node. - + - Returns the absolute playback timestamp of the animation node with name [code]id[/code]. - + - Binds a new [Animation] from the [member master_player] to the [AnimationTreePlayer]'s animation node with name [code]id[/code]. - + - If [code]enable[/code] is [code]true[/code], the animation node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. - + - Binds the [Animation] named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches. - - + + - Returns whether node [code]id[/code] and [code]dst_id[/code] are connected at the specified slot. - + - Returns the blend amount of a Blend2 node given its name. - + - Sets the blend amount of a Blend2 node given its name and value. - A Blend2 node blends two animations (A and B) with the amount between 0 and 1. - At 0, output is input A. Towards 1, the influence of A gets lessened, the influence of B gets raised. At 1, output is input B. - + - If [code]enable[/code] is [code]true[/code], the Blend2 node with name [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. - + - Returns the blend amount of a Blend3 node given its name. - + - Sets the blend amount of a Blend3 node given its name and value. - A Blend3 Node blends three animations (A, B-, B+) with the amount between -1 and 1. - At -1, output is input B-. From -1 to 0, the influence of B- gets lessened, the influence of A gets raised and the influence of B+ is 0. At 0, output is input A. From 0 to 1, the influence of A gets lessened, the influence of B+ gets raised and the influence of B+ is 0. At 1, output is input B+. - + - Returns the blend amount of a Blend4 node given its name. - + - Sets the blend amount of a Blend4 node given its name and value. - A Blend4 Node blends two pairs of animations. - The two pairs are blended like Blend2 and then added together. - - + + - Connects node [code]id[/code] to [code]dst_id[/code] at the specified input slot. - + - Disconnects nodes connected to [code]id[/code] at the specified input slot. @@ -167,175 +144,151 @@ - + - Returns the mix amount of a Mix node given its name. - + - Sets the mix amount of a Mix node given its name and value. - A Mix node adds input b to input a by the amount given by ratio. - + - Check if a node exists (by name). - + - Returns the input count for a given node. Different types of nodes have different amount of inputs. - - + + - Returns the input source for a given node input. - + - Returns position of a node in the graph given its name. - + - Gets the node type, will return from [enum NodeType] enum. - - + + - Renames a node in the graph. - + - Sets the position of a node in the graph given its name and position. - + - Returns the autostart delay of a OneShot node given its name. - + - Returns the autostart random delay of a OneShot node given its name. - + - Returns the fade in time of a OneShot node given its name. - + - Returns the fade out time of a OneShot node given its name. - + - Returns whether a OneShot node will auto restart given its name. - + - Returns whether a OneShot node is active given its name. - + - Sets the autorestart property of a OneShot node given its name and value. - + - Sets the autorestart delay of a OneShot node given its name and value in seconds. - + - Sets the autorestart random delay of a OneShot node given its name and value in seconds. - + - Sets the fade in time of a OneShot node given its name and value in seconds. - + - Sets the fade out time of a OneShot node given its name and value in seconds. - + - If [code]enable[/code] is [code]true[/code], the OneShot node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. - + - Starts a OneShot node given its name. - + - Stops the OneShot node with name [code]id[/code]. @@ -346,9 +299,8 @@ - + - Removes the animation node with name [code]id[/code]. @@ -359,98 +311,83 @@ - + - Returns the time scale value of the TimeScale node with name [code]id[/code]. - + - Sets the time scale of the TimeScale node with name [code]id[/code] to [code]scale[/code]. - The TimeScale node is used to speed [Animation]s up if the scale is above 1 or slow them down if it is below 1. - If applied after a blend or mix, affects all input animations to that blend or mix. - + - Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code]. - This functions as a seek in the [Animation] or the blend or mix of [Animation]s input in it. - + - Deletes the input at [code]input_idx[/code] for the transition node with name [code]id[/code]. - + - Returns the index of the currently evaluated input for the transition node with name [code]id[/code]. - + - Returns the number of inputs for the transition node with name [code]id[/code]. You can add inputs by right-clicking on the transition node. - + - Returns the cross fade time for the transition node with name [code]id[/code]. - + - Returns [code]true[/code] if the input at [code]input_idx[/code] on the transition node with name [code]id[/code] is set to automatically advance to the next input upon completion. - + - The transition node with name [code]id[/code] sets its current input at [code]input_idx[/code]. - + - The transition node with name [code]id[/code] advances to its next input automatically when the input at [code]input_idx[/code] completes. - + - Resizes the number of inputs available for the transition node with name [code]id[/code]. - + - The transition node with name [code]id[/code] sets its cross fade time to [code]time_sec[/code]. diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index 09a397fcd..47af8a958 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -48,7 +48,7 @@ The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. - + The name of the area's audio bus. @@ -85,7 +85,7 @@ If [code]true[/code], the area applies reverb to its associated audio. - + The reverb bus name to use for this area's associated audio. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index de313d0f4..7ad18fd45 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -50,7 +50,7 @@ The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. - + The name of the area's audio bus. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 6839f1d83..fc1c71fe0 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -34,6 +34,12 @@ Constructs an array from a [PoolColorArray]. + + + + + + @@ -41,6 +47,12 @@ Constructs an array from a [PoolVector3Array]. + + + + + + diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index be9beb4d1..dc6b3711b 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -31,9 +31,8 @@ - + - Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added. @@ -67,7 +66,7 @@ - + Returns the name of the blend shape at this index. @@ -82,7 +81,7 @@ - + diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml index 54c179d1d..e69eef2e8 100644 --- a/doc/classes/AudioEffectCompressor.xml +++ b/doc/classes/AudioEffectCompressor.xml @@ -32,7 +32,7 @@ Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000. - + Reduce the sound level using another audio bus for threshold detection. diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index e78c080e3..067533186 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -74,9 +74,8 @@ - + - Returns the index of the bus with the name [code]bus_name[/code]. @@ -103,7 +102,7 @@ - + Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to. @@ -254,9 +253,8 @@ - + - Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code]. diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 2bc43a2ca..113a6c22e 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -53,7 +53,7 @@ If [code]true[/code], audio plays when added to scene tree. - + Bus on which this audio is playing. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index b4a8abe8f..4a999c274 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -55,7 +55,7 @@ If [code]true[/code], audio plays when added to scene tree. - + Bus on which this audio is playing. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 570d8de59..937223564 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -62,7 +62,7 @@ If [code]true[/code], audio plays when the AudioStreamPlayer3D node is added to scene tree. - + The bus on which this audio is playing. diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index b039b51da..96d92ba0e 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -11,149 +11,130 @@ - + - Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case. - + - Returns whether the specified [code]class[/code] is available or not. - - + + - Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. - - + + - Returns an array with all the keys in [code]enum[/code] of [code]class[/code] or its ancestry. - + - Returns an array with all the enums of [code]class[/code] or its ancestry. - - + + - Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found. - - - + + + - Returns which enum the integer constant [code]name[/code] of [code]class[/code] or its ancestry belongs to. - + - Returns an array with the names all the integer constants of [code]class[/code] or its ancestry. - + - Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. - [b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names. - + - Returns the value of [code]property[/code] of [code]class[/code] or its ancestry. - + - Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. - - + + - Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. - + - Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal]. - - + + - Returns whether [code]class[/code] or its ancestry has an enum called [code]name[/code] or not. - - + + - Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not. - - + + - Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not. - - + + - Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not. - + - Sets [code]property[/code] value of [code]class[/code] to [code]value[/code]. @@ -164,38 +145,33 @@ - + - Returns the names of all the classes that directly or indirectly inherit from [code]class[/code]. - - + + - Returns the parent class of [code]class[/code]. - + - Creates an instance of [code]class[/code]. - + - Returns whether this [code]class[/code] is enabled or not. - - + + - Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index efabe2ba1..f33eca989 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -88,78 +88,44 @@ - + - Creates a local override for a theme [Color] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. - See also [method get_color], [method remove_color_override]. - [b]Example of overriding a label's color and resetting it later:[/b] - [codeblock] - # Given the child Label node "MyLabel", override its font color with a custom value. - $MyLabel.add_color_override("font_color", Color(1, 0.5, 0)) - # Reset the font color of the child label. - $MyLabel.add_color_override("font_color", get_color("font_color", "Label")) - [/codeblock] - + - Creates a local override for a theme constant with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. - See also [method get_constant], [method remove_constant_override]. - + - Creates a local override for a theme [Font] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. - [b]Note:[/b] An override can be removed by assigning it a [code]null[/code] value. This behavior is deprecated and will be removed in 4.0, use [method remove_font_override] instead. - See also [method get_font]. - + - Creates a local override for a theme icon with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. - [b]Note:[/b] An override can be removed by assigning it a [code]null[/code] value. This behavior is deprecated and will be removed in 4.0, use [method remove_icon_override] instead. - See also [method get_icon]. - + - Creates a local override for a theme shader with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. - [b]Note:[/b] An override can be removed by assigning it a [code]null[/code] value. This behavior is deprecated and will be removed in 4.0, use [method remove_shader_override] instead. - + - Creates a local override for a theme [StyleBox] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. - [b]Note:[/b] An override can be removed by assigning it a [code]null[/code] value. This behavior is deprecated and will be removed in 4.0, use [method remove_stylebox_override] instead. - See also [method get_stylebox]. - [b]Example of modifying a property in a StyleBox by duplicating it:[/b] - [codeblock] - # The snippet below assumes the child node MyButton has a StyleBoxFlat assigned. - # Resources are shared across instances, so we need to duplicate it - # to avoid modifying the appearance of all other buttons. - var new_stylebox_normal = $MyButton.get_stylebox("normal").duplicate() - new_stylebox_normal.border_width_top = 3 - new_stylebox_normal.border_color = Color(0, 1, 0.5) - $MyButton.add_stylebox_override("normal", new_stylebox_normal) - # Remove the stylebox override. - $MyButton.add_stylebox_override("normal", null) - [/codeblock] @@ -228,18 +194,9 @@ - - + + - Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [code]name[/code] and [code]theme_type[/code]. If [code]theme_type[/code] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. - For the current control its local overrides are considered first (see [method add_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, a custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used. - [codeblock] - func _ready(): - # Get the font color defined for the current Control's class, if it exists. - modulate = get_color("font_color") - # Get the font color defined for the Button class. - modulate = get_color("font_color", "Button") - [/codeblock] @@ -250,11 +207,9 @@ - - + + - Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. @@ -299,11 +254,9 @@ - - + + - Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. @@ -314,11 +267,9 @@ - - + + - Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. @@ -360,11 +311,9 @@ - - + + - Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. @@ -399,36 +348,28 @@ - - + + - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. - + - Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [code]name[/code] in this [Control] node. - See [method add_color_override]. - - + + - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. - + - Returns [code]true[/code] if there is a local override for a theme constant with the specified [code]name[/code] in this [Control] node. - See [method add_constant_override]. @@ -439,36 +380,28 @@ - - + + - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. - + - Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [code]name[/code] in this [Control] node. - See [method add_font_override]. - - + + - Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. - + - Returns [code]true[/code] if there is a local override for a theme icon with the specified [code]name[/code] in this [Control] node. - See [method add_icon_override]. @@ -482,27 +415,21 @@ - + - Returns [code]true[/code] if there is a local override for a theme shader with the specified [code]name[/code] in this [Control] node. - See [method add_shader_override]. - - + + - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. - See [method get_color] for details. - + - Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [code]name[/code] in this [Control] node. - See [method add_stylebox_override]. @@ -519,44 +446,38 @@ - + - Removes a theme override for a [Color] with the given [code]name[/code]. - + - Removes a theme override for a constant with the given [code]name[/code]. - + - Removes a theme override for a [Font] with the given [code]name[/code]. - + - Removes a theme override for an icon with the given [code]name[/code]. - + - Removes a theme override for a shader with the given [code]name[/code]. - + - Removes a theme override for a [StyleBox] with the given [code]name[/code]. @@ -855,7 +776,7 @@ Changing this property replaces the current [Theme] resource this node and all its [Control] children use. - + The name of a theme type variation used by this [Control] to look up its own theme items. When empty, the class name of the node is used (e.g. [code]Button[/code] for the [Button] control), as well as the class names of all parent classes (in order of inheritance). When set, this property gives the highest priority to the type of the specified name. This type can in turn extend another type, forming a dependency chain. See [method Theme.set_type_variation]. If the theme item cannot be found using this type or its base types, lookup falls back on the class names. [b]Note:[/b] To look up [Control]'s own items use various [code]get_*[/code] methods without specifying [code]theme_type[/code]. diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index d2e991c03..678b9750b 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -65,7 +65,7 @@ - + Returns the resource type of the file at index [code]idx[/code]. This returns a string such as [code]"Resource"[/code] or [code]"GDScript"[/code], [i]not[/i] a file extension such as [code]".gd"[/code]. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 568c5341d..8ee5b45b6 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -18,12 +18,11 @@ - + - + - If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure). @@ -33,7 +32,7 @@ - + Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return the property. @@ -87,34 +86,34 @@ - + Used by sub-inspectors. Emit it if what was selected was an Object ID. - + Do not emit this manually, use the [method emit_changed] method instead. - + Emitted when a property was checked. Used internally. - + Emit it if you want to add this value as an animation key (check for keying being enabled first). - + Emit it if you want to key a property with a single value. diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 5f39c5b28..4eddccdb3 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -28,22 +28,18 @@ - + - Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture] preview, [Texture] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. - [b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. - + - Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture] preview, [Texture] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. - [b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 949b5aa4f..251eea1ea 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -123,11 +123,10 @@ - + - Sets the initial value of the setting specified by [code]name[/code] to [code]value[/code]. This is used to provide a value for the Revert button in the Editor Settings. If [code]update_current[/code] is true, the current value of the setting will be set to [code]value[/code] as well. diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index 65632d048..3e56d6bf8 100644 --- a/doc/classes/FuncRef.xml +++ b/doc/classes/FuncRef.xml @@ -38,7 +38,7 @@ - + The name of the referenced function. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 2402dc674..2ba74b3f7 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -40,22 +40,20 @@ - + - + - Create a connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection already exists, no connection is created. - + - + - Removes the connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection does not exist, no connection is removed. @@ -73,12 +71,11 @@ - + - + - Returns [code]true[/code] if the [code]from_port[/code] slot of the [code]from[/code] GraphNode is connected to the [code]to_port[/code] slot of the [code]to[/code] GraphNode. @@ -113,13 +110,12 @@ - + - + - Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [code]activity[/code] theme property. @@ -182,7 +178,7 @@ - + @@ -190,7 +186,7 @@ - + @@ -199,7 +195,7 @@ - + @@ -217,7 +213,7 @@ - + diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 1a73c3e18..5e718ba23 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -14,19 +14,15 @@ - + - This will simulate pressing the specified action. - The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action. - [b]Note:[/b] This method will not cause any [method Node._input] calls. It is intended to be used with [method is_action_pressed] and [method is_action_just_pressed]. If you want to simulate [code]_input[/code], use [method parse_input_event] instead. - + - If the specified action is already pressed, this will release it. @@ -54,29 +50,23 @@ - + - Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use [method get_action_strength] instead. - If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - + - Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. - If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - - + + - Get axis input by specifying two actions, one negative and one positive. - This is a shorthand for writing [code]Input.get_action_strength("positive_action") - Input.get_action_strength("negative_action")[/code]. @@ -196,45 +186,33 @@ - - - - + + + + - Gets an input vector by specifying four actions for the positive and negative X and Y axes. - This method is useful when getting vector input, such as from a joystick, directional pad, arrows, or WASD. The vector has its length limited to 1 and has a circular deadzone, which is useful for using vector input as movement. - By default, the deadzone is automatically calculated from the average of the action deadzones. However, you can override the deadzone to be whatever you want (on the range of 0 to 1). - + - 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. - If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - [b]Note:[/b] Due to keyboard ghosting, [method is_action_just_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. - + - 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. - If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - + - Returns [code]true[/code] if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. - If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - [b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 0a2f63e64..ebabaaafe 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -29,40 +29,31 @@ - + - Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion]. - If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - + - Returns [code]true[/code] if this input event matches a pre-defined action of any type. - If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - + - Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. - If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - [b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. - + - Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. - If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index cef906cb4..ec5c1de88 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -14,7 +14,7 @@ - + The action's name. Actions are accessed via this [String]. diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index 517b200bc..96e8df8e9 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -12,81 +12,69 @@ - + - Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. - + - Removes an [InputEvent] from an action. - + - Removes all events from an action. - + - Returns a deadzone value for the action. - + - Returns [code]true[/code] if the action has the given [InputEvent] associated with it. - + - Sets a deadzone value for the action. - + - Adds an empty action to the [InputMap] with a configurable [code]deadzone[/code]. - An [InputEvent] can then be added to this action with [method action_add_event]. - + - Removes an action from the [InputMap]. - + - Returns [code]true[/code] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. - If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. - + - Returns an array of [InputEvent]s associated with a given action. @@ -97,9 +85,8 @@ - + - Returns [code]true[/code] if the [InputMap] has a registered action with the given name. diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml index ec89b5b40..712a888ac 100644 --- a/doc/classes/JavaScript.xml +++ b/doc/classes/JavaScript.xml @@ -14,9 +14,8 @@ - + - Creates a reference to a script function that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See [JavaScriptObject] for usage. diff --git a/doc/classes/Navigation2DServer.xml b/doc/classes/Navigation2DServer.xml index 334528751..c95aa62ce 100644 --- a/doc/classes/Navigation2DServer.xml +++ b/doc/classes/Navigation2DServer.xml @@ -31,10 +31,9 @@ - + - Callback called at the end of the RVO process. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 66485d9f5..e4e7c49d0 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -127,7 +127,7 @@ The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values. - + The name of the group to scan for geometry. Only used when [member geometry/source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT]. diff --git a/doc/classes/NavigationServer.xml b/doc/classes/NavigationServer.xml index 89e806869..6de6e108c 100644 --- a/doc/classes/NavigationServer.xml +++ b/doc/classes/NavigationServer.xml @@ -31,10 +31,9 @@ - + - Callback called at the end of the RVO process. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 6f9566f2e..91c8834e7 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -133,12 +133,9 @@ - + - Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see [method is_inside_tree]). See notes in the description, and the group methods in [SceneTree]. - The [code]persistent[/code] option is used when packing node to [PackedScene] and saving to file. Non-persistent groups aren't stored. - [b]Note:[/b] For performance reasons, the order of node groups is [i]not[/i] guaranteed. The order of node groups should not be relied upon as it can vary across project runs. @@ -362,9 +359,8 @@ - + - Returns [code]true[/code] if this node is in the specified group. See notes in the description, and the group methods in [SceneTree]. @@ -482,11 +478,10 @@ - + - Calls the given method (if present) with the arguments given in [code]args[/code] on this node and recursively on all its children. If the [code]parent_first[/code] argument is [code]true[/code], the method will be called on the current node first, then on all its children. If [code]parent_first[/code] is [code]false[/code], the children will be called first. @@ -525,9 +520,8 @@ - + - Removes a node from a group. See notes in the description, and the group methods in [SceneTree]. @@ -557,83 +551,72 @@ - + - Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. See also [method rset] and [method rset_config] for properties. Returns an empty [Variant]. - [b]Note:[/b] You can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [SceneTree]. You also need to keep track of the connection state, either by the [SceneTree] signals like [code]server_disconnected[/code] or by checking [code]SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED[/code]. - + - Changes the RPC mode for the given [code]method[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, methods are not exposed to networking (and RPCs). See also [method rset] and [method rset_config] for properties. - + - Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns an empty [Variant]. - + - Sends a [method rpc] using an unreliable protocol. Returns an empty [Variant]. - + - Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] using an unreliable protocol (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns an empty [Variant]. - + - Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see [method rset_config]. See also [method rpc] for RPCs for methods, most information applies to this method as well. - + - Changes the RPC mode for the given [code]property[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, properties are not exposed to networking (and RPCs). See also [method rpc] and [method rpc_config] for methods. - + - Remotely changes the property's value on a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). - + - Remotely changes the property's value on other peers (and locally) using an unreliable protocol. - + - Remotely changes property's value on a specific peer identified by [code]peer_id[/code] using an unreliable protocol (see [method NetworkedMultiplayerPeer.set_target_peer]). @@ -735,7 +718,7 @@ The [MultiplayerAPI] instance associated with this node. Either the [member custom_multiplayer], or the default SceneTree one (if inside tree). - + The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed. [b]Note:[/b] Auto-generated names might include the [code]@[/code] character, which is reserved for unique names when using [method add_child]. When setting the name manually, any [code]@[/code] will be removed. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 122818b54..09abbfb6b 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -27,10 +27,8 @@ - + - Virtual method which can be overridden to customize the return value of [method get]. - Returns the given property. Returns [code]null[/code] if the [code]property[/code] does not exist. @@ -56,11 +54,9 @@ - + - Virtual method which can be overridden to customize the return value of [method set]. - Sets a property. Returns [code]true[/code] if the [code]property[/code] exists. @@ -80,35 +76,21 @@ - + - Calls the [code]method[/code] on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: - [codeblock] - call("set", "position", Vector2(42.0, 0.0)) - [/codeblock] - [b]Note:[/b] In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase). - + - Calls the [code]method[/code] on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: - [codeblock] - call_deferred("set", "position", Vector2(42.0, 0.0)) - [/codeblock] - [b]Note:[/b] In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase). - + - Calls the [code]method[/code] on the object and returns the result. Contrarily to [method call], this method does not support a variable number of arguments but expects all parameters to be via a single [Array]. - [codeblock] - callv("set", [ "position", Vector2(42.0, 0.0) ]) - [/codeblock] @@ -119,49 +101,26 @@ - + - + - Connects a [code]signal[/code] to a [code]method[/code] on a [code]target[/code] object. Pass optional [code]binds[/code] to the call as an [Array] of parameters. These parameters will be passed to the method after any parameter used in the call to [method emit_signal]. Use [code]flags[/code] to set deferred or one-shot connections. See [enum ConnectFlags] constants. - A [code]signal[/code] can only be connected once to a [code]method[/code]. It will throw an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections. - If the [code]target[/code] is destroyed in the game's lifecycle, the connection will be lost. - Examples: - [codeblock] - connect("pressed", self, "_on_Button_pressed") # BaseButton signal - connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal - connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal - [/codeblock] - An example of the relationship between [code]binds[/code] passed to [method connect] and parameters used when calling [method emit_signal]: - [codeblock] - connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last - emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first - func _on_Player_hit(hit_by, level, weapon_type, damage): - print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage]) - [/codeblock] - + - + - Disconnects a [code]signal[/code] from a [code]method[/code] on the given [code]target[/code]. - If you try to disconnect a connection that does not exist, the method will throw an error. Use [method is_connected] to ensure that the connection exists. - + - Emits the given [code]signal[/code]. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: - [codeblock] - emit_signal("hit", weapon_type, damage) - emit_signal("game_over") - [/codeblock] @@ -265,23 +224,20 @@ - + - Returns [code]true[/code] if the object contains the given [code]method[/code]. - + - Returns [code]true[/code] if the given [code]signal[/code] exists. - + - Returns [code]true[/code] if the given user-defined [code]signal[/code] exists. Only signals added using [method add_user_signal] are taken into account. @@ -300,11 +256,10 @@ - + - + - Returns [code]true[/code] if a connection exists for a given [code]signal[/code], [code]target[/code], and [code]method[/code]. @@ -353,11 +308,9 @@ - + - Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. [code]call_deferred("set", property, value)[/code]. - [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). @@ -405,11 +358,9 @@ - - + + - Translates a message using translation catalogs configured in the Project Settings. - Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] unchanged. See [method set_message_translation]. diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 64daea353..3cc5aaabd 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -124,7 +124,7 @@ - + @@ -148,14 +148,8 @@ - + - Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: - 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. - 2: [RID] of the object that entered/exited the area. - 3: Instance ID of the object that entered/exited the area. - 4: The shape index of the object that entered/exited the area. - 5: The shape index of the area where the object entered/exited. @@ -486,10 +480,9 @@ - + - Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 524f394a2..15a59ea6b 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -118,7 +118,7 @@ - + @@ -142,14 +142,8 @@ - + - Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: - 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. - 2: [RID] of the object that entered/exited the area. - 3: Instance ID of the object that entered/exited the area. - 4: The shape index of the object that entered/exited the area. - 5: The shape index of the area where the object entered/exited. @@ -497,10 +491,9 @@ - + - Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). diff --git a/doc/classes/PoolVector2iArray.xml b/doc/classes/PoolVector2iArray.xml new file mode 100644 index 000000000..bedd97df4 --- /dev/null +++ b/doc/classes/PoolVector2iArray.xml @@ -0,0 +1,71 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/PoolVector3iArray.xml b/doc/classes/PoolVector3iArray.xml new file mode 100644 index 000000000..90dd32ff0 --- /dev/null +++ b/doc/classes/PoolVector3iArray.xml @@ -0,0 +1,71 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 81c64b5d4..72ec999bd 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -168,6 +168,10 @@ + + + + Comma-separated list of custom Android modules (which must have been built in the Android export templates) using their Java package path, e.g. [code]"org/godotengine/godot/MyCustomSingleton,com/example/foo/FrenchFriesFactory"[/code]. [b]Note:[/b] Since Godot 3.2.2, the [code]org/godotengine/godot/GodotPaymentV3[/code] module was deprecated and replaced by the [code]GodotPayment[/code] plugin which should be enabled in the Android export preset under [code]Plugins[/code] section. The singleton to access in code was also renamed to [code]GodotPayment[/code]. @@ -402,7 +406,7 @@ If [code]true[/code], enables warnings when assigning the result of a function that returns [code]void[/code] to a variable. - + Message to be displayed before the backtrace when the engine crashes. @@ -1015,7 +1019,7 @@ Desktop override for [member logging/file_logging/enable_file_logging], as log files are not readily accessible on mobile/Web platforms. - + Path to logs within the project. Using an [code]user://[/code] path is recommended. @@ -1029,7 +1033,6 @@ 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. - 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. @@ -1149,9 +1152,6 @@ Enables the use of bounding volume hierarchy instead of hash grid for 2D physics spatial partitioning. This may give better performance. - - Sets whether the 3D physics world will be created with support for [SoftBody] physics. Only applies to the Bullet physics engine. - The default angular damp in 3D. [b]Note:[/b] Good values are in the range [code]0[/code] to [code]1[/code]. At value [code]0[/code] objects will keep moving with the same velocity. Values greater than [code]1[/code] will aim to reduce the velocity to [code]0[/code] in less than a second e.g. a value of [code]2[/code] will aim to reduce the velocity to [code]0[/code] in half a second. A value equal to or greater than the physics frame rate ([member ProjectSettings.physics/common/physics_fps], [code]60[/code] by default) will bring the object to a stop in one iteration. @@ -1176,22 +1176,24 @@ The default linear damp in 3D. [b]Note:[/b] Good values are in the range [code]0[/code] to [code]1[/code]. At value [code]0[/code] objects will keep moving with the same velocity. Values greater than [code]1[/code] will aim to reduce the velocity to [code]0[/code] in less than a second e.g. a value of [code]2[/code] will aim to reduce the velocity to [code]0[/code] in half a second. A value equal to or greater than the physics frame rate ([member ProjectSettings.physics/common/physics_fps], [code]60[/code] by default) will bring the object to a stop in one iteration. - - Additional expansion applied to object bounds in the 3D physics bounding volume hierarchy. This can reduce BVH processing at the cost of a slightly coarser broadphase, which can stress the physics more in some situations. - The default value will work well in most situations. A value of 0.0 will turn this optimization off, and larger values may work better for larger, faster moving objects. - [b]Note:[/b] Used only if [member ProjectSettings.physics/3d/godot_physics/use_bvh] is enabled. + - - Enables the use of bounding volume hierarchy instead of octree for 3D physics spatial partitioning. This may give better performance. + Sets which physics engine to use for 3D physics. "DEFAULT" is currently the [url=https://bulletphysics.org]Bullet[/url] physics engine. The "GodotPhysics" engine is still supported as an alternative. + + + + If [code]true[/code], smooths out collision with trimesh shapes ([ConcavePolygonShape]) by telling the Bullet physics engine to generate internal edge information for every trimesh shape created. [b]Note:[/b] Only effective if [member physics/3d/physics_engine] is set to [code]DEFAULT[/code] or [code]Bullet[/code], [i]not[/i] [code]GodotPhysics[/code]. + + Enables [member Viewport.physics_object_picking] on the root viewport. diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index d4a286029..cd0628601 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -16,10 +16,8 @@ - - + - Constructs a [Rect2] by position and size. @@ -32,6 +30,14 @@ Constructs a [Rect2] by x, y, width, and height. + + + + + + Constructs a [Rect2] by position and size. + + diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml new file mode 100644 index 000000000..2d8b2ecae --- /dev/null +++ b/doc/classes/Rect2i.xml @@ -0,0 +1,100 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index 2b8a8ddb0..b02089a00 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -36,10 +36,8 @@ - + - Tells which resource class this loader can load. - [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them. diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index cf00a5138..7ef0f7609 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -12,17 +12,15 @@ - + - Adds a resource to the preloader with the given [code]name[/code]. If a resource with the given [code]name[/code] already exists, the new resource will be renamed to "[code]name[/code] N" where N is an incrementing number starting from 2. - + - Returns the resource associated to [code]name[/code]. @@ -33,24 +31,21 @@ - + - Returns [code]true[/code] if the preloader contains a resource associated to [code]name[/code]. - + - Removes the resource associated to [code]name[/code] from the preloader. - - + + - Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code]. diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index 01d3337b4..932dc5e5d 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -32,14 +32,14 @@ - + Returns the method connected to the signal at [code]idx[/code]. - + Returns the name of the signal at [code]idx[/code]. @@ -95,7 +95,7 @@ - + Returns the name of the node at [code]idx[/code]. @@ -126,7 +126,7 @@ - + @@ -142,7 +142,7 @@ - + Returns the type of the node at [code]idx[/code]. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 0e1e9effb..23306218c 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -15,28 +15,17 @@ - - + + - Calls [code]method[/code] on each member of the given group. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. This method is equivalent of calling [method call_group_flags] with [constant GROUP_CALL_DEFAULT] flag. - [b]Note:[/b] [code]method[/code] may only have 5 arguments at most (7 arguments passed to this method in total). - [b]Note:[/b] Due to design limitations, [method call_group] will fail silently if one of the arguments is [code]null[/code]. - [b]Note:[/b] [method call_group] will always call methods with an one-frame delay, in a way similar to [method Object.call_deferred]. To call methods immediately, use [method call_group_flags] with the [constant GROUP_CALL_REALTIME] flag. - - + + - Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. - [b]Note:[/b] [code]method[/code] may only have 5 arguments at most (8 arguments passed to this method in total). - [b]Note:[/b] Due to design limitations, [method call_group_flags] will fail silently if one of the arguments is [code]null[/code]. - [codeblock] - # Call the method immediately and in reverse order. - get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy") - [/codeblock] @@ -99,9 +88,8 @@ - + - Returns a list of all nodes assigned to the given group. @@ -112,9 +100,8 @@ - + - Returns [code]true[/code] if the given group exists. @@ -137,19 +124,17 @@ - + - Sends the given notification to all members of the [code]group[/code]. - + - Sends the given notification to all members of the [code]group[/code], respecting the given [enum GroupCallFlags]. @@ -184,21 +169,19 @@ - + - Sets the given [code]property[/code] to [code]value[/code] on all members of the given group. - + - Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GroupCallFlags]. diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 3b941f0b6..1007d718c 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -24,16 +24,15 @@ - + Returns the script's base type. - + - Returns the default value of the specified property. @@ -62,9 +61,8 @@ - + - Returns [code]true[/code] if the script, or a base class, defines a signal with the given name. diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 06db4990e..64dfad225 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -13,10 +13,8 @@ - + - Returns the texture that is set as default for the specified parameter. - [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. @@ -27,19 +25,15 @@ - + - Returns [code]true[/code] if the shader has this param defined as a uniform in its code. - [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. - + - Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial]. - [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 1e4675a5a..d0836d4a4 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -13,9 +13,8 @@ - + - Returns the current value set for this material of a uniform in the shader. @@ -34,11 +33,9 @@ - + - Changes the value set for this material of a uniform in the shader. - [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. diff --git a/doc/classes/SkeletonIK.xml b/doc/classes/SkeletonIK.xml index aab62b46b..1dabba245 100644 --- a/doc/classes/SkeletonIK.xml +++ b/doc/classes/SkeletonIK.xml @@ -71,7 +71,7 @@ If [code]true[/code] overwrites the rotation of the tip bone with the rotation of the [member target] (or [member target_node] if defined). - + The name of the current root bone, the first bone in the IK chain. @@ -80,7 +80,7 @@ Target node [NodePath] for the IK chain. If available, the node's current [Transform] is used instead of the [member target] property. - + The name of the current tip bone, the last bone in the IK chain placed at the [member target] transform (or [member target_node] if defined). diff --git a/doc/classes/Skin.xml b/doc/classes/Skin.xml index c74e48c73..bb8701869 100644 --- a/doc/classes/Skin.xml +++ b/doc/classes/Skin.xml @@ -31,7 +31,7 @@ - + @@ -58,7 +58,7 @@ - + diff --git a/doc/classes/SoftBody.xml b/doc/classes/SoftBody.xml index d48eab58b..c3850de6a 100644 --- a/doc/classes/SoftBody.xml +++ b/doc/classes/SoftBody.xml @@ -86,7 +86,7 @@ - + The physics layers this SoftBody is in. @@ -96,11 +96,11 @@ The physics layers this SoftBody scans for collisions. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - + - + [NodePath] to a [CollisionObject] this SoftBody should avoid clipping. @@ -115,13 +115,13 @@ If [code]true[/code], the [SoftBody] will respond to [RayCast]s. - + Increasing this value will improve the resulting simulation, but can affect performance. Use with care. - + The SoftBody's mass. - + diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index 507bba5c8..7a6eac7a0 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -12,25 +12,22 @@ - + - Adds a new animation to the library. - + - Adds a frame to the given animation. - + - Removes all frames from the given animation. @@ -41,9 +38,8 @@ - + - Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code]. @@ -54,79 +50,69 @@ - + - The animation's speed in frames per second. - + - Returns the animation's selected frame. - + - Returns the number of frames in the animation. - + - If [code]true[/code], the named animation exists. - + - Removes the given animation. - + - Removes the animation's selected frame. - - + + - Changes the animation's name to [code]newname[/code]. - + - If [code]true[/code], the animation will loop. - + - The animation's speed in frames per second. - + - Sets the texture of the given frame. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index b9b1747c2..32bf2e8cc 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -38,6 +38,12 @@ Constructs a new String from the given [Vector2]. + + + + + + @@ -45,6 +51,12 @@ Constructs a new String from the given [Rect2]. + + + + + + @@ -52,6 +64,12 @@ Constructs a new String from the given [Vector3]. + + + + + + @@ -115,6 +133,12 @@ Constructs a new String from the given [RID]. + + + + + + @@ -164,6 +188,12 @@ Constructs a new String from the given [PoolVector2Array]. + + + + + + @@ -171,6 +201,12 @@ Constructs a new String from the given [PoolVector3Array]. + + + + + + diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml new file mode 100644 index 000000000..3b2063c3c --- /dev/null +++ b/doc/classes/StringName.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index 4d44e33dc..2ebefd5ad 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -19,58 +19,51 @@ - - + + - Clears the [Color] at [code]name[/code] if the theme has [code]node_type[/code]. - - + + - Clears the constant at [code]name[/code] if the theme has [code]node_type[/code]. - - + + - Clears the [Font] at [code]name[/code] if the theme has [code]node_type[/code]. - - + + - Clears the icon at [code]name[/code] if the theme has [code]node_type[/code]. - - + + - Clears [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code]. - - + + - Clears the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]node_type[/code]. - + - Unmarks [code]theme_type[/code] as being a variation of another theme type. See [method set_type_variation]. @@ -88,10 +81,9 @@ - - + + - Returns the [Color] at [code]name[/code] if the theme has [code]node_type[/code]. @@ -109,10 +101,9 @@ - - + + - Returns the constant at [code]name[/code] if the theme has [code]node_type[/code]. @@ -130,10 +121,9 @@ - - + + - Returns the [Font] at [code]name[/code] if the theme has [code]node_type[/code]. If such item does not exist and [member default_font] is set on the theme, the default font will be returned. @@ -151,10 +141,9 @@ - - + + - Returns the icon [Texture] at [code]name[/code] if the theme has [code]node_type[/code]. @@ -172,11 +161,9 @@ - - + + - Returns the [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code]. - Valid [code]name[/code]s may be found using [method get_stylebox_list]. Valid [code]node_type[/code]s may be found using [method get_stylebox_types]. @@ -196,11 +183,9 @@ - - + + - Returns the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]node_type[/code]. - Valid [code]name[/code]s may be found using [method get_theme_item_list] or a data type specific method. Valid [code]node_type[/code]s may be found using [method get_theme_item_types] or a data type specific method. @@ -228,35 +213,29 @@ - - + + - Returns the name of the base theme type if [code]theme_type[/code] is a valid variation type. Returns an empty string otherwise. - + - Returns a list of all type variations for the given [code]base_type[/code]. - - + + - Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]node_type[/code]. - Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - + + - Returns [code]true[/code] if constant with [code]name[/code] is in [code]node_type[/code]. - Returns [code]false[/code] if the theme does not have [code]node_type[/code]. @@ -267,47 +246,38 @@ - - + + - Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]node_type[/code]. - Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - + + - Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]node_type[/code]. - Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - + + - Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]node_type[/code]. - Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - + + - Returns [code]true[/code] if a theme item of [code]data_type[/code] with [code]name[/code] is in [code]node_type[/code]. - Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - + + - Returns [code]true[/code] if [code]theme_type[/code] is marked as a variation of [code]base_type[/code]. @@ -320,130 +290,107 @@ - - - + + + - Renames the [Color] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails. - - - + + + - Renames the constant at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails. - - - + + + - Renames the [Font] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails. - - - + + + - Renames the icon at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails. - - - + + + - Renames [StyleBox] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails. - - - + + + - Renames the theme item of [code]data_type[/code] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails. - - + + - Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]node_type[/code]. - Creates [code]node_type[/code] if the theme does not have it. - - + + - Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]node_type[/code]. - Creates [code]node_type[/code] if the theme does not have it. - - + + - Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]node_type[/code]. - Creates [code]node_type[/code] if the theme does not have it. - - + + - Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]node_type[/code]. - Creates [code]node_type[/code] if the theme does not have it. - - + + - Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]node_type[/code]. - Creates [code]node_type[/code] if the theme does not have it. - - + + - Sets the theme item of [code]data_type[/code] to [code]value[/code] at [code]name[/code] in [code]node_type[/code]. - Does nothing if the [code]value[/code] type does not match [code]data_type[/code]. - Creates [code]node_type[/code] if the theme does not have it. - - + + - Marks [code]theme_type[/code] as a variation of [code]base_type[/code]. - This adds [code]theme_type[/code] as a suggested option for [member Control.theme_type_variation] on a [Control] that is of the [code]base_type[/code] class. - Variations can also be nested, i.e. [code]base_type[/code] can be another variation. If a chain of variations ends with a [code]base_type[/code] matching the class of the [Control], the whole chain is going to be suggested as options. - [b]Note:[/b] Suggestions only show up if this theme resource is set as the project default theme. See [member ProjectSettings.gui/theme/custom]. diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index bd5774779..08d870cac 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -35,12 +35,10 @@ - + - Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]method[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum. - Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure. diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index 73366f971..8e063e49f 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -20,24 +20,21 @@ - - + + - Adds a message if nonexistent, followed by its translation. - + - Erases a message. - - + + - Returns a message's translation. diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index a99731cb7..1bae433b4 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -60,10 +60,9 @@ - - + + - Returns the current locale's translation for the given message (key). diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 5a3113da9..54fda6091 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -23,9 +23,8 @@ - + - Calls the [code]method[/code] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. @@ -371,10 +370,8 @@ - + - Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code]. - The [code]callback[/code] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2]. diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 7bcc9cfae..3e6b0b282 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -25,17 +25,15 @@ - + - + - Follows [code]method[/code] of [code]object[/code] and applies the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] later. Methods are called with consecutive values. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. @@ -97,7 +95,7 @@ - + @@ -105,8 +103,6 @@ - Animates [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are called with consecutive values. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. @@ -134,9 +130,8 @@ - + - Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless [code]key[/code] is specified. @@ -148,9 +143,8 @@ - + - Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless [code]key[/code] is specified. @@ -162,9 +156,8 @@ - + - Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless [code]key[/code] is specified. @@ -196,9 +189,8 @@ - + - Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless [code]key[/code] is specified. @@ -210,17 +202,15 @@ - + - + - Animates [code]method[/code] of [code]object[/code] from the value returned by [code]initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index e362ab502..4e034a3fa 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -42,10 +42,9 @@ - + - Register a property value change for "do". @@ -58,18 +57,16 @@ - + - Register a method that will be called when the action is undone. - + - Register a property value change for "undo". diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index e1c7f42db..89e9e650e 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -16,6 +16,12 @@ https://github.com/godotengine/godot-demo-projects/tree/master/2d + + + + + + diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml new file mode 100644 index 000000000..1f6389def --- /dev/null +++ b/doc/classes/Vector2i.xml @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 65f5dcc05..de1fe5730 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -16,6 +16,12 @@ https://github.com/godotengine/godot-demo-projects/tree/master/3d + + + + + + diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml new file mode 100644 index 000000000..8218412c4 --- /dev/null +++ b/doc/classes/Vector3i.xml @@ -0,0 +1,84 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 204d53fd1..315be509c 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -55,7 +55,7 @@ Amount of time in milliseconds to store in buffer while playing. - + Audio bus to use for sound playback. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 86aa69939..88495b573 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1443,17 +1443,15 @@ - + - Returns the value of a certain material's parameter. - + - Returns the default value for the param if available. Otherwise returns an empty [Variant]. @@ -1482,10 +1480,9 @@ - + - Sets a material's parameter. @@ -1974,11 +1971,9 @@ - + - Schedules a callback to the corresponding named [code]method[/code] on [code]where[/code] after a frame has been drawn. - The callback method must use only 1 argument which will be called with [code]userdata[/code]. @@ -2087,9 +2082,8 @@ - + - Returns a default texture from a shader searched by name. @@ -2110,10 +2104,9 @@ - + - Sets a shader's default texture. Overwrites the texture given by name. diff --git a/modules/entity_spell_system/doc_classes/ActionBarButtonEntry.xml b/modules/entity_spell_system/doc_classes/ActionBarButtonEntry.xml index 65750e0bf..a3e811f07 100644 --- a/modules/entity_spell_system/doc_classes/ActionBarButtonEntry.xml +++ b/modules/entity_spell_system/doc_classes/ActionBarButtonEntry.xml @@ -33,7 +33,7 @@ - + diff --git a/modules/entity_spell_system/doc_classes/ClassProfile.xml b/modules/entity_spell_system/doc_classes/ClassProfile.xml index 030039e23..914883942 100644 --- a/modules/entity_spell_system/doc_classes/ClassProfile.xml +++ b/modules/entity_spell_system/doc_classes/ClassProfile.xml @@ -60,7 +60,7 @@ - + diff --git a/modules/entity_spell_system/doc_classes/ESDragAndDrop.xml b/modules/entity_spell_system/doc_classes/ESDragAndDrop.xml index d8c7471da..ecf078080 100644 --- a/modules/entity_spell_system/doc_classes/ESDragAndDrop.xml +++ b/modules/entity_spell_system/doc_classes/ESDragAndDrop.xml @@ -10,7 +10,7 @@ - + diff --git a/modules/entity_spell_system/doc_classes/ESS.xml b/modules/entity_spell_system/doc_classes/ESS.xml index c825c02d4..1a9c39076 100644 --- a/modules/entity_spell_system/doc_classes/ESS.xml +++ b/modules/entity_spell_system/doc_classes/ESS.xml @@ -36,31 +36,31 @@ - + - + - + - + - + @@ -200,31 +200,31 @@ - + - + - + - + - + @@ -244,7 +244,7 @@ - + diff --git a/modules/entity_spell_system/doc_classes/ESSResourceDB.xml b/modules/entity_spell_system/doc_classes/ESSResourceDB.xml index eeb5cbf7b..751d14c24 100644 --- a/modules/entity_spell_system/doc_classes/ESSResourceDB.xml +++ b/modules/entity_spell_system/doc_classes/ESSResourceDB.xml @@ -66,62 +66,62 @@ - + - + - + - + - + - + - + - + - + - + @@ -144,7 +144,7 @@ - + @@ -172,7 +172,7 @@ - + @@ -200,7 +200,7 @@ - + @@ -228,7 +228,7 @@ - + @@ -256,7 +256,7 @@ - + @@ -284,7 +284,7 @@ - + @@ -318,7 +318,7 @@ - + @@ -333,14 +333,14 @@ - + - + @@ -394,14 +394,14 @@ - + - + diff --git a/modules/entity_spell_system/doc_classes/PlayerProfile.xml b/modules/entity_spell_system/doc_classes/PlayerProfile.xml index da0e30516..27c53e490 100644 --- a/modules/entity_spell_system/doc_classes/PlayerProfile.xml +++ b/modules/entity_spell_system/doc_classes/PlayerProfile.xml @@ -32,7 +32,7 @@ - + diff --git a/modules/entity_spell_system/doc_classes/ProfileManager.xml b/modules/entity_spell_system/doc_classes/ProfileManager.xml index 29de4d723..618715a8f 100644 --- a/modules/entity_spell_system/doc_classes/ProfileManager.xml +++ b/modules/entity_spell_system/doc_classes/ProfileManager.xml @@ -70,7 +70,7 @@ - + diff --git a/modules/gltf/doc_classes/GLTFSkin.xml b/modules/gltf/doc_classes/GLTFSkin.xml index b8b3de4bd..2c5bc9a1f 100644 --- a/modules/gltf/doc_classes/GLTFSkin.xml +++ b/modules/gltf/doc_classes/GLTFSkin.xml @@ -42,14 +42,14 @@ - - + + diff --git a/modules/network_synchronizer/doc_classes/DataBuffer.xml b/modules/network_synchronizer/doc_classes/DataBuffer.xml index 554564cdf..a5a868146 100644 --- a/modules/network_synchronizer/doc_classes/DataBuffer.xml +++ b/modules/network_synchronizer/doc_classes/DataBuffer.xml @@ -1,5 +1,5 @@ - + diff --git a/modules/network_synchronizer/doc_classes/Interpolator.xml b/modules/network_synchronizer/doc_classes/Interpolator.xml index 5020ff0b0..a7b957398 100644 --- a/modules/network_synchronizer/doc_classes/Interpolator.xml +++ b/modules/network_synchronizer/doc_classes/Interpolator.xml @@ -1,5 +1,5 @@ - + diff --git a/modules/network_synchronizer/doc_classes/NetworkedController.xml b/modules/network_synchronizer/doc_classes/NetworkedController.xml index 67a075a40..f7262d494 100644 --- a/modules/network_synchronizer/doc_classes/NetworkedController.xml +++ b/modules/network_synchronizer/doc_classes/NetworkedController.xml @@ -1,5 +1,5 @@ - + diff --git a/modules/network_synchronizer/doc_classes/SceneDiff.xml b/modules/network_synchronizer/doc_classes/SceneDiff.xml index 877c08a6b..6e3e95737 100644 --- a/modules/network_synchronizer/doc_classes/SceneDiff.xml +++ b/modules/network_synchronizer/doc_classes/SceneDiff.xml @@ -1,5 +1,5 @@ - + diff --git a/modules/network_synchronizer/doc_classes/SceneSynchronizer.xml b/modules/network_synchronizer/doc_classes/SceneSynchronizer.xml index 353f89ec1..b5f7d5533 100644 --- a/modules/network_synchronizer/doc_classes/SceneSynchronizer.xml +++ b/modules/network_synchronizer/doc_classes/SceneSynchronizer.xml @@ -1,5 +1,5 @@ - + @@ -139,7 +139,7 @@ - + diff --git a/modules/props/doc_classes/PropCache.xml b/modules/props/doc_classes/PropCache.xml index 3b9570cb6..b08e1df0b 100644 --- a/modules/props/doc_classes/PropCache.xml +++ b/modules/props/doc_classes/PropCache.xml @@ -99,7 +99,7 @@ - + diff --git a/modules/props_2d/doc_classes/Prop2DCache.xml b/modules/props_2d/doc_classes/Prop2DCache.xml index d4ad613ee..3333aef2e 100644 --- a/modules/props_2d/doc_classes/Prop2DCache.xml +++ b/modules/props_2d/doc_classes/Prop2DCache.xml @@ -66,7 +66,7 @@ - +