CODEWITHSUNDEEP
unity-game-enginepropertiesscriptable-object
Isaac Thompson
Isaac Thompson

Reputation: 115

Unity ScriptableObjects - Read-only fields

Say I have a ScriptableObject Item:

public class Item : ScriptableObject
{
    public new string name;
    public string description;
    public Sprite sprite;
}

The only issue is that the fields can be modified:

Item item = new Item();
item.description = "Overwrite";

I want them to be readonly. I found this workaround using properties:

public class Item : ScriptableObject
{
    [SerializeField] private new string name;
    [SerializeField] private string description;
    [SerializeField] private Sprite sprite;

    public string Name => name;
    public string Description => description;
    public Sprite Sprite => sprite;
}

The only issue is that this effectively doubles the length of all of my ScriptableObjects and seems cumbersome. Is there another preferred way to make ScriptableObject fields readonly without the extra code and still serializing fields?

Upvotes: 3

Views: 4128

Answers (3)

yingdi fu
yingdi fu

Reputation: 1

Don't directly use the original scriptable object, use its runtime copy to prevent the original value from being modified.

You can do it by using ScriptableObject.Instantiate(your_so)

Upvotes: 0

Lyrca
Lyrca

Reputation: 613

You can use Field-Targeted Attributes:

public class Item : ScriptableObject{
    [field: SerializeField] public string Name { get; private set; }
    [field: SerializeField] public string Description { get; private set; }
    [field: SerializeField] public Sprite Sprite { get; private set; }
}

Upvotes: 5

Geeky Quentin
Geeky Quentin

Reputation: 2508

You can initialize the fields as properties directly and add the get method to it. set method is by default set to private set;. It restricts any external modifications of the properties. These properties can be set privately, i.e. they are accessible and modifiable within the script.

public string Name { get; }
public string Description { get; }
public Sprite SpriteObj { get; }

Note: Naming convention of properties is that they start with an uppercase letter. Changing the property name to SpriteObj so that it doesn't clash with the inbuilt component name.

Upvotes: -1

Related Questions