Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


ScriptableSingleton<T>

Generic class for storing Editor state.
Read time 4 minutesLast updated 5 days ago

Definition

public class ScriptableSingleton<T> : ScriptableObject where T : ScriptableObject

Remarks

The ScriptableSingleton generic class allows you to create 'Manager' type classes in the Unity Editor. In classes that derive from ScriptableSingleton, serializable data you add survives assembly reloading in the Editor. Also, if the class uses the FilePathAttribute, the serializable data persists between sessions of Unity.

Examples

using System.Collections.Generic;using UnityEditor;using UnityEngine;[FilePath("SomeSubFolder/StateFile.foo", FilePathAttribute.Location.PreferencesFolder)]public class MySingleton : ScriptableSingleton<MySingleton>{ [SerializeField] float m_Number = 42; [SerializeField] List<string> m_Strings = new List<string>(); public void Modify() { m_Number *= 2; m_Strings.Add("Foo" + m_Number); Save(true); Debug.Log("Saved to: " + GetFilePath()); } public void Log() { Debug.Log("MySingleton state: " + JsonUtility.ToJson(this, true)); }}static class MySingletonMenuItems{ [MenuItem("SingletonTest/Log")] static void LogMySingletonState() { MySingleton.instance.Log(); } [MenuItem("SingletonTest/Modify")] static void ModifyMySingletonState() { MySingleton.instance.Modify(); }}

Static Properties

Property

Description

instanceGets the instance of the Singleton. Unity creates the Singleton instance when this property is accessed for the first time. If you use the FilePathAttribute, then Unity loads the data on the first access as well.

Methods

Method

Description

SaveSaves the current state of the ScriptableSingleton.

Static Methods

Method

Description

GetFilePathGet the file path where this ScriptableSingleton is saved to.

Inheritance

Inherited Members

Operators

Operator

Description

operator ==Compares two object references to see if they refer to the same object.
boolDetermines whether the object exists.
operator !=Compares if two objects refer to a different object.