Function to load the value of a specific setting that has previously been saved to the settings file.
Note:
To read a setting for the opened project:
var setting = loadSetting('mysetting', 'project');
To read a system wide setting:
var setting = loadSetting('mysetting', 'global');
Parameter | Data type | Required | Description |
---|---|---|---|
setting | string | true | The name of the setting to retrieve |
scope | string | true | The scope of the settings file. Use project for a setting saved in the current project or use global for a setting saved for your user account on the current machine |
Value | Meaning |
---|---|
array | The value of the setting when the setting has multiple values |
string | The value of the setting when the setting has only a single value |
null | Could not retreive the setting |