noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

doc: Add default values to all properties

Browse Source 
Thanks to @bojidar-bg's impressive work in #29380.
This commit is contained in:
Rémi Verschelde
2019-06-29 12:38:01 +02:00
parent 82604195b4
commit c6cea6e9b3
394 changed files with 2881 additions and 2719 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/JSONParseResult.xml
+4 -4
View File
@@ -11,16 +11,16 @@
<methods>
</methods>
<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" default="null">
The error type if the JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants.
</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" default="117929728">
The line number where the error occurred if JSON source was not successfully parsed.
</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" default="&quot;&quot;">
The error message if JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants.
</member>
<member name="result" type="Variant" setter="set_result" getter="get_result">
<member name="result" type="Variant" setter="set_result" getter="get_result" default="null">
A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with braces ([code][][/code]), an [Array] will be returned.
[b]Note:[/b] 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.
[b]Note:[/b] 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: