Version: 2018.3 (switch to 2019.1a or 2017.4)
LanguageEnglish
  • C#

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

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 static bool GetKeyDown(string name);

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 Conventional Game Input. When dealing with input it is recommended to use Input.GetAxis and Input.GetButton instead since it allows end-users to configure the keys.

using UnityEngine;
using System.Collections;

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

public static bool GetKeyDown(KeyCode key);

Description

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

using UnityEngine;
using System.Collections;

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

Did you find this page useful? Please give it a rating: