Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

UnityEvent

Namespace: 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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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.

#pragma strict

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");
}
no example available in C#
no example available in Boo

Constructors

UnityEvent Constructor.

Functions

AddListener Add a non persistent listener to the UnityEvent.
Invoke Invoke all registered callbacks (runtime and peristent).
RemoveListener Remove a non persistent listener from the UnityEvent.

Inherited members

Functions

GetPersistentEventCount Get the number of registered persistent listeners.
GetPersistentMethodName Get the target method name of the listener at index index.
GetPersistentTarget Get the target component of the listener at index index.
RemoveAllListeners Remove all listeners from the event.
SetPersistentListenerState Modify the execution state of a persistent listener.

Static Functions

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