Class ButtonConfig

Configuration class for adding custom inputs and custom key hints.
See for more information on Unity Input handling.
Inheritance
System.Object
ButtonConfig
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Jotunn.Configs
Assembly: Jotunn.dll
Syntax
public class ButtonConfig

Properties

| Improve this Doc View Source

ActiveInCustomGUI

Should this button react on key presses when a custom GUI is open and requested to block input? Defaults to false.
Declaration
public bool ActiveInCustomGUI { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ActiveInGUI

Should this button react on key presses when a Valheim GUI is open? Defaults to false.
Declaration
public bool ActiveInGUI { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Axis

Axis string this config should be bound to.
Use special Axis "Mouse ScrollWheel" to display the scroll icon as the key hint.
Declaration
public string Axis { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

BlockOtherInputs

Should this button block all other inputs using the same key or button? Defaults to false.
Warning: If set to true, all other input using the same key or axis is reset when queried via ZInput. Make sure to gate your usage properly.
Declaration
public bool BlockOtherInputs { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Config

BepInEx configuration entry of a KeyCode that should be used. Overrides the Key value of this config.
Declaration
public ConfigEntry<KeyCode> Config { get; set; }
Property Value
Type Description
ConfigEntry<KeyCode>
| Improve this Doc View Source

GamepadButton

GamepadButton this config should be bound to for gamepads.
Declaration
public InputManager.GamepadButton GamepadButton { get; set; }
Property Value
Type Description
InputManager.GamepadButton
| Improve this Doc View Source

GamepadConfig

BepInEx configuration entry of a GamepadButton that should be used. Overrides the GamepadButton value of this config.
Declaration
public ConfigEntry<InputManager.GamepadButton> GamepadConfig { get; set; }
Property Value
Type Description
ConfigEntry<InputManager.GamepadButton>
| Improve this Doc View Source

HintToken

Token for translating the key hint text.
Declaration
public string HintToken { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Inverted

Should the Axis value be inverted?
Declaration
public bool Inverted { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Key

Unity KeyCode this config should be bound to.
Declaration
public KeyCode Key { get; set; }
Property Value
Type Description
KeyCode
| Improve this Doc View Source

Name

Name of the config. Use this to react to the button press bound by this config.
Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RepeatDelay

Delay until a constantly pressed key is considered "pressed" again.
Declaration
public float RepeatDelay { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RepeatInterval

Interval in which the check timer for the repeat delay is decremented.
Declaration
public float RepeatInterval { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Shortcut

BepInEx KeyboardShortcut this config should be bound to.
Declaration
public KeyboardShortcut Shortcut { get; set; }
Property Value
Type Description
KeyboardShortcut
| Improve this Doc View Source

ShortcutConfig

BepInEx configuration entry of a KeyCode that should be used. Overrides the Shortcut value of this config.
Declaration
public ConfigEntry<KeyboardShortcut> ShortcutConfig { get; set; }
Property Value
Type Description
ConfigEntry<KeyboardShortcut>

Extension Methods