diff options
Diffstat (limited to 'doc/classes')
41 files changed, 480 insertions, 81 deletions
diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml index de574cd75b..b66dceacec 100644 --- a/doc/classes/AnimatedTexture.xml +++ b/doc/classes/AnimatedTexture.xml @@ -6,7 +6,7 @@ <description> [AnimatedTexture] is a resource format for frame-based animations, where multiple textures can be chained automatically with a predefined delay for each frame. Unlike [AnimationPlayer] or [AnimatedSprite], it isn't a [Node], but has the advantage of being usable anywhere a [Texture] resource can be used, e.g. in a [TileSet]. The playback of the animation is controlled by the [member fps] property as well as each frame's optional delay (see [method set_frame_delay]). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame. - [AnimatedTexture] currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. + [AnimatedTexture] currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. Also, it doesn't support [AtlasTexture]. Each frame needs to be separate image. </description> <tutorials> </tutorials> diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 7d5d8a2db1..b4288bbfaa 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -73,7 +73,7 @@ <argument index="6" name="optimize" type="bool" default="true"> </argument> <description> - Blend another animaiton 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. + 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. </description> </method> <method name="get_caption" qualifiers="virtual"> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index e510603281..5bb4a6e3c7 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -71,7 +71,7 @@ <argument index="0" name="animation" type="Animation"> </argument> <description> - Returns the name of [code]animation[/code] or empty string if not found. + Returns the name of [code]animation[/code] or an empty string if not found. </description> </method> <method name="get_animation" qualifiers="const"> @@ -112,6 +112,7 @@ <return type="PoolStringArray"> </return> <description> + Returns a list of the animation names that are currently queued to play. </description> </method> <method name="has_animation" qualifiers="const"> @@ -284,6 +285,7 @@ </signal> <signal name="caches_cleared"> <description> + Notifies when the caches have been cleared, either automatically, or manually via [method clear_caches]. </description> </signal> </signals> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 130908b842..a1529f3eb3 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -304,6 +304,21 @@ Returns the number of elements in the array. </description> </method> + <method name="slice"> + <return type="Array"> + </return> + <argument index="0" name="begin" type="int"> + </argument> + <argument index="1" name="end" type="int"> + </argument> + <argument index="2" name="step" type="int" default="1"> + </argument> + <argument index="3" name="deep" type="bool" default="False"> + </argument> + <description> + Duplicates the subset described in the function and returns it in an array, deeply copying the array if [code]deep[/code] is true. Lower and upper index are inclusive, with the [code]step[/code] describing the change between indices while slicing. + </description> + </method> <method name="sort"> <description> Sorts the array. diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 0e3cb4d110..2d6ad8f996 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -4,8 +4,7 @@ Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. </brief_description> <description> - [Texture] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture], a margin that defines the border width, - and a region that defines the actual area of the AtlasTexture. + [Texture] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture], a margin that defines the border width, and a region that defines the actual area of the AtlasTexture. </description> <tutorials> </tutorials> diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index 6a8cdcd2a8..305be8b58d 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -17,6 +17,9 @@ <member name="clip_text" type="bool" setter="set_clip_text" getter="get_clip_text" default="false"> When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. </member> + <member name="expand_icon" type="bool" setter="set_expand_icon" getter="is_expand_icon" default="false"> + When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect. + </member> <member name="flat" type="bool" setter="set_flat" getter="is_flat" default="false"> Flat buttons don't display decoration. </member> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 16fb483249..aeeebdf00d 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -154,7 +154,7 @@ </member> <member name="offset_h" type="float" setter="set_h_offset" getter="get_h_offset" default="0.0"> The horizontal offset of the camera, relative to the drag margins. - [b]Note:[/b] Offset H is used only to force offset relative to margins. It's not updated in any way if drag margins are enabled and can be used to set inital offset. + [b]Note:[/b] Offset H is used only to force offset relative to margins. It's not updated in any way if drag margins are enabled and can be used to set initial offset. </member> <member name="offset_v" type="float" setter="set_v_offset" getter="get_v_offset" default="0.0"> The vertical offset of the camera, relative to the drag margins. diff --git a/doc/classes/CharFXTransform.xml b/doc/classes/CharFXTransform.xml new file mode 100644 index 0000000000..e03229abe1 --- /dev/null +++ b/doc/classes/CharFXTransform.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CharFXTransform" inherits="Reference" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_value_or"> + <return type="Variant"> + </return> + <argument index="0" name="key" type="String"> + </argument> + <argument index="1" name="default_value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="absolute_index" type="int" setter="set_absolute_index" getter="get_absolute_index" default="0"> + </member> + <member name="character" type="int" setter="set_character" getter="get_character" default="0"> + </member> + <member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 0, 0, 0, 1 )"> + </member> + <member name="elapsed_time" type="float" setter="set_elapsed_time" getter="get_elapsed_time" default="0.0"> + </member> + <member name="env" type="Dictionary" setter="set_environment" getter="get_environment" default="{}"> + </member> + <member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2( 0, 0 )"> + </member> + <member name="relative_index" type="int" setter="set_relative_index" getter="get_relative_index" default="0"> + </member> + <member name="visible" type="bool" setter="set_visibility" getter="is_visible" default="true"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index e183922c19..e8e8d3d8bc 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -41,6 +41,10 @@ Emitted when the color changes. </description> </signal> + <signal name="picker_created"> + <description> + </description> + </signal> <signal name="popup_closed"> <description> </description> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 1eeef92ccc..05ffac803a 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -22,7 +22,7 @@ </return> <description> Virtual method to be implemented by the user. Returns whether [method _gui_input] should not be called for children controls outside this control's rectangle. Input will be clipped to the Rect of this [Control]. Similar to [member rect_clip_content], but doesn't affect visibility. - If not overriden, defaults to [code]false[/code]. + If not overridden, defaults to [code]false[/code]. </description> </method> <method name="_get_minimum_size" qualifiers="virtual"> @@ -30,7 +30,7 @@ </return> <description> Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to [member rect_min_size] for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately). - If not overriden, defaults to [constant Vector2.ZERO]. + If not overridden, defaults to [constant Vector2.ZERO]. </description> </method> <method name="_gui_input" qualifiers="virtual"> @@ -395,7 +395,7 @@ <return type="void"> </return> <description> - Creates an [InputEventMouseButton] that attempts to click the control. If the event is received, the control aquires focus. + Creates an [InputEventMouseButton] that attempts to click the control. If the event is received, the control acquires focus. [codeblock] func _process(delta): grab_click_focus() #when clicking another Control node, this node will be clicked instead @@ -503,7 +503,7 @@ </argument> <description> Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control. - If not overriden, default behavior is checking if the point is within control's Rect. + If not overridden, default behavior is checking if the point is within control's Rect. [b]Node:[/b] If you want to check if a point is inside the control, you can use [code]get_rect().has_point(point)[/code]. </description> </method> @@ -564,7 +564,7 @@ <description> Sets the anchor identified by [code]margin[/code] constant from [enum Margin] enum to value [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. If [code]keep_margin[/code] is [code]true[/code], margins aren't updated after this operation. - If [code]push_opposite_anchor[/code] is [code]true[/code] and the opposite anchor overlaps this anchor, the opposite one will have its value overriden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If [code]push_opposite_anchor[/code] was [code]false[/code], the left anchor would get value 0.5. + If [code]push_opposite_anchor[/code] is [code]true[/code] and the opposite anchor overlaps this anchor, the opposite one will have its value overridden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If [code]push_opposite_anchor[/code] was [code]false[/code], the left anchor would get value 0.5. </description> </method> <method name="set_anchor_and_margin"> diff --git a/doc/classes/EditorFeatureProfile.xml b/doc/classes/EditorFeatureProfile.xml index 21da9fd454..92622cc25d 100644 --- a/doc/classes/EditorFeatureProfile.xml +++ b/doc/classes/EditorFeatureProfile.xml @@ -36,7 +36,7 @@ </return> <argument index="0" name="class_name" type="String"> </argument> - <argument index="1" name="arg1" type="String"> + <argument index="1" name="property" type="String"> </argument> <description> </description> @@ -92,7 +92,7 @@ </argument> <argument index="1" name="property" type="String"> </argument> - <argument index="2" name="arg2" type="bool"> + <argument index="2" name="disable" type="bool"> </argument> <description> </description> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 4f7a6d89a9..20ae0f3391 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -25,6 +25,12 @@ Returns the main container of Godot editor's window. You can use it, for example, to retrieve the size of the container and place your controls accordingly. </description> </method> + <method name="get_current_path" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="get_edited_scene_root"> <return type="Node"> </return> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index 03a274e23e..07740dc754 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -62,7 +62,7 @@ </argument> <argument index="1" name="billboard" type="bool" default="false"> </argument> - <argument index="2" name="skeleton" type="RID"> + <argument index="2" name="skeleton" type="SkinReference"> </argument> <argument index="3" name="material" type="Material" default="null"> </argument> diff --git a/doc/classes/EditorVCSInterface.xml b/doc/classes/EditorVCSInterface.xml new file mode 100644 index 0000000000..f67c1c9eb5 --- /dev/null +++ b/doc/classes/EditorVCSInterface.xml @@ -0,0 +1,115 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorVCSInterface" inherits="Object" category="Core" version="3.2"> + <brief_description> + Version Control System (VCS) interface which reads and writes to the local VCS in use. + </brief_description> + <description> + Used by the editor to display VCS extracted information in the editor. The implementation of this API is included in VCS addons, which are essentially GDNative plugins that need to be put into the project folder. These VCS addons are scripts which are attached (on demand) to the object instance of [code]EditorVCSInterface[/code]. All the functions listed below, instead of performing the task themselves, they call the internally defined functions in the VCS addons to provide a plug-n-play experience. + </description> + <tutorials> + </tutorials> + <methods> + <method name="commit"> + <return type="void"> + </return> + <argument index="0" name="msg" type="String"> + </argument> + <description> + Creates a version commit if the addon is initialized, else returns without doing anything. Uses the files which have been staged previously, with the commit message set to a value as provided as in the argument. + </description> + </method> + <method name="get_file_diff"> + <return type="Array"> + </return> + <argument index="0" name="file_path" type="String"> + </argument> + <description> + Returns an [Array] of [Dictionary] objects containing the diff output from the VCS in use, if a VCS addon is initialized, else returns an empty [Array] object. The diff contents also consist of some contextual lines which provide context to the observed line change in the file. + Each [Dictionary] object has the line diff contents under the keys: + - [code]"content"[/code] to store a [String] containing the line contents + - [code]"status"[/code] to store a [String] which contains [code]"+"[/code] in case the content is a line addition but it stores a [code]"-"[/code] in case of deletion and an empty string in the case the line content is neither an addition nor a deletion. + - [code]"new_line_number"[/code] to store an integer containing the new line number of the line content. + - [code]"line_count"[/code] to store an integer containing the number of lines in the line content. + - [code]"old_line_number"[/code] to store an integer containing the old line number of the line content. + - [code]"offset"[/code] to store the offset of the line change since the first contextual line content. + </description> + </method> + <method name="get_is_vcs_intialized"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if the VCS addon has been initialized, else returns [code]false[/code]. + </description> + </method> + <method name="get_modified_files_data"> + <return type="Dictionary"> + </return> + <description> + Returns a [Dictionary] containing the path of the detected file change mapped to an integer signifying what kind of a change the corresponding file has experienced. + The following integer values are being used to signify that the detected file is: + - [code]0[/code]: New to the VCS working directory + - [code]1[/code]: Modified + - [code]2[/code]: Renamed + - [code]3[/code]: Deleted + - [code]4[/code]: Typechanged + </description> + </method> + <method name="get_project_name"> + <return type="String"> + </return> + <description> + Return the project name of the VCS working directory + </description> + </method> + <method name="get_vcs_name"> + <return type="String"> + </return> + <description> + Return the name of the VCS if the VCS has been initialized, else return an empty string. + </description> + </method> + <method name="initialize"> + <return type="bool"> + </return> + <argument index="0" name="project_root_path" type="String"> + </argument> + <description> + Initialize the VCS addon if not already. Uses the argument value as the path to the working directory of the project. Creates the initial commit if required. Returns [code]true[/code] if no failure occurs, else returns [code]false[/code]. + </description> + </method> + <method name="is_addon_ready"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if the addon is ready to respond to function calls, else returns [code]false[/code]. + </description> + </method> + <method name="shut_down"> + <return type="bool"> + </return> + <description> + Shuts down the VCS addon to allow cleanup code to run on call. Returns [code]true[/code] is no failure occurs, else returns [code]false[/code]. + </description> + </method> + <method name="stage_file"> + <return type="void"> + </return> + <argument index="0" name="file_path" type="String"> + </argument> + <description> + Stage the file which should be committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path. + </description> + </method> + <method name="unstage_file"> + <return type="void"> + </return> + <argument index="0" name="file_path" type="String"> + </argument> + <description> + Unstage the file which was staged previously to be committed, so that it is no longer committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 8aefa41f8a..8470a346ff 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -174,6 +174,7 @@ </methods> <members> <member name="comment" type="bool" setter="set_comment" getter="is_comment" default="false"> + If [code]true[/code], the GraphNode is a comment node. </member> <member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2( 0, 0 )"> The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 10be66feb8..d297bc98ae 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -252,7 +252,7 @@ <argument index="1" name="y" type="int"> </argument> <description> - Returns the color of the pixel at [code](x, y)[/code] if the image is locked. If the image is unlocked it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. + Returns the color of the pixel at [code](x, y)[/code] if the image is locked. If the image is unlocked, it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. This is the same as [method get_pixelv], but two integer arguments instead of a Vector2 argument. </description> </method> <method name="get_pixelv" qualifiers="const"> @@ -261,6 +261,7 @@ <argument index="0" name="src" type="Vector2"> </argument> <description> + Returns the color of the pixel at [code]src[/code] if the image is locked. If the image is unlocked, it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. This is the same as [method get_pixel], but with a Vector2 argument instead of two integer arguments. </description> </method> <method name="get_rect" qualifiers="const"> @@ -414,7 +415,7 @@ <argument index="1" name="grayscale" type="bool" default="false"> </argument> <description> - Saves the image as an EXR file to [code]path[/code]. If grayscale is true and the image has only one channel, it will be saved explicitely as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. + Saves the image as an EXR file to [code]path[/code]. If grayscale is true and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. </description> </method> <method name="save_png" qualifiers="const"> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 5fd5e8c3c0..afb3977849 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -223,7 +223,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns [code]true[/code] if you are pressing the action event. Note that if an action has multiple buttons asigned 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. + 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. </description> </method> <method name="is_joy_button_pressed" qualifiers="const"> @@ -316,6 +316,8 @@ Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See enum [code]CURSOR_*[/code] for the list of shapes. [code]image[/code]'s size must be lower than 256×256. [code]hotspot[/code] must be within [code]image[/code]'s size. + [b]Note:[/b] [AnimatedTexture]s aren't supported as custom mouse cursors. If using an [AnimatedTexture], only the first frame will be displayed. + [b]Note:[/b] Only images imported with the [b]Lossless[/b], [b]Lossy[/b] or [b]Uncompressed[/b] compression modes are supported. The [b]Video RAM[/b] compression mode can't be used for custom cursors. </description> </method> <method name="set_default_cursor_shape"> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index a6dfb50a8b..f5934f0181 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -118,12 +118,19 @@ <member name="placeholder_text" type="String" setter="set_placeholder" getter="get_placeholder" default=""""> Text shown when the [LineEdit] is empty. It is [b]not[/b] the [LineEdit]'s default value (see [member text]). </member> + <member name="right_icon" type="Texture" setter="set_right_icon" getter="get_right_icon"> + Sets the icon that will appear in the right end of the [LineEdit] if there's no [member text], or always, if [member clear_button_enabled] is set to [code]false[/code]. + </member> <member name="secret" type="bool" setter="set_secret" getter="is_secret" default="false"> If [code]true[/code], every character is replaced with the secret character (see [member secret_character]). </member> <member name="secret_character" type="String" setter="set_secret_character" getter="get_secret_character" default=""*""> The character to use to mask secret input (defaults to "*"). Only a single character can be used as the secret character. </member> + <member name="selecting_enabled" type="bool" setter="set_selecting_enabled" getter="is_selecting_enabled" default="true"> + </member> + <member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true"> + </member> <member name="text" type="String" setter="set_text" getter="get_text" default=""""> String value of the [LineEdit]. </member> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index 181a99590a..23ce20a434 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -215,5 +215,13 @@ Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string). Specific to the macOS platform. </constant> + <constant name="NOTIFICATION_APP_RESUMED" value="1014"> + Notification received from the OS when the app is resumed. + Specific to the Android platform. + </constant> + <constant name="NOTIFICATION_APP_PAUSED" value="1015"> + Notification received from the OS when the app is paused. + Specific to the Android platform. + </constant> </constants> </class> diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index c577635c98..a4d2bb4295 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -65,6 +65,8 @@ <member name="skeleton" type="NodePath" setter="set_skeleton_path" getter="get_skeleton_path" default="NodePath("..")"> [NodePath] to the [Skeleton] associated with the instance. </member> + <member name="skin" type="Skin" setter="set_skin" getter="get_skin"> + </member> </members> <constants> </constants> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index c7bcc63297..2b173434d5 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -52,7 +52,7 @@ The height of the 9-slice's top row. </member> <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2( 0, 0, 0, 0 )"> - Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. + Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. If the rect is empty, NinePatchRect will use the whole texture. </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> The node's texture resource. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 097fa1f6e5..b206d4a4d2 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -171,6 +171,7 @@ <description> Duplicates the node, returning a new node. You can fine-tune the behavior using the [code]flags[/code] (see [enum DuplicateFlags]). + [b]Note:[/b] It will not work properly if the node contains a script with constructor arguments (i.e. needs to supply arguments to [method Object._init] method). In that case, the node will be duplicated without a script. </description> </method> <method name="find_node" qualifiers="const"> @@ -962,6 +963,14 @@ Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string). Specific to the macOS platform. </constant> + <constant name="NOTIFICATION_APP_RESUMED" value="1014"> + Notification received from the OS when the app is resumed. + Specific to the Android platform. + </constant> + <constant name="NOTIFICATION_APP_PAUSED" value="1015"> + Notification received from the OS when the app is paused. + Specific to the Android platform. + </constant> <constant name="PAUSE_MODE_INHERIT" value="0" enum="PauseMode"> Inherits pause mode from the node's parent. For the root node, it is equivalent to [constant PAUSE_MODE_STOP]. Default. </constant> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index abdbfa09f7..29c4680685 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -52,7 +52,7 @@ <argument index="0" name="point" type="Vector2"> </argument> <description> - Rotates the node so it points towards the [code]point[/code]. + Rotates the node so it points towards the [code]point[/code], which is expected to use global coordinates. </description> </method> <method name="move_local_x"> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 938777a36b..9f61245819 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -820,6 +820,7 @@ </argument> <description> Sets the window title to the specified string. + [b]Note:[/b] This should be used sporadically. Don't set this every frame, as that will negatively affect performance on some window managers. </description> </method> <method name="shell_open"> @@ -828,9 +829,10 @@ <argument index="0" name="uri" type="String"> </argument> <description> - Requests the OS to open a resource with the most appropriate program. For example. - [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the downloads folders of the user. - [code]OS.shell_open("https://godotengine.org")[/code] opens the default web browser on the official Godot website. + Requests the OS to open a resource with the most appropriate program. For example: + - [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the user's Downloads folder. + - [code]OS.shell_open("https://godotengine.org")[/code] opens the default web browser on the official Godot website. + - [code]OS.shell_open("mailto:example@example.com")[/code] opens the default email client with the "To" field set to [code]example@example.com[/code]. See [url=https://blog.escapecreative.com/customizing-mailto-links/]Customizing [code]mailto:[/code] Links[/url] for a list of fields that can be added. </description> </method> <method name="show_virtual_keyboard"> diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index ba00438ea1..a139fa4664 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -822,7 +822,7 @@ <argument index="5" name="result" type="Physics2DTestMotionResult" default="null"> </argument> <description> - Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. + Returns [code]true[/code] if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. [Physics2DTestMotionResult] can be passed to return additional information in. </description> </method> <method name="capsule_shape_create"> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 2963ad34a5..530c1189d2 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -233,7 +233,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns the index of the item containing the specified [code]id[/code]. Index is automatically assigned to each item by the engine. Index can not be set manualy. + Returns the index of the item containing the specified [code]id[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually. </description> </method> <method name="get_item_metadata" qualifiers="const"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 86b874d8ee..3da403c681 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -722,7 +722,7 @@ Fix to improve physics jitter, specially on monitors where refresh rate is different than the physics FPS. </member> <member name="rendering/environment/default_clear_color" type="Color" setter="" getter="" default="Color( 0.3, 0.3, 0.3, 1 )"> - Default background clear color. Overriddable per [Viewport] using its [Environment]. See [member Environment.background_mode] and [member Environment.background_color] in particular. To change this default color programmatically, use [method VisualServer.set_default_clear_color]. + Default background clear color. Overridable per [Viewport] using its [Environment]. See [member Environment.background_mode] and [member Environment.background_color] in particular. To change this default color programmatically, use [method VisualServer.set_default_clear_color]. </member> <member name="rendering/limits/buffers/blend_shape_max_buffer_size_kb" type="int" setter="" getter="" default="4096"> Max buffer size for blend shapes. Any blend shape bigger than this will not work. @@ -762,7 +762,7 @@ If [code]true[/code], performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. </member> <member name="rendering/quality/directional_shadow/size" type="int" setter="" getter="" default="4096"> - The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. + The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. The value will be rounded up to the nearest power of 2. </member> <member name="rendering/quality/directional_shadow/size.mobile" type="int" setter="" getter="" default="2048"> </member> diff --git a/doc/classes/RichTextEffect.xml b/doc/classes/RichTextEffect.xml new file mode 100644 index 0000000000..5c3ffd9cff --- /dev/null +++ b/doc/classes/RichTextEffect.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RichTextEffect" inherits="Resource" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="_process_custom_fx" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="char_fx" type="CharFXTransform"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 944ff50894..1118a3a637 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -80,6 +80,14 @@ Returns the number of visible lines. </description> </method> + <method name="install_effect"> + <return type="void"> + </return> + <argument index="0" name="effect" type="Variant"> + </argument> + <description> + </description> + </method> <method name="newline"> <return type="void"> </return> @@ -96,6 +104,14 @@ The assignment version of [method append_bbcode]. Clears the tag stack and inserts the new content. Returns [constant OK] if parses [code]bbcode[/code] successfully. </description> </method> + <method name="parse_expressions_for_values"> + <return type="Dictionary"> + </return> + <argument index="0" name="expressions" type="PoolStringArray"> + </argument> + <description> + </description> + </method> <method name="pop"> <return type="void"> </return> @@ -228,6 +244,8 @@ <member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode" default=""""> The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. </member> + <member name="custom_effects" type="Array" setter="set_effects" getter="get_effects" default="[ ]"> + </member> <member name="meta_underlined" type="bool" setter="set_meta_underline" getter="is_meta_underlined" default="true"> If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code]. </member> @@ -320,7 +338,19 @@ </constant> <constant name="ITEM_TABLE" value="11" enum="ItemType"> </constant> - <constant name="ITEM_META" value="12" enum="ItemType"> + <constant name="ITEM_FADE" value="12" enum="ItemType"> + </constant> + <constant name="ITEM_SHAKE" value="13" enum="ItemType"> + </constant> + <constant name="ITEM_WAVE" value="14" enum="ItemType"> + </constant> + <constant name="ITEM_TORNADO" value="15" enum="ItemType"> + </constant> + <constant name="ITEM_RAINBOW" value="16" enum="ItemType"> + </constant> + <constant name="ITEM_CUSTOMFX" value="18" enum="ItemType"> + </constant> + <constant name="ITEM_META" value="17" enum="ItemType"> </constant> </constants> <theme_items> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index fca73e3ea7..e8a88acdb5 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -32,6 +32,38 @@ Returns the script's base type. </description> </method> + <method name="get_property_default_value"> + <return type="Variant"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_script_constant_map"> + <return type="Dictionary"> + </return> + <description> + </description> + </method> + <method name="get_script_method_list"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_script_property_list"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_script_signal_list"> + <return type="Array"> + </return> + <description> + </description> + </method> <method name="has_script_signal" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index b1e71ee924..27a78cd7d1 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -4,7 +4,7 @@ Skeleton for characters and animated objects. </brief_description> <description> - Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. + Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). It can also use ragdoll physics. The overall transform of a bone with respect to the skeleton is determined by the following hierarchical order: rest pose, custom pose and pose. Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone. </description> @@ -54,15 +54,6 @@ Returns the amount of bones in the skeleton. </description> </method> - <method name="get_bone_custom_pose" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. - </description> - </method> <method name="get_bone_global_pose" qualifiers="const"> <return type="Transform"> </return> @@ -109,15 +100,6 @@ Returns the rest transform for a bone [code]bone_idx[/code]. </description> </method> - <method name="get_bone_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - Returns the combination of custom pose and pose. The returned transform is in skeleton's reference frame. - </description> - </method> <method name="get_bound_child_nodes_to_bone" qualifiers="const"> <return type="Array"> </return> @@ -171,12 +153,10 @@ <description> </description> </method> - <method name="set_bone_custom_pose"> - <return type="void"> + <method name="register_skin"> + <return type="SkinReference"> </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <argument index="1" name="custom_pose" type="Transform"> + <argument index="0" name="skin" type="Skin"> </argument> <description> </description> @@ -191,22 +171,16 @@ <description> </description> </method> - <method name="set_bone_global_pose"> + <method name="set_bone_global_pose_override"> <return type="void"> </return> <argument index="0" name="bone_idx" type="int"> </argument> <argument index="1" name="pose" type="Transform"> </argument> - <description> - </description> - </method> - <method name="set_bone_ignore_animation"> - <return type="void"> - </return> - <argument index="0" name="bone" type="int"> + <argument index="2" name="amount" type="float"> </argument> - <argument index="1" name="ignore" type="bool"> + <argument index="3" name="persistent" type="bool" default="false"> </argument> <description> </description> @@ -265,10 +239,6 @@ </description> </method> </methods> - <members> - <member name="bones_in_world_transform" type="bool" setter="set_use_bones_in_world_transform" getter="is_using_bones_in_world_transform" default="false"> - </member> - </members> <constants> <constant name="NOTIFICATION_UPDATE_SKELETON" value="50"> </constant> diff --git a/doc/classes/Skin.xml b/doc/classes/Skin.xml new file mode 100644 index 0000000000..174febc883 --- /dev/null +++ b/doc/classes/Skin.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Skin" inherits="Resource" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_bind"> + <return type="void"> + </return> + <argument index="0" name="bone" type="int"> + </argument> + <argument index="1" name="pose" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="clear_binds"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_bind_bone" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="bind_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bind_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_bind_pose" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="bind_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bind_bone"> + <return type="void"> + </return> + <argument index="0" name="bind_index" type="int"> + </argument> + <argument index="1" name="bone" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bind_count"> + <return type="void"> + </return> + <argument index="0" name="bind_count" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bind_pose"> + <return type="void"> + </return> + <argument index="0" name="bind_index" type="int"> + </argument> + <argument index="1" name="pose" type="Transform"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/SkinReference.xml b/doc/classes/SkinReference.xml new file mode 100644 index 0000000000..c12957654f --- /dev/null +++ b/doc/classes/SkinReference.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SkinReference" inherits="Reference" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_skeleton" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_skin" qualifiers="const"> + <return type="Skin"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index f6ec85c87d..7124d5f4dd 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -677,6 +677,15 @@ Replaces occurrences of a case-insensitive substring with the given one inside the string. </description> </method> + <method name="repeat"> + <return type="String"> + </return> + <argument index="0" name="count" type="int"> + </argument> + <description> + Returns original string repeated a number of times. The number of repetitions is given by the argument. + </description> + </method> <method name="rfind"> <return type="int"> </return> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index b923a38bc7..0c867f1fe4 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -429,6 +429,10 @@ <member name="readonly" type="bool" setter="set_readonly" getter="is_readonly" default="false"> If [code]true[/code], read-only mode is enabled. Existing text cannot be modified and new text cannot be added. </member> + <member name="selecting_enabled" type="bool" setter="set_selecting_enabled" getter="is_selecting_enabled" default="true"> + </member> + <member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true"> + </member> <member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled" default="false"> If [code]true[/code], line numbers are displayed to the left of the text. </member> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index f6545e49e6..3379965596 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -405,8 +405,6 @@ </theme_item> <theme_item name="guide_color" type="Color" default="Color( 0, 0, 0, 0.1 )"> </theme_item> - <theme_item name="guide_width" type="int" default="2"> - </theme_item> <theme_item name="hseparation" type="int" default="4"> </theme_item> <theme_item name="item_margin" type="int" default="12"> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 117c4835eb..9bc46881f9 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -281,7 +281,8 @@ The subdivision amount of fourth quadrant on shadow atlas. </member> <member name="shadow_atlas_size" type="int" setter="set_shadow_atlas_size" getter="get_shadow_atlas_size" default="0"> - The resolution of shadow atlas. Both width and height is equal to one value. + The shadow atlas' resolution (used for omni and spot lights). The value will be rounded up to the nearest power of 2. + [b]Note:[/b] If this is set to 0, shadows won't be visible. Since user-created viewports default to a value of 0, this value must be set above 0 manually. </member> <member name="size" type="Vector2" setter="set_size" getter="get_size" default="Vector2( 0, 0 )"> The width and height of viewport. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 0f25c00489..96f6a42cdf 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -4,7 +4,7 @@ Enables certain nodes only when visible. </brief_description> <description> - The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. + The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect nodes with the same root node as the VisibilityEnabler2D, and the root node itself. </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 5e054ce7ce..b95b970816 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -189,13 +189,13 @@ </argument> <argument index="1" name="mesh" type="RID"> </argument> - <argument index="2" name="texture" type="Transform2D"> + <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> </argument> - <argument index="3" name="normal_map" type="Color"> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> - <argument index="4" name="arg4" type="RID"> + <argument index="4" name="texture" type="RID"> </argument> - <argument index="5" name="arg5" type="RID"> + <argument index="5" name="normal_map" type="RID"> </argument> <description> </description> @@ -3855,7 +3855,7 @@ <argument index="1" name="size" type="int"> </argument> <description> - Sets the size of the shadow atlas's images. + Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2. </description> </method> <method name="viewport_set_size"> diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml index 774586cc95..c18afe9190 100644 --- a/doc/classes/VisualShaderNodeGroupBase.xml +++ b/doc/classes/VisualShaderNodeGroupBase.xml @@ -146,9 +146,9 @@ <method name="set_input_port_name"> <return type="void"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="arg1" type="String"> + <argument index="1" name="name" type="String"> </argument> <description> </description> @@ -156,9 +156,9 @@ <method name="set_input_port_type"> <return type="void"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="type" type="int"> </argument> <description> </description> @@ -174,9 +174,9 @@ <method name="set_output_port_name"> <return type="void"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="arg1" type="String"> + <argument index="1" name="name" type="String"> </argument> <description> </description> @@ -184,9 +184,9 @@ <method name="set_output_port_type"> <return type="void"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="type" type="int"> </argument> <description> </description> diff --git a/doc/classes/VisualShaderNodeScalarSwitch.xml b/doc/classes/VisualShaderNodeScalarSwitch.xml new file mode 100644 index 0000000000..80e75eec3f --- /dev/null +++ b/doc/classes/VisualShaderNodeScalarSwitch.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeScalarSwitch" inherits="VisualShaderNodeSwitch" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> |