KeyBinding.KeyCommand Class Reference

A base class for key presses and how they map to commands. More...

Inheritance diagram for KeyBinding.KeyCommand:

Public Member Functions
override string	ToString ()
	Format the key press and modifier keys as a combined string.

Public Attributes
bool	alt
	Inspector, Code Set to true if the Alt key needs to be pressed at the same time.
bool	ctrl
	Inspector, Code Set to true if the Ctrl key needs to be pressed at the same time.
KeyCode	key
	Inspector, Code The primary key that triggers the command.
string	name
	Inspector, Code The name of the key press and command.
bool	shift
	Inspector, Code Set to true if the Shift key needs to be pressed at the same time.
bool	win
	Inspector, Code Set to true if the Windows key needs to be pressed at the same time.

Detailed Description

A base class for key presses and how they map to commands.

Member Function Documentation

ToString()

override string ToString

(

)

Format the key press and modifier keys as a combined string.

Returns

The key combination as a string.

For example: "CTRL+SHIFT+A"

Member Data Documentation

alt

bool alt

Inspector, Code
Set to true if the Alt key needs to be pressed at the same time.

ctrl

bool ctrl

Inspector, Code
Set to true if the Ctrl key needs to be pressed at the same time.

key

KeyCode key

Inspector, Code
The primary key that triggers the command.

name

string name

Inspector, Code
The name of the key press and command.

shift

bool shift

Inspector, Code
Set to true if the Shift key needs to be pressed at the same time.

win

bool win

Inspector, Code
Set to true if the Windows key needs to be pressed at the same time.

---

The documentation for this class was generated from the following file:

• C:/Users/cgbrown/Development/git/FAST/FAST-SDK/Runtime/IO/KeyBinding.cs