PZAPI::ModOptions Class Reference

Classes
class	Options

Public Member Functions
PZAPI::ModOptions::Options	create (string modOptionsID, string name)
PZAPI::ModOptions::Options	getOptions (string modOptionsID)
void	save ()
void	load ()

Static Public Attributes
static PZAPI::ModOptions::Options[]	Data
	List of all mod options.
static table< string, PZAPI::ModOptions::Options >	Dict
	Dictionary of mod options by ID.
static table	OtherOptions
	Other options not managed by this module.
static PZAPI::ModOptions::Options	Options
	Options class.

Member Function Documentation

create()

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

Return values

options

Parameters

modOptionsID	Unique identifier for the mod options
name	Optional display name for the mod options. Defaults to the modOptionsID if not provided.

getOptions()

PZAPI::ModOptions::Options PZAPI::ModOptions::getOptions

(

string

modOptionsID

)

Parameters

modOptionsID

Unique identifier for the mod options

load()

void PZAPI::ModOptions::load

(

)

save()

void PZAPI::ModOptions::save

(

)

Member Data Documentation

Data

PZAPI::ModOptions::Options [] PZAPI::ModOptions::Data

static

List of all mod options.

Dict

table<string, PZAPI::ModOptions::Options> PZAPI::ModOptions::Dict

static

Dictionary of mod options by ID.

Options

PZAPI::ModOptions::Options PZAPI::ModOptions::Options

static

Options class.

OtherOptions

table PZAPI::ModOptions::OtherOptions

static

Other options not managed by this module.

---

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

• client/PZAPI/ModOptions.yml