Type Alias: KeyBindingModule

KeyBindingModule = object

Defined in: src/keybindings.ts:109

Key-binding module with read-only results and write operations.

import type { KeyBindingModule } from 'osu-files'

return db.keybindings.get.first()?.KeyCombination

Properties

get

readonly get: Keybindings

Defined in: src/keybindings.ts:111

Returns read-only key-binding snapshots through get.

---

write

readonly write: Crud<KeyBinding>

Defined in: src/keybindings.ts:113

Creates, updates, deletes, or upserts key bindings.

Methods

getActionKeys()

getActionKeys<RR>(rulesetName, actionName, variant?): string[]

Defined in: src/keybindings.ts:119

Returns keys assigned to an action.

Type Parameters

Type Parameter
RR extends RulesetShortName | null | undefined

Parameters

Parameter	Type
rulesetName	RR
actionName	RR extends "osu" | "taiko" | "fruits" | "mania" ? keyof object[RR] : RR extends null | undefined ? "ToggleChat" | "ToggleSocial" | "ResetInputSettings" | "ToggleToolbar" | "ToggleSettings" | "ToggleBeatmapListing" | "IncreaseVolume" | "DecreaseVolume" | "ToggleMute" | "SkipCutscene" | "QuickRetry" | "TakeScreenshot" | "ToggleGameplayMouseButtons" | "Back" | "IncreaseScrollSpeed" | "DecreaseScrollSpeed" | "Select" | "QuickExit" | "MusicNext" | "MusicPrev" | "MusicPlay" | "ToggleNowPlaying" | "SelectPrevious" | "SelectNext" | "Home" | "ToggleNotifications" | "PauseGameplay" | "EditorSetupMode" | "EditorComposeMode" | "EditorDesignMode" | "EditorTimingMode" | "HoldForHUD" | "RandomSkin" | "TogglePauseReplay" | "ToggleInGameInterface" | "ToggleModSelection" | "SelectNextRandom" | "SelectPreviousRandom" | "ToggleBeatmapOptions" | "EditorVerifyMode" | "EditorNudgeLeft" | "EditorNudgeRight" | "ToggleSkinEditor" | "PreviousVolumeMeter" | "NextVolumeMeter" | "SeekReplayForward" | "SeekReplayBackward" | "ToggleChatFocus" | "EditorCycleGridSpacing" | "EditorTestGameplay" | "EditorFlipHorizontally" | "EditorFlipVertically" | "EditorIncreaseDistanceSpacing" | "EditorDecreaseDistanceSpacing" | "ActivatePreviousSet" | "ActivateNextSet" | "DeselectAllMods" | "EditorTapForBPM" | "ToggleFPSDisplay" | "ToggleProfile" | "EditorCloneSelection" | "EditorCyclePreviousBeatSnapDivisor" | "EditorCycleNextBeatSnapDivisor" | "SaveReplay" | "ExportReplay" | "ToggleReplaySettings" | "ToggleInGameLeaderboard" | "EditorToggleRotateControl" | "IncreaseOffset" | "DecreaseOffset" | "StepReplayForward" | "StepReplayBackward" | "IncreaseModSpeed" | "DecreaseModSpeed" | "EditorToggleScaleControl" | "EditorTestPlayToggleAutoplay" | "EditorTestPlayToggleQuickPause" | "EditorTestPlayQuickExitToInitialTime" | "EditorTestPlayQuickExitToCurrentTime" | "EditorSeekToPreviousHitObject" | "EditorSeekToNextHitObject" | "EditorSeekToPreviousSamplePoint" | "EditorSeekToNextSamplePoint" | "EditorCycleGridType" | "EditorAddBookmark" | "EditorRemoveClosestBookmark" | "EditorSeekToPreviousBookmark" | "EditorSeekToNextBookmark" | "AbsoluteScrollSongList" | "EditorToggleMoveControl" | "EditorDiscardUnsavedChanges" | "ExpandPreviousGroup" | "ExpandNextGroup" | "ToggleCurrentGroup" | "PreviousSkin" | "NextSkin" | "EditorSubmitBeatmap" | "EditorEditExternally" | "FastForwardReplay" : string
variant?	number

Returns

string[]

This example requires Node.js.

import { KeyBindingModule } from 'osu-files'

return undefined

---

registerAllBuiltInDefaults()

registerAllBuiltInDefaults(): object

Defined in: src/keybindings.ts:117

Registers built-in defaults for every ruleset.

Returns

object

inserted

inserted: number

removed

removed: number

This example requires Node.js.

import { KeyBindingModule } from 'osu-files'

return undefined

---

registerDefaults()

registerDefaults(defaults, rulesetName?, variant?): object

Defined in: src/keybindings.ts:115

Registers default keybindings for a ruleset.

Parameters

Parameter	Type
defaults	KeyBindingDef[]
rulesetName?	RulesetShortName
variant?	number

Returns

object

inserted

inserted: number

removed

removed: number

This example requires Node.js.

import { KeyBindingModule } from 'osu-files'

return undefined

---

setActionKeys()

setActionKeys<RR>(rulesetName, actionName, keys, variant?): void

Defined in: src/keybindings.ts:125

Replaces keys assigned to an action.

Type Parameters

Type Parameter
RR extends RulesetShortName | null | undefined

Parameters

Parameter	Type
rulesetName	RR
actionName	RR extends "osu" | "taiko" | "fruits" | "mania" ? keyof object[RR] : RR extends null | undefined ? "ToggleChat" | "ToggleSocial" | "ResetInputSettings" | "ToggleToolbar" | "ToggleSettings" | "ToggleBeatmapListing" | "IncreaseVolume" | "DecreaseVolume" | "ToggleMute" | "SkipCutscene" | "QuickRetry" | "TakeScreenshot" | "ToggleGameplayMouseButtons" | "Back" | "IncreaseScrollSpeed" | "DecreaseScrollSpeed" | "Select" | "QuickExit" | "MusicNext" | "MusicPrev" | "MusicPlay" | "ToggleNowPlaying" | "SelectPrevious" | "SelectNext" | "Home" | "ToggleNotifications" | "PauseGameplay" | "EditorSetupMode" | "EditorComposeMode" | "EditorDesignMode" | "EditorTimingMode" | "HoldForHUD" | "RandomSkin" | "TogglePauseReplay" | "ToggleInGameInterface" | "ToggleModSelection" | "SelectNextRandom" | "SelectPreviousRandom" | "ToggleBeatmapOptions" | "EditorVerifyMode" | "EditorNudgeLeft" | "EditorNudgeRight" | "ToggleSkinEditor" | "PreviousVolumeMeter" | "NextVolumeMeter" | "SeekReplayForward" | "SeekReplayBackward" | "ToggleChatFocus" | "EditorCycleGridSpacing" | "EditorTestGameplay" | "EditorFlipHorizontally" | "EditorFlipVertically" | "EditorIncreaseDistanceSpacing" | "EditorDecreaseDistanceSpacing" | "ActivatePreviousSet" | "ActivateNextSet" | "DeselectAllMods" | "EditorTapForBPM" | "ToggleFPSDisplay" | "ToggleProfile" | "EditorCloneSelection" | "EditorCyclePreviousBeatSnapDivisor" | "EditorCycleNextBeatSnapDivisor" | "SaveReplay" | "ExportReplay" | "ToggleReplaySettings" | "ToggleInGameLeaderboard" | "EditorToggleRotateControl" | "IncreaseOffset" | "DecreaseOffset" | "StepReplayForward" | "StepReplayBackward" | "IncreaseModSpeed" | "DecreaseModSpeed" | "EditorToggleScaleControl" | "EditorTestPlayToggleAutoplay" | "EditorTestPlayToggleQuickPause" | "EditorTestPlayQuickExitToInitialTime" | "EditorTestPlayQuickExitToCurrentTime" | "EditorSeekToPreviousHitObject" | "EditorSeekToNextHitObject" | "EditorSeekToPreviousSamplePoint" | "EditorSeekToNextSamplePoint" | "EditorCycleGridType" | "EditorAddBookmark" | "EditorRemoveClosestBookmark" | "EditorSeekToPreviousBookmark" | "EditorSeekToNextBookmark" | "AbsoluteScrollSongList" | "EditorToggleMoveControl" | "EditorDiscardUnsavedChanges" | "ExpandPreviousGroup" | "ExpandNextGroup" | "ToggleCurrentGroup" | "PreviousSkin" | "NextSkin" | "EditorSubmitBeatmap" | "EditorEditExternally" | "FastForwardReplay" : string
keys	string[]
variant?	number

Returns

void

This example requires Node.js.

import { KeyBindingModule } from 'osu-files'

return undefined