Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

Input.GetKey

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

Declaration

public static bool GetKey(string name);

Description

Returns true while the user holds down the key identified by name.

Note: This API is part of the legacy Input class, and not recommended for new projects. The documentation is provided here to support legacy projects that use the old Input Manager and Input class. For new projects you should use the newer and Input System Package. (read more).

GetKey will report the status of the named key. This might be used to confirm a key is used for auto fire. 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.

iOS, tvOS: Due platform limitations, GetKeyUp event for keyboard events is delayed by about half a second, see UnityView+Keyboard.mm in the generated Xcode project for more information.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Update() { if (Input.GetKey("up")) { print("up arrow key is held down"); }

if (Input.GetKey("down")) { print("down arrow key is held down"); } } }

Declaration

public static bool GetKey(KeyCode key);

Description

Returns true while the user holds down the key identified by the key KeyCode enum parameter.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Update() { if (Input.GetKey(KeyCode.UpArrow)) { print("up arrow key is held down"); }

if (Input.GetKey(KeyCode.DownArrow)) { print("down arrow key is held down"); } } }