ConfigAPI

This API is only available on the host.

For more information, see Pings.

The ConfigAPI allows storing and loading data between reloads of your avatar.

ConfigAPI is available as the global config variable.

Data Types

Only some data types are supported by ConfigAPI. All other data types will be converted to nil. The supported data types are:

nil
boolean
string
number
table
all types of Vector
all types of Matrix

ConfigAPI Methods

Configuration Switching

`ConfigAPI:setName`

Also available as ConfigAPI:name.

Sets the name of the configuration file to read and write data to. By default, the name of the configuration file is the same as the name of the currently loaded avatar.

Arguments	Return Type
`setName(name string)`	self ConfigAPI

config:setName("my_config_file_name")

`ConfigAPI:getName`

Returns the name of the active configuration file.

Arguments	Return Type
`getName()`	string

-- Print the active configuration file's name.
print(config:getName())

Reading and Writing Data

`ConfigAPI:load`

Read a saved value from the active configuration file (see setName) by key and return it. If no key is given, return all of the saved keys and values in a table.

Arguments	Return Type
`load(key string)`	any \| nil
`load()`	table

-- Print all saved values.
printTable(config:load())
-- Print one specific value.
print(config:load("my_value"))

`ConfigAPI:save`

Associate a key with a value in the active configuration file (see setName.) Only some types of values are allowed; see Data Types for details.

If nil is provided as the value, then the key is removed from the file.

Arguments	Return Type
`save(key string, value any \| nil)`	self ConfigAPI

-- Save a value to be used later.
config:save("my_value", "Figura Wiki")