Updated settings package to fully utilize string user settings.

satoon101 · satoon101 · commit 2192178cc5e5 · 2014-09-15T17:23:08.000-04:00
diff --git a/addons/source-python/packages/source-python/settings/__init__.py b/addons/source-python/packages/source-python/settings/__init__.py
@@ -8,10 +8,15 @@
 # Source.Python Imports
 #   Loggers
 from loggers import _sp_logger
+#   Translations
+from translations.strings import LangStrings
 
 
 # =============================================================================
 # >> GLOBAL VARIABLES
 # =============================================================================
 # Get the sp.settings logger
 settings_logger = _sp_logger.settings
+
+# Get the settings strings
+_settings_strings = LangStrings('_core/settings_strings')
diff --git a/addons/source-python/packages/source-python/settings/menu.py b/addons/source-python/packages/source-python/settings/menu.py
@@ -10,6 +10,8 @@
 from menus import PagedMenu
 #   Players
 from players.helpers import index_from_playerinfo
+#   Settings
+from settings import _settings_strings
 
 
 # =============================================================================
@@ -21,7 +23,9 @@ class _AvailableSettings(dict):
 
     def __init__(self):
         """Create the main settings menu on instantiation."""
-        self._menu = PagedMenu(select_callback=self._chosen_item)
+        self._menu = PagedMenu(
+            select_callback=self._chosen_item,
+            title=_settings_strings['Main Title'])
 
     @property
     def menu(self):
diff --git a/addons/source-python/packages/source-python/settings/player.py b/addons/source-python/packages/source-python/settings/player.py
@@ -51,7 +51,9 @@ def __init__(self, name, text=None):
         self._text = text
 
         # Create the instance's menu
-        self._menu = PagedMenu(select_callback=self._chosen_item)
+        self._menu = PagedMenu(
+            select_callback=self._chosen_item,
+            title=name if text is None else text)
 
         # Call the super class' __init__ to initialize the OrderedDict
         super(_SettingsDictionary, self).__init__()
@@ -158,7 +160,7 @@ def _chosen_item(menu, index, option):
             return
 
         # TODO: Placeholder for sending setting specific menus
-        print('You chose {0}'.format(option.text))
+        option.value.menu.send(index)
 
 
 class PlayerSettings(_SettingsDictionary, AutoUnload):
diff --git a/addons/source-python/packages/source-python/settings/types.py b/addons/source-python/packages/source-python/settings/types.py
@@ -14,11 +14,25 @@
 # Source.Python Imports
 #   Engines
 from engines.server import engine_server
+#   Menus
+from menus import PagedMenu
+from menus import Option
+#   Messages
+from messages import SayText
 #   Players
 from players.helpers import playerinfo_from_index
 from players.helpers import uniqueid_from_playerinfo
 #   Settings
+from settings import _settings_strings
 from settings.storage import _player_settings_storage
+#   Translations
+from translations.strings import TranslationStrings
+
+
+# =============================================================================
+# >> GLOBAL VARIABLES
+# =============================================================================
+_message = SayText(message=_settings_strings['Chosen'])
 
 
 # =============================================================================
@@ -28,7 +42,7 @@ class _SettingsType(object):
 
     """Class used to store settings with possible values."""
 
-    def __new__(cls, name, default, *args):
+    def __new__(cls, name, default, text=None, *args):
         """Verify the name and default value before getting the new object."""
         # Was a valid value passed as the name?
         if not name.replace('_', '').replace(' ', '').isalpha():
@@ -48,6 +62,18 @@ def __new__(cls, name, default, *args):
         # Get the new object instance
         self = object.__new__(cls)
 
+        # Store the base attributes
+        self._name = name
+        self._default = default
+        self._text = text
+
+        # Store a menu for the object
+        self._menu = PagedMenu(
+            select_callback=self._chosen_value,
+            build_callback=self._menu_build,
+            title=name if text is None else text,
+            description=_settings_strings['Description'])
+
         # Return the instance
         return self
 
@@ -71,13 +97,20 @@ def prefix(self):
         """Return the prefix of the setting."""
         return self._prefix
 
+    @property
+    def convar(self):
+        """Returns the convar name of the setting."""
+        return self.prefix + self.name.lower().replace(' ', '_')
+
+    @property
+    def menu(self):
+        """Return the setting's menu."""
+        return self._menu
+
     def get_setting(self, index):
         """Return the setting value for the given player index."""
-        # Get the convar's value
-        convar = self.prefix + self.name.lower().replace(' ', '_')
-
         # Get the client's convar value
-        value = engine_server.get_client_convar_value(index, convar)
+        value = engine_server.get_client_convar_value(index, self.convar)
 
         # Try to typecast the value, suppressing ValueErrors
         with suppress(ValueError):
@@ -98,10 +131,10 @@ def get_setting(self, index):
         if uniqueid in _player_settings_storage:
 
             # Is the convar in the clients's dictionary?
-            if convar in _player_settings_storage[uniqueid]:
+            if self.convar in _player_settings_storage[uniqueid]:
 
                 # Get the client's value for the convar
-                value = _player_settings_storage[uniqueid][convar]
+                value = _player_settings_storage[uniqueid][self.convar]
 
                 # Try to typecast the value, suppressing ValueErrors
                 with suppress(ValueError):
@@ -118,6 +151,21 @@ def get_setting(self, index):
         # Return the default value
         return self.default
 
+    def _menu_build(self, menu, index):
+        """Set the default value in the menu description."""
+        self.menu.description.tokens = {'value': self.get_setting(index)}
+
+    def _chosen_value(self, menu, index, option):
+        """Store the player's chosen value for the setting."""
+        # Get the client's uniqueid
+        uniqueid = uniqueid_from_playerinfo(playerinfo_from_index(index))
+
+        # Set the player's setting
+        _player_settings_storage[uniqueid][self.convar] = option.value
+
+        # Send the player a message about their changed setting
+        _message.send(index, convar=self.convar, value=option.value)
+
 
 class _NumericalSetting(_SettingsType):
 
@@ -126,9 +174,6 @@ class _NumericalSetting(_SettingsType):
     def __init__(
             self, name, default, text=None, min_value=None, max_value=None):
         """Store the base attributes on instantiation."""
-        self._name = name
-        self._default = default
-        self._text = text
         self._min = self._type(min_value) if min_value is not None else None
         self._max = self._type(max_value) if max_value is not None else None
 
@@ -182,9 +227,6 @@ class _StringSetting(_SettingsType):
 
     def __init__(self, name, default, text=None):
         """Store the base attributes on instatiation."""
-        self._name = name
-        self._default = default
-        self._text = text
         self._options = OrderedDict()
 
     @property
@@ -202,7 +244,11 @@ def add_option(self, name, text=None):
                 'Given name "{0}" is already an option'.format(name))
 
         # Store the option
-        self.options[name] = text if text else name
+        option = self.options[name] = Option(
+            name if text is None else text, name)
+
+        # Add the option to the menu
+        self.menu.append(option)
 
     def remove_option(self, name):
         """Remove an option from the settings."""
diff --git a/resource/source-python/translations/_core/settings_strings.ini b/resource/source-python/translations/_core/settings_strings.ini
@@ -0,0 +1,8 @@
+[Main Title]
+en = "User settings"
+
+[Description]
+en = "Current value: $value"
+
+[Chosen]
+en = "Client setting '\x04$convar\x01' has been updated to '\x04$value\x01'."
