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.
CloseFor 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.
Closecall | The callback function to remove. |
Removes a runtime listener from the UnityEvent.
This method removes all occurrences of the specified listener from the UnityEvent. If you have added the same listener multiple times, this method will remove all occurrences of it. Use this to clean up listeners and avoid unintended callbacks.
//Attach this script to a GameObject //This script creates a UnityEvent that calls a method when a key is pressed //Note that 'q' exits this application. using UnityEngine; using UnityEngine.Events;
public class Example : MonoBehaviour { UnityEvent m_MyEvent = new UnityEvent();
void Start() { //Add a listener to the new Event. Calls OnKeyPressed method when invoked m_MyEvent.AddListener(OnKeyPressed); }
void Update() { // Press Q to close the Listener if (Input.GetKeyDown("q") && m_MyEvent != null) { Debug.Log("Quitting"); //Remove the OnKeyPressed callback from the UnityEvent. m_MyEvent.RemoveListener(OnKeyPressed);
#if UNITY_EDITOR UnityEditor.EditorApplication.isPlaying = false; #endif
Application.Quit(); }
//Press any other key to begin the action if the Event exists if (Input.anyKeyDown && m_MyEvent != null) { //Begin the action m_MyEvent.Invoke(); } }
void OnKeyPressed() { //Output message to the console Debug.Log("Q key pressed"); } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.