JSONParseResult

Inherits: Reference < Object

Data class wrapper for decoded JSON.

Description

Returned by JSON.parse, JSONParseResult contains the decoded JSON or error information if the JSON source wasn’t successfully parsed. You can check if the JSON source was successfully parsed with if json_result.error == OK.

Property Descriptions

Setterset_error(value)
Getterget_error()

The error type if the JSON source was not successfully parsed. See the Error constants.


Default-1
Setterset_error_line(value)
Getterget_error_line()

The line number where the error occurred if JSON source was not successfully parsed.


Default""
Setterset_error_string(value)
Getterget_error_string()

The error message if JSON source was not successfully parsed. See the Error constants.


Setterset_result(value)
Getterget_result()

A Variant containing the parsed JSON. Use @GDScript.typeof or the is keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ({}), a Dictionary will be returned. If the JSON source starts with braces ([]), an Array will be returned.

Note: 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: 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:

var p = JSON.parse('["hello", "world", "!"]')
if typeof(p.result) == TYPE_ARRAY:
    print(p.result[0]) # Prints "hello"
else:
    print("unexpected results")

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.