Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


ToJson

Generate a JSON representation of an object.
Read time 2 minutesLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor.CoreModule

ToJson(Object)

Generate a JSON representation of an object.
public static string ToJson(object obj)

Parameters

The object to convert to JSON form.

Returns

Type

Description

stringThe object's data in JSON format.

Remarks

This is similar to JsonUtility.ToJson, but it supports any engine object. The output is similar to the properties exposed via the SerializedObject API, or as found in the YAML-serialized form of the object.
If the object contains fields with references to other Unity objects, those references are serialized by recording the asset guid and local file id for each reference. This string can be saved, then deserialized in another session of the Unity Editor, and the references are resolved correctly. However only objects that are located in an non-scene asset file can be referenced. References to objects within a scene, including the same scene, will not be serialized.

ToJson(Object, bool)

Generate a JSON representation of an object.
public static string ToJson(object obj, bool prettyPrint)

Parameters

The object to convert to JSON form.

prettyPrint

If true, format the output for readability. If false, format the output for minimum size. Default is false.

Returns

Type

Description

stringThe object's data in JSON format.

Remarks

This is similar to JsonUtility.ToJson, but it supports any engine object. The output is similar to the properties exposed via the SerializedObject API, or as found in the YAML-serialized form of the object.
If the object contains fields with references to other Unity objects, those references are serialized by recording the asset guid and local file id for each reference. This string can be saved, then deserialized in another session of the Unity Editor, and the references are resolved correctly. However only objects that are located in an non-scene asset file can be referenced. References to objects within a scene, including the same scene, will not be serialized.