{"id":422,"date":"2024-09-20T20:13:03","date_gmt":"2024-09-20T20:13:03","guid":{"rendered":"https:\/\/docs.sisus.co\/init-args\/?p=422"},"modified":"2025-07-14T19:31:24","modified_gmt":"2025-07-14T19:31:24","slug":"value-provider-menu","status":"publish","type":"post","link":"https:\/\/docs.sisus.co\/init-args\/initializers\/value-provider-menu\/","title":{"rendered":"3. [ValueProviderMenu] attribute"},"content":{"rendered":"

The [ValueProviderMenu] attribute can be used to introduce new menu items that will be shown in the dropdown menus for all Init arguments of targeted types.<\/p>\n

The attribute can be added to a ScriptableObject-derived class that implements IValueProvider<TValue><\/a> or IValueByTypeProvider<\/a>.<\/p>\n

You can then use the Value property to access the value stored inside the field.<\/p>\n

Example<\/h3>\n

\"\"<\/p>\n

[ValueProviderMenu(\"Hierarchy\/Get Component\",<\/span><\/span> Is.<\/span><\/span>SceneObject), CreateAssetMenu]\r\nclass<\/span> GetComponent\u00a0:<\/span><\/span> ScriptableObject,<\/span> IValueByTypeProvider\r\n{<\/span><\/span>\r\n    public bool<\/span> TryGetFor<<\/span>TValue><\/span>(<\/span>Component client,<\/span> out <\/span>TValue value)<\/span>\r\n    {<\/span><\/span>\r\n        if(client ==<\/span> null)\r\n        {<\/span><\/span>\r\n            value = default;<\/span>\r\n            return false;<\/span>\r\n        }<\/span><\/span>\r\n\r\n        return Find.<\/span>In(<\/span>client.<\/span>gameObject,<\/span> out<\/span> value)<\/span>;<\/span>\r\n    }<\/span><\/span>\r\n}<\/span>\r\n<\/span><\/span><\/pre>\n
Shared Value Provider<\/h2>\n
If you have a value provider class with no serialized fields, and you create a single asset from it somewhere in your project, then all Init arguments for which the menu item is selected, will be assigned a reference to that same single asset.<\/p>\n
[CreateAssetMenu, ValueProviderMenu(\"Shared Value Provider\", typeof(string))]\r\nclass SharedValueProvider : ScriptableObject, IValueProvider<string>\r\n{\r\n    public string Value => \"Value\";\r\n}<\/pre>\n
\"\"<\/p>\n
This can be useful for conserving memory, in cases where only a single value provider is needed.<\/p>\n
Embedded Value Providers<\/h2>\n
If your value provider contains serialized fields, or you have zero, or more than one instances of the value provider class in your project, then each Init argument for which the menu item is selected, will be assigned its own instance of the value provider object.<\/p>\n
[ValueProviderMenu(\"Embedded Value Provider\", typeof(string))]\r\nclass EmbeddedValueProvider : ScriptableObject, IValueProvider<string>\r\n{\r\n    [SerializeField] string value;\r\n    public string Value => value;\r\n}<\/pre>\n
\"\"<\/p>\n
This makes it possible to configure each value provider separately.<\/p>\n
Is Constraints<\/span><\/p>\n
The following Is<\/em> constraints can be applied for the targets of value providers with the ValueProviderMenu attribute:<\/p>\n
Unconstrained<\/h3>\n
No constraints applied to the types of Init parameters targeted.<\/div>\n
Class<\/h3>\n
Shown in dropdown menus of reference type Init parameters.<\/div>\n
ValueType<\/h3>\n
Shown in dropdown menus of struct type Init parameters.<\/div>\n
Concrete<\/h3>\n
Shown in dropdown menus of concrete type Init parameters.<\/div>\n
Abstract<\/h3>\n
Shown in dropdown menus of abstract type Init parameters.<\/div>\n
Interface<\/h3>\n
Shown in dropdown menus of interface type Init parameters.<\/div>\n
BuiltIn<\/h3>\n
Shown in dropdown menus of Init parameters of built-in C# types, such as bool, int, float and string.<\/div>\n
Component<\/h3>\n
\n
Shown in dropdown menus of component type Init parameters.<\/div>\n
<\/div>\n
This includes both all component-derived types, as well as any interface types which are implemented by at least one component-derived type.<\/div>\n<\/div>\n
WrappedObject<\/h3>\n
\n
Shown in dropdown menus of parameters of plain old C# types that have a Wrapper<\/a> class.<\/div>\n<\/div>\n
SceneObject<\/h3>\n
\n
Shown in dropdown menus of Init parameters of types that can exist as part of a scene.<\/div>\n
<\/div>\n
This includes all component-derived types, all plain old C# types that have a Wrapper class, all interface types that are implemented by at least one component-derived type, and the GameObject type.<\/div>\n<\/div>\n
Asset<\/h3>\n
\n
Shown in dropdown menus of Init parameters of types that can exist as a standalone asset, or as part of a prefab.<\/div>\n
<\/div>\n
This includes all Object<\/a>-derived types, all plain old C# types that have a Wrapper class, all interface types that are implemented by at least one Object-derived type, and the GameObject type.<\/div>\n<\/div>\n
Collection<\/h3>\n
\n
Shown in dropdown menus of Init parameters that implement IEnumerable, such as lists<\/a> and arrays<\/a>.<\/div>\n<\/div>\n
Service<\/h3>\n
Shown in dropdown menus of Init parameters whose type is the defining type of a Service (registered using the ServiceAttribute<\/a>).<\/p>\n
Note that you can add multiple constraints to one ValueProviderMenu attribute using the | operator.<\/p><\/blockquote>\n
Type Constraints<\/h2>\n
You can also provide one or more Type arguments in the ValueProviderMenu attribute’s constructor, to constrain it to only appear in the dropdown menus of Init parameters that match those types.<\/p>\n
Not Type Constraints<\/h2>\n
You can also assign a Type to the Not property in the ValueProviderMenu attribute’s constructor, to constrain it to NOT appear in the dropdown menus of Init parameters whose type matches that type.<\/p>\n
If you would like to stop it from appearing in the dropdown menus of more than one types of Init parameters, then you can assign an array of types to the NotAny property instead.<\/p>\n","protected":false},"excerpt":{"rendered":"
The [ValueProviderMenu] attribute can be used to introduce new menu items that will be shown in the dropdown menus for all Init arguments of targeted types. The attribute can be added to a ScriptableObject-derived class that implements IValueProvider<TValue> or IValueByTypeProvider. You can then use the Value property to access the value stored inside the field. ..<\/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":[12],"tags":[],"_links":{"self":[{"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/posts\/422"}],"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=422"}],"version-history":[{"count":15,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/posts\/422\/revisions"}],"predecessor-version":[{"id":607,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/posts\/422\/revisions\/607"}],"wp:attachment":[{"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/media?parent=422"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/categories?post=422"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.sisus.co\/init-args\/wp-json\/wp\/v2\/tags?post=422"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}