Show / Hide Table of Contents

Class ModKey

Represents a keybinding that is managed by the mod loader. Keys are defined in the mod manifest.

Properties correspond to properties of the same name in the MKey class. This naming is different to that of the UnityEngine.Input class!

If the modifier is KeyCode.None, the keybinding only considers the trigger.

If the trigger is KeyCode.None, the keybinding is considered to be disabled, and all the properties always return false.

Inheritance
Object
ModKey
Namespace: Modding
Assembly: Assembly-CSharp.dll
Syntax
public class ModKey

Constructors

ModKey()

Declaration
public ModKey()

Properties

IsDown

Whether the key (combination) is currently pressed.

Declaration
public bool IsDown { get; }
Property Value
Type Description
Boolean

IsPressed

Whether the key (combination) was pressed down this frame.

Declaration
public bool IsPressed { get; }
Property Value
Type Description
Boolean

IsReleased

Whether the key (combination) was released this frame.

Declaration
public bool IsReleased { get; }
Property Value
Type Description
Boolean
Back to top Generated by DocFX