s&box docs
API ReferenceEditor

KeyEventclass

Information about a `Editor.Widget`s keyboard event.

object→KeyEvent
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public sealed struct Editor.KeyEvent

Methods1

Showing 1 methods

public string GetButtonCodeName()PUBLIC

Returns:string—

Properties11

Showing 11 properties

public bool Editor.KeyEvent.Accepted { get; set; }PUBLICGETSET

Returns:bool—

public bool Editor.KeyEvent.HasAlt { get; set; }PUBLICGETSET

Returns:bool—

public bool Editor.KeyEvent.HasCtrl { get; set; }PUBLICGETSET

Returns:bool—

public bool Editor.KeyEvent.HasShift { get; set; }PUBLICGETSET

Returns:bool—

public bool Editor.KeyEvent.IsAutoRepeat { get; set; }PUBLICGETSET

Whether this key event was generated by keyboard auto-repeat.

Returns:bool—

public Editor.KeyCode Editor.KeyEvent.Key { get; set; }PUBLICGETSET

The key that triggered this event.

Returns:KeyCode—

public string Editor.KeyEvent.Name { get; set; }PUBLICGETSET

The name of the key that triggered this event.

Returns:string—

public uint Editor.KeyEvent.NativeKeyCode { get; set; }PUBLICGETSET

OS specific key code that triggered this event.

Returns:uint—

public uint Editor.KeyEvent.NativeScanCode { get; set; }PUBLICGETSET

The native scan code.

Returns:uint—

public string Editor.KeyEvent.Text { get; set; }PUBLICGETSET

Text the `Editor.KeyEvent.Key` would type in a text field.

Returns:string—

KeyCode

Previous Page

Accepted

Next Page

On this page

Methodspublic System.String GetButtonCodeName()Propertiespublic System.Boolean Editor.KeyEvent.Accepted { get; set; }public System.Boolean Editor.KeyEvent.HasAlt { get; set; }public System.Boolean Editor.KeyEvent.HasCtrl { get; set; }public System.Boolean Editor.KeyEvent.HasShift { get; set; }public System.Boolean Editor.KeyEvent.IsAutoRepeat { get; set; }public Editor.KeyCode Editor.KeyEvent.Key { get; set; }public Sandbox.KeyboardModifiers Editor.KeyEvent.KeyboardModifiers { get; set; }public System.String Editor.KeyEvent.Name { get; set; }public System.UInt32 Editor.KeyEvent.NativeKeyCode { get; set; }public System.UInt32 Editor.KeyEvent.NativeScanCode { get; set; }public System.String Editor.KeyEvent.Text { get; set; }Metadata