diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index ea3414474d2..476cd662558 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -500,7 +500,8 @@ - Returns length of Variant [code]var[/code]. Length is the character count of String, element count of Array, size of Dictionary, etc. Note: Generates a fatal error if Variant can not provide a length. + Returns length of Variant [code]var[/code]. Length is the character count of String, element count of Array, size of Dictionary, etc. + [b]Note:[/b] Generates a fatal error if Variant can not provide a length. [codeblock] a = [1, 2, 3, 4] len(a) # returns 4 @@ -538,7 +539,8 @@ - Loads a resource from the filesystem located at [code]path[/code]. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". + Loads a resource from the filesystem located at [code]path[/code]. + [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". [codeblock] # load a scene called main located in the root of the project directory var main = load("res://main.tscn") @@ -551,7 +553,8 @@ - Natural logarithm. The amount of time needed to reach a certain level of continuous growth. Note: This is not the same as the log function on your calculator which is a base 10 logarithm. + Natural logarithm. The amount of time needed to reach a certain level of continuous growth. + [b]Note:[/b] This is not the same as the log function on your calculator which is a base 10 logarithm. [codeblock] log(10) # returns 2.302585 [/codeblock] @@ -650,7 +653,8 @@ - Returns a resource from the filesystem that is loaded during script parsing. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". + Returns a resource from the filesystem that is loaded during script parsing. + [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". [codeblock] # load a scene called main located in the root of the project directory var main = preload("res://main.tscn") diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index bf0458a1aab..e89b8b4f8a6 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -353,7 +353,8 @@ - Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" + Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". + [b]Example:[/b] "character/skeleton:ankle" or "character/mesh:transform/local". diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 5e4d71e19ca..9224121e73f 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -292,7 +292,8 @@ - Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. + Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. + [b]Note:[/b] you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. [codeblock] class MyCustomSorter: static func sort(a, b): diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 8eb76981abe..fda990c7fa4 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -656,6 +656,7 @@ The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. + [b]Note:[/b] On Linux, shapes may vary depending on the cursor theme of the system. Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Use one of the [code]MOUSE_FILTER_*[/code] constants. See the constants to learn what each does. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index b14d105dee8..64eff81e57d 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -4,10 +4,8 @@ Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. - This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, - or both text and icon. Tooltips are supported and may be different for every item in the list. Selectable items in the list - may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled - to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). + This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, or both text and icon. Tooltips are supported and may be different for every item in the list. + Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 3e994cd77ba..9087d0d41e4 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -224,8 +224,8 @@ Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and attempts to access it will result in an "Attempt to call <method> on a null instance." error. - Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). - [i]Example:[/i] Assume your current node is Character and the following tree: + [b]Note:[/b] Fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). + [b]Example:[/b] Assume your current node is Character and the following tree: [codeblock] /root /root/Character diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 9ac4936f94a..56a02545c2d 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -667,7 +667,8 @@ - Splits the string by a divisor string and returns an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + Splits the string by a divisor string and returns an array of the substrings. + [b]Example:[/b] "One,Two,Three" will return ["One","Two","Three"] if split by ",". If [code]maxsplit[/code] is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) @@ -679,7 +680,8 @@ - Splits the string in floats by using a divisor string and returns an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". + Splits the string in floats by using a divisor string and returns an array of the substrings. + [b]Example:[/b] "1,2.5,3" will return [1,2.5,3] if split by ",".