summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index 294fc18..3dc239f 100644
--- a/README
+++ b/README
@@ -70,6 +70,13 @@ playersettings.set(player_name,setting_name,new_value)
-- 'new_value' is the new value of the setting.
-- Changing settings via this interface bypasses the built-in validation (such as range checking on numbers) but NOT any specified onchange or afterchange actions.
+To reset a setting:
+
+playersettings.reset(player_name,setting_name)
+-- 'player_name' is the player to change the setting for.
+-- 'setting_name' is the name of the setting to reset/clear.
+-- This will cause 'playersettings.get' to fall back to the default value.
+
To get the value of a setting (from another mod):
playersettings.get(player_name,setting_name)