Class SubscribeAttribute

Namespace: Void.Proxy.Api.Events
Assembly: Void.Proxy.Api.dll

Attribute to mark a method as an event listener.

[AttributeUsage(AttributeTargets.Method)]
public class SubscribeAttribute : Attribute

Inheritance

object ← Attribute ← SubscribeAttribute

Inherited Members

Attribute.Equals(object?), Attribute.GetCustomAttribute(Assembly, Type), Attribute.GetCustomAttribute(Assembly, Type, bool), Attribute.GetCustomAttribute(MemberInfo, Type), Attribute.GetCustomAttribute(MemberInfo, Type, bool), Attribute.GetCustomAttribute(Module, Type), Attribute.GetCustomAttribute(Module, Type, bool), Attribute.GetCustomAttribute(ParameterInfo, Type), Attribute.GetCustomAttribute(ParameterInfo, Type, bool), Attribute.GetCustomAttributes(Assembly), Attribute.GetCustomAttributes(Assembly, bool), Attribute.GetCustomAttributes(Assembly, Type), Attribute.GetCustomAttributes(Assembly, Type, bool), Attribute.GetCustomAttributes(MemberInfo), Attribute.GetCustomAttributes(MemberInfo, bool), Attribute.GetCustomAttributes(MemberInfo, Type), Attribute.GetCustomAttributes(MemberInfo, Type, bool), Attribute.GetCustomAttributes(Module), Attribute.GetCustomAttributes(Module, bool), Attribute.GetCustomAttributes(Module, Type), Attribute.GetCustomAttributes(Module, Type, bool), Attribute.GetCustomAttributes(ParameterInfo), Attribute.GetCustomAttributes(ParameterInfo, bool), Attribute.GetCustomAttributes(ParameterInfo, Type), Attribute.GetCustomAttributes(ParameterInfo, Type, bool), Attribute.GetHashCode(), Attribute.IsDefaultAttribute(), Attribute.IsDefined(Assembly, Type), Attribute.IsDefined(Assembly, Type, bool), Attribute.IsDefined(MemberInfo, Type), Attribute.IsDefined(MemberInfo, Type, bool), Attribute.IsDefined(Module, Type), Attribute.IsDefined(Module, Type, bool), Attribute.IsDefined(ParameterInfo, Type), Attribute.IsDefined(ParameterInfo, Type, bool), Attribute.Match(object?), Attribute.TypeId, object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

SubscribeAttribute(PostOrder, bool)

Attribute to mark a method as an event listener.

public SubscribeAttribute(PostOrder order = PostOrder.Normal, bool bypassScopedFilter = false)

Parameters

order PostOrder

Specifies the order in which the event should be processed.

bypassScopedFilter bool

Indicates if this event should be triggered by all players, not only scoped one.

Properties

BypassScopedFilter

Gets whether player-scope filtering is disabled for the annotated handler.

public bool BypassScopedFilter { get; }

Property Value

Order

Gets the priority used to order the annotated handler relative to other handlers.

public PostOrder Order { get; }

Property Value

Methods

SanityChecks(MethodInfo)

Validates that a subscribed method has a supported event-handler signature.

public static void SanityChecks(MethodInfo methodInfo)

Parameters

methodInfo MethodInfo

The subscribed method to validate.

Exceptions

ArgumentException

The method does not have one or two parameters, its first parameter does not implement , or its optional second parameter is not a .