godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #14638 from mhilbrunner/patch-7 

[DOCS] JSON: Small fixes
This commit is contained in:
Rémi Verschelde 2017-12-13 22:32:35 +01:00 committed by GitHub
parent 8771329f55 a187345603
commit 592ce20fc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/JSON.xml
View File

@ -4,7 +4,7 @@
Helper class for parsing JSON data. Helper class for parsing JSON data.
</brief_description> </brief_description>
<description> <description>
Helper class for parsing JSON data. Helper class for parsing JSON data. For usage example, see [JSONParseResult].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

10
doc/classes/JSONParseResult.xml
View File

@ -14,23 +14,23 @@
</methods> </methods>
<members> <members>
<member name="error" type="int" setter="set_error" getter="get_error" enum="Error"> <member name="error" type="int" setter="set_error" getter="get_error" enum="Error">
The error type if JSON source was not successfully parsed. See [@GlobalScope]ERR_* constants. The error type if JSON source was not successfully parsed. See [@GlobalScope] ERR_* constants.
</member> </member>
<member name="error_line" type="int" setter="set_error_line" getter="get_error_line"> <member name="error_line" type="int" setter="set_error_line" getter="get_error_line">
The line number where the error occurred if JSON source was not successfully parsed. The line number where the error occurred if JSON source was not successfully parsed.
</member> </member>
<member name="error_string" type="String" setter="set_error_string" getter="get_error_string"> <member name="error_string" type="String" setter="set_error_string" getter="get_error_string">
The error message if JSON source was not successfully parsed. See [@GlobalScope]ERR_* constants. The error message if JSON source was not successfully parsed. See [@GlobalScope] ERR_* constants.
</member> </member>
<member name="result" type="Variant" setter="set_result" getter="get_result"> <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 braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned. 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.[/i]
[codeblock] [codeblock]
p = JSON.parse('["hello", "world", "!"]') p = JSON.parse('["hello", "world", "!"]')
if typeof(p) == TYPE_ARRAY: if typeof(p) == TYPE_ARRAY:
print(p[0]) # prints 'hello' print(p[0]) # prints 'hello'
else: else:
print("unexpected results") print("unexpected results")
[/codeblock] [/codeblock]
</member> </member>
</members> </members>