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

◆ TryLoadSetting()

bool TryLoadSetting ( string  section,
string  settingKey,
Variant  value,
out Variant  effectiveValue 
)
inline

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

Parameters
sectionKeyThe section key of the .ini entry.
settingKeyThe 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 true if the operation was successful.

It returns false if either -

  • 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.