# Options
## Module Definition
The module is inherited from [ModuleBase](https://luffyyy.gitbook.io/beardlib/modules/modulebase). So base parameters can be found there.
### Module name
The name of the module you use as the meta of the module definition is 'Options' or 'OptionModule' if `_force_search` is set to true in the module definition.
### XML Structure
```markup
...
...
...
...
...
...
...
...
...
```
#### ``
| Parameter | Type | Description |
| ----------------- | ------- | --------------------------------------------------------------------------------------- |
| save\_file | String | Filename of the save file, relative to the SavePath. \[DEFAULT: 'ModName\_Options.txt'] |
| loaded\_callback | String | Function path/name of a function which should be called when the Options are loaded. |
| auto\_build\_menu | Boolean | Determines if the menu should be automatically built. \[DEFAULT: True] |
| auto\_load | Boolean | Determines if the options should be automatically loaded. \[DEFAULT: True] |
#### ``
| Parameter | Type | Description |
| ------------ | ------- | ------------------------------------------------------------------------------------------- |
| name | String | The base name of the options group. Only required if it is an option\_set or option\_group. |
| node\_name | String | The name of the node that holds the options. |
| title\_id | String | The localization id of the title of the button for this options node |
| desc\_id | String | The localization id of the description of the button for this options node |
| build\_items | Boolean | Determines if the items in the menu should be created |
#### ` ... `
*Any additional parameters which should be included in the item/node definition*
#### ``
*Every value type uses these parameters*
| Parameter | Type | Description |
| ----------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| name | String | The name of option \[REQUIRED] |
| type | String | The option type. Options are `multichoice`, `number`, `bool`, `colour`, `color`, `vector`, `rotation` and `table` |
| value\_changed | String | Function path/name which is called once the value of the option has been changed. This is given the parameters 'name' and 'value' of the option. |
| converter | String | Function path/name which is called to convert the value of option once GetValue param #2 is given 'true' |
| enabled\_callback | String | Function path/name which should return a bool that determines if the option is enabled |
| default\_value | Any | The default value of the option |
| disabled | Boolean | Determines if the option is disabled |
| title\_id | String | Localization id of the title of the option. \[DEFAULT: ModNameOptionNameTitleID] |
| desc\_id | String | Localization id of the description of the option. \[DEFAULT: ModNameOptionNameDescID] |
| hidden | Boolean | Determines if the option is hidden in the menu |
#### ` ...`
| Parameter | Type | Description |
| ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| values\_tbl | String | Path/Name of a table that holds all the values for the multichoice option (BeardLib reads the string and finds the object with the name/path) Example: `self.MyValues` or `MyGlobalClass.MyValues` |
| save\_value | Boolean | Determines if the value of the option should be saved or the index. This is useful if you have a variable amount of values which may have ones inserted in the middle or the end and the value should be retained. |
#### ` `
*This allows you to define the multichoice items in the xml.* value\_node automatically assigns the index depending on its location inside ``
#### ` ... `
| Parameter | Type | Description |
| ----------- | ------- | ----------------------------------------------------------------- |
| min | Number | The minimum value of the option in the menu |
| max | Number | The maximum value of the option in the menu |
| step | Number | The step value of the option in the menu |
| show\_value | Boolean | Determines if the value should be shown on the option in the menu |
#### ` ... `
| Parameter | Type | Description |
| ------------- | ------- | --------------------------------------------------------------------------------------------------- |
| alpha | Boolean | Determines if there should be an option for the alpha of the colour in the menu. |
| scale\_factor | Number | What the values of the colour are scaled up to. E.g. 255 so that it is more intuitive for the user. |
| step | Number | The step of the options for the colour |
| min | Number | The minimum value of the options for the colour |
| max | Number | The maximum value of the options for the colour |
#### ` ... `
*`scale_factor`, `step`, `min`, `max`* Same as in the colour option.
#### `
```
#### ` ... `
*Same parameters as defined in the main `options` docs. The `option_group` can hold sub\_menus in the form of option\_groups or option\_sets and sub options. The `option_group` is used for grouping of similar options, this will create a sub menu in the parent node for the options.*
| Parameter | Type | Description |
| ----------- | ------- | --------------------------------------------------------------- |
| build\_menu | Boolean | Determines if this sub menu should be built in the options menu |
#### ``
*The option set is used to create a collection of options which have similar parameters. This is used in PD:TH Hud to create the options for Heist Specific colour grading, as it generates the set of options based on the values from the tweak\_data.*
| Parameter | Type | Description | | |
| ------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | ------------------ |
| not\_pre\_generated | Boolean | Determines if the options are pre\_generated. This should be used if you are saving options which are not fixed and you just want to store values. This is used in the BeardLib-Editor to save the prefabs for the map editor. | | |
| items\_tbl | String | Path/Name of a table which contains data for the items which are part of the option\_set. It should be setup like a table of sub tables which contains the item parameters for an option, these will overwrite any of the \`item\_parameters | | that were defined. |
| populate\_items | String | Path/name of a function which returns a table for the items. See: above detail. | | |
#### ` `
*This can be used to define the items for the option set. See: 'items\_tbl' definition above.*
#### ` ... `
*Item parameters as defined in the docs for the 'option' node.*
### Example
See: [Mod Template](https://github.com/Luffyyy/BeardLib-Templates/blob/master/BLT%20Mod%20template/main.xml)
## Functions
| Function | Description |
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| SetValue(String name, Any value) | Sets value of option `name` (can be a path to it example ui/hud/color1) to `value` |
| GetValue(String name) | Returns the value of the option `name` |
| GetOption(String name) | Return the option `name`. The table pretty much has the same data as defined in the XML but also has "value" |
| ResetToDefaultValues(String path, Boolean shallow, Boolean no) | Resets the options. `path` is the path to the option group that should be reset (leave as an empty string to reset all), `shallow` determines if the reset should only happen in the current table and not in the sub options too, `no_save` determines if after resetting the options the function shouldn't save the changes |
| Save() | Saves the options |
There are more functions but as they are mostly used in the class itself they are not defined here.