diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/@GDScript.xml | 1 | ||||
| -rw-r--r-- | doc/classes/EditorImportPlugin.xml | 14 | ||||
| -rw-r--r-- | doc/classes/EditorPlugin.xml | 11 | ||||
| -rw-r--r-- | doc/classes/InputEventJoypadMotion.xml | 2 | ||||
| -rw-r--r-- | doc/classes/ItemList.xml | 5 | ||||
| -rw-r--r-- | doc/classes/JSON.xml | 2 | ||||
| -rw-r--r-- | doc/classes/JSONParseResult.xml | 11 | ||||
| -rw-r--r-- | doc/classes/KinematicBody.xml | 2 | ||||
| -rw-r--r-- | doc/classes/OS.xml | 3 | ||||
| -rw-r--r-- | doc/classes/StreamPeerSSL.xml | 7 | ||||
| -rw-r--r-- | doc/classes/Vector3.xml | 2 |
11 files changed, 50 insertions, 10 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index d4bd937f49..4e9a6a5fc0 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -608,6 +608,7 @@ <description> Parse JSON text to a Variant (use [method typeof] to check if it is what you expect). Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to [float] types. + Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: [codeblock] p = parse_json('["a", "b", "c"]') if typeof(p) == TYPE_ARRAY: diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 07d6f92274..85f3d80607 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -64,6 +64,13 @@ Get the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: "name", "default_value", "property_hint" (optional), "hint_string" (optional), "usage" (optional). </description> </method> + <method name="get_import_order" qualifiers="virtual"> + <return type="int"> + </return> + <description> + Get the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. + </description> + </method> <method name="get_importer_name" qualifiers="virtual"> <return type="String"> </return> @@ -97,6 +104,13 @@ Get the name of the options preset at this index. </description> </method> + <method name="get_priority" qualifiers="virtual"> + <return type="float"> + </return> + <description> + Get the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. + </description> + </method> <method name="get_recognized_extensions" qualifiers="virtual"> <return type="Array"> </return> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 8f4784334d..b3aca798a4 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -274,6 +274,17 @@ Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly. </description> </method> + <method name="remove_control_from_container"> + <return type="void"> + </return> + <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer"> + </argument> + <argument index="1" name="control" type="Control"> + </argument> + <description> + Remove the control from the specified container. Use it when cleaning up after adding a control with [method add_control_to_container]. Note that you can simply free the control if you won't use it anymore. + </description> + </method> <method name="remove_control_from_docks"> <return type="void"> </return> diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index 7d40fcd4b3..478f0dddfc 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0-stable"> <brief_description> - Input event type for gamepad joysticks and other motions. For buttons see [code]InputEventJoypadMotion[/code]. + Input event type for gamepad joysticks and other motions. For buttons see [code]InputEventJoypadButton[/code]. </brief_description> <description> Stores information about joystick motions. One [code]InputEventJoypadMotion[/code] represents one axis at a time. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index bc95472ea8..b94a06f170 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -308,7 +308,11 @@ </method> </methods> <members> + <member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect"> + If [code]true[/code] the currently selected item may be selected again. + </member> <member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select"> + If [code]true[/code] a right mouse button click can select items. </member> <member name="auto_height" type="bool" setter="set_auto_height" getter="has_auto_height"> </member> @@ -327,6 +331,7 @@ <member name="same_column_width" type="bool" setter="set_same_column_width" getter="is_same_column_width"> </member> <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="ItemList.SelectMode"> + Allow single or multiple selection. See the [code]SELECT_*[/code] constants. </member> </members> <signals> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index e69c05c3df..078c293fc0 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -4,7 +4,7 @@ Helper class for parsing JSON data. </brief_description> <description> - Helper class for parsing JSON data. For usage example, see [JSONParseResult]. + Helper class for parsing JSON data. For usage example and other important hints, see [JSONParseResult]. </description> <tutorials> </tutorials> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 424720a871..18313beaf8 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -4,7 +4,7 @@ Data class wrapper for decoded JSON. </brief_description> <description> - Returned by [method JSON.parse], [code]JSONParseResult[/code] contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with [code]if json_result.error == 0[/code]. + Returned by [method JSON.parse], [code]JSONParseResult[/code] contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with [code]if json_result.error == OK[/code]. </description> <tutorials> </tutorials> @@ -24,11 +24,12 @@ </member> <member name="result" type="Variant" setter="set_result" getter="get_result"> A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces ([code]{}[/code]) a [Dictionary] will be returned, if JSON source starts with braces ([code][][/code]) an [Array] will be returned. - [i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.[/i] + [i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. + Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:[/i] [codeblock] - p = JSON.parse('["hello", "world", "!"]') - if typeof(p) == TYPE_ARRAY: - print(p[0]) # prints 'hello' + var p = JSON.parse('["hello", "world", "!"]') + if typeof(p.result) == TYPE_ARRAY: + print(p.result[0]) # prints 'hello' else: print("unexpected results") [/codeblock] diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 2c22ae4f93..1735501a47 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -85,7 +85,7 @@ [code]linear_velocity[/code] is a value in pixels per second. Unlike in for example [method move_and_collide], you should [i]not[/i] multiply it with [code]delta[/code] — this is done by the method. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector3(0, 0, 0)[/code], everything is considered a wall. This is useful for topdown games. If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. - If the body collides, it will change direction a maximum of [code]max_bounces[/code] times before it stops. + If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. </description> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 80febff4af..a61b156b01 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -346,7 +346,8 @@ <return type="String"> </return> <description> - Returns a string that is unique to the device. Currently only works on Android and iOS. Returns empty string on other platforms. + Returns a string that is unique to the device. + Returns empty string on HTML5 and UWP which are not supported yet. </description> </method> <method name="get_unix_time" qualifiers="const"> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 0c60213e49..62e5240c7f 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -47,6 +47,13 @@ Return the status of the connection, one of STATUS_* enum. </description> </method> + <method name="poll"> + <return type="void"> + </return> + <description> + Poll the connection to check for incoming bytes. Call this right before "get_available_bytes()" for it to work properly. + </description> + </method> </methods> <constants> <constant name="STATUS_DISCONNECTED" value="0" enum="Status"> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 050285af02..0dc808329f 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -216,7 +216,7 @@ <method name="snapped"> <return type="Vector3"> </return> - <argument index="0" name="by" type="float"> + <argument index="0" name="by" type="Vector3"> </argument> <description> Returns a copy of the vector, snapped to the lowest neared multiple. |