Skip to content

Class KeybindExtensions

Definition

Namespace: StardewUI.Widgets.Keybinding
Assembly: StardewUI.dll

Extensions for SMAPI's keybind types.

public static class KeybindExtensions

Inheritance
Object ⇦ KeybindExtensions

Members

Methods

Name Description
KeybindEquals(Keybind, Keybind) Checks if two keybind instances are equal.
KeybindEquals(KeybindList, KeybindList) Checks if two keybind lists are equal.

Details

Methods

KeybindEquals(Keybind, Keybind)

Checks if two keybind instances are equal.

public static bool KeybindEquals(StardewModdingAPI.Utilities.Keybind keybind, StardewModdingAPI.Utilities.Keybind other);
Parameters

keybind   Keybind
The first keybind to compare.

other   Keybind
The second keybind to compare.

Returns

Boolean

true if keybind has the same Buttons as other and in the same order, otherwise false.

Remarks

The comparison is order-sensitive; two keybinds with the same buttons in a different order are considered to be unequal to each other.


KeybindEquals(KeybindList, KeybindList)

Checks if two keybind lists are equal.

public static bool KeybindEquals(StardewModdingAPI.Utilities.KeybindList keybindList, StardewModdingAPI.Utilities.KeybindList other);
Parameters

keybindList   KeybindList
The first keybind list to compare.

other   KeybindList
The second keybind list to compare.

Returns

Boolean

true if both keybindList and other contain the exact same keybinds in the same order, otherwise false.

Remarks

The comparison is order-sensitive; two keybind lists with the same keybinds in a different order, or with any two keybinds having keys in a different order