Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

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

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

public static method KeyboardEvent(key: string): Event;
public static Event KeyboardEvent(string key);

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 .

function 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")))
        print ("I said enter, not return - try the keypad");
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { 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"))) print("I said enter, not return - try the keypad"); } }

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