Registered Keybinding actions
A mapping of a string key to possible Actions that might execute off it
A stored cache of Keybind Actions Ids to Bindings
An alias of the movement key set tracked by the keyboard
Internal
Register core keybindings.
The active game view
Get the current Bindings of a given namespace's Keybinding Action
The namespace under which the setting is registered
The keybind action to retrieve
Initializes the keybinding values for all registered actions
Register a new keybinding
The namespace the Keybinding Action belongs to
A unique machine-readable id for the Keybinding Action
Configuration for keybinding data
game.keybindings.register("myModule", "showNotification", {
name: "My Settings Keybinding",
hint: "A description of what will occur when the Keybinding is executed.",
uneditable: [
{
key: "Digit1",
modifiers: ["Control"]
}
],
editable: [
{
key: "F1"
}
],
onDown: () => { ui.notifications.info("Pressed!") },
onUp: () => {},
restricted: true, // Restrict this Keybinding to gamemaster only?
reservedModifiers: ["Alt"], // On ALT, the notification is permanent instead of temporary
precedence: CONST.KEYBINDING_PRECEDENCE.NORMAL
});
Reset all client keybindings back to their default configuration.
Set the editable Bindings of a Keybinding Action for a certain namespace and Action
The namespace under which the Keybinding is registered
The Keybinding action to set
The Bindings to assign to the Keybinding
Static
_compareInternal
Compares two Keybinding Actions based on their Order
The first Keybinding Action
the second Keybinding Action
A class responsible for managing defined game keybinding. Each keybinding is a string key/value pair belonging to a certain namespace and a certain store scope.
When Foundry Virtual Tabletop is initialized, a singleton instance of this class is constructed within the global Game object as as game.keybindings.
See