Version: Unity 6 (6000.0)
LanguageEnglish
  • C#
Method group is Obsolete

PropertyCollectionAttribute

class in UnityEngine

/

Inherits from:PropertyAttribute

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Obsolete Derive collection attributes from 'PropertyAttribute' and set its 'applyToCollection' property to 'true'.

Description

Base class to derive custom property attributes for collections from. Use this to create custom attributes for array and list variables in scripts.

A custom attributes can be hooked up with a custom PropertyDrawer class to control how a script variable with that attribute is shown in the Inspector.

using UnityEditor;
using UnityEditor.UIElements;
using UnityEngine;
using UnityEngine.UIElements;

public class Collection : MonoBehaviour { public int before; [GreenCollectionDrawer] public int[] collection; public int after; }

public class GreenCollectionDrawerAttribute : PropertyCollectionAttribute { }

[CustomPropertyDrawer(typeof(GreenCollectionDrawerAttribute))] public class GreenCollectionDrawer : PropertyDrawer { public override VisualElement CreatePropertyGUI(SerializedProperty property) { return new PropertyField(property) { style = { backgroundColor = Color.green } }; } }

Additional resources: PropertyDrawer class.

Inherited Members

Properties

applyToCollectionMakes attribute affect collections instead of their items.
orderOptional field to specify the order that multiple DecorationDrawers should be drawn in.