JsonUtility.FromJson

Parameters

Returns

T An instance of the object.

Description

Create an object from its JSON representation.

Internally, this method uses the Unity serializer. The object you're creating and all its fields must meet the requirements for serialization by the Unity serializer. For the full list of these requirements, refer to Serialization rules in the manual.

FromJson only supports plain classes and structures. It does not support classes derived from UnityEngine.Object, such as MonoBehaviour or ScriptableObject. To deserialize data into classes derived from MonoBehaviour or ScriptableObject, use JsonUtility.FromJsonOverwrite instead.

Field initializers and any logic in the default constructor are executed during deserialization. After the instance is constructed, fields that appear in the supplied JSON representation are set to those values. Any fields missing from the JSON keep their values as assigned by the constructor or field initializers.

If the input is null or empty, FromJson returns null.

FromJson can be called from background threads.

using UnityEngine;

public class FromJsonTest : MonoBehaviour
{
    public static string completeJson = "{\"name\":\"Dr Charles\",\"lives\":3,\"health\":0.8}";
    // Partial JSON, missing lives and health. In this example, these fields will get their values from the initializer and constructor respectively.
    public static string partialJson = "{\"name\":\"Dr Charles\"}";

    void Start()
    {
        PlayerInfo player1 = PlayerInfo.CreateFromJSON(completeJson);
        Debug.Log("Player1 Name: " + player1.name); // Dr Charles
        Debug.Log("Player1 Lives: " + player1.lives); // 3
        Debug.Log("Player1 Health: " + player1.health); // 0.8
        PlayerInfo player2 = PlayerInfo.CreateFromJSON(partialJson);
        Debug.Log("Player2 Name: " + player2.name); // Dr Charles (from JSON)
        Debug.Log("Player2 Lives: " + player2.lives); // 2 (from initializer)
        Debug.Log("Player2 Health: " + player2.health); // 1 (from constructor)
    }

}

[System.Serializable]
public class PlayerInfo
{
    public string name = "Unknown";
    public int lives = 2;
    public float health;

    public PlayerInfo()
    {
        health = 1.0f;
    }

    public static PlayerInfo CreateFromJSON(string jsonString)
    {
        return JsonUtility.FromJson<PlayerInfo>(jsonString);
    }

}

Parameters

Returns

object An instance of the object.

Description

Create an object from its JSON representation.

Internally, this method uses the Unity serializer. The object you're creating and all its fields must meet the requirements for serialization by the Unity serializer. For the full list of these requirements, refer to Serialization rules in the manual.

FromJson only supports plain classes and structures. It does not support classes derived from UnityEngine.Object, such as MonoBehaviour or ScriptableObject. To deserialize data into classes derived from MonoBehaviour or ScriptableObject, use JsonUtility.FromJsonOverwrite instead.

Field initializers and any logic in the default constructor are executed during deserialization. After the instance is constructed, fields that appear in the supplied JSON representation are set to those values. Any fields missing from the JSON keep their values as assigned by the constructor or field initializers.

FromJson can be called from background threads.