키보드 이벤트

키보드 이벤트는 키보드 키를 누르거나 놓을 때 발생합니다. 각 이벤트에는 해당 이벤트에 대한 수정자, 텍스트 문자, 관련 키 코드에 대한 정보가 포함되어 있습니다.

많은 표준 컨트롤은 KeyDownEvent를 사용하여 단축키 또는 접근성 동작을 인코딩합니다. 다음 예는 모두 키보드 이벤트를 사용합니다.

• Toggle 및 Button 클래스는 마우스 클릭에 대한 대체 동작으로 Enter 및 Spacebar 키 누름을 수신합니다.
• ScrollView 및 Slider 컨트롤은 방향 화살표 키 누름을 사용하여 값을 조정합니다.
• TextField 컨트롤은 keyCode 프로퍼티와 문자 프로퍼티를 모두 확인하여 특수 동작을 실행하거나 텍스트를 수락합니다.

모든 키보드 이벤트의 기본 클래스는 KeyboardEventBase입니다.

고유한 프로퍼티

keyCode: keyCode 프로퍼티는 키보드나 조이스틱 같은 입력 기기의 물리적 키에 직접 대응하는 문자 키를 반환합니다. character 프로퍼티와 keyCode 프로퍼티의 차이점은 keyCode는 물리적 키를 나타내고 character는 특정 문자의 입력을 나타낸다는 것입니다. 예를 들어 a와 A는 모두 keyDownEvent 동안 keyCode=KeyCode.A를 반환합니다.

character: character 프로퍼티는 keyDownEvent 동안 문자 코드를 반환합니다.

modifiers: modifiers 프로퍼티는 누르고 있는 수정 키를 반환합니다. 수정 키의 몇 가지 예로는 Shift, Ctrl 또는 Alt 키가 있습니다.

자세한 내용은 MDN 문서의 수정 키 섹션을 참조하십시오.

이벤트 리스트

다음 리스트는 이벤트 패밀리에 있는 각 이벤트의 이름, 설명 및 타겟을 제공합니다. 이벤트에 대한 자세한 내용은 UI 툴킷 API를 참조하십시오.

KeyDownEvent

KeyDownEvent는 키보드 키를 누를 때마다 전송됩니다. 누른 키에는 해당 이벤트에 대한 keyCode 프로퍼티가 포함되어 있습니다. 해당 키 누름에 연결된 텍스트 입력이 있는 경우 텍스트 입력의 각 문자에 대해 추가 이벤트가 전송됩니다. character 프로퍼티에는 해당 이벤트에 대한 문자가 포함됩니다.

a를 누르거나 놓으면 UI 툴킷이 다음 이벤트를 전송합니다.

KeyDownEvent { keyCode=KeyCode.A }
KeyDownEvent { character=’a’ }
KeyUpEvent { keyCode=KeyCode.A }

Ctrl+a를 누르거나 놓으면 UI 툴킷이 다음 이벤트를 전송합니다.

KeyDownEvent { keyCode=KeyCode.LeftControl, modifiers=EventModifiers.Control }
KeyDownEvent { keyCode=KeyCode.A, modifiers=EventModifiers.Control }
KeyUpEvent { keyCode=KeyCode.A, modifiers=EventModifiers.Control }
KeyUpEvent { keyCode=KeyCode.LeftControl }

target: 포커스가 있는 시각적 요소입니다. 포커스가 있는 요소가 없는 경우에는 패널의 루트 시각적 요소입니다.

KeyUpEvent

KeyUpEvent는 키보드 키를 놓을 때 전송됩니다. 해당 이벤트에 대한 keyCode 프로퍼티에는 놓는 키가 포함되어 있습니다. KeyDownEvent에는 키 입력에 연결된 텍스트 입력이 있을 때 전송되는 추가 이벤트가 있습니다.

a를 누르거나 놓으면 UI 툴킷이 다음 이벤트를 전송합니다.

KeyDownEvent { keyCode=KeyCode.A }
KeyDownEvent { character=’a’ }
KeyUpEvent { keyCode=KeyCode.A }

Ctrl+a를 누르거나 놓으면 UI 툴킷이 다음 이벤트를 전송합니다.

KeyDownEvent { keyCode=KeyCode.LeftControl, modifiers=EventModifiers.Control }
KeyDownEvent { keyCode=KeyCode.A, modifiers=EventModifiers.Control }
KeyUpEvent { keyCode=KeyCode.A, modifiers=EventModifiers.Control }
KeyUpEvent { keyCode=KeyCode.LeftControl }

target: 포커스가 있는 시각적 요소입니다. 포커스가 있는 요소가 없는 경우에는 패널의 루트 시각적 요소입니다.

예제

다음 코드 예제에서는 사용자가 TextField에서 키를 누를 때 콘솔에 메시지를 출력합니다. 이 코드 샘플은 KeyUpEvent 및 KeyDownEvent 모두의 이벤트 발생을 강조 표시합니다.

예제가 동작하는 방식을 확인하려면 다음 단계를 따르십시오.

1. 유효한 UIDocument를 사용하여 게임 오브젝트를 만듭니다.
2. Assets > Scripts에서 KeyboardEventTest라는 C# 스크립트를 작성합니다.
3. 예제를 복사하여 C# 스크립트에 붙여넣습니다.
4. UIDocument를 사용하여 KeyboardEventTest 스크립트를 게임 오브젝트에 연결합니다.
5. 플레이 모드를 시작하고 TextField에 입력합니다.

using UnityEngine;
using UnityEngine.UIElements;

// Add KeyboardEventTest to a GameObject with a valid UIDocument.
// When the user presses a key, it will print the keyboard event properties to the console.
[RequireComponent(typeof(UIDocument))]
public class KeyboardEventTest : MonoBehaviour
{
    void OnEnable()
    {
        var root = GetComponent<UIDocument>().rootVisualElement;
        root.Add(new Label("Press any key to see the keyDown properties"));
        root.Add(new TextField());
        root.Q<TextField>().Focus();
        root.RegisterCallback<KeyDownEvent>(OnKeyDown, TrickleDown.TrickleDown);
        root.RegisterCallback<KeyUpEvent>(OnKeyUp, TrickleDown.TrickleDown);
    }
    void OnKeyDown(KeyDownEvent ev)
    {
        Debug.Log("KeyDown:" + ev.keyCode);
        Debug.Log("KeyDown:" + ev.character);
        Debug.Log("KeyDown:" + ev.modifiers);
    }

    void OnKeyUp(KeyUpEvent ev)
    {
        Debug.Log("KeyUp:" + ev.keyCode);
        Debug.Log("KeyUp:" + ev.character);
        Debug.Log("KeyUp:" + ev.modifiers);
    }
}