{"id":78,"date":"2021-10-24T07:53:00","date_gmt":"2021-10-24T07:53:00","guid":{"rendered":"https:\/\/docs.sisus.co\/inity\/?p=78"},"modified":"2025-07-14T19:37:08","modified_gmt":"2025-07-14T19:37:08","slug":"scriptablewrapper","status":"publish","type":"post","link":"https:\/\/docs.sisus.co\/init-args\/wrappers\/scriptablewrapper\/","title":{"rendered":"2. ScriptableWrapper"},"content":{"rendered":"

The ScriptableWrapper class is a ScriptableObject that can act as a simple wrapper for a plain old class object.<\/p>\n

It makes it easy to take a plain old class object and serialize it as an asset in the project.<\/p>\n

Let\u2019s say you had a plain old class called Settings:<\/p>\n

public class Settings\r\n{\r\n    public float MoveSpeed = 10f;\r\n    public float JumpHeight = 4f;\r\n}\r\n<\/pre>\n
To create a scriptable wrapper for the Settings class, create a class that inherits from ScriptableWrapper<Settings>.<\/p>\n
public class SettingsAsset : ScriptableWrapper<Settings> { }<\/pre>\n
Beyond being able to wrap a plain old class object, this class functions just like a normal ScriptableObject, so you can decorate it with the CreateAssetMenu attribute<\/a> to make it easy to create an instance of the asset from Unity’s create menu.<\/p>\n
[CreateAssetMenu]\r\npublic class SettingsAsset : ScriptableWrapper<Settings> { }<\/pre>\n
You can access the plain old class wrapped by a ScriptableWrapper through the WrappedObject property.<\/p>\n
var settingsAsset = Resources.Load<SettingsAsset>(\"Settings\");\r\nSettings settings = settingsAsset.WrappedObject;<\/pre>\n
This scriptable wrapper implements IInitializable<Settings>, which means that a new instance can be initialized with the Settings object passed as an argument using the custom Instantiate or Create.Instance methods that come with Init(args).<\/p>\n
You can create create a new instance of the SettingsAsset with a Settings object wrapped inside of it using Create.Instance:<\/p>\n
public void SaveSettings(Settings settings)\r\n{\r\n    var settingsAsset = Create.Instance<SettingsAsset>(settings);\r\n    AssetDatabase.CreateAsset(settingsAsset, \"Resources\/Settings.asset\");\r\n}<\/pre>\n
You can clone an existing Settings asset while injecting a new Settings object inside of it using settingsAsset.Instantiate(settings);<\/p>\n
public SettingsAsset InstantiateSettingsAsset(Settings overrideSettings = null)\r\n{\r\n    SettingsAsset settingsAsset = Resources.Load<SettingsAsset>(\"Settings\");\r\n\r\n    if(overrideSettings != null)\r\n    {\r\n        return settingsAsset.Instantiate(overrideSettings);\r\n    }\r\n\r\n    return Object.Instantiate(settingsAsset);\r\n}<\/pre>\n
Unity Events<\/h2>\n
Wrapped objects can receive callbacks during select Unity events from their wrapper by implementing one of the following interfaces:<\/p>\n
    \n
  1. IAwake <\/b><\/span><\/span><\/span>– Receive callback during the <\/span><\/span><\/span>ScriptableObject<\/span><\/span><\/span>.<\/span><\/span><\/span>Awake event.<\/span><\/span><\/span><\/li>\n
  2. I<\/b><\/span><\/span><\/span>O<\/b><\/span><\/span><\/span>nEnable<\/b><\/span><\/span><\/span> – <\/span><\/span><\/span>Receive callback during the <\/span><\/span><\/span>ScriptableObject<\/span><\/span><\/span>.OnEnable<\/span><\/span><\/span> event.<\/span><\/span><\/span><\/li>\n
  3. I<\/b><\/span><\/span><\/span>U<\/b><\/span><\/span><\/span>pdate<\/b><\/span><\/span><\/span> –<\/span><\/span><\/span> Receive callback during the Update event.<\/span><\/span><\/span><\/li>\n
  4. I<\/b><\/span><\/span><\/span>F<\/b><\/span><\/span><\/span>ixedUpdate<\/b><\/span><\/span><\/span> – <\/span><\/span><\/span>Receive callback during the FixedUpdate<\/span><\/span><\/span> event.<\/span><\/span><\/span><\/li>\n
  5. I<\/b><\/span><\/span><\/span>L<\/b><\/span><\/span><\/span>ateUpdate<\/b><\/span><\/span><\/span> – <\/span><\/span><\/span>Receive callback during the LateUpdate<\/span><\/span><\/span> event.<\/span><\/span><\/span><\/li>\n
  6. I<\/b><\/span><\/span><\/span>O<\/b><\/span><\/span><\/span>nDisable<\/b><\/span><\/span><\/span> – <\/span><\/span><\/span>Receive callback during the <\/span><\/span><\/span>ScriptableObject<\/span><\/span><\/span>.OnDisable<\/span><\/span><\/span> event.<\/span><\/span><\/span><\/li>\n
  7. IOnDestroy<\/b><\/span><\/span><\/span> – <\/span><\/span><\/span>Receive callback during the <\/span><\/span><\/span>ScriptableObject<\/span><\/span><\/span>.OnDestroy<\/span><\/span><\/span> event.<\/span><\/span><\/span><\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    The ScriptableWrapper class is a ScriptableObject that can act as a simple wrapper for a plain old class object. It makes it easy to take a plain old class object and serialize it as an asset in the project. Let\u2019s say you had a plain old class called Settings: public class Settings { public float ..<\/p>\n
    <\/div>\n
    Read more<\/a><\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[13],"tags":[],"_links":{"self":[{"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/posts\/78"}],"collection":[{"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/comments?post=78"}],"version-history":[{"count":8,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/posts\/78\/revisions"}],"predecessor-version":[{"id":613,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/posts\/78\/revisions\/613"}],"wp:attachment":[{"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/media?parent=78"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/categories?post=78"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/tags?post=78"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}