Class EventHelper

Namespace

S1API.Utils

Assembly

S1API.dll

Provides cross-runtime helpers for subscribing to and unsubscribing from Unity events.

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 event-trigger entry whose callback does not need the event data.

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

Parameters

trigger EventTrigger

The target event-trigger component.

eventType EventTriggerType

The event type to subscribe to.

listener Action

The callback invoked when the event fires.

AddEventTrigger(EventTrigger, EventTriggerType, Action<BaseEventData>)

Adds an event-trigger entry whose callback receives the event data.

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

Parameters

trigger EventTrigger

The target event-trigger component.

eventType EventTriggerType

The event type to subscribe to.

listener Action<BaseEventData>

The callback invoked with the event data.

AddListener(Action, UnityEvent)

Adds a listener to a Unity event in a Mono and IL2CPP compatible manner.

public static void AddListener(Action listener, UnityEvent unityEvent)

Parameters

listener Action

The callback to subscribe.

unityEvent UnityEvent

The Unity event to subscribe to.

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

Adds a listener to a generic Unity event in a Mono and IL2CPP compatible manner.

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

Parameters

listener Action<T>

The callback to subscribe.

unityEvent UnityEvent<T>

The Unity event to subscribe to.

Type Parameters

T

The event argument type.

RemoveEventTrigger(EventTrigger, EventTriggerType, Action<BaseEventData>)

Removes a matching event-trigger entry and its callback.

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

Parameters

trigger EventTrigger

The target event-trigger component.

eventType EventTriggerType

The event type to remove.

listener Action<BaseEventData>

The callback previously supplied when adding the entry.

RemoveListener(Action, UnityEvent)

Removes a listener previously added with AddListener(Action, UnityEvent).

public static void RemoveListener(Action listener, UnityEvent unityEvent)

Parameters

listener Action

The callback to unsubscribe.

unityEvent UnityEvent

The Unity event to unsubscribe from.

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

Removes a listener previously added with AddListener<T>(Action<T>, UnityEvent<T>).

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

Parameters

listener Action<T>

The callback to unsubscribe.

unityEvent UnityEvent<T>

The Unity event to unsubscribe from.

Type Parameters

T

The event argument type.