SetSetting
PluginSecurity
This member cannot be used in scripts, but is usable in the command bar and plugins.
Stores a given value for later use under the given key. The value will persist even after studio is closed.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
|
|
|||
|
|
Returns
| Return Type | Summary |
|---|---|
Code Samples
Plugin:GetSetting and Plugin:SetSetting
This code sample demonstrates the use of the plugin settings functions: Plugin/GetSetting|GetSetting and Plugin/SetSetting|SetSetting. They are used to detect if a plugin is running for the first time by setting a key “RunBefore”. If it detects this key is set to true, a welcome-back message is printed. If not, it prints a first-run message and sets the key.
local runBeforeKey = "RunBefore"
local hasRunBefore = plugin:GetSetting(runBeforeKey)
if hasRunBefore then
print("Welcome back!")
else
print("Welcome! Thanks for installing this plugin!")
plugin:SetSetting(runBeforeKey, true)
end