SetSetting

PluginSecurity

This member cannot be used in scripts, but is usable in the command bar and plugins.

Function of:

Description:

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
Name key	Type string	Default	Summary
Name value	Type Variant	Default	Summary

Returns

Return Type	Summary
Return Type void	Summary

Code Samples

Plugin:SetSetting1

The below example would save the value of the key “FirstTime” as false. This could be useful in plugins which provide the user with a tutorial of it’s use.

Expand

 
local Plugin = PluginManager():CreatePlugin()
local RanBefore = Plugin:GetSetting("RanBefore")
Plugin:SetSetting("RanBefore", true)

if RanBefore then
	print("Welcome back!")
else
	print("Welcome! Thanks for installing this plugin!")
end

Copy Code Light Theme

SetSetting

Parameters

key

value

Returns

void

Code Samples

Plugin:SetSetting1