Class CustomKeyCode
- Namespace
- PAC.KeyboardShortcuts
A class to supersede Unity's KeyCode enum to allow keycodes to refer to multiple keys - e.g. Shift instead of separated into LeftShift and RightShift.
public class CustomKeyCode : IEnumerable- Inheritance
-
CustomKeyCode
- Implements
- Inherited Members
Fields
Alt
public static readonly CustomKeyCode AltField Value
Ctrl
public static readonly CustomKeyCode CtrlField Value
GreaterThan
public static readonly CustomKeyCode GreaterThanField Value
LessThan
public static readonly CustomKeyCode LessThanField Value
Minus
public static readonly CustomKeyCode MinusField Value
Plus
public static readonly CustomKeyCode PlusField Value
Shift
public static readonly CustomKeyCode ShiftField Value
_0
The keycode for 0.
public static readonly CustomKeyCode _0Field Value
_1
The keycode for 1.
public static readonly CustomKeyCode _1Field Value
_2
The keycode for 2.
public static readonly CustomKeyCode _2Field Value
_3
The keycode for 3.
public static readonly CustomKeyCode _3Field Value
_4
The keycode for 4.
public static readonly CustomKeyCode _4Field Value
_5
The keycode for 5.
public static readonly CustomKeyCode _5Field Value
_6
The keycode for 6.
public static readonly CustomKeyCode _6Field Value
_7
The keycode for 7.
public static readonly CustomKeyCode _7Field Value
_8
The keycode for 8.
public static readonly CustomKeyCode _8Field Value
_9
The keycode for 9.
public static readonly CustomKeyCode _9Field Value
allKeyCodes
All Unity KeyCodes and all combined keycodes.
public static readonly CustomKeyCode[] allKeyCodesField Value
alphabet
The keycodes A-Z.
public static readonly CustomKeyCode[] alphabetField Value
combinedKeyCodes
All the defined keycodes that combine multiple Unity KeyCodes.
public static readonly CustomKeyCode[] combinedKeyCodesField Value
digits
The keycodes 0-9.
public static readonly CustomKeyCode[] digitsField Value
Properties
displayName
What will be returned from ToString().
public string displayName { get; }Property Value
keyCodes
The Unity KeyCodes comprising this keycode.
public List<KeyCode> keyCodes { get; }Property Value
- List<KeyCode>
Methods
Contains(KeyCode)
Returns true if the Unity KeyCode forms part of this CustomKeyCode.
public bool Contains(KeyCode keyCode)Parameters
keyCodeKeyCode
Returns
Equals(object)
Determines whether the specified object is equal to the current object.
public override bool Equals(object obj)Parameters
objobjectThe object to compare with the current object.
Returns
FromString(string)
Converts a string into the keycode with that display name. Returns null if there isn't one.
public static CustomKeyCode FromString(string displayName)Parameters
displayNamestring
Returns
GetEnumerator()
Returns an enumerator that iterates through a collection.
public IEnumerator GetEnumerator()Returns
- IEnumerator
An IEnumerator object that can be used to iterate through the collection.
GetHashCode()
Serves as the default hash function.
public override int GetHashCode()Returns
- int
A hash code for the current object.
GetKey()
Returns true while this key is being held down.
public bool GetKey()Returns
GetKeyDown()
Returns true the frame this key is pressed.
public bool GetKeyDown()Returns
GetKeyUp()
Returns true the frame this key is released.
public bool GetKeyUp()Returns
ToString()
Returns a string that represents the current object.
public override string ToString()Returns
- string
A string that represents the current object.
Operators
operator ==(CustomKeyCode, CustomKeyCode)
public static bool operator ==(CustomKeyCode keyCode1, CustomKeyCode keyCode2)Parameters
keyCode1CustomKeyCodekeyCode2CustomKeyCode
Returns
implicit operator CustomKeyCode(KeyCode)
public static implicit operator CustomKeyCode(KeyCode keyCode)Parameters
keyCodeKeyCode
Returns
operator !=(CustomKeyCode, CustomKeyCode)
public static bool operator !=(CustomKeyCode keyCode1, CustomKeyCode keyCode2)Parameters
keyCode1CustomKeyCodekeyCode2CustomKeyCode