Class RuleCreatorAttribute

This attribute is used to tag methods that associate IComponentRuleCreator instances with component types. Unity automatically tracks the registered component types in the opened scenes, when a component has the same type (or is a derived class) the associated CreateRules(Component, List<BuildValidationRule>) instance method is invoked.

Inheritance

Object

Attribute

RuleCreatorAttribute

Inherited Members

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, Boolean)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, Boolean)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, Boolean)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, Boolean)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean)

Attribute.GetCustomAttributes(ParameterInfo, Boolean)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, Boolean)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, Boolean)

Attribute.GetCustomAttributes(Module, Type, Boolean)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, Boolean)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, Boolean)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, Boolean)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, Boolean)

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, Boolean)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, Boolean)

Attribute.Equals(Object)

Attribute.GetHashCode()

Attribute.Match(Object)

Attribute.IsDefaultAttribute()

Attribute._Attribute.GetTypeInfoCount(UInt32)

Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Attribute.TypeId

Object.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEditor.PolySpatial.Validation

Syntax

[AttributeUsage(AttributeTargets.Method)]
public class RuleCreatorAttribute : Attribute, _Attribute

Remarks

The tagged method should have the following signature: <code>static void Method(List<ValueTuple<Type, IComponentRuleCreator>> ruleCreators)</code>
The rule creators are registered in the same order as they are added in the

ruleCreators

list parameter. It's possible to associate a component type with a null IComponentRuleCreator, in this case no validation will be performed for the component type. This is useful to override validations for derived types.

Examples

public class MyInvalidComponent : MonoBehaviour
{ }

public class MyValidDerivedComponent : MyInvalidComponent
{ }

public class MyRuleCreatorManager
{
    [RuleCreatorAttribute]
    public static void RegisterRuleCreators(List<ValueTuple<Type, IComponentRuleCreator>> ruleCreators)
    {
        // no validation will be performed for MyValidDerivedComponent
        ruleCreators.Add(new(typeof(MyValidDerivedComponent), null));
        ruleCreators.Add(new(typeof(MyInvalidComponent), new UnsupportedComponentsRule(PolySpatialSceneType.Volume, PolySpatialSceneType.MR, PolySpatialSceneType.VR)));
    }
}

Constructors

RuleCreatorAttribute(Int32)

The attribute constructor.

Declaration

public RuleCreatorAttribute(int priority = 0)

Parameters

Type	Name	Description
Int32	priority	An optional priority value to define the order to register the rule creators. High values are registered later, the default value is `0` .