diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index f5319db05..4cf7415a8 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -17,6 +17,7 @@ + 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. diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 2bd09bad6..ba84dd798 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -20,6 +20,7 @@ + Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 84576989c..bcc3ca3e7 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -42,6 +42,7 @@ + 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. @@ -50,6 +51,7 @@ + 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. diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index a6d785a24..a1e90d664 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -26,6 +26,7 @@ + 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. @@ -50,6 +51,7 @@ + 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. @@ -146,6 +148,7 @@ + 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/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index ac91f40d7..9aaafea5d 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -17,6 +17,7 @@ + Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later. @@ -25,6 +26,7 @@ + Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code]. @@ -32,30 +34,35 @@ + 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. @@ -63,6 +70,7 @@ + Changes the name of a sub-node. @@ -70,6 +78,7 @@ + Modifies the position of a sub-node. diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index 476a4756f..f7cc29dec 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -21,6 +21,7 @@ + Adds a new node to the graph. The [code]position[/code] is used for display in the editor. @@ -29,6 +30,7 @@ + Adds a transition between the given nodes. @@ -47,6 +49,7 @@ + Returns the animation node with the given name. @@ -60,6 +63,7 @@ + Returns the given node's coordinates. Used for display in the editor. @@ -99,6 +103,7 @@ + Returns [code]true[/code] if the graph contains the given node. @@ -106,12 +111,14 @@ + Returns [code]true[/code] if there is a transition between the given nodes. + Deletes the given node from the graph. @@ -119,6 +126,7 @@ + Deletes the transition between the two specified nodes. @@ -133,6 +141,7 @@ + Renames the given node. @@ -140,12 +149,14 @@ + Replaces the node and keeps its transitions unchanged. + Sets the given node as the graph end point. @@ -160,12 +171,14 @@ + 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 c410d953d..84e3e29aa 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -48,6 +48,7 @@ + Starts playing the given animation. @@ -60,6 +61,7 @@ + Transitions from the current state to another one, following the shortest path. diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index c978ccdee..a9c5d25e4 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -19,6 +19,7 @@ + Adds [code]animation[/code] to the player accessible with the key [code]name[/code]. @@ -32,6 +33,7 @@ + Returns the name of the next animation in the queue. @@ -39,6 +41,7 @@ + Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. @@ -64,6 +67,7 @@ + Returns the [Animation] with the key [code]name[/code]. If the animation does not exist, [code]null[/code] is returned and an error is logged. @@ -77,6 +81,7 @@ + Gets the blend time (in seconds) between two animations, referenced by their names. @@ -95,6 +100,7 @@ + Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code]. @@ -110,6 +116,9 @@ + 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]. @@ -117,18 +126,23 @@ + 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]. @@ -136,6 +150,7 @@ + Renames an existing animation with key [code]name[/code] to [code]newname[/code]. @@ -153,6 +168,7 @@ + Specifies a blend time (in seconds) between two animations, referenced by their names. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 22ff97389..fe8a52ea5 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -33,6 +33,7 @@ + Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added. @@ -85,6 +86,7 @@ + Sets the name of the specified blend shape. diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index fffbbeaee..d3d3e7851 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -77,6 +77,7 @@ + Returns the index of the bus with the name [code]bus_name[/code]. @@ -262,6 +263,7 @@ + Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code]. diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 2c990828b..9c7e514f3 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -13,18 +13,21 @@ + 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. @@ -33,6 +36,7 @@ + Returns an array with all the keys in [code]enum[/code] of [code]class[/code] or its ancestry. @@ -40,6 +44,7 @@ + Returns an array with all the enums of [code]class[/code] or its ancestry. @@ -47,6 +52,7 @@ + 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. @@ -55,6 +61,7 @@ + Returns which enum the integer constant [code]name[/code] of [code]class[/code] or its ancestry belongs to. @@ -62,6 +69,7 @@ + Returns an array with the names all the integer constants of [code]class[/code] or its ancestry. @@ -69,6 +77,8 @@ + 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. @@ -76,6 +86,7 @@ + Returns the value of [code]property[/code] of [code]class[/code] or its ancestry. @@ -83,6 +94,7 @@ + Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. @@ -90,6 +102,7 @@ + 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]. @@ -97,6 +110,7 @@ + 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]. @@ -105,6 +119,7 @@ + Returns whether [code]class[/code] or its ancestry has an enum called [code]name[/code] or not. @@ -112,6 +127,7 @@ + Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not. @@ -120,6 +136,7 @@ + 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. @@ -127,6 +144,7 @@ + Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not. @@ -135,6 +153,7 @@ + Sets [code]property[/code] value of [code]class[/code] to [code]value[/code]. @@ -147,24 +166,28 @@ + 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. @@ -172,6 +195,7 @@ + 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 e029f3ae8..cb2dd1b31 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -91,6 +91,15 @@ + 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] @@ -98,6 +107,8 @@ + 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]. @@ -105,6 +116,9 @@ + 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, but use [method remove_font_override] instead. + See also [method get_font]. @@ -112,6 +126,9 @@ + 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, but use [method remove_icon_override] instead. + See also [method get_icon]. @@ -119,6 +136,8 @@ + 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, but use [method remove_shader_override] instead. @@ -126,6 +145,21 @@ + 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, but 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] @@ -286,6 +320,15 @@ + 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] @@ -293,6 +336,8 @@ + 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. @@ -307,6 +352,8 @@ + 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,6 +361,8 @@ + 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. @@ -321,6 +370,8 @@ + 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. @@ -367,12 +418,16 @@ + 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]. @@ -380,12 +435,16 @@ + 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]. @@ -393,12 +452,16 @@ + 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]. @@ -406,18 +469,24 @@ + 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]. + 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]. @@ -425,12 +494,16 @@ + 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]. @@ -461,36 +534,42 @@ + 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]. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index b6a72b0a6..3bb1f3a0f 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -23,6 +23,7 @@ + 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). diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index ba5f714f8..ead9d8edc 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -31,6 +31,8 @@ + 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. @@ -40,6 +42,8 @@ + 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 891a0bf52..916172dd8 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -127,6 +127,7 @@ + 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/GraphEdit.xml b/doc/classes/GraphEdit.xml index afbdd9d46..dd3740b26 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -45,6 +45,7 @@ + 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. @@ -54,6 +55,7 @@ + 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. @@ -76,6 +78,7 @@ + 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. @@ -116,6 +119,7 @@ + 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. diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 26252cf37..1e08ea08d 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -32,6 +32,8 @@ + 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. @@ -39,6 +41,8 @@ + 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. @@ -47,6 +51,9 @@ + 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. @@ -54,6 +61,8 @@ + 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/InputMap.xml b/doc/classes/InputMap.xml index bed94c057..560f52410 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -15,6 +15,7 @@ + Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. @@ -22,18 +23,21 @@ + Removes an [InputEvent] from an action. + Removes all events from an action. + Returns a deadzone value for the action. @@ -41,6 +45,7 @@ + Returns [code]true[/code] if the action has the given [InputEvent] associated with it. @@ -48,6 +53,7 @@ + Sets a deadzone value for the action. @@ -55,12 +61,15 @@ + 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]. @@ -69,12 +78,16 @@ + 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. + [b]Note:[/b] When used in the editor (e.g. a tool script or [EditorPlugin]), this method will return events for the editor action. If you want to access your project's input binds from the editor, read the [code]input/*[/code] settings from [ProjectSettings]. @@ -87,6 +100,7 @@ + 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 b54ace1da..fbdedf162 100644 --- a/doc/classes/JavaScript.xml +++ b/doc/classes/JavaScript.xml @@ -16,6 +16,7 @@ + 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/Node.xml b/doc/classes/Node.xml index 3e2a11167..672e13e83 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -160,6 +160,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. @@ -416,6 +419,7 @@ + Returns [code]true[/code] if this node is in the specified group. See notes in the description, and the group methods in [SceneTree]. @@ -573,6 +577,7 @@ + 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. @@ -614,6 +619,7 @@ + Removes a node from a group. See notes in the description, and the group methods in [SceneTree]. @@ -645,6 +651,8 @@ + 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 [code]null[/code]. + [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]. @@ -652,6 +660,7 @@ + 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. @@ -659,12 +668,14 @@ + Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns [code]null[/code]. + Sends a [method rpc] using an unreliable protocol. Returns [code]null[/code]. @@ -672,64 +683,75 @@ + 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 [code]null[/code]. + Add a Node that is seen by this Node. Used by vrpcs. + Get a Node that is seen by this node. Used by vrpcs. + How many Nodes see this Node. + Remove a Node that is seen by this node. Used by vrpcs. + Remove a Node that is seen by this node. Used by vrpcs. + Add a Node that this Node sees. Used by vrpcs. + Get a Node that this Node sees. Used by vrpcs. + How many Nodes this Node sees. + Remove a Node that this Node sees. Used by vrpcs. + Remove a Node that this Node sees. Used by vrpcs. @@ -855,12 +877,14 @@ + Same as [method rpc] but it will only send the call to clients that see ([mehod seen_by_add]) this Node. (v = visibility) + Same as [method rpc_unreliable] but it will only send the call to clients that see ([mehod seen_by_add]) this Node. (v = visibility) diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 004b02e52..4042b19be 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -29,6 +29,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. @@ -58,6 +60,8 @@ + 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. @@ -79,12 +83,22 @@ + 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). @@ -92,6 +106,10 @@ + 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] @@ -114,6 +132,22 @@ + 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 print 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] @@ -122,12 +156,19 @@ + 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 print 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] @@ -235,18 +276,21 @@ + 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. @@ -269,6 +313,7 @@ + Returns [code]true[/code] if a connection exists for a given [code]signal[/code], [code]target[/code], and [code]method[/code]. @@ -320,6 +365,8 @@ + 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). diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 23a8db1f7..7c43ba33d 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -150,6 +150,12 @@ + 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. @@ -483,6 +489,7 @@ + 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 e3ece0318..ff5b360a1 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -144,6 +144,12 @@ + 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. @@ -494,6 +500,7 @@ + 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/RenderingServer.xml b/doc/classes/RenderingServer.xml index eedf124d5..9a9a6d5c1 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -1571,6 +1571,7 @@ + Returns the value of a certain material's parameter. @@ -1578,6 +1579,7 @@ + Returns the default value for the param if available. Returns [code]null[/code] otherwise. @@ -1609,6 +1611,7 @@ + Sets a material's parameter. @@ -2136,6 +2139,8 @@ + 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]. @@ -2246,6 +2251,7 @@ + Returns a default texture from a shader searched by name. @@ -2269,6 +2275,7 @@ + Sets a shader's default texture. Overwrites the texture given by name. diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index d21e40998..7a1324f1b 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -38,6 +38,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 5b9db2492..2095090ce 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -15,12 +15,14 @@ + 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,12 +35,14 @@ + 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. @@ -46,6 +50,7 @@ + Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code]. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index c3523241d..34104433e 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -18,6 +18,10 @@ + 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. @@ -26,6 +30,13 @@ + 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] @@ -103,6 +114,7 @@ + Returns a list of all nodes assigned to the given group. @@ -121,6 +133,7 @@ + Returns [code]true[/code] if the given group exists. @@ -146,6 +159,7 @@ + Sends the given notification to all members of the [code]group[/code]. @@ -154,6 +168,7 @@ + Sends the given notification to all members of the [code]group[/code], respecting the given [enum GroupCallFlags]. @@ -184,6 +199,7 @@ + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group. @@ -193,6 +209,7 @@ + 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/SceneTreeTween.xml b/doc/classes/SceneTreeTween.xml index f6da798ce..df541ef9d 100644 --- a/doc/classes/SceneTreeTween.xml +++ b/doc/classes/SceneTreeTween.xml @@ -214,6 +214,18 @@ + Creates and appends a [CallbackTweener]. This method can be used to call an arbitrary method in any object. Use [code]binds[/code] to bind additional arguments for the call. + Example: object that keeps shooting every 1 second. + [codeblock] + var tween = get_tree().create_tween().set_loops() + tween.tween_callback(self, "shoot").set_delay(1) + [/codeblock] + Example: turning a sprite red and then blue, with 2 second delay. + [codeblock] + var tween = get_tree().create_tween() + tween.tween_callback($Sprite, "set_modulate", [Color.red]).set_delay(2) + tween.tween_callback($Sprite, "set_modulate", [Color.blue]).set_delay(2) + [/codeblock] @@ -248,6 +260,21 @@ + Creates and appends a [MethodTweener]. This method is similar to a combination of [method tween_callback] and [method tween_property]. It calls a method over time with a tweened value provided as an argument. The value is tweened between [code]from[/code] and [code]to[/code] over the time specified by [code]duration[/code], in seconds. Use [code]binds[/code] to bind additional arguments for the call. You can use [method MethodTweener.set_ease] and [method MethodTweener.set_trans] to tweak the easing and transition of the value or [method MethodTweener.set_delay] to delay the tweening. + Example: making a 3D object look from one point to another point. + [codeblock] + var tween = create_tween() + tween.tween_method(self, "look_at", Vector3(-1, 0, -1), Vector3(1, 0, -1), 1, [Vector3.UP]) # The look_at() method takes up vector as second argument. + [/codeblock] + Example: setting a text of a [Label], using an intermediate method and after a delay. + [codeblock] + func _ready(): + var tween = create_tween() + tween.tween_method(self, "set_label_text", 0, 10, 1).set_delay(1) + + func set_label_text(value: int): + $Label.text = "Counting " + str(value) + [/codeblock] diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index b8322b86c..8514a9579 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -33,6 +33,7 @@ + Returns the default value of the specified property. @@ -63,6 +64,7 @@ + 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 c332593b1..86d3a6db1 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -15,6 +15,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,6 +29,8 @@ + 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. @@ -34,6 +38,8 @@ + 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 b8d843ddf..bbc150aa8 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -15,6 +15,7 @@ + Returns the current value set for this material of a uniform in the shader. @@ -36,6 +37,8 @@ + 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/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index a3dcf78df..fe9ad90af 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -14,6 +14,7 @@ + Adds a new animation to the library. @@ -22,12 +23,14 @@ + Adds a frame to the given animation. + Removes all frames from the given animation. @@ -40,6 +43,7 @@ + Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code]. @@ -52,6 +56,7 @@ + The animation's speed in frames per second. @@ -59,24 +64,28 @@ + 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. @@ -84,6 +93,7 @@ + Removes the animation's selected frame. @@ -91,6 +101,7 @@ + Changes the animation's name to [code]newname[/code]. @@ -98,6 +109,7 @@ + If [code]true[/code], the animation will loop. @@ -105,6 +117,7 @@ + The animation's speed in frames per second. @@ -113,6 +126,7 @@ + Sets the texture of the given frame. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 378fc1736..c7eeb8e9a 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -215,6 +215,7 @@ + Constructs a new String from the given [StringName]. diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index 6f08db584..2415ca858 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -15,6 +15,8 @@ + Adds an empty theme type for every valid data type. + [b]Note:[/b] Empty types are not saved with the theme. This method only exists to perform in-memory changes to the resource. Use available [code]set_*[/code] methods to add theme items. @@ -28,6 +30,7 @@ + Clears the [Color] at [code]name[/code] if the theme has [code]theme_type[/code]. @@ -35,6 +38,7 @@ + Clears the constant at [code]name[/code] if the theme has [code]theme_type[/code]. @@ -42,6 +46,7 @@ + Clears the [Font] at [code]name[/code] if the theme has [code]theme_type[/code]. @@ -49,6 +54,7 @@ + Clears the icon at [code]name[/code] if the theme has [code]theme_type[/code]. @@ -56,6 +62,7 @@ + Clears [StyleBox] at [code]name[/code] if the theme has [code]theme_type[/code]. @@ -64,12 +71,14 @@ + Clears the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]theme_type[/code]. + Unmarks [code]theme_type[/code] as being a variation of another theme type. See [method set_type_variation]. @@ -90,6 +99,7 @@ + Returns the [Color] at [code]name[/code] if the theme has [code]theme_type[/code]. @@ -110,6 +120,7 @@ + Returns the constant at [code]name[/code] if the theme has [code]theme_type[/code]. @@ -130,6 +141,7 @@ + Returns the [Font] at [code]name[/code] if the theme has [code]theme_type[/code]. If such item does not exist and [member default_font] is set on the theme, the default font will be returned. @@ -150,6 +162,7 @@ + Returns the icon [Texture] at [code]name[/code] if the theme has [code]theme_type[/code]. @@ -170,6 +183,8 @@ + Returns the [StyleBox] at [code]name[/code] if the theme has [code]theme_type[/code]. + Valid [code]name[/code]s may be found using [method get_stylebox_list]. Valid [code]theme_type[/code]s may be found using [method get_stylebox_types]. @@ -192,6 +207,8 @@ + Returns the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]theme_type[/code]. + Valid [code]name[/code]s may be found using [method get_theme_item_list] or a data type specific method. Valid [code]theme_type[/code]s may be found using [method get_theme_item_types] or a data type specific method. @@ -222,12 +239,14 @@ + 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]. @@ -235,6 +254,8 @@ + Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]theme_type[/code]. + Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. @@ -242,6 +263,8 @@ + Returns [code]true[/code] if constant with [code]name[/code] is in [code]theme_type[/code]. + Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. @@ -255,6 +278,8 @@ + Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]theme_type[/code]. + Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. @@ -262,6 +287,8 @@ + Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]theme_type[/code]. + Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. @@ -269,6 +296,8 @@ + Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]theme_type[/code]. + Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. @@ -277,6 +306,8 @@ + Returns [code]true[/code] if a theme item of [code]data_type[/code] with [code]name[/code] is in [code]theme_type[/code]. + Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. @@ -284,6 +315,7 @@ + Returns [code]true[/code] if [code]theme_type[/code] is marked as a variation of [code]base_type[/code]. @@ -298,6 +330,7 @@ + Removes the theme type, gracefully discarding defined theme items. If the type is a variation, this information is also erased. If the type is a base for type variations, those variations lose their base. @@ -306,6 +339,7 @@ + Renames the [Color] at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. @@ -314,6 +348,7 @@ + Renames the constant at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. @@ -322,6 +357,7 @@ + Renames the [Font] at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. @@ -330,6 +366,7 @@ + Renames the icon at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. @@ -338,6 +375,7 @@ + Renames [StyleBox] at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. @@ -347,6 +385,7 @@ + Renames the theme item of [code]data_type[/code] at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. @@ -355,6 +394,8 @@ + Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]theme_type[/code]. + Creates [code]theme_type[/code] if the theme does not have it. @@ -363,6 +404,8 @@ + Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]theme_type[/code]. + Creates [code]theme_type[/code] if the theme does not have it. @@ -371,6 +414,8 @@ + Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]theme_type[/code]. + Creates [code]theme_type[/code] if the theme does not have it. @@ -379,6 +424,8 @@ + Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]theme_type[/code]. + Creates [code]theme_type[/code] if the theme does not have it. @@ -387,6 +434,8 @@ + Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]theme_type[/code]. + Creates [code]theme_type[/code] if the theme does not have it. @@ -396,6 +445,9 @@ + Sets the theme item of [code]data_type[/code] to [code]value[/code] at [code]name[/code] in [code]theme_type[/code]. + Does nothing if the [code]value[/code] type does not match [code]data_type[/code]. + Creates [code]theme_type[/code] if the theme does not have it. @@ -403,6 +455,10 @@ + 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 61a22c56c..117900cf9 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -38,6 +38,8 @@ + 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/TreeItem.xml b/doc/classes/TreeItem.xml index 40f8453f5..6c065813a 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -26,6 +26,7 @@ + Calls the [code]method[/code] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. @@ -373,6 +374,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 9087680a6..f034d7b97 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -34,6 +34,8 @@ + 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. @@ -103,6 +105,8 @@ + 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. @@ -132,6 +136,7 @@ + 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. @@ -159,6 +164,7 @@ + Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless [code]key[/code] is specified. @@ -192,6 +198,7 @@ + Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless [code]key[/code] is specified. @@ -212,6 +219,8 @@ + 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 b32fdefbc..c24fd4086 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -45,6 +45,7 @@ + Register a property value change for "do". @@ -59,6 +60,7 @@ + Register a method that will be called when the action is undone. @@ -67,6 +69,7 @@ + Register a property value change for "undo". diff --git a/modules/gdnative/doc_classes/NativeScript.xml b/modules/gdnative/doc_classes/NativeScript.xml index e9e4e1516..068d80611 100644 --- a/modules/gdnative/doc_classes/NativeScript.xml +++ b/modules/gdnative/doc_classes/NativeScript.xml @@ -17,18 +17,21 @@ + Returns the documentation string that was previously set with [code]godot_nativescript_set_method_documentation[/code]. + Returns the documentation string that was previously set with [code]godot_nativescript_set_property_documentation[/code]. + Returns the documentation string that was previously set with [code]godot_nativescript_set_signal_documentation[/code].