Player settings update (#188)

* Added boolean player settings.

* Added boolean settings menu options.

* No longer tries to get value for bots and just returns the default.

* Added menu for IntegerSetting.

* Removed FloatSetting for player settings.

* StringSetting changed to show the displayed value from the menu in the chosen message.

Author: satoon101

addons/source-python/packages/source-python/menus/base.py

@@ -48,17 +48,17 @@ def __init__(self, data=None, select_callback=None, build_callback=None):
         :param callable|None select_callback: A function that gets called
             whenever a selection was made.
 
-            The callback will recieve 3 parameters:
+            The callback will receive 3 parameters:
                 1. The instance of this menu.
                 2. The player's index who made the selection.
                 3. The player's choice.
 
         :param callable|None build_callback: A function that gets called
             before a menu is displayed.
 
-            The callback will recieve 2 parameters:
+            The callback will receive 2 parameters:
                 1. The instance of this menu.
-                2. The index of the player who will recieve this menu.
+                2. The index of the player who will receive this menu.
         """
         super().__init__(list() if data is None else data)
 
@@ -119,7 +119,7 @@ def send(self, *ply_indexes, **tokens):
         If no indexes were given, the menu will be sent to every player.
 
         :param ply_indexes:
-            Player indexes that should recieve the menu.
+            Player indexes that should receive the menu.
         :param tokens:
             Translation tokens for menu options, title and description.
         """
@@ -237,7 +237,7 @@ def register_select_callback(self, callback):
         :param callable callback: A function that gets called
             whenever a selection was made.
 
-            The callback will recieve 3 parameters:
+            The callback will receive 3 parameters:
                 1. The instance of this menu.
                 2. The player's index who made the selection.
                 3. The player's choice.
@@ -253,9 +253,9 @@ def register_build_callback(self, callback):
         :param callable callback: A function that gets called
             before a menu is displayed.
 
-            The callback will recieve 2 parameters:
+            The callback will receive 2 parameters:
                 1. The instance of this menu.
-                2. The index of the player who will recieve this menu.
+                2. The index of the player who will receive this menu.
         """
         self.build_callback = callback
         return callback

addons/source-python/packages/source-python/settings/menu.py

@@ -21,15 +21,10 @@ class _AvailableSettings(dict):
     def __init__(self):
         """Create the main settings menu on instantiation."""
         super().__init__()
-        self._menu = PagedMenu(
+        self.menu = PagedMenu(
             select_callback=self._chosen_item,
             title=_settings_strings['Main Title'])
 
-    @property
-    def menu(self):
-        """Return the main settings menu instance."""
-        return self._menu
-
     def _private_send_menu(self, *args):
         """Called when a private say command is used for sending the menu."""
         # Send the menu

addons/source-python/packages/source-python/settings/player.py

@@ -5,22 +5,16 @@
 # =============================================================================
 # >> IMPORTS
 # =============================================================================
-# Python Imports
-#   Collections
+# Python
 from collections import OrderedDict
 
-# Source.Python Imports
-#   Core
+# Source.Python
 from core import AutoUnload
-#   Menus
-from menus import PagedMenu
-from menus import PagedOption
-#   Settings
+from menus import PagedMenu, PagedOption
 from settings.menu import _player_settings
-from settings.types import _SettingsType
-from settings.types import _FloatSetting
-from settings.types import _IntegerSetting
-from settings.types import _StringSetting
+from settings.types import (
+    BoolSetting, IntegerSetting, SettingsType, StringSetting
+)
 
 
 # =============================================================================
@@ -46,11 +40,11 @@ def __init__(self, name, text=None):
                 'Given name "{0}" is not valid'.format(name))
 
         # Set the base attributes
-        self._name = name
-        self._text = text
+        self.name = name
+        self.text = text
 
         # Create the instance's menu
-        self._menu = PagedMenu(
+        self.menu = PagedMenu(
             select_callback=self._chosen_item,
             title=name if text is None else text)
 
@@ -60,7 +54,7 @@ def __init__(self, name, text=None):
     def __setitem__(self, item, value):
         """Validate the given value and its type before setting the item."""
         # Is the given value a proper type?
-        if not isinstance(value, (_SettingsDictionary, _SettingsType)):
+        if not isinstance(value, (_SettingsDictionary, SettingsType)):
 
             # Raise an error
             raise ValueError(
@@ -80,70 +74,39 @@ def __setitem__(self, item, value):
         value = self[item]
 
         # Set the item's prefix
-        value._prefix = self.prefix + '_'
+        value.prefix = self.prefix
+        if not value.prefix.endswith('_'):
+            value.prefix += '_'
 
         # Does the section's name need added to the prefix?
         if not isinstance(self, PlayerSettings):
 
             # Add the section's name to the prefix
-            value._prefix += self.name.lower().replace(' ', '_') + '_'
+            value.prefix += self.name.lower().replace(' ', '_') + '_'
 
         # Add the option to the menu
         self.menu.append(PagedOption(
             value.name if value.text is None else value.text, value))
 
-    @property
-    def name(self):
-        """Return the name of the _SettingsDictionary instance."""
-        return self._name
-
-    @property
-    def text(self):
-        """Return the text of the _SettingsDictionary instance."""
-        return self._text
-
-    @property
-    def prefix(self):
-        """Return the prefix of the _SettingsDictionary instance."""
-        return self._prefix
-
-    @property
-    def menu(self):
-        """Return the instance's menu object."""
-        return self._menu
-
-    def add_float_setting(
-            self, name, default, text=None, min_value=None, max_value=None):
-        """Add a new float setting to the dictionary."""
-        # Add the new float setting to the dictionary
-        self[name] = _FloatSetting(name, default, text, min_value, max_value)
-
-        # Return the setting
-        return self[name]
-
     def add_int_setting(
             self, name, default, text=None, min_value=None, max_value=None):
         """Add a new integer setting to the dictionary."""
-        # Add the new integer setting to the dictionary
-        self[name] = _IntegerSetting(name, default, text, min_value, max_value)
+        self[name] = IntegerSetting(name, default, text, min_value, max_value)
+        return self[name]
 
-        # Return the setting
+    def add_bool_setting(self, name, default, text=None):
+        """Add a new boolean setting to the dictionary."""
+        self[name] = BoolSetting(name, default, text)
         return self[name]
 
     def add_string_setting(self, name, default, text=None):
         """Add a new string setting to the dictionary."""
-        # Add the new string setting to the dictionary
-        self[name] = _StringSetting(name, default, text)
-
-        # Return the setting
+        self[name] = StringSetting(name, default, text)
         return self[name]
 
     def add_section(self, name, text=None):
         """Add a new section to the dictionary."""
-        # Add the new section to the dictionary
         self[name] = _SettingsDictionary(name, text)
-
-        # Return the section
         return self[name]
 
     @staticmethod
@@ -186,17 +149,18 @@ def __init__(self, name, prefix, text=None):
         super().__init__(name, text)
 
         # Set the prefix for the settings
-        self._prefix = prefix.lower()
+        self.prefix = prefix.lower()
 
         # Add the instance to the main dictionary
         _player_settings[name] = self
 
         # Add the settings instance to the main settings menu
-        _player_settings.menu.append(
-            PagedOption(name if text is None else text, self))
+        self.option = PagedOption(name if text is None else text, self)
+        _player_settings.menu.append(self.option)
 
     def unregister_settings(self):
         """Unregister the given settings from the dictionary."""
+        _player_settings.menu.remove(self.option)
         del _player_settings[self.name]
 
     def _unload_instance(self):

addons/source-python/packages/source-python/settings/storage.py

@@ -41,7 +41,7 @@ def __init__(self, uniqueid):
         super().__init__()
 
         # Store the given uniqueid
-        self._uniqueid = uniqueid
+        self.uniqueid = uniqueid
 
         # If _player_settings_storage is initializing, don't try to call it
         if _IN_INITIALIZATION:
@@ -73,11 +73,6 @@ def __setitem__(self, variable, value):
             """WHERE variables.name=? AND players.uniqueid=?""",
             (value, variable, self.uniqueid))
 
-    @property
-    def uniqueid(self):
-        """Return the instance's uniqueid."""
-        return self._uniqueid
-
 
 class _PlayerSettingsDictionary(dict):
     """Dictionary class used to store user specific settings values."""
@@ -88,13 +83,13 @@ def __init__(self):
         super().__init__()
 
         # Connect to the database
-        self._connection = connect(_STORAGE_PATH)
+        self.connection = connect(_STORAGE_PATH)
 
         # Set the text factory
         self.connection.text_factory = str
 
         # Get the cursor instance
-        self._cursor = self.connection.cursor()
+        self.cursor = self.connection.cursor()
 
         # Create the variables table if it does not exist
         self.cursor.execute(
@@ -140,16 +135,6 @@ def __missing__(self, uniqueid):
         # Return the _UniqueSettings instance
         return value
 
-    @property
-    def connection(self):
-        """Return the connection to the database."""
-        return self._connection
-
-    @property
-    def cursor(self):
-        """Return the cursor instance."""
-        return self._cursor
-
     def on_level_shutdown(self):
         """Store the dictionary to the database on map change."""
         self.connection.commit()