TraGUS
Godot plugin for user settings
Loading...
Searching...
No Matches

◆ LoadSetting()

static LoadResult LoadSetting ( string  section,
string  key,
Variant  value,
out Variant  effectiveValue 
)
inlinestaticprivate

Tries to load the provided config.ini entry in the settings server.

Parameters
sectionKeyThe section key of the .ini entry.
keyThe setting key of the .ini entry.
valueThe value to set the setting to.
effectiveValueIf the provided value was not accepted by the setting, the value the setting remains at.
Returns
The function returns a LoadResult, corresponding to either a success, or one of the possible failures -
  • The sectionKey corresponds to no actual user settings section.
  • The settingKey corresponds to no actual user settings within the provided section.
  • The new setting value was rejected by the setting.