Unigine::Json Class

Header:

#include <UnigineJson.h>

List of functions:

This class is used to parse and create JSON formatted strings.

Json Class

Members

static JsonPtr create()

Default constructor that creates an empty instance.

static JsonPtr create(const char * name)

Constructor that creates a JSON node with a given name.

Arguments

const char * name - Name of the Json node.

void setArray()

Sets array type to the current Json node and adds a given array as a child.

Usage Example

Adding an Array

The following example shows how to add an array to the Json node.

Source code (UnigineScript)

Json json = new Json();
Json array = json.addChild("array");
array.setArray((1,2.2,"3"));
array.addChild(NULL,"data_0");
array.addChild(NULL, 5);

The result is:

Output

{
  "array": [
    1,
    2.2,
    "3",
    "data_0",
    5
  ]
}

Adding an Array to Array

To add array to the array, just add an array as a child:

Source code (UnigineScript)

Json json = new Json();
Json array = json.addChild("array");
array.setArray((1,2.2,"3"));
array.addChild(NULL,"data_0");
array.addChild(NULL, 5); 
array.addChild(NULL,"array").setArray((5,6,7));

The result is:

Output

{
  "array": [
    1,
    2.2,
    "3",
    "data_0",
    5",
    [
      5,
      6,
      7
    ]
  ]
}

Adding an Object to Array

To add an object to array, do the following:

Source code (UnigineScript)

Json json = new Json();
Json array = json.addChild("array");
array.setArray((1,2.2,"3"));
array.addChild(NULL,"object").setObject(("one": 5, "two": 6, "three": 7));

The result is:

Output

{
  "array": [
    1,
    2.2,
    "3",
    {
      "one": 5,
      "three": 7,
      "two": 6
    }
  ]
}

Notice

The setObject() function alphabetizes child nodes by using their names.

int isArray()

Returns a value indicating if the Json node has an array type.

Return value

1 if the Json has an array type; otherwise, 0.

void setBool(int arg1)

Sets a boolean value and type to the current Json node.

Arguments

int arg1 - Integer value.

int getBool()

Reads a boolean value of the current Json node.

Return value

1 if the Json node has a bool type; otherwise, 0.

int isBool()

Returns a value indicating if the Json node has a bool type.

Return value

1 if the Json has a bool type; otherwise, 0.

Ptr<Json> getChild(int num)

Returns the child node of the current Json node.

Arguments

int num - Argument of one of the following types:
- string name - Name of the Json node.
- int number - Number of the child of the Json node.

Return value

Child Json node.

Ptr<Json> getChild(const char * name)

Returns the child node of the current Json node.

Arguments

const char * name - Argument of one of the following types:
- string name - Name of the Json node.
- int number - Number of the child of the Json node.

Return value

Child Json node.

int isChild(const char * name)

Checks if a child node with a given name exists.

Arguments

const char * name - Name of the child node.

Return value

1 if a child with the provided name exists; otherwise, 0.

String getFormattedSubTree(const char * name = 0)

Returns a subtree of a Json node as the formatted string.

Usage Example

To get the formatted subtree of a Json node, do the following:

Source code (UnigineScript)

Json json = new Json();

json.addChild("child_0", 1);
json.addChild("child_1", 2.2);
json.addChild("child_2", "three");
Json object = json.addChild("object");
object.setObject(("1": 5, "4": 6, "2": 7));

string fSubTree = json.getFormattedSubTree();
log.message("the formatted subtree is:%s\n", fSubTree);

In the console you see the following:

Output

the formatted subtree is:{
  "child_0": 1,
  "child_1": 2.2,
  "child_2": "three",
  "object": {
    "1": 5,
    "2": 7,
    "4": 6
  }
}

Arguments

const char * name - The name of a child node. If there is a name, the function returns formatted subtree for this child Json node.

Return value

Formatted subtree.

void setName(const char * name)

Sets the given name to the Json node.

Arguments

const char * name - Name of the Json node.

const char * getName()

Returns the name of the current Json node.

Return value

The name of the Json node.

void setNull()

Sets null type to the current Json node.

int isNull()

Returns a value indicating if the Json node has a null type.

Return value

1 if the Json has a null type; otherwise, 0.

void setNumber(double arg1)

Sets a number value and type to the current Json node.

Arguments

double arg1 - Double value.

void setNumber(int arg1)

Sets a number value and type to the current Json node.

Arguments

int arg1 - Integer value.

double getNumber()

Returns the number value of the current Json node.

Return value

Number value of the current Json node.

int isNumber()

Returns a value indicating if the Json node has a number type.

Return value

1 if the Json has a number type; otherwise, 0.

int getNumChildren()

Returns the number of child nodes of the current Json node.

Return value

Number of child nodes.

void setObject()

Adds a given object to the current Json node.

Usage Example

Adding an Object

To add an object to the Json node, do the following:

Source code (UnigineScript)

Json json = new Json();
Json object = json.addChild("object");
object.setObject(("1": 5, "4": 6, "2": 7, "3": 8));
object.addChild("child_0", "data_0");

The result is:

Output

{
  "object": {
    "1": 5,
    "2": 7,
    "3": 8,
    "4": 6,
    "child_0": "data_0"
  }
}

Notice

The setObject() function alphabetizes child nodes by using their names.

Adding an Array to the Object

To add an array to the added object, do the following:

Source code (UnigineScript)

Json json = new Json();
Json object = json.addChild("object");
object.setObject(("1": 5, "4": 6, "2": 7, "3": 8));
object.addChild(class_remove(new Json("array"))).setArray((1,2,3));

The result is:

Output

{
  "object": {
    "1": 5,
    "2": 7,
    "3": 8,
    "4": 6,
    "array": [
      1,
      2,
      3
    ]
  }
}

Adding an Object to the Object

To add an object to the added object, do the following:

Source code (UnigineScript)

Json json = new Json();
Json object = json.addChild("object");
object.setObject(("1": 5, "4": 6, "2": 7, "3": 8));
object.addChild(class_remove(new Json("object"))).setObject(("one" : 1,"two" : 2,"three" : 3));

The result is:

Output

{
  "object": {
    "1": 5,
    "2": 7,
    "3": 8,
    "4": 6,
    "object": {
      "one": 1,
      "three": 3,
      "two": 2
    }
  }
}

int isObject()

Returns a value indicating if the Json node has an object type.

Return value

1 if the Json has an object type; otherwise, 0.

int isOwner()

Ptr<Json> getParent()

Returns the parent node of the current Json node.

Return value

Parent Json node.

void setString(const char * arg1)

Sets a string value and type to the current Json node. The function automatically casts number values to string type.

Arguments

const char * arg1 - String value.

String getString()

Returns the value of the current Json node as string.

Return value

Value of the current Json node

int isString()

Returns a value indicating if the Json node has a string type.

Return value

1 if the Json has a string type; otherwise, 0.

String getSubTree(const char * name = 0)

Returns a subtree of a Json node as the non-formatted string.

Usage Example

To get the subtree of a Json node, do the following:

Source code (UnigineScript)

Json json = new Json();

json.addChild("child_0", 1);
json.addChild("child_1", 2.2);
json.addChild("child_2", "three");
Json object = json.addChild("object");
object.setObject(("1": 5, "4": 6, "2": 7));

string subTree = json.getSubTree();
log.message("the subtree is:%s\n", subTree);

In the console you see the following:

Output

the subtree is:{"child_0":1,"child_1":2.2,"child_2":"three","object":{"1":5,"2":7,"4":6}}

Arguments

const char * name - The name of a child node. If there is a name, the function returns formatted subtree for this child Json node.