ToggleMenuItem Class Reference

Menu item that lets users choose one of several options.

Inheritance diagram for ToggleMenuItem:

Member Functions
	ToggleMenuItem(name, options, currentIndex, wrap, help)
	Constructor.

Detailed Description

Menu item that lets users choose one of several options.

Constructor Documentation

ToggleMenuItem.new(name, options, currentIndex, wrap, help)

Arg types: name: string, options: table, currentIndex: int, wrap: bool, help: string  |  returns ToggleMenuItem

Constructor.

Example:

togglemenuitem = ToggleMenuItem.new(name, options, currentIndex, wrap, help)
...
levelgen:addItem(togglemenuitem)

Parameters

name	The text shown on the menu item.
options	The options to be displayed.
currentIndex	The index of the item to be selected initially (1 = first item).
wrap	trueif the items should wrap around when you reach the last index.
help	A bit of help text.

The MenuItem will return the text of the item the user selected.

For example:

m = ToggleMenuItem.new("Type", { "BarrierMaker", "LoadoutZone", "GoalZone" }, 1, `true`, "Type of item to insert")