Menu

Table to work with cheat menu.

AddOptionBool(path: table, name: string, default: boolean): integer

Name	Type	Description
path	table	path to option
name	string	option name
default	boolean	default value

Creates menu toggle option. Returns option id.

Example

local option = Menu.AddOptionBool( { "EXAMPLE" } , "Enable" , true );
if ( Menu.IsEnabled( option ) ) then
    -- do something
end

---

AddOptionButton(path: table, name: string, callback: function): integer

Name	Type	Description
path	table	path to option
name	string	option name
callback	function	callback function which will be called when button is pressed

Creates menu button option. Returns option id.

Example

Menu.AddButtonOption( {"EXAMPLE"} , "Button" , function ()
   Log.Write("Button Clicked")
end );

---

AddOptionCombo(path: table, name: string, items: table, default: integer): integer

Name	Type	Description
path	table	path to option
name	string	option name
items	table	table with items
default	integer	default value (0-based index of item in table)

Creates menu combobox option. Returns option id.

Example

local items = { "Item 1" , "Item 2" , "Item 3" };
local option = Menu.AddOptionCombo( { "EXAMPLE" } , "Combo" , items , 0 );
if ( Menu.GetValue( option ) == 0 ) then
    -- "Item 1"
end

---

AddOptionSlider(path: table, name: string, min: integer, max: integer, default: integer): integer

Name	Type	Description
path	table	path to option
name	string	option name
min	integer	minimum value
max	integer	maximum value
default	integer	default value

Creates integer slider option. Returns option id.

Example

local option = Menu.AddOptionSlider( { "EXAMPLE" } , "Slider" , 0 , 100 , 50 );
Log.Write( Menu.GetValue( option ) ); -- 50

---

AddOptionSliderFloat(path: table, name: string, min: number, max: number, default: number): integer

Name	Type	Description
path	table	path to option
name	string	option name
min	number	minimum value
max	number	maximum value
default	number	default value

Creates float slider option. Returns option id.

Example

local option = Menu.AddOptionSliderFloat( { "EXAMPLE" } , "Slider" , 0.0 , 100.0 , 50.0 );
Log.Write( Menu.GetValue( option ) );

---

AddKeyOption(path: table, name: string, default: Enum.ButtonCode): integer

Name	Type	Description
path	table	path to option
name	string	option name
default	Enum.ButtonCode	default value

Creates keybind option. Returns option id.

Example

local option = Menu.AddKeyOption( { "EXAMPLE" } , "Key" , Enum.ButtonCode.KEY_NONE );
Log.Write(Menu.IsKeyDown( option )); -- false

---

AddOptionMultiSelect(path: table, name: string, elements: table, isOneItemMode: boolean): integer

Name	Type	Description
path	table	path to option
name	string	option name
elements	table	table with elements in the format {stringId, pathToImage, isEnabledByDefault}. see example
isOneItemMode	boolean	if true, only one element can be selected at a time

Creates multi select icon option. Returns option id.

Example

-- add_multiselect.lua
local option = Menu.AddOptionMultiSelect({"EXAMPLE"}, "Items:",
{
    -- name, path to image, default value
    {"hex", "panorama/images/items/sheepstick_png.vtex_c", true},
    {"veil", "panorama/images/items/veil_of_discord_png.vtex_c", false},
}, true);

if (Menu.IsSelected(option, 'hex')) then
    Log.Write('hex is selected');
end

for index, name in pairs(Menu.GetItems(option)) do
    Log.Write(index, " ", name);
end

---

IsSelected(optionID: integer, elementName: string): boolean

Name	Type	Description
optionID	integer	option id
elementName	string	name of element

Returns true if element from Menu.AddOptionMultiSelect is selected.

---

GetItems(optionID: integer): table

Name	Type	Description
optionID	integer	option id

Returns the 1-based indexed table with all element names from Menu.AddOptionMultiSelect, maintaining the same order as in the menu.

---

SetSelected(optionID: integer, elementName: string, value: boolean, callBack [?]: boolean): void

Name	Type	Description
optionID	integer	option id
elementName	string	name of element
value	boolean	new value of element
callBack [?]	boolean	if true then OnMenuOptionChange callback will be called (default: true)

Sets the selected state of an element from the Menu.AddOptionMultiSelect option

---

MoveItem(optionID: integer, elementName: string, newIdx: integer, callBack [?]: boolean): void

Name	Type	Description
optionID	integer	option id
elementName	string	name of element
newIdx	integer	new index of element. 1-based
callBack [?]	boolean	if true then OnMenuOptionChange callback will be called (default: true)

Moves element from Menu.AddOptionMultiSelect option to new index.

---

AddOptionInputText(path: table, name: string, defaultText: string): integer

Name	Type	Description
path	table	path to option
name	string	option name
defaultText	string	default text

Creates input text option. Returns option id.

Example

local option = Menu.AddOptionInputText({"EXAMPLE"}, "Color", "default");
Log.Write(Menu.GetInputText(option))
Menu.SetInputText(option, "new text")
Log.Write(Menu.GetInputText(option))

---

SetInputText(optionID: integer, text: string, callBack [?]: boolean): void

Name	Type	Description
optionID	integer	option id
text	string	new text
callBack [?]	boolean	if true then OnMenuOptionChange callback will be called (default: false)

Sets the text to Menu.AddOptionInputText option.

---

GetInputText(optionID: integer): string

Name	Type	Description
optionID	integer	option id

Gets the text from Menu.AddOptionInputText option.

---

AddOptionTip(optionID: integer, tipInfo: string): void

Name	Type	Description
optionID	integer	option id
tipInfo	string	tip text. Could use for new line and {{paht_to_image}} for image

Adds tip to option.

Example

local option = Menu.AddOptionBool({"EXAMPLE"}, "enable", false);
Menu.AddOptionTip(option, "This is a tooltip\n{{panorama/images/heroes/icons/npc_dota_hero_earthshaker_png.vtex_c}}")

---

IsEnabled(optionID: integer): boolean

Name	Type	Description
optionID	integer	option id

Returns true if Menu.AddOptionBool option is enabled.

---

AddOptionColorPicker(path: table, name: string, r: number, g: number, b: number, a: number): integer

Name	Type	Description
path	table	path to option
name	string	option name
r	number	default red value
g	number	default green value
b	number	default blue value
a	number	default alpha value

Creates color picker option. Returns option id.

Example

local option = Menu.AddOptionColorPicker({"EXAMPLE"}, "Color", 255, 255, 255, 255);
local value = Menu.GetValue(option);
Log.Write(value.r, " ",  value.g, " ",value.b, " ", value.a)

---

SetColorValue(optionID: integer, r: integer, g: integer, b: integer, a: integer, callBack [?]: boolean): void

Name	Type	Description
optionID	integer	option id
r	integer	red color value
g	integer	green color value
b	integer	blue color value
a	integer	alpha color value
callBack [?]	boolean	if true then OnMenuOptionChange callback will be called (default: true)

Sets value to Menu.AddOptionColorPicker option.

---

SetValue(optionID: integer, value: number | integer, callBack [?]: boolean): void

Name	Type	Description
optionID	integer	option id
value	number | integer	new value
callBack [?]	boolean	if true then OnMenuOptionChange callback will be called (default: true)

Sets value to Menu.AddOptionSlider, Menu.AddOptionSliderFloat, Menu.AddOptionCombo and Menu.AddKeyOption option.

---

SetValue(optionID: integer, value: boolean, callBack [?]: boolean): boolean

Name	Type	Description
optionID	integer	option id
value	boolean	new value
callBack [?]	boolean	if true then OnMenuOptionChange callback will be called (default: true)

Sets Menu.AddOptionBool option value.

---

GetValue(optionID: integer): number | table

Name	Type	Description
optionID	integer	option id

Gets Menu.AddOptionSlider, Menu.AddOptionSliderFloat, Menu.AddOptionColorPicker, Menu.AddOptionCombo and Menu.AddKeyOption option value.

---

IsKeyDown(optionID: integer): boolean

Name	Type	Description
optionID	integer	option id

Returns true if Menu.AddKeyOption key is pressed.

---

IsKeyDownOnce(optionID: integer): boolean

Name	Type	Description
optionID	integer	option id

Returns true if Menu.AddKeyOption key is pressed once.

---

RemoveOption(optionID: integer): void

Name	Type	Description
optionID	integer	option id

Removes option from menu.

---

AddOptionIcon(categoryList: table, icon: string): void

Name	Type	Description
categoryList	table	category list
icon	string	icon path

Adds icon to menu category.

Example

local option = Menu.AddOptionBool({"EXAMPLE"}, "Enable", false)
Menu.AddMenuIcon({"EXAMPLE"}, "panorama/images/items/blink_png.vtex_c");

---

RemoveOptionIcon(categoryList: table): void

Name	Type	Description
categoryList	table	category list

Removes icon from menu category.

---

AddOptionIcon(optionID: integer, icon: string): void

Name	Type	Description
optionID	integer	option id
icon	string	icon path

Adds icon to option.

Example

local option = Menu.AddOptionBool({"EXAMPLE"}, "Enable", false)
Menu.AddOptionIcon(option, "panorama/images/items/blink_png.vtex_c");

---

RemoveOptionIcon(optionID: integer): void

Name	Type	Description
optionID	integer	option id

Removes icon from option.

---

RemoveMenu(categoryList: table): void

Name	Type	Description
categoryList	table	category list

Removes menu category.

---

FindMenu(categoryList: table, name: string, type: Enum.MenuType): integer | nil

Name	Type	Description
categoryList	table	category list
name	string	option name
type	Enum.MenuType	option type

Returns option id by option name. Not the best way to get option id, pretty slow.

Example

Menu.AddOptionBool({"EXAMPLE"}, "Enable", false)
local option = Menu.FindMenu({"EXAMPLE"}, "Enable", Enum.MenuType.MENU_TYPE_BOOL)
Log.Write(option, " ", tostring(Menu.IsEnabled(option)))

---

OpenMenuList(categoryList: table): void

Name	Type	Description
categoryList	table	category list

Pops out the menu category list.

---

KeyCodeToString(keycode: Enum.ButtonCode): string | nil

Name	Type	Description
keycode	Enum.ButtonCode	key code

Returns key name by key code.

Example

local option = Menu.AddKeyOption( { "EXAMPLE" } , "Key" , Enum.ButtonCode.KEY_MOUSE1 );
local key = Menu.GetValue(option);
Log.Write(Menu.KeyCodeToString(key))

---

GetKeyString(optionID: integer): string | nil

Name	Type	Description
optionID	integer	option id

Returns key name by Menu.AddKeyOption option id.

Example

local option = Menu.AddKeyOption( { "EXAMPLE" } , "Key" , Enum.ButtonCode.KEY_MOUSE1 );
Log.Write(Menu.GetKeyString(option))