KeyboardEventType Class

Localized message formatting class for a Unity keyboard event.

Inheritance Hierarchy

SystemObject
KSPDev.GUIUtils.TypeFormattersKeyboardEventType

Namespace: KSPDev.GUIUtils.TypeFormatters
Assembly: KSPDev_Utils.2.0 (in KSPDev_Utils.2.0.dll) Version: 2.0 for KSP v1.8+

Syntax

Copy

public sealed class KeyboardEventType

Request Example View Source

The KeyboardEventType type exposes the following members.

Constructors

	Name	Description
	KeyboardEventType	Constructs an object from an event.

Top

Methods

	Name	Description
	Format	Formats the value into a human friendly string.
	ToString	Returns a string formatted as a human friendly key specification. (Overrides ObjectToString.)

Top

Operators

	Name	Description
	(Event to KeyboardEventType)	Converts a numeric value into a type object.
	(KeyboardEventType to Event)	Converts a type object into an event value.

Top

Fields

	Name	Description
	value	A wrapped event value.

Top

Remarks

Use it as a generic parameter when creating a LocalizableMessage descendants. Even though the name assumes it's only relevant to keyboard, it is not! A mouse or joystick action can also be a part of a "keyboard event", e.g. Ctrl + LMB.

Examples

Copy

public class KeyboardEventTypeDemo1 : PartModule {
  static readonly Message<KeyboardEventType> msg1 = new Message<KeyboardEventType>(
      "#TypeDemo_msg1", defaultTemplate: "Keybinding is [<<1>>]");

  // Depending on the current language in the system, this method will present different unit names. 
  void Show() {
    Debug.Log(msg1.Format(Event.KeyboardEvent("^1")));
    // Prints: Keybinding is [Ctrl+1]
    Debug.Log(msg1.Format(Event.KeyboardEvent("^[1]")));
    // Prints: Keybinding is [Ctrl+Alpha1]
    Debug.Log(msg1.Format(Event.KeyboardEvent("$^A")));
    // Prints: Keybinding is [Shift+Ctrl+A]
  }
}