Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


KeyboardEvent(string)

Create a keyboard event.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.UICommonModule
public static Event KeyboardEvent(string key)

Parameters

A string representing keyboard keys and modifiers.

Returns

Type

Description

EventA new Event with EventType.KeyDown and the requested KeyCode and optional EventModifiers.

Remarks

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.

Examples

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"); } }}