Tom.docsHomeHomePIXEL UIPIXEL UIUI3D2DUI3D2DI18NI18N
GitHubGitHub (opens in a new tab)
  • Getting Started
  • Configuration
  • API Reference
  • Elements
    • ValidatedTextEntry
      • IsTextValid
      • OnValidate
      • SetValue
      • GetValue
      • SetPlaceholderText
      • GetPlaceholderText
    • TextEntry
      • IsEnabled
      • SetEnabled
      • GetValue
      • SetValue
      • IsMultiline
      • SetMultiline
      • IsEditing
      • GetEnterAllowed
      • SetEnterAllowed
      • GetUpdateOnType
      • SetUpdateOnType
      • GetNumeric
      • SetNumeric
      • GetHistoryEnabled
      • SetHistoryEnabled
      • GetTabbingDisabled
      • SetTabbingDisabled
      • GetPlaceholderText
      • SetPlaceholderText
      • GetFont
      • SetFont
      • GetInt
      • GetFloat
      • SetEditable
      • AllowInput
      • GetAutoComplete
      • OnKeyCode
    • TextButton
      • SizeToText
      • PaintExtra
    • Slider
      • OnValueChanged
    • Sidebar
      • SetImgurID
      • GetImgurID
      • SetImgurScale
      • GetImgurScale
      • SetImgurOffset
      • GetImgurOffset
      • AddItem
      • RemoveItem
      • SelectItem
    • ScrollPanel
      • AddItem
      • OnChildAdded
      • GetVBar
      • GetCanvas
      • InnerWidth
      • Rebuild
      • OnMouseWheeled
      • OnVScroll
      • ScrollToChild
      • LayoutContent
      • Clear
    • PropertySheet
      • AddSheet
      • SetActiveTab
      • OnActiveTabChanged
      • GetItems
      • SizeToContentWidth
      • SwitchToName
      • CloseTab
    • Navbar
      • AddItem
      • RemoveItem
      • SelectItem
    • MenuOptionCVar
      • OnChecked
    • Menu
      • AddPanel
      • AddOption
      • AddCVar
      • AddSpacer
      • AddSubMenu
      • Hide
      • OpenSubMenu
      • CloseSubMenu
      • ChildCount
      • GetChild
      • LayoutContent
      • Open
      • OptionSelectedInternal
      • OptionSelected
      • ClearHighlights
      • HighlightItem
    • LabelledCheckbox
      • OnToggled
      • SetText
      • GetText
      • SetFont
      • GetFont
      • SetTextColor
      • GetTextColor
      • SetAutoWrap
      • GetAutoWrap
    • Label
      • SetText
      • CalculateSize
    • ImgurButton
      • SetImgurID
      • GetImgurID
      • SetImgurSize
      • GetImgurSize
    • Frame
      • SetImgurID
      • GetImgurID
      • DragThink
      • SizeThink
      • CreateSidebar
      • AddHeaderButton
      • LayoutContent
      • Open
      • Close
      • OnClose
      • PaintHeader
      • PaintBefore
    • ComboBox
      • Clear
      • GetOptionText
      • GetOptionData
      • GetOptionTextByData
      • ChooseOption
      • ChooseOptionID
      • GetSelectedID
      • GetSelected
      • OnSelect
      • AddChoice
      • IsMenuOpen
      • CloseMenu
      • CheckConVarChanges
      • SetValue
    • ColorPicker
      • UpdateColor
      • SetColor
      • UpdatePositions
      • GetCenter
      • GetRadius
      • GetTriangleRadius
      • GetRingThickness
      • GetHueColor
    • Checkbox
    • Category
      • UnselectAll
      • SetTitle
      • SetContents
      • SetExpanded
      • Toggle
      • OnToggle
      • DoExpansion
      • LayoutContent
    • Button
      • DoToggle
      • PaintExtra
      • IsDown
      • OnPressed
      • OnReleased
      • OnToggled
      • DoClick
      • DoRightClick
      • DoMiddleClick
    • Avatar
      • SetPlayer
      • SetSteamID
  • Color
    • CopyColor
    • OffsetColor
    • LerpColor
    • GetRainbowColor
    • IsColorEqualTo
    • IsColorLight
    • ColorToHex
    • ColorToHSL
    • HexToColor
    • HSLToColor
  • Drawing
    • Text
      • DrawSimpleText
      • DrawText
      • DrawShadowText
      • DrawDualText
    • Rounded Boxes
      • DrawRoundedBox
      • DrawRoundedBoxEx
      • DrawFullRoundedBox
      • DrawFullRoundedBoxEx
    • Images
      • DrawImage
      • DrawImageRotated
      • DrawImgur
      • DrawImgurRotated
      • DrawProgressWheel
    • Overheads
      • DrawEntOverhead
      • DrawNPCOverhead
      • EnableIconOverheads
    • Circles
      • DrawCircle
      • CreateCircle
      • DrawCircleUncached
    • Outlined Boxes
      • DrawOutlinedBox
      • DrawOutlinedRoundedBox
    • Miscellaneous
      • DrawBlur
      • DrawRoundedTextBox
      • DrawFixedRoundedTextBox
  • Fonts
    • RegisterFont
    • RegisterFontUnscaled
    • GetRealFont
    • GetTextSize
  • Formatting
    • WrapText
    • EllipsesText
    • FormatMoney
    • FormatTime
    • DecToHex
  • Images
    • GetImage
    • GetImgur
  • Loaders
    • LoadDirectory
    • LoadDirectoryRecursive
  • Scaling
    • Scale
    • GetScaledConstant
    • RegisterScaledConstant
  • More
  • Example Projects
  • GitHub Repository ↗ (opens in a new tab)
  • Home
    • Getting Started
    • Configuration
    • API Reference
    • Elements
      • ValidatedTextEntry
        • IsTextValid
        • OnValidate
        • SetValue
        • GetValue
        • SetPlaceholderText
        • GetPlaceholderText
      • TextEntry
        • IsEnabled
        • SetEnabled
        • GetValue
        • SetValue
        • IsMultiline
        • SetMultiline
        • IsEditing
        • GetEnterAllowed
        • SetEnterAllowed
        • GetUpdateOnType
        • SetUpdateOnType
        • GetNumeric
        • SetNumeric
        • GetHistoryEnabled
        • SetHistoryEnabled
        • GetTabbingDisabled
        • SetTabbingDisabled
        • GetPlaceholderText
        • SetPlaceholderText
        • GetFont
        • SetFont
        • GetInt
        • GetFloat
        • SetEditable
        • AllowInput
        • GetAutoComplete
        • OnKeyCode
      • TextButton
        • SizeToText
        • PaintExtra
      • Slider
        • OnValueChanged
      • Sidebar
        • SetImgurID
        • GetImgurID
        • SetImgurScale
        • GetImgurScale
        • SetImgurOffset
        • GetImgurOffset
        • AddItem
        • RemoveItem
        • SelectItem
      • ScrollPanel
        • AddItem
        • OnChildAdded
        • GetVBar
        • GetCanvas
        • InnerWidth
        • Rebuild
        • OnMouseWheeled
        • OnVScroll
        • ScrollToChild
        • LayoutContent
        • Clear
      • PropertySheet
        • AddSheet
        • SetActiveTab
        • OnActiveTabChanged
        • GetItems
        • SizeToContentWidth
        • SwitchToName
        • CloseTab
      • Navbar
        • AddItem
        • RemoveItem
        • SelectItem
      • MenuOptionCVar
        • OnChecked
      • Menu
        • AddPanel
        • AddOption
        • AddCVar
        • AddSpacer
        • AddSubMenu
        • Hide
        • OpenSubMenu
        • CloseSubMenu
        • ChildCount
        • GetChild
        • LayoutContent
        • Open
        • OptionSelectedInternal
        • OptionSelected
        • ClearHighlights
        • HighlightItem
      • LabelledCheckbox
        • OnToggled
        • SetText
        • GetText
        • SetFont
        • GetFont
        • SetTextColor
        • GetTextColor
        • SetAutoWrap
        • GetAutoWrap
      • Label
        • SetText
        • CalculateSize
      • ImgurButton
        • SetImgurID
        • GetImgurID
        • SetImgurSize
        • GetImgurSize
      • Frame
        • SetImgurID
        • GetImgurID
        • DragThink
        • SizeThink
        • CreateSidebar
        • AddHeaderButton
        • LayoutContent
        • Open
        • Close
        • OnClose
        • PaintHeader
        • PaintBefore
      • ComboBox
        • Clear
        • GetOptionText
        • GetOptionData
        • GetOptionTextByData
        • ChooseOption
        • ChooseOptionID
        • GetSelectedID
        • GetSelected
        • OnSelect
        • AddChoice
        • IsMenuOpen
        • CloseMenu
        • CheckConVarChanges
        • SetValue
      • ColorPicker
        • UpdateColor
        • SetColor
        • UpdatePositions
        • GetCenter
        • GetRadius
        • GetTriangleRadius
        • GetRingThickness
        • GetHueColor
      • Checkbox
      • Category
        • UnselectAll
        • SetTitle
        • SetContents
        • SetExpanded
        • Toggle
        • OnToggle
        • DoExpansion
        • LayoutContent
      • Button
        • DoToggle
        • PaintExtra
        • IsDown
        • OnPressed
        • OnReleased
        • OnToggled
        • DoClick
        • DoRightClick
        • DoMiddleClick
      • Avatar
        • SetPlayer
        • SetSteamID
    • Color
      • CopyColor
      • OffsetColor
      • LerpColor
      • GetRainbowColor
      • IsColorEqualTo
      • IsColorLight
      • ColorToHex
      • ColorToHSL
      • HexToColor
      • HSLToColor
    • Drawing
      • Text
        • DrawSimpleText
        • DrawText
        • DrawShadowText
        • DrawDualText
      • Rounded Boxes
        • DrawRoundedBox
        • DrawRoundedBoxEx
        • DrawFullRoundedBox
        • DrawFullRoundedBoxEx
      • Images
        • DrawImage
        • DrawImageRotated
        • DrawImgur
        • DrawImgurRotated
        • DrawProgressWheel
      • Overheads
        • DrawEntOverhead
        • DrawNPCOverhead
        • EnableIconOverheads
      • Circles
        • DrawCircle
        • CreateCircle
        • DrawCircleUncached
      • Outlined Boxes
        • DrawOutlinedBox
        • DrawOutlinedRoundedBox
      • Miscellaneous
        • DrawBlur
        • DrawRoundedTextBox
        • DrawFixedRoundedTextBox
    • Fonts
      • RegisterFont
      • RegisterFontUnscaled
      • GetRealFont
      • GetTextSize
    • Formatting
      • WrapText
      • EllipsesText
      • FormatMoney
      • FormatTime
      • DecToHex
    • Images
      • GetImage
      • GetImgur
    • Loaders
      • LoadDirectory
      • LoadDirectoryRecursive
    • Scaling
      • Scale
      • GetScaledConstant
      • RegisterScaledConstant
    • More
    • Example Projects
    • GitHub Repository ↗ (opens in a new tab)
    • Getting Started
    • API Reference
    • StartDraw
    • EndDraw
    • GetCursorPos
    • IsHovering
    • IsPressing
    • IsPressed
    • DrawVGUI
    • More
    • GitHub Repository ↗ (opens in a new tab)
    • Getting Started
    • Examples
    • API Reference
    • Core
      • GetLanguage
      • GetAddon
      • RegisterAddon
      • RegisterTranslation
    • Addon
      • New
      • GetName
      • GetAuthor
      • SetAuthor
      • GetFallbackLanguage
      • SetFallbackLanguage
      • GetTranslations
      • GetString
      • AddTranslation
    • Translation
      • New
      • GetLanguage
      • GetAuthor
      • GetPhrases
      • GetString
      • AddPhrase
    • Phrase
      • New
      • GetIdentifier
      • GetTemplate
      • GetFallbacks
      • GetString
    • More
    • GitHub Repository ↗ (opens in a new tab)

On This Page

  • Methods
Create an issue → (opens in a new tab)Edit this page →
PIXEL UI
Elements
MenuOptionCVar

PIXEL.MenuOptionCVar

  • Base panel: PIXEL.MenuOption (opens in a new tab)
  • Source: cl_menu_option.lua (opens in a new tab)
  • Description: PIXEL menu option bound to a console variable.

Methods

The following methods are available on the PIXEL.MenuOptionCVar panel:

PANEL:OnChecked( boolean )

Updates the bound convar when checked state changes.

SelectItemOnChecked
MIT License – © 2026 Tom O'Sullivan