Moved all _PlayerWeapons functionality directly into Player class.

Added base game-specific functionality to raise NotImplementedErrors inside players.games.base._GameWeapons.  Any game-specific classes must inherit from players.games.base._GameWeapons with the _GameWeapons base class being listed last in inheritance.

Author: satoon101

addons/source-python/packages/source-python/players/entity.py

@@ -15,6 +15,7 @@
 #   Engines
 from engines.server import server
 from engines.server import engine_server
+from engines.server import server_game_dll
 from engines.trace import engine_trace
 from engines.trace import ContentMasks
 from engines.trace import GameTrace
@@ -23,9 +24,13 @@
 from engines.trace import TraceFilterSimple
 #   Entities
 from entities.constants import CollisionGroup
+from entities.constants import INVALID_ENTITY_INDEX
 from entities.constants import MoveType
 from entities.constants import TakeDamage
 from entities.entity import Entity
+from entities.helpers import edict_from_index
+from entities.helpers import index_from_inthandle
+from entities.props import SendPropType
 #   Mathlib
 from mathlib import Vector
 from mathlib import QAngle
@@ -41,7 +46,10 @@
 from players.helpers import uniqueid_from_playerinfo
 from players.games import _GameWeapons
 from players.voice import mute_manager
-from players.weapons import _PlayerWeapons
+#   Weapons
+from weapons.default import NoWeaponManager
+from weapons.entity import Weapon
+from weapons.manager import weapon_manager
 
 
 # =============================================================================
@@ -54,7 +62,7 @@
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class Player(Entity, _GameWeapons, _PlayerWeapons):
+class Player(Entity, _GameWeapons):
     """Class used to interact directly with players."""
 
     def __init__(self, index):
@@ -539,6 +547,122 @@ def get_stuck(self):
 
     stuck = property(get_stuck, set_stuck)
 
+    # =========================================================================
+    # >> PLAYER WEAPON FUNCTIONALITY
+    # =========================================================================
+    @property
+    def primary(self):
+        """Return the player's primary weapon.
+
+        :rtype: Weapon
+        """
+        return self.get_weapon(is_filters='primary')
+
+    @property
+    def secondary(self):
+        """Return the player's secondary weapon.
+
+        :rtype: Weapon
+        """
+        return self.get_weapon(is_filters='secondary')
+
+    @property
+    def active_weapon(self):
+        """Return the player's active weapon.
+
+        :rtype: Weapon
+        """
+        # Get the player's active weapon's index
+        index = index_from_inthandle(self.active_weapon_handle)
+
+        # Does the player have an active weapon?
+        if index is not None:
+
+            # Return a Weapon instance for the player's active weapon
+            return Weapon(index)
+
+        # If no active weapon, return None
+        return None
+
+    def get_weapon(self, classname=None, is_filters=None, not_filters=None):
+        """Return the first found weapon for the given arguments.
+
+        :rtype: Weapon
+        """
+        # Loop through all weapons for the given arguments
+        for weapon in self.weapons(classname, is_filters, not_filters):
+
+            # Return the first found weapon
+            return weapon
+
+        # If no weapon is found, return None
+        return None
+
+    def weapons(self, classname=None, is_filters=None, not_filters=None):
+        """Iterate over the player's weapons for the given arguments.
+
+        :return: A generator of :class:`weapons.entity.Weapon` objects
+        :rtype: generator
+        """
+        # Loop through all the players weapons for the given arguments
+        for index in self.weapon_indexes(classname, is_filters, not_filters):
+
+            # Yield the current weapon
+            yield Weapon(index)
+
+    def weapon_indexes(
+            self, classname=None, is_filters=None, not_filters=None):
+        """Iterate over the player's weapon indexes for the given arguments.
+
+        :return: A generator of indexes
+        :rtype: generator
+        """
+        # Is the weapon array supported for the current game?
+        if _weapon_prop_length is None:
+            return
+
+        # Loop through the length of the weapon array
+        for offset in range(_weapon_prop_length):
+
+            # Get the player's current weapon at this offset
+            handle = self.get_property_int(
+                weapon_manager.myweapons + '%03i' % offset)
+
+            # Get the weapon's index
+            index = index_from_inthandle(handle, raise_exception=False)
+
+            # Is this a valid index?
+            if index == INVALID_ENTITY_INDEX:
+
+                # Move onto the next offset
+                continue
+
+            # Get the weapon's classname
+            weapon_class = edict_from_index(index).get_class_name()
+
+            # Was a classname given and the current
+            # weapon is not of that classname?
+            if classname is not None and weapon_class != classname:
+
+                # Do not yield this index
+                continue
+
+            # Import WeaponClassIter to use its functionality
+            from filters.weapons import WeaponClassIter
+
+            # Was a weapon type given and the
+            # current weapon is not of that type?
+            if not (is_filters is None and not_filters is None):
+                if weapon_class not in [
+                        weapon.name for weapon in WeaponClassIter(
+                            is_filters, not_filters)]:
+
+                    # Do not yield this index
+                    continue
+
+            # Yield the index
+            yield index
+
 
 # =============================================================================
 # >> CALLBACKS
@@ -552,3 +676,51 @@ def _pre_client_command(args):
         """
         if args[2] == 'name "%s"':
             return 0
+
+
+# =============================================================================
+# >> HELPER FUNCTIONS
+# =============================================================================
+def _find_weapon_prop_length(table):
+    """Loop through a prop table to find the myweapons property length."""
+    # Loop through the props in the table
+    for offset in range(len(table)):
+
+        # Get the prop
+        item = table[offset]
+
+        # Is this the m_hMyWeapons prop?
+        if item.name == weapon_manager.myweapons[:~0]:
+
+            # If so, return the length of the prop table
+            return len(item.data_table)
+
+        # Is the current prop a table?
+        if item.type == SendPropType.DATATABLE:
+
+            # Loop through the table
+            _find_weapon_prop_length(item.data_table)
+
+# Default the weapon prop length to None
+_weapon_prop_length = None
+
+# Is the game supported?
+if not isinstance(weapon_manager, NoWeaponManager):
+
+    # Get the first ServerClass object
+    _current_class = server_game_dll.get_all_server_classes()
+
+    # Use "while" to loop through all ServerClass objects
+    while _current_class:
+
+        # Loop through the ServerClass' props
+        _weapon_prop_length = _find_weapon_prop_length(_current_class.table)
+
+        # Was m_hMyWeapons found?
+        if _weapon_prop_length is not None:
+
+            # No need to continue looping
+            break
+
+        # Move to the next ServerClass
+        _current_class = _current_class.next

addons/source-python/packages/source-python/players/games/base.py

@@ -5,6 +5,10 @@
 # =============================================================================
 # >> IMPORTS
 # =============================================================================
+# Source.Python Imports
+#   Core
+from core import GAME_NAME
+#   Players
 from players.classes.language import get_client_language
 
 
@@ -13,3 +17,102 @@
 # =============================================================================
 class _GameWeapons(object):
     """Base class for game specific weapon functionality."""
+
+    # =========================================================================
+    # >> BASE GAME-SPECIFIC FUNCTIONALITY
+    # =========================================================================
+    @property
+    def hegrenade_indexes(self):
+        """Yield all hegrenade indexes for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def get_hegrenade_ammo(self):
+        """Return the amount of hegrenade ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def set_hegrenade_ammo(self):
+        """Set the amount of hegrenade ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def flashbang_indexes(self):
+        """Yield all flashbang indexes for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def get_flashbang_ammo(self):
+        """Return the amount of flashbang ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def set_flashbang_ammo(self):
+        """Set the amount of flashbang ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def smokegrenade_indexes(self):
+        """Yield all smokegrenade indexes for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def get_smokegrenade_ammo(self):
+        """Return the amount of smokegrenade ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def set_smokegrenade_ammo(self):
+        """Set the amount of smokegrenade ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def decoy_indexes(self):
+        """Yield all decoy indexes for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def get_decoy_ammo(self):
+        """Return the amount of decoy ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def set_decoy_ammo(self):
+        """Set the amount of decoy ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def incendiary_indexes(self):
+        """Yield all incendiary indexes for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def get_incendiary_ammo(self):
+        """Return the amount of incendiary ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def set_incendiary_ammo(self):
+        """Set the amount of incendiary ammo for the player."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))
+
+    @property
+    def has_c4(self):
+        """Return whether or not the player is carrying C4."""
+        raise NotImplementedError(
+            'Not supported for game {0}.'.format(GAME_NAME))

addons/source-python/packages/source-python/players/games/csgo.py

@@ -8,6 +8,7 @@
 # Source.Python Imports
 #   Players
 from players.classes.language.cache import get_client_language
+from players.games.base import _GameWeapons as _BaseWeapons
 from players.weapons.projectiles import _HEGrenade
 from players.weapons.projectiles import _Flashbang
 from players.weapons.projectiles import _SmokeGrenade
@@ -20,5 +21,6 @@
 # >> CLASSES
 # =============================================================================
 class _GameWeapons(
-        _HEGrenade, _Flashbang, _SmokeGrenade, _Decoy, _Incendiary, _C4):
+        _HEGrenade, _Flashbang, _SmokeGrenade,
+        _Decoy, _Incendiary, _C4, _BaseWeapons):
     """CS:GO specific player weapon functionality."""

addons/source-python/packages/source-python/players/games/cstrike.py

@@ -7,6 +7,7 @@
 # =============================================================================
 # Source.Python Imports
 #   Players
+from players.games.base import _GameWeapons as _BaseWeapons
 from players.weapons.projectiles import _HEGrenade
 from players.weapons.projectiles import _Flashbang
 from players.weapons.projectiles import _SmokeGrenade
@@ -16,5 +17,5 @@
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class _GameWeapons(_HEGrenade, _Flashbang, _SmokeGrenade, _C4):
+class _GameWeapons(_HEGrenade, _Flashbang, _SmokeGrenade, _C4, _BaseWeapons):
     """CS:S specific player weapon functionality."""