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

Script language

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

UnityEvent

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

A zero argument persistent callback that can be saved with the scene.

var m_MyEvent : UnityEvent;

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

m_MyEvent.AddListener (Ping); }

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

function Ping () { Debug.Log ("Ping"); }
using UnityEngine;
using UnityEngine.Events;
using System.Collections;

public class ExampleClass : MonoBehaviour { UnityEvent m_MyEvent;

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

m_MyEvent.AddListener(Ping); }

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

void Ping() { Debug.Log("Ping"); } }

Constructors

UnityEventConstructor.

Public Functions

AddListenerAdd a non persistent listener to the UnityEvent.
InvokeInvoke all registered callbacks (runtime and persistent).
RemoveListenerRemove a non persistent listener from the UnityEvent.

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.