Converted all C++ side conversions functions to use the C++ side naming ie index_from_edict is now IndexFromEdict. The changes do not affect Python side imports.

Fixed all conversions_c functions to use inline.

Changed all pointer_from_<type> functions to return a CPointer instance instead of just the memory location.

Updated some data files to reflect recent changes in method names.

Changed name of a few entities package classes (EntityFunctions, EntityKeyValues, EntityOffset, and EntityProperties).  Imports of these have always been by BaseEntity itself, so no real changes for scripters.

The new Entity classes now all inherit from EntityAttributes, since much of the functionality of each of the classes was identical.

Author: satoon101

addons/source-python/data/source-python/keyvalues/entity/csgo.ini

@@ -1 +1 @@
-gravity = Float
+gravity = float

addons/source-python/data/source-python/keyvalues/entity/cstrike.ini

@@ -1 +1 @@
-gravity = Float
+gravity = float

addons/source-python/data/source-python/offsets/player/csgo.ini

@@ -1,19 +1,19 @@
 [kills]
 nt = 3760
 linux = 3780
-type = "Int"
+type = "int"
 
 [assists]
 nt = 3764
 linux = 3784
-type = "Int"
+type = "int"
 
 [deaths]
 nt = 3768
 linux = 3788
-type = "Int"
+type = "int"
 
 [hitgroup]
 nt = 1776
 linux = 1800
-type = "Int"
+type = "int"

addons/source-python/packages/source-python/entities/attributes.py

@@ -0,0 +1,84 @@
+# ../entities/attributes.py
+
+# =============================================================================
+# >> IMPORTS
+# =============================================================================
+# Site-Package Imports
+#   ConfigObj
+from configobj import ConfigObj
+
+# Source.Python Imports
+from core import GAME_NAME
+from paths import SP_DATA_PATH
+
+
+# =============================================================================
+# >> ALL DECLARATION
+# =============================================================================
+__all__ = []
+
+
+# =============================================================================
+# >> CLASSES
+# =============================================================================
+class EntityAttributes(dict):
+    '''Base Attribute class used to interact with
+        entity's based off of ini data files.'''
+
+    '''Each class that inherits from EntityAttributes
+                    must have the following attributes:
+        type        -   used to know which directory within data to get values
+        unrepr      -   used to know what to have ConfigObj unrepr set to
+        instance    -   used to know which class to use to create the objects
+    '''
+
+    def __missing__(self, entity):
+        '''Called the first time an entity is added to the dictionary'''
+
+        # Get all attributes for the given entity
+        values = self[entity] = self._retrieve_attributes(entity)
+
+        # Return the attributes and their values
+        return values
+
+    def get_game_attributes(self, args):
+        '''Returns all attributes for the given entities'''
+
+        # Create an empty dictionary
+        values = dict()
+
+        # Loop through all given entities
+        for arg in args:
+
+            # Add teh entities to the dictionary
+            values.update(self[arg])
+
+        # Return all attributes for the given entities
+        return values
+
+    def _retrieve_attributes(self, entity):
+        '''Retrieves all attributes for the given entity'''
+
+        # Create an empty dictionary
+        game_attributes = dict()
+
+        # Get the path to the entity's attributes
+        inifile = SP_DATA_PATH.joinpath(self.type, entity, GAME_NAME + '.ini')
+
+        # Does the file exist?
+        if not inifile.isfile():
+
+            # Return the empty dictionary
+            return game_attributes
+
+        # Get the file's contents
+        ini = ConfigObj(inifile, unrepr=self.unrepr)
+
+        # Loop through all items in the file
+        for key in ini:
+
+            # Add the item to the dictionary
+            game_attributes[key] = self.instance(ini[key])
+
+        # Return the dictionary
+        return game_attributes

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

@@ -8,10 +8,10 @@
 from conversions_c import edict_from_index
 from public import public
 #   Entities
-#from entities.functions import Functions
-from entities.keyvalues import KeyValues
-from entities.offsets import Offsets
-from entities.properties import Properties
+#from entities.functions import EntityFunctions
+from entities.keyvalues import EntityKeyValues
+from entities.offsets import EntityOffsets
+from entities.properties import EntityProperties
 #from entities.specials import _EntitySpecials
 
 
@@ -328,19 +328,19 @@ def pointer(self):
     @property
     def properties(self):
         '''Returns all properties for all entities'''
-        return Properties.get_entity_properties(self.entities)
+        return EntityProperties.get_game_attributes(self.entities)
 
     @property
     def keyvalues(self):
         '''Returns all keyvalues for all entities'''
-        return KeyValues.get_entity_keyvalues(self.entities)
+        return EntityKeyValues.get_game_attributes(self.entities)
 
     @property
     def offsets(self):
         '''Returns all offsets for all entities'''
-        return Offsets.get_entity_offsets(self.entities)
+        return EntityOffsets.get_game_attributes(self.entities)
 
     @property
     def functions(self):
         '''Returns all dynamic calling functions for all entities'''
-        return Functions.get_entity_functions(self.entities)
+        return EntityFunctions.get_game_attributes(self.entities)

addons/source-python/packages/source-python/entities/functions.py

@@ -3,15 +3,11 @@
 # =============================================================================
 # >> IMPORTS
 # =============================================================================
-# Site Package Imports
-#   ConfigObj
-from configobj import ConfigObj
-
 # Source.Python Imports
-from core import GAME_NAME
-from paths import SP_DATA_PATH
 #   DynCall
 from dyncall.dictionary import SignatureDictionary
+#   Entities
+from entities.attributes import EntityAttributes
 
 
 # =============================================================================
@@ -21,47 +17,9 @@
 __all__ = []
 
 
-# =============================================================================
-# >> GLOBAL VARIABLES
-# =============================================================================
-# Store the base "functions" path
-_basepath = SP_DATA_PATH.joinpath('functions')
-
-
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class _Functions(dict):
-    '''Dictionary that stores all entities with their functions'''
-
-    def __missing__(self, item):
-        '''Called the first time an entity is added to the dictionary'''
-
-        # Get all functions for the given entity
-        value = self[item] = _get_all_entity_functions(item)
-
-        # Return the functions
-        return value
-
-    def get_entity_functions(self, args):
-        '''Returns all functions for the given entities'''
-
-        # Create an empty dictionary
-        values = dict()
-
-        # Loop through all given entities
-        for arg in args:
-
-            # Add the entities to the dictionary
-            values.update(self[arg])
-
-        # Return all functions for the given entities
-        return values
-
-# Get the _Functions instance
-Functions = _Functions()
-
-
 class _FunctionInstance(object):
     '''Class used to store a function to be called with
         the entity's pointer as the first argument'''
@@ -108,32 +66,12 @@ def _pre_call_function(self, *args):
         self.current_pointer = None
 
 
-# =============================================================================
-# >> FUNCTIONS
-# =============================================================================
-def _get_all_entity_functions(entity):
-    '''Retrieves all functions for the given entity'''
-
-    # Create an empty dictionary to pass
-    game_functions = {}
-
-    # Get the path to the entity's function file
-    inifile = _basepath.join(entity, GAME_NAME + '.ini')
-
-    # Does the file exist?
-    if not inifile.isfile():
-
-        # Return the empty dictionary
-        return game_functions
-
-    # Get the file's contents
-    ini = ConfigObj(inifile, unrepr=True)
-
-    # Loop through all items in the file
-    for key in ini:
+class _EntityFunctions(EntityAttributes):
+    '''Dictionary that stores all entities with their functions'''
 
-        # Add the item to the dictionary
-        game_functions[key] = _FunctionInstance(ini[key])
+    type = 'functions'
+    unrepr = True
+    instance = _FunctionInstance
 
-    # Return the dictionary
-    return game_functions
+# Get the _EntityFunctions instance
+EntityFunctions = _EntityFunctions()

addons/source-python/packages/source-python/entities/helpers.py

@@ -7,8 +7,23 @@
 from conversions_c import *
 
 
+# =============================================================================
+# >> PLAYER OBJECT REMOVAL
+# =============================================================================
+# Loop through all functions imported
+for function in dict(globals()):
+
+    # Is the current function a "player" based function?
+    if 'playerinfo' in function or 'userid' in function:
+
+        # Remove the function
+        del globals()[function]
+
+# Remove the function variable
+del function
+
+
 # =============================================================================
 # >> ALL DECLARATION
 # =============================================================================
-__all__ = [x for x in globals() if not 'userid' in x and
-    not 'playerinfo' in x and not x.startswith('__')]
+__all__ = [x for x in globals() if not x.startswith('__')]

addons/source-python/packages/source-python/entities/keyvalues.py

@@ -3,13 +3,9 @@
 # =============================================================================
 # >> IMPORTS
 # =============================================================================
-# Site Package Imports
-#   ConfigObj
-from configobj import ConfigObj
-
 # Source.Python Imports
-from core import GAME_NAME
-from paths import SP_DATA_PATH
+#   Entities
+from entities.attributes import EntityAttributes
 
 
 # =============================================================================
@@ -19,73 +15,15 @@
 __all__ = []
 
 
-# =============================================================================
-# >> GLOBAL VARIABLES
-# =============================================================================
-# Store the base "keyvalues" path
-_basepath = SP_DATA_PATH.joinpath('keyvalues')
-
-
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class _KeyValues(dict):
+class _EntityKeyValues(EntityAttributes):
     '''Dictionary that stores all entities with their keyvalues'''
 
-    def __missing__(self, item):
-        '''Called the first time an entity is added to the dictionary'''
-
-        # Get all keyvalues for the given entity
-        value = self[item] = _get_all_entity_keyvalues(item)
-
-        # Return the keyvalues
-        return value
-
-    def get_entity_keyvalues(self, args):
-        '''Returns all keyvalues for the given entities'''
-
-        # Create an empty dictionary
-        values = dict()
-
-        # Loop through all given entities
-        for arg in args:
-
-            # Add the entities to the dictionary
-            values.update(self[arg])
-
-        # Return all keyvalues for the given entities
-        return values
-
-# Get the _KeyValues instance
-KeyValues = _KeyValues()
-
-
-# =============================================================================
-# >> FUNCTIONS
-# =============================================================================
-def _get_all_entity_keyvalues(entity):
-    '''Retrieves all keyvalues for the given entity'''
-
-    # Create an empty dictionary to pass
-    game_keyvalues = {}
-
-    # Get the path to the entity's keyvalue file
-    inifile = _basepath.joinpath(entity, GAME_NAME + '.ini')
-
-    # Does the file exist?
-    if not inifile.isfile():
-
-        # Return the empty dictionary
-        return game_keyvalues
-
-    # Get the file's contents
-    ini = ConfigObj(inifile)
-
-    # Loop through all items in the file
-    for key in ini:
-
-        # Add the item to the dictionary
-        game_keyvalues[key] = ini[key]
+    type = 'keyvalues'
+    unrepr = False
+    instance = staticmethod(lambda value: value)
 
-    # Return the dictionary
-    return game_keyvalues
+# Get the _EntityKeyValues instance
+EntityKeyValues = _EntityKeyValues()