cp.choices

Choices Module.

---

Submodules

• cp.choices.builder

---

API Overview

Functions - API calls offered directly by the extension

• new

Methods - API calls which can only be made on an object returned by a constructor

• getChoices
• new

---

API Documentation

Functions

new

Signature	cp.choices.new(type) -> choices
Type	Function
Description	Creates a new cp.choices instance for the specified type.
Parameters	type - The unique ID for the type.
Returns	The new choices instance.
Notes	None
Examples	None
Source	src/extensions/cp/choices/init.lua line 105

---

Methods

getChoices

Signature	cp.choices:getChoices() -> array of choices
Type	Method
Description	Returns the array of choices that have been added to this instance.
Parameters	None
Returns	The array of choices.
Notes	None
Examples	None
Source	src/extensions/cp/choices/init.lua line 157

---

new

Signature	cp.choices:new(choiceType) -> choices.builder
Type	Method
Description	Adds a new choice with the specified.
Parameters	text - The text title for the choice.
Returns	The choice builder, added to the choices set.
Notes	Additional settings can be set using the returned builder instance. E.g.: </li><li>choices:add("Do Something")</li><li> :subText("Cool Actions")</li><li> :params({</li><li> one = "foo",</li><li> two = "bar",</li><li> })</li><li>
Examples	None
Source	src/extensions/cp/choices/init.lua line 127

---

---