PZAPI::ModOptions::Options Class Reference

Public Member Functions
void	apply ()
umbrella::ModOptions::OptionElement	getOption (string id)
void	addTitle (string name)
void	addDescription (string text)
void	addSeparator ()
umbrella::ModOptions::TextEntry	addTextEntry (string id, string name, string value, string _tooltip)
umbrella::ModOptions::TickBox	addTickBox (string id, string name, boolean value, string _tooltip)
umbrella::ModOptions::MultipleTickBox	addMultipleTickBox (string id, string name, string _tooltip)
umbrella::ModOptions::ComboBox	addComboBox (string id, string name, string _tooltip)
umbrella::ModOptions::ColorPicker	addColorPicker (string id, string name, number r, number g, number b, number a, string _tooltip)
umbrella::ModOptions::Keybind	addKeyBind (string id, string name, integer key, string _tooltip)
umbrella::ModOptions::Slider	addSlider (string id, string name, number min, number max, number step, number value, string _tooltip)
umbrella::ModOptions::Button	addButton (string id, string name, string tooltip, umbrella::ISButton::OnClick onclickfunc, unknown target, unknown arg1, unknown arg2, unknown arg3, unknown arg4)
	PZAPI::ModOptions::Options (string modOptionsID, string name)

Public Attributes
umbrella::ModOptions::Element[]	data
	Array of option objects.
table< string, umbrella::ModOptions::OptionElement >	dict
	Dictionary of options by ID.
string	modOptionsID
	Unique identifier for this options set.
string	name
	Display name for this options set.

Member Function Documentation

addButton()

umbrella::ModOptions::Button PZAPI::ModOptions::Options::addButton	(	string	id,
		string	name,
		string	tooltip,
		umbrella::ISButton::OnClick	onclickfunc,
		unknown	target,
		unknown	arg1,
		unknown	arg2,
		unknown	arg3,
		unknown	arg4 )

Return values

option

Parameters

id	Unique identifier for this option
name	Display name for this option
tooltip	Optional tooltip text
onclickfunc	Function to call when button is clicked
target	Optional target object for the onclick function
arg1	Optional first argument for the onclick function
arg2	Optional second argument for the onclick function
arg3	Optional third argument for the onclick function
arg4	Optional fourth argument for the onclick function

addColorPicker()

umbrella::ModOptions::ColorPicker PZAPI::ModOptions::Options::addColorPicker	(	string	id,
		string	name,
		number	r,
		number	g,
		number	b,
		number	a,
		string	_tooltip )

Return values

option

Parameters

id	Unique identifier for this option
name	Display name for this option
r	Red component (0-1)
g	Green component (0-1)
b	Blue component (0-1)
a	Alpha component (0-1)
_tooltip	Optional tooltip text

addComboBox()

umbrella::ModOptions::ComboBox PZAPI::ModOptions::Options::addComboBox	(	string	id,
		string	name,
		string	_tooltip )

Return values

option

Parameters

id	Unique identifier for this option
name	Display name for this option
_tooltip	Optional tooltip text

addDescription()

void PZAPI::ModOptions::Options::addDescription

(

string

text

)

Parameters

text	The description text (will be processed by getText)

addKeyBind()

umbrella::ModOptions::Keybind PZAPI::ModOptions::Options::addKeyBind	(	string	id,
		string	name,
		integer	key,
		string	_tooltip )

Return values

option

Parameters

id	Unique identifier for this option
name	Display name for this option
key	Initial key code
_tooltip	Optional tooltip text

addMultipleTickBox()

umbrella::ModOptions::MultipleTickBox PZAPI::ModOptions::Options::addMultipleTickBox	(	string	id,
		string	name,
		string	_tooltip )

Return values

option

Parameters

id	Unique identifier for this option
name	Display name for this option
_tooltip	Optional tooltip text

addSeparator()

void PZAPI::ModOptions::Options::addSeparator

(

)

addSlider()

umbrella::ModOptions::Slider PZAPI::ModOptions::Options::addSlider	(	string	id,
		string	name,
		number	min,
		number	max,
		number	step,
		number	value,
		string	_tooltip )

Return values

option

Parameters

id	Unique identifier for this option
name	Display name for this option
min	Minimum value
max	Maximum value
step	Step size
value	Initial value
_tooltip	Optional tooltip text

addTextEntry()

umbrella::ModOptions::TextEntry PZAPI::ModOptions::Options::addTextEntry	(	string	id,
		string	name,
		string	value,
		string	_tooltip )

Return values

option

Parameters

id	Unique identifier for this option
name	Display name for this option
value	Initial value
_tooltip	Optional tooltip text

addTickBox()

umbrella::ModOptions::TickBox PZAPI::ModOptions::Options::addTickBox	(	string	id,
		string	name,
		boolean	value,
		string	_tooltip )

Return values

option

Parameters

id	Unique identifier for this option
name	Display name for this option
value	Initial value
_tooltip	Optional tooltip text

addTitle()

void PZAPI::ModOptions::Options::addTitle

(

string

name

)

Parameters

name	The title text

apply()

void PZAPI::ModOptions::Options::apply

(

)

getOption()

umbrella::ModOptions::OptionElement PZAPI::ModOptions::Options::getOption

(

string

id

)

Parameters

id	The option ID

PZAPI::ModOptions::Options()

PZAPI::ModOptions::Options::PZAPI::ModOptions::Options	(	string	modOptionsID,
		string	name )

Member Data Documentation

data

umbrella::ModOptions::Element [] PZAPI::ModOptions::Options::data

Array of option objects.

dict

table<string, umbrella::ModOptions::OptionElement> PZAPI::ModOptions::Options::dict

Dictionary of options by ID.

modOptionsID

string PZAPI::ModOptions::Options::modOptionsID

Unique identifier for this options set.

name

string PZAPI::ModOptions::Options::name

Display name for this options set.

---

The documentation for this class was generated from the following file:

• client/PZAPI/ModOptions.yml