diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/@GlobalScope.xml | 13 | ||||
| -rw-r--r-- | doc/classes/CodeEdit.xml | 166 | ||||
| -rw-r--r-- | doc/classes/CollisionObject2D.xml | 4 | ||||
| -rw-r--r-- | doc/classes/CollisionObject3D.xml | 8 | ||||
| -rw-r--r-- | doc/classes/ConfigFile.xml | 83 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 144 | ||||
| -rw-r--r-- | doc/classes/SoftBody3D.xml | 8 | ||||
| -rw-r--r-- | doc/classes/TextEdit.xml | 30 | ||||
| -rw-r--r-- | doc/classes/TileMap.xml | 94 | ||||
| -rw-r--r-- | doc/classes/TileSet.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Transform2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/VisualShader.xml | 6 | ||||
| -rwxr-xr-x | doc/tools/makerst.py | 18 |
13 files changed, 481 insertions, 97 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 33d877af29..c86812742c 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -193,19 +193,6 @@ Converts from decibels to linear energy (audio). </description> </method> - <method name="dectime"> - <return type="float" /> - <argument index="0" name="value" type="float" /> - <argument index="1" name="amount" type="float" /> - <argument index="2" name="step" type="float" /> - <description> - Returns the result of [code]value[/code] decreased by [code]step[/code] * [code]amount[/code]. - [codeblock] - # a = 59 - a = dectime(60, 10, 0.1)) - [/codeblock] - </description> - </method> <method name="deg2rad"> <return type="float" /> <argument index="0" name="deg" type="float" /> diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index 6a3f38f51e..0b060ec277 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CodeEdit" inherits="TextEdit" version="4.0"> <brief_description> + Multiline text control intended for editing code. </brief_description> <description> + CodeEdit is a specialised [TextEdit] designed for editing plain text code files. It contains a bunch of features commonly found in code editors such as line numbers, line folding, code completion, indent management and string / comment management. [b]Note[/b]: By default [CodeEdit] always use left-to-right text direction to correctly display source code. </description> <tutorials> @@ -30,6 +32,15 @@ Override this method to define what happens when the user requests code completion. If [code]force[/code] is true, any checks should be bypassed. </description> </method> + <method name="add_auto_brace_completion_pair"> + <return type="void" /> + <argument index="0" name="start_key" type="String" /> + <argument index="1" name="end_key" type="String" /> + <description> + Adds a brace pair. + Both the start and end keys must be symbols. Only the start key has to be unique. + </description> + </method> <method name="add_code_completion_option"> <return type="void" /> <argument index="0" name="type" type="int" enum="CodeEdit.CodeCompletionKind" /> @@ -81,11 +92,13 @@ <method name="clear_bookmarked_lines"> <return type="void" /> <description> + Clears all bookmarked lines. </description> </method> <method name="clear_breakpointed_lines"> <return type="void" /> <description> + Clears all breakpointed lines. </description> </method> <method name="clear_comment_delimiters"> @@ -97,6 +110,7 @@ <method name="clear_executing_lines"> <return type="void" /> <description> + Clears all executed lines. </description> </method> <method name="clear_string_delimiters"> @@ -137,14 +151,23 @@ Folds the given line, if possible (see [method can_fold_line]). </description> </method> + <method name="get_auto_brace_completion_close_key" qualifiers="const"> + <return type="String" /> + <argument index="0" name="open_key" type="String" /> + <description> + Gets the matching auto brace close key for [code]open_key[/code]. + </description> + </method> <method name="get_bookmarked_lines" qualifiers="const"> <return type="Array" /> <description> + Gets all bookmarked lines. </description> </method> <method name="get_breakpointed_lines" qualifiers="const"> <return type="Array" /> <description> + Gets all breakpointed lines. </description> </method> <method name="get_code_completion_option" qualifiers="const"> @@ -205,6 +228,7 @@ <method name="get_executing_lines" qualifiers="const"> <return type="Array" /> <description> + Gets all executing lines. </description> </method> <method name="get_folded_lines" qualifiers="const"> @@ -219,6 +243,26 @@ Returns the full text with char [code]0xFFFF[/code] at the caret location. </description> </method> + <method name="get_text_for_symbol_lookup"> + <return type="String" /> + <description> + Returns the full text with char [code]0xFFFF[/code] at the cursor location. + </description> + </method> + <method name="has_auto_brace_completion_close_key" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="close_key" type="String" /> + <description> + Returns [code]true[/code] if close key [code]close_key[/code] exists. + </description> + </method> + <method name="has_auto_brace_completion_open_key" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="open_key" type="String" /> + <description> + Returns [code]true[/code] if open key [code]open_key[/code] exists. + </description> + </method> <method name="has_comment_delimiter" qualifiers="const"> <return type="bool" /> <argument index="0" name="start_key" type="String" /> @@ -259,18 +303,21 @@ <return type="bool" /> <argument index="0" name="line" type="int" /> <description> + Returns whether the line at the specified index is bookmarked or not. </description> </method> <method name="is_line_breakpointed" qualifiers="const"> <return type="bool" /> <argument index="0" name="line" type="int" /> <description> + Returns whether the line at the specified index is breakpointed or not. </description> </method> <method name="is_line_executing" qualifiers="const"> <return type="bool" /> <argument index="0" name="line" type="int" /> <description> + Returns whether the line at the specified index is marked as executing or not. </description> </method> <method name="is_line_folded" qualifiers="const"> @@ -327,6 +374,7 @@ <argument index="0" name="line" type="int" /> <argument index="1" name="bookmarked" type="bool" /> <description> + Sets the line as bookmarked. </description> </method> <method name="set_line_as_breakpoint"> @@ -334,6 +382,7 @@ <argument index="0" name="line" type="int" /> <argument index="1" name="breakpointed" type="bool" /> <description> + Sets the line as breakpointed. </description> </method> <method name="set_line_as_executing"> @@ -341,6 +390,14 @@ <argument index="0" name="line" type="int" /> <argument index="1" name="executing" type="bool" /> <description> + Sets the line as executing. + </description> + </method> + <method name="set_symbol_lookup_word_as_valid"> + <return type="void" /> + <argument index="0" name="valid" type="bool" /> + <description> + Sets the symbol emitted by [signal symbol_validate] as a valid lookup. </description> </method> <method name="toggle_foldable_line"> @@ -353,6 +410,7 @@ <method name="unfold_all_lines"> <return type="void" /> <description> + Unfolds all lines, folded or not. </description> </method> <method name="unfold_line"> @@ -378,6 +436,15 @@ </method> </methods> <members> + <member name="auto_brace_completion_enabled" type="bool" setter="set_auto_brace_completion_enabled" getter="is_auto_brace_completion_enabled" default="false"> + Sets whether brace pairs should be autocompleted. + </member> + <member name="auto_brace_completion_highlight_matching" type="bool" setter="set_highlight_matching_braces_enabled" getter="is_highlight_matching_braces_enabled" default="false"> + Highlight mismatching brace pairs. + </member> + <member name="auto_brace_completion_pairs" type="Dictionary" setter="set_auto_brace_completion_pairs" getter="get_auto_brace_completion_pairs" default="{"\"": "\"","'": "'","(": ")","[": "]","{": "}"}"> + Sets the brace pairs to be autocompleted. + </member> <member name="code_completion_enabled" type="bool" setter="set_code_completion_enabled" getter="is_code_completion_enabled" default="false"> Sets whether code completion is allowed. </member> @@ -387,18 +454,26 @@ <member name="delimiter_comments" type="String[]" setter="set_comment_delimiters" getter="get_comment_delimiters" default="[]"> Sets the comment delimiters. All existing comment delimiters will be removed. </member> - <member name="delimiter_strings" type="String[]" setter="set_string_delimiters" getter="get_string_delimiters" default="[]"> + <member name="delimiter_strings" type="String[]" setter="set_string_delimiters" getter="get_string_delimiters" default="["' '", "\" \""]"> Sets the string delimiters. All existing string delimiters will be removed. </member> - <member name="draw_bookmarks" type="bool" setter="set_draw_bookmarks_gutter" getter="is_drawing_bookmarks_gutter" default="false"> + <member name="gutters_draw_bookmarks" type="bool" setter="set_draw_bookmarks_gutter" getter="is_drawing_bookmarks_gutter" default="false"> + Sets if bookmarked should be drawn in the gutter. This gutter is shared with breakpoints and executing lines. </member> - <member name="draw_breakpoints_gutter" type="bool" setter="set_draw_breakpoints_gutter" getter="is_drawing_breakpoints_gutter" default="false"> + <member name="gutters_draw_breakpoints_gutter" type="bool" setter="set_draw_breakpoints_gutter" getter="is_drawing_breakpoints_gutter" default="false"> + Sets if breakpoints should be drawn in the gutter. This gutter is shared with bookmarks and executing lines. </member> - <member name="draw_executing_lines" type="bool" setter="set_draw_executing_lines_gutter" getter="is_drawing_executing_lines_gutter" default="false"> + <member name="gutters_draw_executing_lines" type="bool" setter="set_draw_executing_lines_gutter" getter="is_drawing_executing_lines_gutter" default="false"> + Sets if executing lines should be marked in the gutter. This gutter is shared with breakpoints and bookmarks lines. </member> - <member name="draw_fold_gutter" type="bool" setter="set_draw_fold_gutter" getter="is_drawing_fold_gutter" default="false"> + <member name="gutters_draw_fold_gutter" type="bool" setter="set_draw_fold_gutter" getter="is_drawing_fold_gutter" default="false"> + Sets if foldable lines icons should be drawn in the gutter. </member> - <member name="draw_line_numbers" type="bool" setter="set_draw_line_numbers" getter="is_draw_line_numbers_enabled" default="false"> + <member name="gutters_draw_line_numbers" type="bool" setter="set_draw_line_numbers" getter="is_draw_line_numbers_enabled" default="false"> + Sets if line numbers should be drawn in the gutter. + </member> + <member name="gutters_zero_pad_line_numbers" type="bool" setter="set_line_numbers_zero_padded" getter="is_line_numbers_zero_padded" default="false"> + Sets if line numbers drawn in the gutter are zero padded. </member> <member name="indent_automatic" type="bool" setter="set_auto_indent_enabled" getter="is_auto_indent_enabled" default="false"> Sets whether automatic indent are enabled, this will add an extra indent if a prefix or brace is found. @@ -413,18 +488,23 @@ Use spaces instead of tabs for indentation. </member> <member name="layout_direction" type="int" setter="set_layout_direction" getter="get_layout_direction" override="true" enum="Control.LayoutDirection" default="2" /> - <member name="line_folding" type="bool" setter="set_line_folding_enabled" getter="is_line_folding_enabled" default="true"> + <member name="line_folding" type="bool" setter="set_line_folding_enabled" getter="is_line_folding_enabled" default="false"> Sets whether line folding is allowed. </member> + <member name="line_length_guidelines" type="int[]" setter="set_line_length_guidelines" getter="get_line_length_guidelines" default="[]"> + Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently + </member> <member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" override="true" default="[]" /> - <member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" override="true" enum="Control.TextDirection" default="1" /> - <member name="zero_pad_line_numbers" type="bool" setter="set_line_numbers_zero_padded" getter="is_line_numbers_zero_padded" default="false"> + <member name="symbol_lookup_on_click" type="bool" setter="set_symbol_lookup_on_click_enabled" getter="is_symbol_lookup_on_click_enabled" default="false"> + Set when a validated word from [signal symbol_validate] is clicked, the [signal symbol_lookup] should be emitted. </member> + <member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" override="true" enum="Control.TextDirection" default="1" /> </members> <signals> <signal name="breakpoint_toggled"> <argument index="0" name="line" type="int" /> <description> + Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line. </description> </signal> <signal name="request_code_completion"> @@ -432,114 +512,176 @@ Emitted when the user requests code completion. </description> </signal> + <signal name="symbol_lookup"> + <argument index="0" name="symbol" type="String" /> + <argument index="1" name="line" type="int" /> + <argument index="2" name="column" type="int" /> + <description> + Emitted when the user has clicked on a valid symbol. + </description> + </signal> + <signal name="symbol_validate"> + <argument index="0" name="symbol" type="String" /> + <description> + Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling [method set_symbol_lookup_word_as_valid]. + </description> + </signal> </signals> <constants> <constant name="KIND_CLASS" value="0" enum="CodeCompletionKind"> + Marks the option as a class. </constant> <constant name="KIND_FUNCTION" value="1" enum="CodeCompletionKind"> + Marks the option as a function. </constant> <constant name="KIND_SIGNAL" value="2" enum="CodeCompletionKind"> + Marks the option as a Godot signal. </constant> <constant name="KIND_VARIABLE" value="3" enum="CodeCompletionKind"> + Marks the option as a variable. </constant> <constant name="KIND_MEMBER" value="4" enum="CodeCompletionKind"> + Marks the option as a member. </constant> <constant name="KIND_ENUM" value="5" enum="CodeCompletionKind"> + Marks the option as a enum entry. </constant> <constant name="KIND_CONSTANT" value="6" enum="CodeCompletionKind"> + Marks the option as a constant. </constant> <constant name="KIND_NODE_PATH" value="7" enum="CodeCompletionKind"> + Marks the option as a Godot node path. </constant> <constant name="KIND_FILE_PATH" value="8" enum="CodeCompletionKind"> + Marks the option as a file path. </constant> <constant name="KIND_PLAIN_TEXT" value="9" enum="CodeCompletionKind"> + Marks the option as unclassified or plain text. </constant> </constants> <theme_items> <theme_item name="background_color" type="Color" default="Color(0, 0, 0, 0)"> + Sets the background [Color]. </theme_item> <theme_item name="bookmark" type="Texture2D"> + Sets a custom [Texture2D] to draw in the bookmark gutter for bookmarked lines. </theme_item> <theme_item name="bookmark_color" type="Color" default="Color(0.5, 0.64, 1, 0.8)"> + [Color] of the bookmark icon for bookmarked lines. </theme_item> <theme_item name="brace_mismatch_color" type="Color" default="Color(1, 0.2, 0.2, 1)"> + [Color] of the text to highlight mismatched braces. </theme_item> <theme_item name="breakpoint" type="Texture2D"> + Sets a custom [Texture2D] to draw in the breakpoint gutter for breakpointed lines. </theme_item> <theme_item name="breakpoint_color" type="Color" default="Color(0.9, 0.29, 0.3, 1)"> + [Color] of the breakpoint icon for bookmarked lines. </theme_item> <theme_item name="can_fold" type="Texture2D"> + Sets a custom [Texture2D] to draw in the line folding gutter when a line can be folded. </theme_item> <theme_item name="caret_background_color" type="Color" default="Color(0, 0, 0, 1)"> + [Color] of the text behind the caret when block caret is enabled. </theme_item> <theme_item name="caret_color" type="Color" default="Color(0.88, 0.88, 0.88, 1)"> + [Color] of the caret. </theme_item> <theme_item name="code_folding_color" type="Color" default="Color(0.8, 0.8, 0.8, 0.8)"> + [Color] for all icons related to line folding. </theme_item> <theme_item name="completion" type="StyleBox"> + [StyleBox] for the code completion popup. </theme_item> <theme_item name="completion_background_color" type="Color" default="Color(0.17, 0.16, 0.2, 1)"> + Sets the background [Color] for the code completion popup. </theme_item> <theme_item name="completion_existing_color" type="Color" default="Color(0.87, 0.87, 0.87, 0.13)"> + Background highlight [Color] for matching text in code completion options. </theme_item> <theme_item name="completion_font_color" type="Color" default="Color(0.67, 0.67, 0.67, 1)"> + Font [Color] for the code completion popup. </theme_item> <theme_item name="completion_lines" type="int" default="7"> + Max number of options to display in the code completion popup at any one time. </theme_item> <theme_item name="completion_max_width" type="int" default="50"> + Max width of options in the code completion popup. Options longer then this will be cut off. </theme_item> <theme_item name="completion_scroll_color" type="Color" default="Color(1, 1, 1, 1)"> + [Color] of the scrollbar in the code completion popup. </theme_item> <theme_item name="completion_scroll_width" type="int" default="3"> + Width of the scrollbar in the code completion popup. </theme_item> <theme_item name="completion_selected_color" type="Color" default="Color(0.26, 0.26, 0.27, 1)"> + Background highlight [Color] for the current selected option item in the code completion popup. </theme_item> <theme_item name="current_line_color" type="Color" default="Color(0.25, 0.25, 0.26, 0.8)"> + Background [Color] of the line containing the caret. </theme_item> <theme_item name="executing_line" type="Texture2D"> + Icon to draw in the executing gutter for executing lines. </theme_item> <theme_item name="executing_line_color" type="Color" default="Color(0.98, 0.89, 0.27, 1)"> + [Color] of the executing icon for executing lines. </theme_item> <theme_item name="focus" type="StyleBox"> + Sets the [StyleBox] when in focus. </theme_item> <theme_item name="folded" type="Texture2D"> + Sets a custom [Texture2D] to draw in the line folding gutter when a line is folded and can be unfolded. </theme_item> <theme_item name="folded_eol_icon" type="Texture2D"> + Sets a custom [Texture2D] to draw at the end of a folded line. </theme_item> <theme_item name="font" type="Font"> + Sets the default [Font]. </theme_item> <theme_item name="font_color" type="Color" default="Color(0.88, 0.88, 0.88, 1)"> + Sets the font [Color]. </theme_item> <theme_item name="font_outline_color" type="Color" default="Color(1, 1, 1, 1)"> The tint of text outline of the [CodeEdit]. </theme_item> <theme_item name="font_readonly_color" type="Color" default="Color(0.88, 0.88, 0.88, 0.5)"> + Sets the font [Color] when [member readonly] is enabled. </theme_item> <theme_item name="font_selected_color" type="Color" default="Color(0, 0, 0, 1)"> + Sets the [Color] of the selected text. [member override_selected_font_color] has to be enabled. </theme_item> <theme_item name="font_size" type="int"> - Font size of the [CodeEdit]'s text. + Sets default font size. + </theme_item> + <theme_item name="line_length_guideline_color" type="Color" default="Color(0.3, 0.5, 0.8, 0.1)"> + [Color] of the main line length guideline, secondary guidelines will have 50% alpha applied. </theme_item> <theme_item name="line_number_color" type="Color" default="Color(0.67, 0.67, 0.67, 0.4)"> + Sets the [Color] of line numbers. </theme_item> <theme_item name="line_spacing" type="int" default="4"> + Sets the spacing between the lines. </theme_item> <theme_item name="normal" type="StyleBox"> + Sets the [StyleBox]. </theme_item> <theme_item name="outline_size" type="int" default="0"> The size of the text outline. </theme_item> <theme_item name="read_only" type="StyleBox"> - </theme_item> - <theme_item name="safe_line_number_color" type="Color" default="Color(0.67, 0.78, 0.67, 0.6)"> + Sets the [StyleBox] when [member readonly] is enabled. </theme_item> <theme_item name="selection_color" type="Color" default="Color(0.49, 0.49, 0.49, 1)"> + Sets the highlight [Color] of text selections. </theme_item> <theme_item name="space" type="Texture2D"> + Sets a custom [Texture2D] for space text characters. </theme_item> <theme_item name="tab" type="Texture2D"> + Sets a custom [Texture2D] for tab text characters. </theme_item> <theme_item name="word_highlighted_color" type="Color" default="Color(0.8, 0.9, 0.9, 0.15)"> + Sets the highlight [Color] of multiple occurrences. [member highlight_all_occurrences] has to be enabled. </theme_item> </theme_items> </class> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index b6269520e1..6bb756ea2c 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -200,11 +200,11 @@ <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1"> The physics layers this CollisionObject2D is in. Collision objects can exist in one or more of 32 different layers. See also [member collision_mask]. - [b]Note:[/b] A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> The physics layers this CollisionObject2D scans. Collision objects can scan one or more of 32 different layers. See also [member collision_layer]. - [b]Note:[/b] A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="disable_mode" type="int" setter="set_disable_mode" getter="get_disable_mode" enum="CollisionObject2D.DisableMode" default="0"> Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. See [enum DisableMode] for more details about the different modes. diff --git a/doc/classes/CollisionObject3D.xml b/doc/classes/CollisionObject3D.xml index ecfe758343..0210f6297f 100644 --- a/doc/classes/CollisionObject3D.xml +++ b/doc/classes/CollisionObject3D.xml @@ -171,12 +171,12 @@ </methods> <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1"> - The physics layers this CollisionObject3D is in. Collision objects can exist in one or more of 32 different layers. See also [member collision_mask]. - [b]Note:[/b] A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + The physics layers this CollisionObject3D [b]is in[/b]. Collision objects can exist in one or more of 32 different layers. See also [member collision_mask]. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> - The physics layers this CollisionObject3D scans. Collision objects can scan one or more of 32 different layers. See also [member collision_layer]. - [b]Note:[/b] A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + The physics layers this CollisionObject3D [b]scans[/b]. Collision objects can scan one or more of 32 different layers. See also [member collision_layer]. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="disable_mode" type="int" setter="set_disable_mode" getter="get_disable_mode" enum="CollisionObject3D.DisableMode" default="0"> Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. See [enum DisableMode] for more details about the different modes. diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index bcd4266f6c..f970be23a6 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -12,34 +12,75 @@ a_vector=Vector3(1, 0, 2) [/codeblock] The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly without accessing the filesystem. - The following example shows how to parse an INI-style file from the system, read its contents and store new values in it: + The following example shows how to create a simple [ConfigFile] and save it on disc: [codeblocks] [gdscript] + # Create new ConfigFile object. var config = ConfigFile.new() - var err = config.load("user://settings.cfg") - if err == OK: # If not, something went wrong with the file loading - # Look for the display/width pair, and default to 1024 if missing - var screen_width = config.get_value("display", "width", 1024) - # Store a variable if and only if it hasn't been defined yet - if not config.has_section_key("audio", "mute"): - config.set_value("audio", "mute", false) - # Save the changes by overwriting the previous file - config.save("user://settings.cfg") + + # Store some values. + config.set_value("Player1", "player_name", "Steve") + config.set_value("Player1", "best_score", 10) + config.set_value("Player2", "player_name", "V3geta") + config.set_value("Player2", "best_score", 9001) + + # Save it to a file (overwrite if already exists). + config.save("user://scores.cfg") [/gdscript] [csharp] + // Create new ConfigFile object. var config = new ConfigFile(); - Error err = config.Load("user://settings.cfg"); - if (err == Error.Ok) // If not, something went wrong with the file loading + + // Store some values. + config.SetValue("Player1", "player_name", "Steve"); + config.SetValue("Player1", "best_score", 10); + config.SetValue("Player2", "player_name", "V3geta"); + config.SetValue("Player2", "best_score", 9001); + + // Save it to a file (overwrite if already exists). + config.Save("user://scores.cfg"); + [/csharp] + [/codeblocks] + This example shows how the above file could be loaded: + [codeblocks] + [gdscript] + var score_data = {} + var config = ConfigFile.new() + + # Load data from a file. + var err = config.load("user://scores.cfg") + + # If the file didn't load, ignore it. + if err != OK: + return + + # Iterate over all sections. + for player in config.get_sections(): + # Fetch the data for each section. + var player_name = config.get_value(player, "player_name") + var player_score = config.get_value(player, "best_score") + score_data[player_name] = player_score + [/gdscript] + [csharp] + var score_data = new Godot.Collections.Dictionary(); + var config = new ConfigFile(); + + // Load data from a file. + Error err = config.Load("user://scores.cfg"); + + // If the file didn't load, ignore it. + if (err != Error.Ok) + { + return; + } + + // Iterate over all sections. + foreach (String player in config.GetSections()) { - // Look for the display/width pair, and default to 1024 if missing - int screenWidth = (int)config.GetValue("display", "width", 1024); - // Store a variable if and only if it hasn't been defined yet - if (!config.HasSectionKey("audio", "mute")) - { - config.SetValue("audio", "mute", false); - } - // Save the changes by overwriting the previous file - config.Save("user://settings.cfg"); + // Fetch the data for each section. + var player_name = (String)config.GetValue(player, "player_name"); + var player_score = (int)config.GetValue(player, "best_score"); + score_data[player_name] = player_score; } [/csharp] [/codeblocks] diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index a1a320446b..383049fb3e 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -786,9 +786,45 @@ <member name="layer_names/2d_navigation/layer_2" type="String" setter="" getter="" default=""""> Optional name for the 2D navigation layer 2. If left empty, the layer will display as "Layer 2". </member> + <member name="layer_names/2d_navigation/layer_20" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 20. If left empty, the layer will display as "Layer 20". + </member> + <member name="layer_names/2d_navigation/layer_21" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 21. If left empty, the layer will display as "Layer 21". + </member> + <member name="layer_names/2d_navigation/layer_22" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 22. If left empty, the layer will display as "Layer 22". + </member> + <member name="layer_names/2d_navigation/layer_23" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 23. If left empty, the layer will display as "Layer 23". + </member> + <member name="layer_names/2d_navigation/layer_24" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 24. If left empty, the layer will display as "Layer 24". + </member> + <member name="layer_names/2d_navigation/layer_25" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 25. If left empty, the layer will display as "Layer 25". + </member> + <member name="layer_names/2d_navigation/layer_26" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 26. If left empty, the layer will display as "Layer 26". + </member> + <member name="layer_names/2d_navigation/layer_27" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 27. If left empty, the layer will display as "Layer 27". + </member> + <member name="layer_names/2d_navigation/layer_28" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 28. If left empty, the layer will display as "Layer 28". + </member> + <member name="layer_names/2d_navigation/layer_29" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 29. If left empty, the layer will display as "Layer 29". + </member> <member name="layer_names/2d_navigation/layer_3" type="String" setter="" getter="" default=""""> Optional name for the 2D navigation layer 3. If left empty, the layer will display as "Layer 3". </member> + <member name="layer_names/2d_navigation/layer_30" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 30. If left empty, the layer will display as "Layer 30". + </member> + <member name="layer_names/2d_navigation/layer_31" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 31. If left empty, the layer will display as "Layer 31". + </member> <member name="layer_names/2d_navigation/layer_4" type="String" setter="" getter="" default=""""> Optional name for the 2D navigation layer 4. If left empty, the layer will display as "Layer 4". </member> @@ -846,9 +882,45 @@ <member name="layer_names/2d_physics/layer_2" type="String" setter="" getter="" default=""""> Optional name for the 2D physics layer 2. If left empty, the layer will display as "Layer 2". </member> + <member name="layer_names/2d_physics/layer_20" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 20. If left empty, the layer will display as "Layer 20". + </member> + <member name="layer_names/2d_physics/layer_21" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 21. If left empty, the layer will display as "Layer 21". + </member> + <member name="layer_names/2d_physics/layer_22" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 22. If left empty, the layer will display as "Layer 22". + </member> + <member name="layer_names/2d_physics/layer_23" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 23. If left empty, the layer will display as "Layer 23". + </member> + <member name="layer_names/2d_physics/layer_24" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 24. If left empty, the layer will display as "Layer 24". + </member> + <member name="layer_names/2d_physics/layer_25" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 25. If left empty, the layer will display as "Layer 25". + </member> + <member name="layer_names/2d_physics/layer_26" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 26. If left empty, the layer will display as "Layer 26". + </member> + <member name="layer_names/2d_physics/layer_27" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 27. If left empty, the layer will display as "Layer 27". + </member> + <member name="layer_names/2d_physics/layer_28" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 28. If left empty, the layer will display as "Layer 28". + </member> + <member name="layer_names/2d_physics/layer_29" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 29. If left empty, the layer will display as "Layer 29". + </member> <member name="layer_names/2d_physics/layer_3" type="String" setter="" getter="" default=""""> Optional name for the 2D physics layer 3. If left empty, the layer will display as "Layer 3". </member> + <member name="layer_names/2d_physics/layer_30" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 30. If left empty, the layer will display as "Layer 30". + </member> + <member name="layer_names/2d_physics/layer_31" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 31. If left empty, the layer will display as "Layer 31". + </member> <member name="layer_names/2d_physics/layer_4" type="String" setter="" getter="" default=""""> Optional name for the 2D physics layer 4. If left empty, the layer will display as "Layer 4". </member> @@ -966,9 +1038,45 @@ <member name="layer_names/3d_navigation/layer_2" type="String" setter="" getter="" default=""""> Optional name for the 3D navigation layer 2. If left empty, the layer will display as "Layer 2". </member> + <member name="layer_names/3d_navigation/layer_20" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 20. If left empty, the layer will display as "Layer 20". + </member> + <member name="layer_names/3d_navigation/layer_21" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 21. If left empty, the layer will display as "Layer 21". + </member> + <member name="layer_names/3d_navigation/layer_22" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 22. If left empty, the layer will display as "Layer 22". + </member> + <member name="layer_names/3d_navigation/layer_23" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 23. If left empty, the layer will display as "Layer 23". + </member> + <member name="layer_names/3d_navigation/layer_24" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 24. If left empty, the layer will display as "Layer 24". + </member> + <member name="layer_names/3d_navigation/layer_25" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 25. If left empty, the layer will display as "Layer 25". + </member> + <member name="layer_names/3d_navigation/layer_26" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 26. If left empty, the layer will display as "Layer 26". + </member> + <member name="layer_names/3d_navigation/layer_27" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 27. If left empty, the layer will display as "Layer 27". + </member> + <member name="layer_names/3d_navigation/layer_28" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 28. If left empty, the layer will display as "Layer 28". + </member> + <member name="layer_names/3d_navigation/layer_29" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 29. If left empty, the layer will display as "Layer 29". + </member> <member name="layer_names/3d_navigation/layer_3" type="String" setter="" getter="" default=""""> Optional name for the 3D navigation layer 3. If left empty, the layer will display as "Layer 3". </member> + <member name="layer_names/3d_navigation/layer_30" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 30. If left empty, the layer will display as "Layer 30". + </member> + <member name="layer_names/3d_navigation/layer_31" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 31. If left empty, the layer will display as "Layer 31". + </member> <member name="layer_names/3d_navigation/layer_4" type="String" setter="" getter="" default=""""> Optional name for the 3D navigation layer 4. If left empty, the layer will display as "Layer 4". </member> @@ -1026,9 +1134,45 @@ <member name="layer_names/3d_physics/layer_2" type="String" setter="" getter="" default=""""> Optional name for the 3D physics layer 2. If left empty, the layer will display as "Layer 2". </member> + <member name="layer_names/3d_physics/layer_20" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 20. If left empty, the layer will display as "Layer 20". + </member> + <member name="layer_names/3d_physics/layer_21" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 21. If left empty, the layer will display as "Layer 21". + </member> + <member name="layer_names/3d_physics/layer_22" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 22. If left empty, the layer will display as "Layer 22". + </member> + <member name="layer_names/3d_physics/layer_23" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 23. If left empty, the layer will display as "Layer 23". + </member> + <member name="layer_names/3d_physics/layer_24" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 24. If left empty, the layer will display as "Layer 24". + </member> + <member name="layer_names/3d_physics/layer_25" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 25. If left empty, the layer will display as "Layer 25". + </member> + <member name="layer_names/3d_physics/layer_26" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 26. If left empty, the layer will display as "Layer 26". + </member> + <member name="layer_names/3d_physics/layer_27" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 27. If left empty, the layer will display as "Layer 27". + </member> + <member name="layer_names/3d_physics/layer_28" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 28. If left empty, the layer will display as "Layer 28". + </member> + <member name="layer_names/3d_physics/layer_29" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 29. If left empty, the layer will display as "Layer 29". + </member> <member name="layer_names/3d_physics/layer_3" type="String" setter="" getter="" default=""""> Optional name for the 3D physics layer 3. If left empty, the layer will display as "Layer 3". </member> + <member name="layer_names/3d_physics/layer_30" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 30. If left empty, the layer will display as "Layer 30". + </member> + <member name="layer_names/3d_physics/layer_31" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 31. If left empty, the layer will display as "Layer 31". + </member> <member name="layer_names/3d_physics/layer_4" type="String" setter="" getter="" default=""""> Optional name for the 3D physics layer 4. If left empty, the layer will display as "Layer 4". </member> diff --git a/doc/classes/SoftBody3D.xml b/doc/classes/SoftBody3D.xml index 16f80c43bc..53bd7e67bf 100644 --- a/doc/classes/SoftBody3D.xml +++ b/doc/classes/SoftBody3D.xml @@ -68,12 +68,12 @@ </methods> <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1"> - The physics layers this SoftBody3D is in. - Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + The physics layers this SoftBody3D [b]is in[/b]. Collision objects can exist in one or more of 32 different layers. See also [member collision_mask]. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> - The physics layers this SoftBody3D scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + The physics layers this SoftBody3D [b]scans[/b]. Collision objects can scan one or more of 32 different layers. See also [member collision_layer]. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="damping_coefficient" type="float" setter="set_damping_coefficient" getter="get_damping_coefficient" default="0.01"> </member> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 5444721e10..5d62050a94 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -16,6 +16,12 @@ A virtual method that is called whenever backspace is triggered. </description> </method> + <method name="_handle_unicode_input" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="unicode" type="int" /> + <description> + </description> + </method> <method name="add_gutter"> <return type="void" /> <argument index="0" name="at" type="int" default="-1" /> @@ -256,6 +262,11 @@ Returns the [TextEdit]'s' tab size. </description> </method> + <method name="get_total_gutter_width" qualifiers="const"> + <return type="int" /> + <description> + </description> + </method> <method name="get_visible_line_count" qualifiers="const"> <return type="int" /> <description> @@ -281,6 +292,11 @@ Returns [code]true[/code] if the caret is visible on the screen. </description> </method> + <method name="is_dragging_cursor" qualifiers="const"> + <return type="bool" /> + <description> + </description> + </method> <method name="is_gutter_clickable" qualifiers="const"> <return type="bool" /> <argument index="0" name="gutter" type="int" /> @@ -654,18 +670,6 @@ <description> </description> </signal> - <signal name="symbol_lookup"> - <argument index="0" name="symbol" type="String" /> - <argument index="1" name="row" type="int" /> - <argument index="2" name="column" type="int" /> - <description> - </description> - </signal> - <signal name="symbol_validate"> - <argument index="0" name="symbol" type="String" /> - <description> - </description> - </signal> <signal name="text_changed"> <description> Emitted when the text changes. @@ -790,8 +794,6 @@ <theme_item name="background_color" type="Color" default="Color(0, 0, 0, 0)"> Sets the background [Color] of this [TextEdit]. </theme_item> - <theme_item name="brace_mismatch_color" type="Color" default="Color(1, 0.2, 0.2, 1)"> - </theme_item> <theme_item name="caret_background_color" type="Color" default="Color(0, 0, 0, 1)"> </theme_item> <theme_item name="caret_color" type="Color" default="Color(0.88, 0.88, 0.88, 1)"> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 957619ad81..f3c64c3c7d 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -31,22 +31,43 @@ </method> <method name="get_cell_alternative_tile" qualifiers="const"> <return type="int" /> - <argument index="0" name="coords" type="Vector2i" /> - <argument index="1" name="use_proxies" type="bool" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="coords" type="Vector2i" /> + <argument index="2" name="use_proxies" type="bool" /> <description> </description> </method> <method name="get_cell_atlas_coords" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="coords" type="Vector2i" /> - <argument index="1" name="use_proxies" type="bool" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="coords" type="Vector2i" /> + <argument index="2" name="use_proxies" type="bool" /> <description> </description> </method> <method name="get_cell_source_id" qualifiers="const"> <return type="int" /> - <argument index="0" name="coords" type="Vector2i" /> - <argument index="1" name="use_proxies" type="bool" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="coords" type="Vector2i" /> + <argument index="2" name="use_proxies" type="bool" /> + <description> + </description> + </method> + <method name="get_layer_name" qualifiers="const"> + <return type="String" /> + <argument index="0" name="layer" type="int" /> + <description> + </description> + </method> + <method name="get_layer_y_sort_origin" qualifiers="const"> + <return type="int" /> + <argument index="0" name="layer" type="int" /> + <description> + </description> + </method> + <method name="get_layer_z_indexd" qualifiers="const"> + <return type="int" /> + <argument index="0" name="layer" type="int" /> <description> </description> </method> @@ -65,6 +86,7 @@ </method> <method name="get_used_cells" qualifiers="const"> <return type="Vector2i[]" /> + <argument index="0" name="layer" type="int" /> <description> Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]). </description> @@ -75,6 +97,18 @@ Returns a rectangle enclosing the used (non-empty) tiles of the map. </description> </method> + <method name="is_layer_enabled" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="layer" type="int" /> + <description> + </description> + </method> + <method name="is_layer_y_sort_enabled" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="layer" type="int" /> + <description> + </description> + </method> <method name="map_to_world" qualifiers="const"> <return type="Vector2" /> <argument index="0" name="map_position" type="Vector2i" /> @@ -84,18 +118,48 @@ </method> <method name="set_cell"> <return type="void" /> - <argument index="0" name="coords" type="Vector2i" /> - <argument index="1" name="source_id" type="int" default="-1" /> - <argument index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> - <argument index="3" name="alternative_tile" type="int" default="-1" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="coords" type="Vector2i" /> + <argument index="2" name="source_id" type="int" default="-1" /> + <argument index="3" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> + <argument index="4" name="alternative_tile" type="int" default="-1" /> <description> Sets the tile index for the cell given by a Vector2i. </description> </method> - <method name="update_dirty_quadrants"> + <method name="set_layer_enabled"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="enabled" type="bool" /> + <description> + </description> + </method> + <method name="set_layer_name"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="name" type="String" /> + <description> + </description> + </method> + <method name="set_layer_y_sort_enabled"> <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="y_sort_enabled" type="bool" /> + <description> + </description> + </method> + <method name="set_layer_y_sort_origin"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="y_sort_origin" type="int" /> + <description> + </description> + </method> + <method name="set_layer_z_index"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="z_index" type="int" /> <description> - Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified. </description> </method> <method name="world_to_map" qualifiers="const"> @@ -110,9 +174,11 @@ <member name="cell_quadrant_size" type="int" setter="set_quadrant_size" getter="get_quadrant_size" default="16"> The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. </member> - <member name="show_collision" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMap.VisibilityMode" default="0"> + <member name="collision_visibility_mode" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMap.VisibilityMode" default="0"> + </member> + <member name="layers_count" type="int" setter="set_layers_count" getter="get_layers_count" default="1"> </member> - <member name="show_navigation" type="int" setter="set_navigation_visibility_mode" getter="get_navigation_visibility_mode" enum="TileMap.VisibilityMode" default="0"> + <member name="navigation_visibility_mode" type="int" setter="set_navigation_visibility_mode" getter="get_navigation_visibility_mode" enum="TileMap.VisibilityMode" default="0"> </member> <member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset"> The assigned [TileSet]. diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 27e31f25a4..439c6e3830 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -329,8 +329,6 @@ </member> <member name="uv_clipping" type="bool" setter="set_uv_clipping" getter="is_uv_clipping" default="false"> </member> - <member name="y_sorting" type="bool" setter="set_y_sorting" getter="is_y_sorting" default="false"> - </member> </members> <constants> <constant name="TILE_SHAPE_SQUARE" value="0" enum="TileShape"> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 2c3eda1e07..b9d3951b0a 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -4,7 +4,7 @@ 2D transformation (2×3 matrix). </brief_description> <description> - 2×3 matrix (2 rows, 3 columns) used for 2D linear transformations. It can represent transformations such as translation, rotation, or scaling. It consists of a three [Vector2] values: [member x], [member y], and the [member origin]. + 2×3 matrix (2 rows, 3 columns) used for 2D linear transformations. It can represent transformations such as translation, rotation, or scaling. It consists of three [Vector2] values: [member x], [member y], and the [member origin]. For more information, read the "Matrices and transforms" documentation article. </description> <tutorials> diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 6f65f32ed5..cdb9de4f86 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -146,11 +146,13 @@ </method> </methods> <members> + <member name="engine_version" type="Dictionary" setter="set_engine_version" getter="get_engine_version" default="{}"> + The Godot version this [VisualShader] was designed for, in the form of a [Dictionary] with [code]major[/code] and [code]minor[/code] keys with integer values. Example: [code]{"major": 4, "minor": 0}[/code] + This is used by the editor to convert visual shaders from older Godot versions. + </member> <member name="graph_offset" type="Vector2" setter="set_graph_offset" getter="get_graph_offset" default="Vector2(0, 0)"> The offset vector of the whole graph. </member> - <member name="version" type="String" setter="set_version" getter="get_version" default=""""> - </member> </members> <constants> <constant name="TYPE_VERTEX" value="0" enum="Type"> diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py index 9be7751d3d..438b64ebbf 100755 --- a/doc/tools/makerst.py +++ b/doc/tools/makerst.py @@ -108,7 +108,7 @@ class ClassDef: self.brief_description = None # type: Optional[str] self.description = None # type: Optional[str] self.theme_items = None # type: Optional[OrderedDict[str, List[ThemeItemDef]]] - self.tutorials = [] # type: List[str] + self.tutorials = [] # type: List[Tuple[str, str]] # Used to match the class with XML source for output filtering purposes. self.filepath = "" # type: str @@ -257,7 +257,7 @@ class State: assert link.tag == "link" if link.text is not None: - class_def.tutorials.append(link.text) + class_def.tutorials.append((link.text.strip(), link.get("title", ""))) def sort_classes(self): # type: () -> None self.classes = OrderedDict(sorted(self.classes.items(), key=lambda t: t[0])) @@ -431,9 +431,8 @@ def make_rst_class(class_def, state, dry_run, output_dir): # type: (ClassDef, S # Online tutorials if len(class_def.tutorials) > 0: f.write(make_heading("Tutorials", "-")) - for t in class_def.tutorials: - link = t.strip() - f.write("- " + make_url(link) + "\n\n") + for url, title in class_def.tutorials: + f.write("- " + make_link(url, title) + "\n\n") # Properties overview if len(class_def.properties) > 0: @@ -1062,8 +1061,8 @@ def make_footer(): # type: () -> str # fmt: on -def make_url(link): # type: (str) -> str - match = GODOT_DOCS_PATTERN.search(link) +def make_link(url, title): # type: (str, str) -> str + match = GODOT_DOCS_PATTERN.search(url) if match: groups = match.groups() if match.lastindex == 2: @@ -1080,7 +1079,10 @@ def make_url(link): # type: (str) -> str else: # External link, for example: # `http://enet.bespin.org/usergroup0.html` - return "`" + link + " <" + link + ">`_" + if title != "": + return "`" + title + " <" + url + ">`_" + else: + return "`" + url + " <" + url + ">`_" if __name__ == "__main__": |