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.

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

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

public function CancelInvoke(): void;
public void CancelInvoke();

Description

Cancels all Invoke calls on this MonoBehaviour.

#pragma strict
public class ExampleScript extends MonoBehaviour {
	public var projectile: GameObject;
	function Start() {
		// Starting in 2 seconds, a projectile will be launched every 0.3 seconds
		InvokeRepeating("LaunchProjectile", 2, 0.3F);
	}
	function LaunchProjectile() {
		// Create a projectile GameObject and set its velocity to a random direction
		var instance: GameObject = Instantiate(projectile);
		var rigidbody: Rigidbody = instance.GetComponent.<Rigidbody>();
		rigidbody.velocity = Random.insideUnitSphere * 5;
	}
	function Update() {
		// Cancel all Invoke calls
		if (Input.GetButton("Fire1"))
			CancelInvoke();
	}
}
using UnityEngine;
using System.Collections.Generic;

public class ExampleScript : MonoBehaviour { public GameObject projectile;

void Start() { // Starting in 2 seconds, a projectile will be launched every 0.3 seconds InvokeRepeating("LaunchProjectile", 2, 0.3F); }

void LaunchProjectile() { // Create a projectile GameObject and set its velocity to a random direction GameObject instance = Instantiate(projectile); Rigidbody rigidbody = instance.GetComponent<Rigidbody>();

rigidbody.velocity = Random.insideUnitSphere * 5; }

void Update() { // Cancel all Invoke calls if (Input.GetButton("Fire1")) CancelInvoke(); } }

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

Description

Cancels all Invoke calls with name methodName on this behaviour.

#pragma strict
public class ExampleScript extends MonoBehaviour {
	public var projectile: GameObject;
	function Start() {
		// Starting in 2 seconds, a projectile will be launched every 0.3 seconds
		InvokeRepeating("LaunchProjectile", 2, 0.3F);
	}
	function LaunchProjectile() {
		// Create a projectile GameObject and set its velocity to a random direction
		var instance: GameObject = Instantiate(projectile);
		var rigidbody: Rigidbody = instance.GetComponent.<Rigidbody>();
		rigidbody.velocity = Random.insideUnitSphere * 5;
	}
	function Update() {
		// Cancel only the LaunchProjectile invoke
		if (Input.GetButton("Fire1"))
			CancelInvoke("LaunchProjectile");
	}
}
using UnityEngine;
using System.Collections.Generic;

public class ExampleScript : MonoBehaviour { public GameObject projectile;

void Start() { // Starting in 2 seconds, a projectile will be launched every 0.3 seconds InvokeRepeating("LaunchProjectile", 2, 0.3F); }

void LaunchProjectile() { // Create a projectile GameObject and set its velocity to a random direction GameObject instance = Instantiate(projectile); Rigidbody rigidbody = instance.GetComponent<Rigidbody>();

rigidbody.velocity = Random.insideUnitSphere * 5; }

void Update() { // Cancel only the LaunchProjectile invoke if (Input.GetButton("Fire1")) CancelInvoke("LaunchProjectile"); } }