summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorKrock <mk939@ymail.com>2026-05-16 09:16:40 -0500
committercheapie <no-email-for-you@example.com>2026-05-16 09:16:40 -0500
commit5a0bf16ea4fbbf298c8db33ccf163d688aa7fb07 (patch)
tree132bb767d06df4bca8f46ad566e661381c00bcb6 /README
parent0a795ae447ccca69fe7f9ad28f7267758b4d5e35 (diff)
downloadplayersettings-5a0bf16ea4fbbf298c8db33ccf163d688aa7fb07.tar
playersettings-5a0bf16ea4fbbf298c8db33ccf163d688aa7fb07.tar.gz
playersettings-5a0bf16ea4fbbf298c8db33ccf163d688aa7fb07.tar.bz2
playersettings-5a0bf16ea4fbbf298c8db33ccf163d688aa7fb07.tar.xz
playersettings-5a0bf16ea4fbbf298c8db33ccf163d688aa7fb07.zip
[PATCH 2/2] Add playersettings.reset to fall back to default
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)