Merge pull request #7 from apple1417/master

change the functions the keybinds implementation should overwrite

Author: apple1417

Readme.md

@@ -11,14 +11,18 @@ game specific things:
 - A mod menu. Consider using [console_mod_menu](https://github.com/bl-sdk/console_mod_menu/)
   while developing, though you likely want to create a gui version for users.
 
-- A keybind implementation, which overwrites `KeybindType.enable` and `KeybindType.disable`, and
-  sets up some hooks to run the callbacks as appropriate.
+- A keybind implementation, which overwrites `KeybindType._enable` and `KeybindType._disable` (and
+  possibly `KeybindType._rebind`), and sets up some hooks to run the callbacks as appropriate.
 
 - An initialization script. This should import this and the keybind implementation, then find and
-  import all mods, and finally call `mods_base.mod_list.register_base_mod `
+  import all mods, and finally call `mods_base.mod_list.register_base_mod`
 
 # Changelog
 
+### v1.7 (Upcoming)
+- Changed the functions the keybind implementation should overwrite from `KeybindType.enable` to
+  `KeybindType._enable` (+ same for disable). These functions don't need to set `is_enabled`.
+
 ### v1.6
 - Changed default type of `HookType` generic type hint to any, so that by default pre and post hooks
   can be combined under the same type. As an example, previously if you passed an explicit hook list

__init__.py

@@ -8,7 +8,7 @@
 from .dot_sdkmod import open_in_mod_dir
 
 # Need to define a few things first to avoid circular imports
-__version_info__: tuple[int, int] = (1, 6)
+__version_info__: tuple[int, int] = (1, 7)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"
 

keybinds.py

@@ -96,19 +96,26 @@ def __setattr__(self, name: str, value: Any) -> None:
 
         super().__setattr__(name, value)
 
+    def enable(self) -> None:
+        """Enables this keybind."""
+        self._enable()
+        self.is_enabled = True
+
+    def disable(self) -> None:
+        """Disables this keybind."""
+        self._disable()
+        self.is_enabled = False
+
     # These three functions should get replaced by the keybind implementation
     # The initialization script should make sure to load it before any mods, to make sure they don't
     # end up with references to these functions
-    # If writing a new implementation, make sure to still set `is_enabled` correctly
-    def enable(self) -> None:
+    def _enable(self) -> None:
         """Enables this keybind."""
         logging.error("No keybind implementation loaded, unable to enable binds")
-        self.is_enabled = True
 
-    def disable(self) -> None:
+    def _disable(self) -> None:
         """Disables this keybind."""
         logging.error("No keybind implementation loaded, unable to disable binds")
-        self.is_enabled = False
 
     def _rebind(self, new_key: str | None) -> None:
         """