Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetKeyDown

Returns true during the frame the user starts pressing down the key identified by the key KeyCode enum parameter.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.InputLegacyModule

GetKeyDown(KeyCode)

Returns true during the frame the user starts pressing down the key identified by the 
key
KeyCode enum parameter.
public static bool GetKeyDown(KeyCode key)

Parameters

key

KeyCode

Returns

Type

Description

bool

Examples

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

GetKeyDown(string)

Returns true during the frame the user starts pressing down the key identified by 
name
.
public static bool GetKeyDown(string name)

Parameters

name

string

Returns

Type

Description

bool

Remarks

Note: This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, use the Input System package. To learn more about input, refer to Input.
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.
When dealing with input it is recommended to use Input.GetAxis and Input.GetButton instead since it allows end-users to configure the keys.

Examples

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