diff options
Diffstat (limited to 'doc/classes')
27 files changed, 95 insertions, 99 deletions
diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 317a578559..52f79ecc9d 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -78,7 +78,7 @@ <return type="void" /> <param index="0" name="index" type="int" /> <description> - Removes the point at [code]index[/code] from the curve. + Removes the point at [param index] from the curve. </description> </method> <method name="sample" qualifiers="const"> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index d545c144ab..abf71c5754 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -80,7 +80,7 @@ <return type="void" /> <param index="0" name="idx" type="int" /> <description> - Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. + Deletes the point [param idx] from the curve. Sends an error to the console if [param idx] is out of bounds. </description> </method> <method name="sample" qualifiers="const"> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 4134df25dd..4d1f5a7180 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -100,7 +100,7 @@ <return type="void" /> <param index="0" name="idx" type="int" /> <description> - Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. + Deletes the point [param idx] from the curve. Sends an error to the console if [param idx] is out of bounds. </description> </method> <method name="sample" qualifiers="const"> diff --git a/doc/classes/EditorVCSInterface.xml b/doc/classes/EditorVCSInterface.xml index d5dc6abe81..031d2a50c3 100644 --- a/doc/classes/EditorVCSInterface.xml +++ b/doc/classes/EditorVCSInterface.xml @@ -13,21 +13,21 @@ <return type="bool" /> <param index="0" name="branch_name" type="String" /> <description> - Checks out a [code]branch_name[/code] in the VCS. + Checks out a [param branch_name] in the VCS. </description> </method> <method name="_commit" qualifiers="virtual"> <return type="void" /> <param index="0" name="msg" type="String" /> <description> - Commits the currently staged changes and applies the commit [code]msg[/code] to the resulting commit. + Commits the currently staged changes and applies the commit [param msg] to the resulting commit. </description> </method> <method name="_create_branch" qualifiers="virtual"> <return type="void" /> <param index="0" name="branch_name" type="String" /> <description> - Creates a new branch named [code]branch_name[/code] in the VCS. + Creates a new branch named [param branch_name] in the VCS. </description> </method> <method name="_create_remote" qualifiers="virtual"> @@ -35,21 +35,21 @@ <param index="0" name="remote_name" type="String" /> <param index="1" name="remote_url" type="String" /> <description> - Creates a new remote destination with name [code]remote_name[/code] and points it to [code]remote_url[/code]. This can be an HTTPS remote or an SSH remote. + Creates a new remote destination with name [param remote_name] and points it to [param remote_url]. This can be an HTTPS remote or an SSH remote. </description> </method> <method name="_discard_file" qualifiers="virtual"> <return type="void" /> <param index="0" name="file_path" type="String" /> <description> - Discards the changes made in a file present at [code]file_path[/code]. + Discards the changes made in a file present at [param file_path]. </description> </method> <method name="_fetch" qualifiers="virtual"> <return type="void" /> <param index="0" name="remote" type="String" /> <description> - Fetches new changes from the remote, but doesn't write changes to the current working directory. Equivalent to [code]git fetch[/code]. + Fetches new changes from the [param remote], but doesn't write changes to the current working directory. Equivalent to [code]git fetch[/code]. </description> </method> <method name="_get_branch_list" qualifiers="virtual"> @@ -69,7 +69,7 @@ <param index="0" name="identifier" type="String" /> <param index="1" name="area" type="int" /> <description> - Returns an array of [Dictionary] items (see [method create_diff_file], [method create_diff_hunk], [method create_diff_line], [method add_line_diffs_into_diff_hunk] and [method add_diff_hunks_into_diff_file]), each containing information about a diff. If [code]identifier[/code] is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff. + Returns an array of [Dictionary] items (see [method create_diff_file], [method create_diff_hunk], [method create_diff_line], [method add_line_diffs_into_diff_hunk] and [method add_diff_hunks_into_diff_file]), each containing information about a diff. If [param identifier] is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff. </description> </method> <method name="_get_line_diff" qualifiers="virtual"> @@ -77,7 +77,7 @@ <param index="0" name="file_path" type="String" /> <param index="1" name="text" type="String" /> <description> - Returns an [Array] of [Dictionary] items (see [method create_diff_hunk]), each containing a line diff between a file at [code]file_path[/code] and the [code]text[/code] which is passed in. + Returns an [Array] of [Dictionary] items (see [method create_diff_hunk]), each containing a line diff between a file at [param file_path] and the [param text] which is passed in. </description> </method> <method name="_get_modified_files_data" qualifiers="virtual"> @@ -109,7 +109,7 @@ <return type="bool" /> <param index="0" name="project_path" type="String" /> <description> - Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at [code]project_path[/code]. + Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at [param project_path]. </description> </method> <method name="_pull" qualifiers="virtual"> @@ -149,7 +149,7 @@ <param index="3" name="ssh_private_key_path" type="String" /> <param index="4" name="ssh_passphrase" type="String" /> <description> - Set user credentials in the underlying VCS. [code]username[/code] and [code]password[/code] are used only during HTTPS authentication unless not already mentioned in the remote URL. [code]ssh_public_key_path[/code], [code]ssh_private_key_path[/code], and [code]ssh_passphrase[/code] are only used during SSH authentication. + Set user credentials in the underlying VCS. [param username] and [param password] are used only during HTTPS authentication unless not already mentioned in the remote URL. [param ssh_public_key_path], [param ssh_private_key_path], and [param ssh_passphrase] are only used during SSH authentication. </description> </method> <method name="_shut_down" qualifiers="virtual"> @@ -162,14 +162,14 @@ <return type="void" /> <param index="0" name="file_path" type="String" /> <description> - Stages the file present at [code]file_path[/code] to the staged area. + Stages the file present at [param file_path] to the staged area. </description> </method> <method name="_unstage_file" qualifiers="virtual"> <return type="void" /> <param index="0" name="file_path" type="String" /> <description> - Unstages the file present at [code]file_path[/code] from the staged area to the unstaged area. + Unstages the file present at [param file_path] from the staged area to the unstaged area. </description> </method> <method name="add_diff_hunks_into_diff_file"> @@ -177,7 +177,7 @@ <param index="0" name="diff_file" type="Dictionary" /> <param index="1" name="diff_hunks" type="Dictionary[]" /> <description> - Helper function to add an array of [code]diff_hunks[/code] into a [code]diff_file[/code]. + Helper function to add an array of [param diff_hunks] into a [param diff_file]. </description> </method> <method name="add_line_diffs_into_diff_hunk"> @@ -185,7 +185,7 @@ <param index="0" name="diff_hunk" type="Dictionary" /> <param index="1" name="line_diffs" type="Dictionary[]" /> <description> - Helper function to add an array of [code]line_diffs[/code] into a [code]diff_hunk[/code]. + Helper function to add an array of [param line_diffs] into a [param diff_hunk]. </description> </method> <method name="create_commit"> @@ -196,7 +196,7 @@ <param index="3" name="unix_timestamp" type="int" /> <param index="4" name="offset_minutes" type="int" /> <description> - Helper function to create a commit [Dictionary] item. [code]msg[/code] is the commit message of the commit. [code]author[/code] is a single human-readable string containing all the author's details, e.g. the email and name configured in the VCS. [code]id[/code] is the identifier of the commit, in whichever format your VCS may provide an identifier to commits. [code]unix_timestamp[/code] is the UTC Unix timestamp of when the commit was created. [code]offset_minutes[/code] is the timezone offset in minutes, recorded from the system timezone where the commit was created. + Helper function to create a commit [Dictionary] item. [param msg] is the commit message of the commit. [param author] is a single human-readable string containing all the author's details, e.g. the email and name configured in the VCS. [param id] is the identifier of the commit, in whichever format your VCS may provide an identifier to commits. [param unix_timestamp] is the UTC Unix timestamp of when the commit was created. [param offset_minutes] is the timezone offset in minutes, recorded from the system timezone where the commit was created. </description> </method> <method name="create_diff_file"> @@ -204,7 +204,7 @@ <param index="0" name="new_file" type="String" /> <param index="1" name="old_file" type="String" /> <description> - Helper function to create a [code]Dictionary[/code] for storing old and new diff file paths. + Helper function to create a [Dictionary] for storing old and new diff file paths. </description> </method> <method name="create_diff_hunk"> @@ -214,7 +214,7 @@ <param index="2" name="old_lines" type="int" /> <param index="3" name="new_lines" type="int" /> <description> - Helper function to create a [code]Dictionary[/code] for storing diff hunk data. [code]old_start[/code] is the starting line number in old file. [code]new_start[/code] is the starting line number in new file. [code]old_lines[/code] is the number of lines in the old file. [code]new_lines[/code] is the number of lines in the new file. + Helper function to create a [Dictionary] for storing diff hunk data. [param old_start] is the starting line number in old file. [param new_start] is the starting line number in new file. [param old_lines] is the number of lines in the old file. [param new_lines] is the number of lines in the new file. </description> </method> <method name="create_diff_line"> @@ -224,7 +224,7 @@ <param index="2" name="content" type="String" /> <param index="3" name="status" type="String" /> <description> - Helper function to create a [code]Dictionary[/code] for storing a line diff. [code]new_line_no[/code] is the line number in the new file (can be [code]-1[/code] if the line is deleted). [code]old_line_no[/code] is the line number in the old file (can be [code]-1[/code] if the line is added). [code]content[/code] is the diff text. [code]status[/code] is a single character string which stores the line origin. + Helper function to create a [Dictionary] for storing a line diff. [param new_line_no] is the line number in the new file (can be [code]-1[/code] if the line is deleted). [param old_line_no] is the line number in the old file (can be [code]-1[/code] if the line is added). [param content] is the diff text. [param status] is a single character string which stores the line origin. </description> </method> <method name="create_status_file"> @@ -233,7 +233,7 @@ <param index="1" name="change_type" type="int" enum="EditorVCSInterface.ChangeType" /> <param index="2" name="area" type="int" enum="EditorVCSInterface.TreeArea" /> <description> - Helper function to create a [code]Dictionary[/code] used by editor to read the status of a file. + Helper function to create a [Dictionary] used by editor to read the status of a file. </description> </method> <method name="popup_error"> diff --git a/doc/classes/EngineDebugger.xml b/doc/classes/EngineDebugger.xml index f8ca5326a0..45317be394 100644 --- a/doc/classes/EngineDebugger.xml +++ b/doc/classes/EngineDebugger.xml @@ -50,7 +50,7 @@ <param index="1" name="enable" type="bool" /> <param index="2" name="arguments" type="Array" default="[]" /> <description> - Calls the [code]toggle[/code] callable of the profiler with given [param name] and [param arguments]. Enables/Disables the same profiler depending on [code]enable[/code] argument. + Calls the [code]toggle[/code] callable of the profiler with given [param name] and [param arguments]. Enables/Disables the same profiler depending on [param enable] argument. </description> </method> <method name="register_message_capture"> diff --git a/doc/classes/FileAccess.xml b/doc/classes/FileAccess.xml index 8dd73c79e5..d1ee90142e 100644 --- a/doc/classes/FileAccess.xml +++ b/doc/classes/FileAccess.xml @@ -204,7 +204,7 @@ <return type="int" /> <param index="0" name="file" type="String" /> <description> - Returns the last time the [param file] was modified in Unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This Unix timestamp can be converted to another format using the [Time] singleton. + Returns the last time the [param file] was modified in Unix timestamp format or returns a [String] "ERROR IN [param file]". This Unix timestamp can be converted to another format using the [Time] singleton. </description> </method> <method name="get_open_error" qualifiers="static"> diff --git a/doc/classes/ImageTexture3D.xml b/doc/classes/ImageTexture3D.xml index ebfd38c3f4..4396039ab2 100644 --- a/doc/classes/ImageTexture3D.xml +++ b/doc/classes/ImageTexture3D.xml @@ -26,7 +26,7 @@ <return type="void" /> <param index="0" name="data" type="Image[]" /> <description> - Replaces the texture's existing data with the layers specified in [code]data[/code]. The size of [code]data[/code] must match the parameters that were used for [method create]. In other words, the texture cannot be resized or have its format changed by calling [method update]. + Replaces the texture's existing data with the layers specified in [param data]. The size of [param data] must match the parameters that were used for [method create]. In other words, the texture cannot be resized or have its format changed by calling [method update]. </description> </method> </methods> diff --git a/doc/classes/ImageTextureLayered.xml b/doc/classes/ImageTextureLayered.xml index 7f17c8e897..215ff6ac5d 100644 --- a/doc/classes/ImageTextureLayered.xml +++ b/doc/classes/ImageTextureLayered.xml @@ -22,7 +22,7 @@ <param index="0" name="image" type="Image" /> <param index="1" name="layer" type="int" /> <description> - Replaces the existing [Image] data at the given [code]layer[/code] with this new image. + Replaces the existing [Image] data at the given [param layer] with this new image. The given [Image] must have the same width, height, image format and mipmapping setting (a [code]bool[/code] value) as the rest of the referenced images. If the image format is unsupported, it will be decompressed and converted to a similar and supported [enum Image.Format]. The update is immediate: it's synchronized with drawing. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index f63243e8d4..d040c51bb0 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -203,7 +203,7 @@ [b]Note:[/b] [kbd]Backspace[/kbd] is always removing individual composite character components. </member> <member name="clear_button_enabled" type="bool" setter="set_clear_button_enabled" getter="is_clear_button_enabled" default="false"> - If [code]true[/code], the [LineEdit] will show a clear button if [code]text[/code] is not empty, which can be used to clear the text quickly. + If [code]true[/code], the [LineEdit] will show a clear button if [member text] is not empty, which can be used to clear the text quickly. </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled" default="true"> If [code]true[/code], the context menu will appear when right-clicked. @@ -302,7 +302,7 @@ <signal name="text_change_rejected"> <param index="0" name="rejected_substring" type="String" /> <description> - Emitted when appending text that overflows the [member max_length]. The appended text is truncated to fit [member max_length], and the part that couldn't fit is passed as the [code]rejected_substring[/code] argument. + Emitted when appending text that overflows the [member max_length]. The appended text is truncated to fit [member max_length], and the part that couldn't fit is passed as the [param rejected_substring] argument. </description> </signal> <signal name="text_changed"> @@ -487,7 +487,7 @@ Texture for the clear button. See [member clear_button_enabled]. </theme_item> <theme_item name="focus" data_type="style" type="StyleBox"> - Background used when [LineEdit] has GUI focus. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] the base [StyleBox], so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + Background used when [LineEdit] has GUI focus. The [theme_item focus] [StyleBox] is displayed [i]over[/i] the base [StyleBox], so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. </theme_item> <theme_item name="normal" data_type="style" type="StyleBox"> Default background for the [LineEdit]. diff --git a/doc/classes/NavigationLink2D.xml b/doc/classes/NavigationLink2D.xml index 39509e10b7..a08f65da3c 100644 --- a/doc/classes/NavigationLink2D.xml +++ b/doc/classes/NavigationLink2D.xml @@ -26,7 +26,7 @@ <return type="bool" /> <param index="0" name="layer_number" type="int" /> <description> - Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. + Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. </description> </method> <method name="set_global_end_position"> @@ -48,7 +48,7 @@ <param index="0" name="layer_number" type="int" /> <param index="1" name="value" type="bool" /> <description> - Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. + Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. </description> </method> </methods> @@ -65,7 +65,7 @@ The distance the link will search is controlled by [method NavigationServer2D.map_set_link_connection_radius]. </member> <member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0"> - When pathfinding enters this link from another regions navigation mesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. + When pathfinding enters this link from another regions navigation mesh the [member enter_cost] value is added to the path distance for determining the shortest path. </member> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with [method NavigationServer2D.map_get_path]. @@ -76,7 +76,7 @@ The distance the link will search is controlled by [method NavigationServer2D.map_set_link_connection_radius]. </member> <member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0"> - When pathfinding moves along the link the traveled distance is multiplied with [code]travel_cost[/code] for determining the shortest path. + When pathfinding moves along the link the traveled distance is multiplied with [member travel_cost] for determining the shortest path. </member> </members> </class> diff --git a/doc/classes/NavigationLink3D.xml b/doc/classes/NavigationLink3D.xml index 49fdc774cd..70dfee9c10 100644 --- a/doc/classes/NavigationLink3D.xml +++ b/doc/classes/NavigationLink3D.xml @@ -26,7 +26,7 @@ <return type="bool" /> <param index="0" name="layer_number" type="int" /> <description> - Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. + Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. </description> </method> <method name="set_global_end_position"> @@ -48,7 +48,7 @@ <param index="0" name="layer_number" type="int" /> <param index="1" name="value" type="bool" /> <description> - Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. + Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. </description> </method> </methods> @@ -65,7 +65,7 @@ The distance the link will search is controlled by [method NavigationServer3D.map_set_link_connection_radius]. </member> <member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0"> - When pathfinding enters this link from another regions navigation mesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. + When pathfinding enters this link from another regions navigation mesh the [member enter_cost] value is added to the path distance for determining the shortest path. </member> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with [method NavigationServer3D.map_get_path]. @@ -76,7 +76,7 @@ The distance the link will search is controlled by [method NavigationServer3D.map_set_link_connection_radius]. </member> <member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0"> - When pathfinding moves along the link the traveled distance is multiplied with [code]travel_cost[/code] for determining the shortest path. + When pathfinding moves along the link the traveled distance is multiplied with [member travel_cost] for determining the shortest path. </member> </members> </class> diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index 75d648c540..e96f3dc7e4 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -148,7 +148,7 @@ <return type="Vector2" /> <param index="0" name="link" type="RID" /> <description> - Returns the ending position of this [code]link[/code]. + Returns the ending position of this [param link]. </description> </method> <method name="link_get_enter_cost" qualifiers="const"> @@ -162,14 +162,14 @@ <return type="RID" /> <param index="0" name="link" type="RID" /> <description> - Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to. + Returns the navigation map [RID] the requested [param link] is currently assigned to. </description> </method> <method name="link_get_navigation_layers" qualifiers="const"> <return type="int" /> <param index="0" name="link" type="RID" /> <description> - Returns the navigation layers for this [code]link[/code]. + Returns the navigation layers for this [param link]. </description> </method> <method name="link_get_owner_id" qualifiers="const"> @@ -183,7 +183,7 @@ <return type="Vector2" /> <param index="0" name="link" type="RID" /> <description> - Returns the starting position of this [code]link[/code]. + Returns the starting position of this [param link]. </description> </method> <method name="link_get_travel_cost" qualifiers="const"> @@ -197,7 +197,7 @@ <return type="bool" /> <param index="0" name="link" type="RID" /> <description> - Returns whether this [code]link[/code] can be travelled in both directions. + Returns whether this [param link] can be travelled in both directions. </description> </method> <method name="link_set_bidirectional"> @@ -205,7 +205,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="bidirectional" type="bool" /> <description> - Sets whether this [code]link[/code] can be travelled in both directions. + Sets whether this [param link] can be travelled in both directions. </description> </method> <method name="link_set_end_position"> @@ -213,7 +213,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="position" type="Vector2" /> <description> - Sets the exit position for the [code]link[/code]. + Sets the exit position for the [param link]. </description> </method> <method name="link_set_enter_cost"> @@ -221,7 +221,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="enter_cost" type="float" /> <description> - Sets the [code]enter_cost[/code] for this [code]link[/code]. + Sets the [param enter_cost] for this [param link]. </description> </method> <method name="link_set_map"> @@ -253,7 +253,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="position" type="Vector2" /> <description> - Sets the entry position for this [code]link[/code]. + Sets the entry position for this [param link]. </description> </method> <method name="link_set_travel_cost"> @@ -261,7 +261,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="travel_cost" type="float" /> <description> - Sets the [code]travel_cost[/code] for this [code]link[/code]. + Sets the [param travel_cost] for this [param link]. </description> </method> <method name="map_create"> @@ -328,7 +328,7 @@ <return type="RID[]" /> <param index="0" name="map" type="RID" /> <description> - Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code]. + Returns all navigation link [RID]s that are currently assigned to the requested navigation [param map]. </description> </method> <method name="map_get_path" qualifiers="const"> diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index e6eed172f2..5b79355b61 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -155,7 +155,7 @@ <return type="Vector3" /> <param index="0" name="link" type="RID" /> <description> - Returns the ending position of this [code]link[/code]. + Returns the ending position of this [param link]. </description> </method> <method name="link_get_enter_cost" qualifiers="const"> @@ -169,14 +169,14 @@ <return type="RID" /> <param index="0" name="link" type="RID" /> <description> - Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to. + Returns the navigation map [RID] the requested [param link] is currently assigned to. </description> </method> <method name="link_get_navigation_layers" qualifiers="const"> <return type="int" /> <param index="0" name="link" type="RID" /> <description> - Returns the navigation layers for this [code]link[/code]. + Returns the navigation layers for this [param link]. </description> </method> <method name="link_get_owner_id" qualifiers="const"> @@ -190,7 +190,7 @@ <return type="Vector3" /> <param index="0" name="link" type="RID" /> <description> - Returns the starting position of this [code]link[/code]. + Returns the starting position of this [param link]. </description> </method> <method name="link_get_travel_cost" qualifiers="const"> @@ -204,7 +204,7 @@ <return type="bool" /> <param index="0" name="link" type="RID" /> <description> - Returns whether this [code]link[/code] can be travelled in both directions. + Returns whether this [param link] can be travelled in both directions. </description> </method> <method name="link_set_bidirectional"> @@ -212,7 +212,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="bidirectional" type="bool" /> <description> - Sets whether this [code]link[/code] can be travelled in both directions. + Sets whether this [param link] can be travelled in both directions. </description> </method> <method name="link_set_end_position"> @@ -220,7 +220,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="position" type="Vector3" /> <description> - Sets the exit position for the [code]link[/code]. + Sets the exit position for the [param link]. </description> </method> <method name="link_set_enter_cost"> @@ -228,7 +228,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="enter_cost" type="float" /> <description> - Sets the [code]enter_cost[/code] for this [code]link[/code]. + Sets the [param enter_cost] for this [param link]. </description> </method> <method name="link_set_map"> @@ -260,7 +260,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="position" type="Vector3" /> <description> - Sets the entry position for this [code]link[/code]. + Sets the entry position for this [param link]. </description> </method> <method name="link_set_travel_cost"> @@ -268,7 +268,7 @@ <param index="0" name="link" type="RID" /> <param index="1" name="travel_cost" type="float" /> <description> - Sets the [code]travel_cost[/code] for this [code]link[/code]. + Sets the [param travel_cost] for this [param link]. </description> </method> <method name="map_create"> @@ -353,7 +353,7 @@ <return type="RID[]" /> <param index="0" name="map" type="RID" /> <description> - Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code]. + Returns all navigation link [RID]s that are currently assigned to the requested navigation [param map]. </description> </method> <method name="map_get_path" qualifiers="const"> diff --git a/doc/classes/PathFollow3D.xml b/doc/classes/PathFollow3D.xml index bf8194a7cf..41727a7bd8 100644 --- a/doc/classes/PathFollow3D.xml +++ b/doc/classes/PathFollow3D.xml @@ -15,7 +15,7 @@ <param index="0" name="transform" type="Transform3D" /> <param index="1" name="rotation_mode" type="int" enum="PathFollow3D.RotationMode" /> <description> - Correct the [code]transform[/code]. [code]rotation_mode[/code] implicitly specifies how posture (forward, up and sideway direction) is calculated. + Correct the [param transform]. [param rotation_mode] implicitly specifies how posture (forward, up and sideway direction) is calculated. </description> </method> </methods> diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index 010a73a8e5..4ed65e7bfb 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -595,7 +595,7 @@ Sets the function used to calculate physics for the body, if that body allows it (see [method body_set_omit_force_integration]). The force integration function takes the following two parameters: 1. a [PhysicsDirectBodyState2D] [code]state[/code]: used to retrieve and modify the body's state, - 2. a [Variant] [code]userdata[/code]: optional user data. + 2. a [Variant] [param userdata]: optional user data. [b]Note:[/b] This callback is currently not called in Godot Physics. </description> </method> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 6eed8434ac..4a6368ca6c 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -20,9 +20,9 @@ <param index="0" name="hint" type="Dictionary" /> <description> Adds a custom property info to a property. The dictionary must contain: - - [code]name[/code]: [String] (the property's name) - - [code]type[/code]: [int] (see [enum Variant.Type]) - - optionally [code]hint[/code]: [int] (see [enum PropertyHint]) and [code]hint_string[/code]: [String] + - [code]"name"[/code]: [String] (the property's name) + - [code]"type"[/code]: [int] (see [enum Variant.Type]) + - optionally [code]"hint"[/code]: [int] (see [enum PropertyHint]) and [code]"hint_string"[/code]: [String] [b]Example:[/b] [codeblocks] [gdscript] diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 143c199cac..c402040c65 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -154,7 +154,7 @@ <param index="0" name="b" type="Rect2" /> <param index="1" name="include_borders" type="bool" default="false" /> <description> - Returns [code]true[/code] if the [Rect2] overlaps with [code]b[/code] (i.e. they have at least one point in common). + Returns [code]true[/code] if the [Rect2] overlaps with [param b] (i.e. they have at least one point in common). If [param include_borders] is [code]true[/code], they will also be considered overlapping if their borders touch, even without intersection. </description> </method> diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index 44c7345edb..ba20bb60e6 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -143,7 +143,7 @@ <return type="Rect2i" /> <param index="0" name="b" type="Rect2i" /> <description> - Returns the intersection of this [Rect2i] and [code]b[/code]. + Returns the intersection of this [Rect2i] and [param b]. If the rectangles do not intersect, an empty [Rect2i] is returned. </description> </method> @@ -151,7 +151,7 @@ <return type="bool" /> <param index="0" name="b" type="Rect2i" /> <description> - Returns [code]true[/code] if the [Rect2i] overlaps with [code]b[/code] (i.e. they have at least one point in common). + Returns [code]true[/code] if the [Rect2i] overlaps with [param b] (i.e. they have at least one point in common). </description> </method> <method name="merge" qualifiers="const"> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 2921117b8b..ce793deec1 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -62,9 +62,9 @@ <param index="3" name="ignore_time_scale" type="bool" default="false" /> <description> Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. - If [code]process_always[/code] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. - If [code]process_in_physics[/code] is set to [code]true[/code], will update the [SceneTreeTimer] during the physics frame instead of the process frame (fixed framerate processing). - If [code]ignore_time_scale[/code] is set to [code]true[/code], will ignore [member Engine.time_scale] and update the [SceneTreeTimer] with the actual frame delta. + If [param process_always] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. + If [param process_in_physics] is set to [code]true[/code], will update the [SceneTreeTimer] during the physics frame instead of the process frame (fixed framerate processing). + If [param ignore_time_scale] is set to [code]true[/code], will ignore [member Engine.time_scale] and update the [SceneTreeTimer] with the actual frame delta. Commonly used to create a one-shot delay timer as in the following example: [codeblocks] [gdscript] diff --git a/doc/classes/SkeletonIK3D.xml b/doc/classes/SkeletonIK3D.xml index 58cf70df6a..0fb8a0d44a 100644 --- a/doc/classes/SkeletonIK3D.xml +++ b/doc/classes/SkeletonIK3D.xml @@ -4,7 +4,7 @@ SkeletonIK3D is used to place the end bone of a [Skeleton3D] bone chain at a certain point in 3D by rotating all bones in the chain accordingly. </brief_description> <description> - SkeletonIK3D is used to place the end bone of a [Skeleton3D] bone chain at a certain point in 3D by rotating all bones in the chain accordingly. A typical scenario for IK in games is to place a characters feet on the ground or a characters hands on a currently hold object. SkeletonIK uses FabrikInverseKinematic internally to solve the bone chain and applies the results to the [Skeleton3D] [code]bones_global_pose_override[/code] property for all affected bones in the chain. If fully applied this overwrites any bone transform from [Animation]s or bone custom poses set by users. The applied amount can be controlled with the [code]interpolation[/code] property. + SkeletonIK3D is used to place the end bone of a [Skeleton3D] bone chain at a certain point in 3D by rotating all bones in the chain accordingly. A typical scenario for IK in games is to place a characters feet on the ground or a characters hands on a currently hold object. SkeletonIK uses FabrikInverseKinematic internally to solve the bone chain and applies the results to the [Skeleton3D] [code]bones_global_pose_override[/code] property for all affected bones in the chain. If fully applied this overwrites any bone transform from [Animation]s or bone custom poses set by users. The applied amount can be controlled with the [member interpolation] property. [codeblock] # Apply IK effect automatically on every new frame (not the current) skeleton_ik_node.start() @@ -45,7 +45,7 @@ <return type="void" /> <param index="0" name="one_time" type="bool" default="false" /> <description> - Starts applying IK effects on each frame to the [Skeleton3D] bones but will only take effect starting on the next frame. If [code]one_time[/code] is [code]true[/code], this will take effect immediately but also reset on the next frame. + Starts applying IK effects on each frame to the [Skeleton3D] bones but will only take effect starting on the next frame. If [param one_time] is [code]true[/code], this will take effect immediately but also reset on the next frame. </description> </method> <method name="stop"> diff --git a/doc/classes/SoftBody3D.xml b/doc/classes/SoftBody3D.xml index f6935779d6..bbf51114bd 100644 --- a/doc/classes/SoftBody3D.xml +++ b/doc/classes/SoftBody3D.xml @@ -69,7 +69,7 @@ <param index="0" name="layer_number" type="int" /> <param index="1" name="value" type="bool" /> <description> - Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [param layer_number] between 1 and 32. + Based on [param value], enables or disables the specified layer in the [member collision_layer], given a [param layer_number] between 1 and 32. </description> </method> <method name="set_collision_mask_value"> @@ -77,7 +77,7 @@ <param index="0" name="layer_number" type="int" /> <param index="1" name="value" type="bool" /> <description> - Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [param layer_number] between 1 and 32. + Based on [param value], enables or disables the specified layer in the [member collision_mask], given a [param layer_number] between 1 and 32. </description> </method> <method name="set_point_pinned"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index a1552982ae..bf66d27ac6 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -867,7 +867,7 @@ <description> Moves the caret to the specified [param line] index. If [param adjust_viewport] is [code]true[/code], the viewport will center at the caret position after the move occurs. - If [param can_be_hidden] is [code]true[/code], the specified [code]line[/code] can be hidden. + If [param can_be_hidden] is [code]true[/code], the specified [param line] can be hidden. [b]Note:[/b] If supporting multiple carets this will not check for any overlap. See [method merge_overlapping_carets]. </description> </method> @@ -1061,7 +1061,7 @@ <return type="void" /> <param index="0" name="action" type="int" enum="TextEdit.EditAction" /> <description> - Starts an action, will end the current action if [code]action[/code] is different. + Starts an action, will end the current action if [param action] is different. An action will also end after a call to [method end_action], after [member ProjectSettings.gui/timers/text_edit_idle_detect_sec] is triggered or a new undoable step outside the [method start_action] and [method end_action] calls. </description> </method> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index ba9fc9a6f9..d4ba3ebb1f 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -310,7 +310,7 @@ <description> Update all the cells in the [param cells] coordinates array so that they use the given [param terrain] for the given [param terrain_set]. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions. If [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. - [b]Note:[/b] To work correctly, [code]set_cells_terrain_connect[/code] requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. + [b]Note:[/b] To work correctly, this method requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. </description> </method> <method name="set_cells_terrain_path"> @@ -323,7 +323,7 @@ <description> Update all the cells in the [param path] coordinates array so that they use the given [param terrain] for the given [param terrain_set]. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions. If [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. - [b]Note:[/b] To work correctly, [code]set_cells_terrain_path[/code] requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. + [b]Note:[/b] To work correctly, this method requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. </description> </method> <method name="set_layer_enabled"> @@ -341,7 +341,7 @@ <param index="1" name="modulate" type="Color" /> <description> Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate. - If [code]layer[/code] is negative, the layers are accessed from the last one. + If [param layer] is negative, the layers are accessed from the last one. </description> </method> <method name="set_layer_name"> @@ -350,7 +350,7 @@ <param index="1" name="name" type="String" /> <description> Sets a layer's name. This is mostly useful in the editor. - If [code]layer[/code] is negative, the layers are accessed from the last one. + If [param layer] is negative, the layers are accessed from the last one. </description> </method> <method name="set_layer_y_sort_enabled"> @@ -360,7 +360,7 @@ <description> Enables or disables a layer's Y-sorting. If a layer is Y-sorted, the layer will behave as a CanvasItem node where each of its tile gets Y-sorted. Y-sorted layers should usually be on different Z-index values than not Y-sorted layers, otherwise, each of those layer will be Y-sorted as whole with the Y-sorted one. This is usually an undesired behavior. - If [code]layer[/code] is negative, the layers are accessed from the last one. + If [param layer] is negative, the layers are accessed from the last one. </description> </method> <method name="set_layer_y_sort_origin"> @@ -370,7 +370,7 @@ <description> Sets a layer's Y-sort origin value. This Y-sort origin value is added to each tile's Y-sort origin value. This allows, for example, to fake a different height level on each layer. This can be useful for top-down view games. - If [code]layer[/code] is negative, the layers are accessed from the last one. + If [param layer] is negative, the layers are accessed from the last one. </description> </method> <method name="set_layer_z_index"> @@ -379,7 +379,7 @@ <param index="1" name="z_index" type="int" /> <description> Sets a layers Z-index value. This Z-index is added to each tile's Z-index value. - If [code]layer[/code] is negative, the layers are accessed from the last one. + If [param layer] is negative, the layers are accessed from the last one. </description> </method> <method name="set_navigation_map"> @@ -408,7 +408,7 @@ </member> <member name="collision_animatable" type="bool" setter="set_collision_animatable" getter="is_collision_animatable" default="false"> If enabled, the TileMap will see its collisions synced to the physics tick and change its collision type from static to kinematic. This is required to create TileMap-based moving platform. - [b]Note:[/b] Enabling [code]collision_animatable[/code] may have a small performance impact, only do it if the TileMap is moving and has colliding tiles. + [b]Note:[/b] Enabling [member collision_animatable] may have a small performance impact, only do it if the TileMap is moving and has colliding tiles. </member> <member name="collision_visibility_mode" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMap.VisibilityMode" default="0"> Show or hide the TileMap's collision shapes. If set to [constant VISIBILITY_MODE_DEFAULT], this depends on the show collision debug settings. diff --git a/doc/classes/VideoStreamPlayback.xml b/doc/classes/VideoStreamPlayback.xml index a81d011e9d..be3b0d4950 100644 --- a/doc/classes/VideoStreamPlayback.xml +++ b/doc/classes/VideoStreamPlayback.xml @@ -61,21 +61,21 @@ <return type="void" /> <param index="0" name="time" type="float" /> <description> - Seeks to [code]time[/code] seconds. Called in response to the [member VideoStreamPlayer.stream_position] setter. + Seeks to [param time] seconds. Called in response to the [member VideoStreamPlayer.stream_position] setter. </description> </method> <method name="_set_audio_track" qualifiers="virtual"> <return type="void" /> <param index="0" name="idx" type="int" /> <description> - Select the audio track [code]idx[/code]. Called when playback starts, and in response to the [member VideoStreamPlayer.audio_track] setter. + Select the audio track [param idx]. Called when playback starts, and in response to the [member VideoStreamPlayer.audio_track] setter. </description> </method> <method name="_set_paused" qualifiers="virtual"> <return type="void" /> <param index="0" name="paused" type="bool" /> <description> - Set the paused status of video playback. [method _is_paused] must return [code]paused[/code]. Called in response to the [member VideoStreamPlayer.paused] setter. + Set the paused status of video playback. [method _is_paused] must return [param paused]. Called in response to the [member VideoStreamPlayer.paused] setter. </description> </method> <method name="_stop" qualifiers="virtual"> @@ -88,7 +88,7 @@ <return type="void" /> <param index="0" name="delta" type="float" /> <description> - Ticks video playback for [code]delta[/code] seconds. Called every frame as long as [method _is_paused] and [method _is_playing] return true. + Ticks video playback for [param delta] seconds. Called every frame as long as [method _is_paused] and [method _is_playing] return true. </description> </method> <method name="mix_audio"> @@ -97,7 +97,7 @@ <param index="1" name="buffer" type="PackedFloat32Array" default="PackedFloat32Array()" /> <param index="2" name="offset" type="int" default="0" /> <description> - Render [code]num_frames[/code] audio frames (of [method _get_channels] floats each) from [code]buffer[/code], starting from index [code]offset[/code] in the array. Returns the number of audio frames rendered, or -1 on error. + Render [param num_frames] audio frames (of [method _get_channels] floats each) from [param buffer], starting from index [param offset] in the array. Returns the number of audio frames rendered, or -1 on error. </description> </method> </methods> diff --git a/doc/classes/VisualInstance3D.xml b/doc/classes/VisualInstance3D.xml index c563c0e014..6e7042431b 100644 --- a/doc/classes/VisualInstance3D.xml +++ b/doc/classes/VisualInstance3D.xml @@ -36,7 +36,7 @@ <return type="bool" /> <param index="0" name="layer_number" type="int" /> <description> - Returns whether or not the specified layer of the [member layers] is enabled, given a [code]layer_number[/code] between 1 and 20. + Returns whether or not the specified layer of the [member layers] is enabled, given a [param layer_number] between 1 and 20. </description> </method> <method name="set_base"> diff --git a/doc/classes/VoxelGI.xml b/doc/classes/VoxelGI.xml index d72139d483..a019eac910 100644 --- a/doc/classes/VoxelGI.xml +++ b/doc/classes/VoxelGI.xml @@ -20,7 +20,7 @@ <param index="0" name="from_node" type="Node" default="null" /> <param index="1" name="create_visual_debug" type="bool" default="false" /> <description> - Bakes the effect from all [GeometryInstance3D]s marked with [constant GeometryInstance3D.GI_MODE_STATIC] and [Light3D]s marked with either [constant Light3D.BAKE_STATIC] or [constant Light3D.BAKE_DYNAMIC]. If [code]create_visual_debug[/code] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [VoxelGI]'s data and debug any issues that may be occurring. + Bakes the effect from all [GeometryInstance3D]s marked with [constant GeometryInstance3D.GI_MODE_STATIC] and [Light3D]s marked with either [constant Light3D.BAKE_STATIC] or [constant Light3D.BAKE_DYNAMIC]. If [param create_visual_debug] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [VoxelGI]'s data and debug any issues that may be occurring. [b]Note:[/b] [method bake] works from the editor and in exported projects. This makes it suitable for procedurally generated or user-built levels. Baking a [VoxelGI] node generally takes from 5 to 20 seconds in most scenes. Reducing [member subdiv] can speed up baking. [b]Note:[/b] [GeometryInstance3D]s and [Light3D]s must be fully ready before [method bake] is called. If you are procedurally creating those and some meshes or lights are missing from your baked [VoxelGI], use [code]call_deferred("bake")[/code] instead of calling [method bake] directly. </description> diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 87fef49aac..4cc48bd70b 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -348,16 +348,14 @@ <return type="void" /> <param index="0" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" /> <description> - Shows the [Window] and makes it transient (see [member transient]). If [param rect] is provided, it will be set as the [Window]'s size. - Fails if called on the main window. + Shows the [Window] and makes it transient (see [member transient]). If [param rect] is provided, it will be set as the [Window]'s size. Fails if called on the main window. </description> </method> <method name="popup_centered"> <return type="void" /> <param index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" /> <description> - Popups the [Window] at the center of the current screen, with optionally given minimum size. - If the [Window] is embedded, it will be centered in the parent [Viewport] instead. + Popups the [Window] at the center of the current screen, with optionally given minimum size. If the [Window] is embedded, it will be centered in the parent [Viewport] instead. [b]Note:[/b] Calling it with the default value of [param minsize] is equivalent to calling it with [member size]. </description> </method> @@ -366,8 +364,7 @@ <param index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" /> <param index="1" name="fallback_ratio" type="float" default="0.75" /> <description> - Popups the [Window] centered inside its parent [Window]. - [code]fallback_ratio[/code] determines the maximum size of the [Window], in relation to its parent. + Popups the [Window] centered inside its parent [Window]. [param fallback_ratio] determines the maximum size of the [Window], in relation to its parent. [b]Note:[/b] Calling it with the default value of [param minsize] is equivalent to calling it with [member size]. </description> </method> @@ -382,8 +379,7 @@ <return type="void" /> <param index="0" name="parent_rect" type="Rect2i" /> <description> - Popups the [Window] with a position shifted by parent [Window]'s position. - If the [Window] is embedded, has the same effect as [method popup]. + Popups the [Window] with a position shifted by parent [Window]'s position. If the [Window] is embedded, has the same effect as [method popup]. </description> </method> <method name="remove_theme_color_override"> |