Skip to main content

Config.Read

Reads and returns a config.

Syntax​

Config.Read "config_name"

Returns​

reference to CustomConfig object

Arguments​

NameRequiredTypeDescription
config nameYesAny text e.g. "Hello, World!"

Details​

This method will attempt to read basic '.yaml' files from 'C:\Users\Olgie\AppData\Roaming\SCP Secret Laboratory\LabAPI\configs\Scripted Events Reloaded\Custom Configs' folder. If the folder doesn't exist, you can safely make one and create '.yaml' files there. The '.yml' extension is also supported. If a file with the config name is not found, an invalid reference will be returned. Learn more about YAML files: https://www.cloudbees.com/blog/yaml-tutorial-everything-you-need-get-started

Possible errors​

  • The config name resolves outside the SER custom config directory.

On a running server​

Use serhelp Config.Read to inspect the reference generated by your installed SER version.