Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

UnityEvent<T0>

class in UnityEngine.Events

/

Inherits from:Events.UnityEventBase

/

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

Description

One argument version of UnityEvent.

Generics are supported, specify a type parameter on initialization as shown in the example. Refer to Configure callbacks in the Inspector for details on configuring callbacks in the Inspector window.

using UnityEngine;
using UnityEngine.Events;

public class ExampleClass : MonoBehaviour { public UnityEvent<int> m_MyEvent;

void Start() { if (m_MyEvent == null) m_MyEvent = new UnityEvent<int>();

m_MyEvent.AddListener(Ping); }

void Update() { if (Input.anyKeyDown && m_MyEvent != null) { m_MyEvent.Invoke(5); } }

void Ping(int i) { Debug.Log("Ping" + i); } }

Note: UnityEvent can also be awaited in any async method.

Inherited Members

Public Methods

GetPersistentEventCountGet the number of registered persistent listeners.
GetPersistentListenerStateReturns the execution state of a persistent listener.
GetPersistentMethodNameGet the target method name of the listener at index index.
GetPersistentTargetGet the target component of the listener at index index.
RemoveAllListenersRemove all non-persistent (ie created from script) listeners from the event.
SetPersistentListenerStateModify the execution state of a persistent listener.

Static Methods

GetValidMethodInfoGiven an object, function name, and a list of argument types; find the method that matches.