diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2018-02-12 08:03:53 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-02-12 08:03:53 +0100 |
| commit | 889b9b6dcec7b4b9ae5ac2d01f98a2cde993dae7 (patch) | |
| tree | 50d78d91d38361dedf1419860163627bee8d23aa /doc/classes | |
| parent | 6e4106ace6958e0aa3d934a5bfc53a30fa22064d (diff) | |
| parent | 82b8f1729dd2d0d1e574628e82261e2a21809a96 (diff) | |
Merge pull request #16306 from mhilbrunner/mhilbrunner-docs-json-keyorder
[DOCS] parse_json: Objects do not keep key order
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/@GDScript.xml | 1 | ||||
| -rw-r--r-- | doc/classes/JSON.xml | 2 | ||||
| -rw-r--r-- | doc/classes/JSONParseResult.xml | 3 |
3 files changed, 4 insertions, 2 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/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..0e8d9b66fa 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -24,7 +24,8 @@ </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: |