Show raw api
{
"functions": [],
"properties": [],
"types": [
{
"name": "IRainbowColorSequenceParameters",
"desc": "",
"fields": [
{
"name": "Event?",
"lua_type": "RBXScriptSignal",
"desc": "The event to connect to. Defaults to [RunService.Heartbeat]."
},
{
"name": "IsPerformanceMode?",
"lua_type": "boolean",
"desc": "Whether or not the hook should be in performance mode. Performance mode disables the effect entirely. Defaults to `false`."
},
{
"name": "Visible?",
"lua_type": "boolean",
"desc": "Whether or not the hook should be visible. Defaults to `true`."
}
],
"source": {
"line": 19,
"path": "src/useRainbowColorSequence.lua"
}
},
{
"name": "IUseUncontrolledInput<T>",
"desc": "",
"fields": [
{
"name": "DefaultValue?",
"lua_type": "T",
"desc": "Initial value for uncontrolled state."
},
{
"name": "FinalValue?",
"lua_type": "T",
"desc": "Final value for uncontrolled state when Value and DefaultValue are not provided."
},
{
"name": "OnChange?",
"lua_type": "(value: T) -> ()",
"desc": "Controlled state onChange handler."
},
{
"name": "Value?",
"lua_type": "T",
"desc": "Value for controlled state."
}
],
"source": {
"line": 16,
"path": "src/useUncontrolled.lua"
}
},
{
"name": "ColorData",
"desc": "",
"fields": [
{
"name": "Default",
"lua_type": "Color3",
"desc": "The `Enum.StudioStyleGuideModifier.Default` Color3."
},
{
"name": "Disabled",
"lua_type": "Color3",
"desc": "The `Enum.StudioStyleGuideModifier.Disabled` Color3."
},
{
"name": "Hover",
"lua_type": "Color3",
"desc": "The `Enum.StudioStyleGuideModifier.Hover` Color3."
},
{
"name": "Pressed",
"lua_type": "Color3",
"desc": "The `Enum.StudioStyleGuideModifier.Pressed` Color3."
},
{
"name": "Selected",
"lua_type": "Color3",
"desc": "The `Enum.StudioStyleGuideModifier.Selected` Color3."
}
],
"source": {
"line": 13,
"path": "src/Utility/Types.lua"
}
},
{
"name": "ThemeData",
"desc": "",
"fields": [
{
"name": "ThemeName",
"lua_type": "\"Dark\" | \"Light\"",
"desc": "The name of the current theme."
},
{
"name": "GetColor",
"lua_type": "(StudioStyleGuideColor: Enum.StudioStyleGuideColor, StudioStyleGuideModifier?: Enum.StudioStyleGuideModifier) -> Color3",
"desc": "A function that returns a Color3 based on the given `Enum.StudioStyleGuideColor` and `Enum.StudioStyleGuideModifier`."
},
{
"name": "AttributeCog",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.AttributeCog` theme entry."
},
{
"name": "Border",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Border` theme entry."
},
{
"name": "BrightText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.BrightText` theme entry."
},
{
"name": "Button",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Button` theme entry."
},
{
"name": "ButtonBorder",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ButtonBorder` theme entry."
},
{
"name": "ButtonText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ButtonText` theme entry."
},
{
"name": "CategoryItem",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.CategoryItem` theme entry."
},
{
"name": "ChatIncomingBgColor",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ChatIncomingBgColor` theme entry."
},
{
"name": "ChatIncomingTextColor",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ChatIncomingTextColor` theme entry."
},
{
"name": "ChatModeratedMessageColor",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ChatModeratedMessageColor` theme entry."
},
{
"name": "ChatOutgoingBgColor",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ChatOutgoingBgColor` theme entry."
},
{
"name": "ChatOutgoingTextColor",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ChatOutgoingTextColor` theme entry."
},
{
"name": "CheckedFieldBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.CheckedFieldBackground` theme entry."
},
{
"name": "CheckedFieldBorder",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.CheckedFieldBorder` theme entry."
},
{
"name": "CheckedFieldIndicator",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.CheckedFieldIndicator` theme entry."
},
{
"name": "ColorPickerFrame",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ColorPickerFrame` theme entry."
},
{
"name": "CurrentMarker",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.CurrentMarker` theme entry."
},
{
"name": "Dark",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Dark` theme entry."
},
{
"name": "DebuggerCurrentLine",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DebuggerCurrentLine` theme entry."
},
{
"name": "DebuggerErrorLine",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DebuggerErrorLine` theme entry."
},
{
"name": "DialogButton",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DialogButton` theme entry."
},
{
"name": "DialogButtonBorder",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DialogButtonBorder` theme entry."
},
{
"name": "DialogButtonText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DialogButtonText` theme entry."
},
{
"name": "DialogMainButton",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DialogMainButton` theme entry."
},
{
"name": "DialogMainButtonText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DialogMainButtonText` theme entry."
},
{
"name": "DiffFilePathBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffFilePathBackground` theme entry."
},
{
"name": "DiffFilePathBorder",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffFilePathBorder` theme entry."
},
{
"name": "DiffFilePathText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffFilePathText` theme entry."
},
{
"name": "DiffLineNum",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffLineNum` theme entry."
},
{
"name": "DiffLineNumAdditionBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffLineNumAdditionBackground` theme entry."
},
{
"name": "DiffLineNumDeletionBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffLineNumDeletionBackground` theme entry."
},
{
"name": "DiffLineNumNoChangeBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffLineNumNoChangeBackground` theme entry."
},
{
"name": "DiffLineNumSeparatorBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffLineNumSeparatorBackground` theme entry."
},
{
"name": "DiffTextAddition",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffTextAddition` theme entry."
},
{
"name": "DiffTextAdditionBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffTextAdditionBackground` theme entry."
},
{
"name": "DiffTextDeletion",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffTextDeletion` theme entry."
},
{
"name": "DiffTextDeletionBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffTextDeletionBackground` theme entry."
},
{
"name": "DiffTextHunkInfo",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffTextHunkInfo` theme entry."
},
{
"name": "DiffTextNoChange",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffTextNoChange` theme entry."
},
{
"name": "DiffTextNoChangeBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffTextNoChangeBackground` theme entry."
},
{
"name": "DiffTextSeparatorBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DiffTextSeparatorBackground` theme entry."
},
{
"name": "DimmedText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DimmedText` theme entry."
},
{
"name": "DocViewCodeBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DocViewCodeBackground` theme entry."
},
{
"name": "Dropdown",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Dropdown` theme entry."
},
{
"name": "DropShadow",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.DropShadow` theme entry."
},
{
"name": "EmulatorBar",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.EmulatorBar` theme entry."
},
{
"name": "EmulatorDropDown",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.EmulatorDropDown` theme entry."
},
{
"name": "ErrorText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ErrorText` theme entry."
},
{
"name": "FilterButtonAccent",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.FilterButtonAccent` theme entry."
},
{
"name": "FilterButtonBorder",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.FilterButtonBorder` theme entry."
},
{
"name": "FilterButtonBorderAlt",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.FilterButtonBorderAlt` theme entry."
},
{
"name": "FilterButtonChecked",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.FilterButtonChecked` theme entry."
},
{
"name": "FilterButtonDefault",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.FilterButtonDefault` theme entry."
},
{
"name": "FilterButtonHover",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.FilterButtonHover` theme entry."
},
{
"name": "GameSettingsTableItem",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.GameSettingsTableItem` theme entry."
},
{
"name": "GameSettingsTooltip",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.GameSettingsTooltip` theme entry."
},
{
"name": "HeaderSection",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.HeaderSection` theme entry."
},
{
"name": "InfoBarWarningBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.InfoBarWarningBackground` theme entry."
},
{
"name": "InfoBarWarningText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.InfoBarWarningText` theme entry."
},
{
"name": "InfoText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.InfoText` theme entry."
},
{
"name": "InputFieldBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.InputFieldBackground` theme entry."
},
{
"name": "InputFieldBorder",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.InputFieldBorder` theme entry."
},
{
"name": "Item",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Item` theme entry."
},
{
"name": "Light",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Light` theme entry."
},
{
"name": "LinkText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.LinkText` theme entry."
},
{
"name": "MainBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.MainBackground` theme entry."
},
{
"name": "MainButton",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.MainButton` theme entry."
},
{
"name": "MainText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.MainText` theme entry."
},
{
"name": "Mid",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Mid` theme entry."
},
{
"name": "Midlight",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Midlight` theme entry."
},
{
"name": "Notification",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Notification` theme entry."
},
{
"name": "RibbonButton",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.RibbonButton` theme entry."
},
{
"name": "RibbonTab",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.RibbonTab` theme entry."
},
{
"name": "RibbonTabTopBar",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.RibbonTabTopBar` theme entry."
},
{
"name": "ScriptBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptBackground` theme entry."
},
{
"name": "ScriptBool",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptBool` theme entry."
},
{
"name": "ScriptBracket",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptBracket` theme entry."
},
{
"name": "ScriptBuiltInFunction",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptBuiltInFunction` theme entry."
},
{
"name": "ScriptComment",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptComment` theme entry."
},
{
"name": "ScriptEditorCurrentLine",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptEditorCurrentLine` theme entry."
},
{
"name": "ScriptError",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptError` theme entry."
},
{
"name": "ScriptFindSelectionBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptFindSelectionBackground` theme entry."
},
{
"name": "ScriptFunction",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptFunction` theme entry."
},
{
"name": "ScriptFunctionName",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptFunctionName` theme entry."
},
{
"name": "ScriptKeyword",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptKeyword` theme entry."
},
{
"name": "ScriptLocal",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptLocal` theme entry."
},
{
"name": "ScriptLuauKeyword",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptLuauKeyword` theme entry."
},
{
"name": "ScriptMatchingWordSelectionBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptMatchingWordSelectionBackground` theme entry."
},
{
"name": "ScriptMethod",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptMethod` theme entry."
},
{
"name": "ScriptNil",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptNil` theme entry."
},
{
"name": "ScriptNumber",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptNumber` theme entry."
},
{
"name": "ScriptOperator",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptOperator` theme entry."
},
{
"name": "ScriptProperty",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptProperty` theme entry."
},
{
"name": "ScriptRuler",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptRuler` theme entry."
},
{
"name": "ScriptSelectionBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptSelectionBackground` theme entry."
},
{
"name": "ScriptSelectionText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptSelectionText` theme entry."
},
{
"name": "ScriptSelf",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptSelf` theme entry."
},
{
"name": "ScriptSideWidget",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptSideWidget` theme entry."
},
{
"name": "ScriptString",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptString` theme entry."
},
{
"name": "ScriptText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptText` theme entry."
},
{
"name": "ScriptTodo",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptTodo` theme entry."
},
{
"name": "ScriptWarning",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptWarning` theme entry."
},
{
"name": "ScriptWhitespace",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScriptWhitespace` theme entry."
},
{
"name": "ScrollBar",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScrollBar` theme entry."
},
{
"name": "ScrollBarBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ScrollBarBackground` theme entry."
},
{
"name": "SensitiveText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.SensitiveText` theme entry."
},
{
"name": "Separator",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Separator` theme entry."
},
{
"name": "Shadow",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Shadow` theme entry."
},
{
"name": "StatusBar",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.StatusBar` theme entry."
},
{
"name": "SubText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.SubText` theme entry."
},
{
"name": "Tab",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Tab` theme entry."
},
{
"name": "TabBar",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.TabBar` theme entry."
},
{
"name": "TableItem",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.TableItem` theme entry."
},
{
"name": "Titlebar",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Titlebar` theme entry."
},
{
"name": "TitlebarText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.TitlebarText` theme entry."
},
{
"name": "Tooltip",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.Tooltip` theme entry."
},
{
"name": "ViewPortBackground",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.ViewPortBackground` theme entry."
},
{
"name": "WarningText",
"lua_type": "ColorData",
"desc": "The `Enum.StudioStyleGuideColor.WarningText` theme entry."
}
],
"source": {
"line": 145,
"path": "src/Utility/Types.lua"
}
}
],
"name": "Types",
"desc": "The extra types for the hooks.",
"source": {
"line": 31,
"path": "src/init.lua"
}
}