Class EventHelper

Namespace

S1API.Internal.Abstraction

Assembly

S1API.dll

This static class provides us an easy wrapper for subscribing and unsubscribing unity actions.

public static class EventHelper

Inheritance

object

EventHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

AddEventTrigger(EventTrigger, EventTriggerType, Action)

Adds an EventTrigger entry in a cross-compatible manner. Use this from Mono mods so IL2CPP handles the actual Entry construction.

public static void AddEventTrigger(EventTrigger trigger, EventTriggerType eventType, Action listener)

Parameters

trigger EventTrigger

Target EventTrigger component.

eventType EventTriggerType

The EventTriggerType to subscribe to.

listener Action

Callback invoked when the event fires.

AddEventTrigger(EventTrigger, EventTriggerType, Action<BaseEventData>)

Adds an EventTrigger entry with access to BaseEventData.

public static void AddEventTrigger(EventTrigger trigger, EventTriggerType eventType, Action<BaseEventData> listener)

Parameters

trigger EventTrigger

Target EventTrigger component.

eventType EventTriggerType

The EventTriggerType to subscribe to.

listener Action<BaseEventData>

Callback invoked with BaseEventData when the event fires.

AddListener(Action, UnityEvent)

Adds a listener to the event, as well as the subscription list.

public static void AddListener(Action listener, UnityEvent unityEvent)

Parameters

listener Action

The action / method you want to subscribe.

unityEvent UnityEvent

The event you want to subscribe to.

AddListener<T>(Action<T>, UnityEvent<T>)

public static void AddListener<T>(Action<T> listener, UnityEvent<T> unityEvent)

Parameters

listener Action<T>

unityEvent UnityEvent<T>

Type Parameters

T

RemoveEventTrigger(EventTrigger, EventTriggerType, Action<BaseEventData>)

Removes an EventTrigger entry from the trigger.

public static void RemoveEventTrigger(EventTrigger trigger, EventTriggerType eventType, Action<BaseEventData> listener)

Parameters

trigger EventTrigger

Target EventTrigger component

eventType EventTriggerType

The EventTriggerType to remove

listener Action<BaseEventData>

BaseEventData callback to remove from the trigger

RemoveListener(Action, UnityEvent)

Removes a listener to the event, as well as the subscription list.

public static void RemoveListener(Action listener, UnityEvent unityEvent)

Parameters

listener Action

The action / method you want to unsubscribe.

unityEvent UnityEvent

The event you want to unsubscribe from.

RemoveListener<T>(Action<T>, UnityEvent<T>)

public static void RemoveListener<T>(Action<T> listener, UnityEvent<T> unityEvent)

Parameters

listener Action<T>

unityEvent UnityEvent<T>

Type Parameters

T