Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

UnityEvent<T0>

class in UnityEngine.Events

/

Inherits from:Events.UnityEventBase

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.

If you wish to use a generic UnityEvent type you must override the class type.

#pragma strict

class MyIntEvent extends UnityEvent.<int> {}

var m_MyEvent : MyIntEvent;

function Start () { if (m_MyEvent == null) m_MyEvent = new MyIntEvent ();

m_MyEvent.AddListener (Ping); }

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

function Ping (i: int) { Debug.Log ("Ping" + i); }
using UnityEngine;
using UnityEngine.Events;

[System.Serializable] public class MyIntEvent : UnityEvent<int> { }

public class ExampleClass : MonoBehaviour { public MyIntEvent m_MyEvent;

void Start() { if (m_MyEvent == null) m_MyEvent = new MyIntEvent();

m_MyEvent.AddListener(Ping); }

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

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

Inherited members

Public Functions

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

Static Functions

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