Version: 2021.3
LanguageEnglish
  • C#

Event.KeyboardEvent

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 Event KeyboardEvent(string key);

Parameters

key A string representing keyboard keys and modifiers.

Returns

Event A new Event with EventType.KeyDown and the requested KeyCode and optional EventModifier.

Description

Create a keyboard event.

This is useful when you need to check if a certain key has been pressed - possibly with modifiers. The syntax for the key string is a key name (same as in the Input Manager), optionally prefixed by any number of modifiers:
& = Alternate, ^ = Control, % = Command/Windows key, # = Shift
Examples: &f12 = Alternate + F12, "^[0]" = Control + keypad0 .


See the Input Manager manual page for more information on key names.

using UnityEngine;

public class Example : MonoBehaviour { // Detects if the Enter key was pressed void OnGUI() { GUILayout.Label("Press Enter To Start Game");

if (Event.current.Equals(Event.KeyboardEvent("[enter]"))) { Application.LoadLevel(1); }

if (Event.current.Equals(Event.KeyboardEvent("return"))) { Debug.Log("I said enter, not return - try the keypad"); } } }