JSON

Inherits: RefCounted < Object

Helper class for creating and parsing JSON data.

Description

The JSON enables all data types to be converted to and from a JSON string. This useful for serializing data to save to a file or send over the network.

stringify is used to convert any data type into a JSON string.

parse is used to convert any existing JSON data into a Variant that can be used within Godot. If successfully parsed, use get_data to retrieve the Variant, and use typeof to check if the Variant's type is what you expect. JSON Objects are converted into a Dictionary, but JSON data can be used to store Arrays, numbers, Strings and even just a boolean.

Example

var data_to_send = ["a", "b", "c"]
var json = JSON.new()
var json_string = json.stringify(data_to_send)
# Save data
# ...
# Retrieve data
var error = json.parse(json_string)
if error == OK:
    var data_received = json.get_data()
    if typeof(data_received) == TYPE_ARRAY:
        print(data_received) # Prints array
    else:
        print("Unexpected data")
else:
    print("JSON Parse Error: ", json.get_error_message(), " in ", json_string, " at line ", json.get_error_line())

Methods

Variant

get_data ( ) const

int

get_error_line ( ) const

String

get_error_message ( ) const

Error

parse ( String json_string )

String

stringify ( Variant data, String indent="", bool sort_keys=true, bool full_precision=false )

Method Descriptions

Returns the Variant containing the data of a successful parse.

Note: It will return Null if the last call to parse was unsuccessful or parse has not yet been called.


  • int get_error_line ( ) const

Returns 0 if the last call to parse was successful, or the line number where the parse failed.


  • String get_error_message ( ) const

Returns an empty string if the last call to parse was successful, or the error message if it failed.


Attempts to parse the json_string provided.

Returns an Error. If the parse was successful, it returns OK and the result can be retrieved using get_data. If unsuccessful, use get_error_line and get_error_message for identifying the source of the failure.


Converts a Variant var to JSON text and returns the result. Useful for serializing data to store or send over the network.

Note: The JSON specification does not define integer or float types, but only a number type. Therefore, converting a Variant to JSON text will convert all numerical values to float types.

Note: If full_precision is true, when stringifying floats, the unreliable digits are stringified in addition to the reliable digits to guarantee exact decoding.

Use indent parameter to pretty stringify the output.

Example output:

## JSON.stringify(my_dictionary)
{"name":"my_dictionary","version":"1.0.0","entities":[{"name":"entity_0","value":"value_0"},{"name":"entity_1","value":"value_1"}]}

## JSON.stringify(my_dictionary, "\t")
{
        "name": "my_dictionary",
        "version": "1.0.0",
        "entities": [
                {
                        "name": "entity_0",
                        "value": "value_0"
                },
                {
                        "name": "entity_1",
                        "value": "value_1"
                }
        ]
}