Language: English
  • C#
  • JS
  • Boo

Script language

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

Input.GetKeyDown

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

public static function GetKeyDown(name: string): bool;
public static bool GetKeyDown(string name);
public static def GetKeyDown(name as string) as bool

Description

Returns true during the frame the user starts pressing down the key identified by name.

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 released the key and pressed it again.

For the list of key identifiers see Input Manager. When dealing with input it is recommended to use Input.GetAxis and Input.GetButton instead since it allows end-users to configure the keys.

	function Update () {
		if (Input.GetKeyDown ("space"))
			print ("space key was pressed");
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Update() {
        if (Input.GetKeyDown("space"))
            print("space key was pressed");
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Update() as void:
		if Input.GetKeyDown('space'):
			print('space key was pressed')

public static function GetKeyDown(key: KeyCode): bool;
public static bool GetKeyDown(KeyCode key);
public static def GetKeyDown(key as KeyCode) as bool

Description

Returns true during the frame the user starts pressing down the key identified by the key KeyCode enum parameter.

	function Update () {
		if (Input.GetKeyDown (KeyCode.Space))
			print ("space key was pressed");
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Update() {
        if (Input.GetKeyDown(KeyCode.Space))
            print("space key was pressed");
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Update() as void:
		if Input.GetKeyDown(KeyCode.Space):
			print('space key was pressed')