BeardLib
  • Home
  • Things to Know
    • Adding Files
    • ScriptData
  • Modules
    • Achievements
    • Add Files
    • Adding your own modules
    • AssetUpdates (Mod Updates)
    • Classes
    • Contact (contractors)
    • Crime Spree Mission
    • DLC
    • Dependencies
    • Elements
    • Global Value (Tagging weapons/etc)
    • Heist Music
      • Stealth Music
    • Hooks
    • Interactions
    • Keybind
    • Level
    • Localization
    • Mask Material
    • Mask Pattern
    • Mask
    • Melee
    • Menu Music
    • Menu
    • ModuleBase
    • Narrative
    • Options
    • Package
    • Script Mods (Replace script data)
    • Sounds
    • Tweak Modify
    • Weapon Mod
    • Weapon Skin
    • Weapon
    • XML
  • API
    • BeardLib Class
    • Constants
    • File Manager
    • Frameworks
    • Hooks
    • ModCore
    • Package Manager
    • Special Hook IDs
  • Utilities
    • FileIO
    • Input
    • Main
    • Math
    • Menu Helper Plus
    • Path
    • String
    • Sync
    • Table
    • Tweak Data Helper
    • XML
    • YAML
  • MenuUI
    • ComboBox
    • ImageButton
    • Item
    • Items
    • Keybind
    • Menus
    • Slider
    • TextBox
    • Toggle
Powered by GitBook
On this page
  • Toggle
  • Creation
  • Parameters

Was this helpful?

Edit on GitHub
  1. MenuUI

Toggle

Updated for version 3.36.

It's recommended to first read about the base item before reading about other items https://luffyyy.gitbook.io/beardlib/menuui/menuui-item

Toggle

Creation

MyRandomMenu:Toggle({
    name = "MyToggle",
    text = "This is a toggle",
    value = true,
    on_callback = function(item)
        log("I was toggled to", tostring(item:Value()))
    end
})

Parameters

Parameter
Type
Description

value

Boolean

Value of the toggle true for on false for off

Functions

Get

Function
Return Type
Description

Value()

Boolean

Returns the boolean value of the toggle

Set

Function
Description

SetValue(Boolean value, Boolean run_callback)

Sets the value of the item. value is the boolean value and run_callback decides whether to run the callback after the value is set

PreviousTextBox

Last updated 3 years ago

Was this helpful?