Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Input.GetButtonUp

static function GetButtonUp(buttonName: string): bool;
static bool GetButtonUp(string buttonName);
static def GetButtonUp(buttonName as string) as bool

Description

Returns true the first frame the user releases the virtual button identified by buttonName.

You need to call this function from the Update function, since the state gets reset each frame. It will not return true until the user has pressed the button and released it again.

Use this only when implementing action like events IE: shooting a weapon.
Use Input.GetAxis for any kind of movement behaviour.

	// Instantiates a projectile whenever the user hits the Fire1 Button.

var projectile : GameObject; function Update () { if (Input.GetButtonUp ("Fire1")) { Instantiate (projectile, transform.position, transform.rotation); } }

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public GameObject projectile;
    void Update() {
        if (Input.GetButtonUp("Fire1"))
            Instantiate(projectile, transform.position, transform.rotation) as GameObject;
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public projectile as GameObject

	def Update() as void:
		if Input.GetButtonUp('Fire1'):
			(Instantiate(projectile, transform.position, transform.rotation) as GameObject)