configuration
- Last UpdatedDec 06, 2023
- 2 minute read
The configuration statement can be used only inside a defmodule to create a module configuration field. Module configuration fields are used to customize the internal behavior of a module and should be set only at module declaration time.
Platform support
This element is fully supported on XR-Windows, XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-P Hololens platforms.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Full support |
Full support |
Full support |
Full support |
|
|
|
|
|
|
Code example
This is a code example for a configuration statement.
<configuration name="aNonMandatoryConfig" isMandatory="false" type="sfloat" value="0.1" />
Fields
These are the fields for a configuration statement.
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
name |
sstring |
Mandatory |
The name of the configuration field of the module template. |
|
|
isMandatory |
sbool |
Optional |
false |
When set to true, the configuration must be set in the module declaration. |
|
type |
sstring |
Mandatory |
|
Defines the configuration field type |
|
value |
sstring |
Optional |
|
Default value for the configuration. This is the value applied if the configuration is not mandatory and not set by the module. |