ReGui
  • Introduction
  • Getting Started
    • Installing
    • Creating windows
  • Plugins
    • Custom elements
    • Custom flags
    • Custom themes
  • Examples
    • Demo window
    • Example scripts
  • Methods
  • ReGui functions
  • Canvas functions
  • Configuration saving
  • Elements
    • :Label
    • :Error
    • Code Editor
    • :Button
    • :SmallButton
    • :RadioButton
    • :Image
    • :VideoPlayer
    • :Checkbox
    • :Radiobox
    • :Viewport
    • :Console
    • :Region
    • :List
    • :CollapsingHeader
    • :TreeNode
    • :Separator
    • :Indent
    • :BulletText
    • :Bullet
    • :Row
    • :SliderInt
    • :SliderFloat
    • :SliderEnum
    • :SliderColor3
    • :SliderCFrame
    • :SliderProgress
    • :DragInt
    • :DragFloat
    • :DragColor3
    • :DragCFrame
    • :InputText
    • :InputTextMultiline
    • :InputInt
    • :InputColor3
    • :InputCFrame
    • :ProgressBar
    • :Combo
    • :Keybind
    • :PlotHistogram
    • :Table
    • :TabSelector
    • :Window
    • :TabsWindow
    • :PopupModal
Powered by GitBook
On this page
  • Example usage:
  • Theme colors:
  1. Elements

:Keybind

Previous:ComboNext:PlotHistogram

Last updated 2 months ago

type KeyId = (Enum.UserInputType | Enum.KeyCode)

export type Keybind = {
	Value: Enum.KeyCode?,
	DeleteKey: Enum.KeyCode?,
	Enabled: boolean?,
	IgnoreGameProcessed: boolean?,
	Callback: ((KeyId) -> any)?,
	OnKeybindSet: ((KeyId) -> any)?,
	OnBlacklistedKeybindSet: ((KeyId) -> any)?,
	KeyBlacklist: {
		[number]: KeyId
	},

	SetValue: ((Keybind, New: Enum.KeyCode) -> any)?,
	WaitForNewKey: ((Keybind) -> any)?
}

Example usage:

:Keybind({
	Label = "Toggle checkbox",
	Value = Enum.KeyCode.Q,
	OnKeybindSet = function(self, KeyId)
		warn("[OnKeybindSet] .Value ->", KeyId)
	end,
	Callback = function(self, KeyId)
		print(KeyId)
		TestCheckbox:Toggle()
	end,
})

Theme colors:

Tag
Affects

FrameBg

Background color

FrameBgTransparency

Background transparency

Text

Text color

TextFont

Text font

TextSize

Text font size