Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

MonoBehaviour.CancelInvoke

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

Switch to Manual
public function CancelInvoke(): void;
public void CancelInvoke();
public def CancelInvoke() as void

Description

Cancels all Invoke calls on this MonoBehaviour.

	// Starting in 2 seconds.
	// a projectile will be launched every 0.3 seconds
	var projectile : Rigidbody;
	InvokeRepeating("LaunchProjectile", 2, 0.3);

// Cancels the repeating invoke call, // when the user pressed the ctrl button function Update() { if (Input.GetButton ("Fire1")) CancelInvoke(); }

function LaunchProjectile () { instance = Instantiate(projectile); instance.velocity = Random.insideUnitSphere * 5; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Rigidbody projectile;
    void Update() {
        if (Input.GetButton("Fire1"))
            CancelInvoke();
        
    }
    void LaunchProjectile() {
        instance = Instantiate(projectile);
        instance.velocity = Random.insideUnitSphere * 5;
    }
    void Example() {
        InvokeRepeating("LaunchProjectile", 2, 0.3F);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public projectile as Rigidbody

	def Update() as void:
		if Input.GetButton('Fire1'):
			CancelInvoke()

	def LaunchProjectile() as void:
		instance = Instantiate(projectile)
		instance.velocity = (Random.insideUnitSphere * 5)

	def Example() as void:
		InvokeRepeating('LaunchProjectile', 2, 0.3F)

public function CancelInvoke(methodName: string): void;
public void CancelInvoke(string methodName);
public def CancelInvoke(methodName as string) as void

Description

Cancels all Invoke calls with name methodName on this behaviour.

	// Starting in 2 seconds.
	// a projectile will be launched every 0.3 seconds

var projectile : Rigidbody; InvokeRepeating("LaunchProjectile", 2, 0.3);

// Cancels the repeating invoke call, // when the user pressed the ctrl button function Update() { if (Input.GetButton ("Fire1")) CancelInvoke("LaunchProjectile"); }

function LaunchProjectile () { instance = Instantiate(projectile); instance.velocity = Random.insideUnitSphere * 5; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Rigidbody projectile;
    void Update() {
        if (Input.GetButton("Fire1"))
            CancelInvoke("LaunchProjectile");
        
    }
    void LaunchProjectile() {
        instance = Instantiate(projectile);
        instance.velocity = Random.insideUnitSphere * 5;
    }
    void Example() {
        InvokeRepeating("LaunchProjectile", 2, 0.3F);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public projectile as Rigidbody

	def Update() as void:
		if Input.GetButton('Fire1'):
			CancelInvoke('LaunchProjectile')

	def LaunchProjectile() as void:
		instance = Instantiate(projectile)
		instance.velocity = (Random.insideUnitSphere * 5)

	def Example() as void:
		InvokeRepeating('LaunchProjectile', 2, 0.3F)