Player class updates (#276)

* Added _Player mixin to speed up things

* Added missing property

* Removed properties from data files

Those properties have been moved to C++ last year

* Fixed documentation

* Also take advantage of the speed improvements on CS:GO

* Moved eye_angle and view_vector to the C++ side

* Moved view_angle

* Moved game specific properties

* Renamed _Player to PlayerMixin

Added PlayerMixin to documentation

* Fixed PlayerWrapper::SetSpeed

* Fixed ValueError message

* Renamed PlayerWrapper to PlayerMixin on the C++ side as well

Author: Ayuto

addons/source-python/data/source-python/entities/CBaseEntity.ini

@@ -23,64 +23,12 @@
 
 [keyvalue]
 
-    avelocity = avelocity
-    base_velocity = basevelocity
-    class_name = classname
-    damage_filter = damagefilter
-    effects = effects
-    friction = friction
-    global_name = globalname
-    gravity = gravity
-    hammerid = hammerid
-    health = health
-    ltime = ltime
-    max_health = max_health
-    parent_name = parentname
-    render_color = rendercolor
-    render_mode = rendermode
-    shadow_cast_dist = shadowcastdist
-    spawn_flags = spawnflags
-    speed = speed
-    target = target
-    velocity = velocity
     view_ofs = view_ofs
-    water_level = waterlevel
 
     # =========================================================================
     # >> Hard-coded KeyValues
     # =========================================================================
 
-    [[angles]]
-        name = angles
-        type = VECTOR
-
-    [[origin]]
-        name = origin
-        type = VECTOR
-
     [[render_amt]]
         name = renderamt
         type = SHORT
-
-    [[target_name]]
-        name = targetname
-        type = STRING
-
-
-[property]
-
-    maxs = m_Collision.m_vecMaxs
-    mins = m_Collision.m_vecMins
-    solid_type = m_Collision.m_nSolidType
-    solid_flags = m_Collision.m_usSolidFlags
-    collision_group = m_CollisionGroup
-    rotation = m_angRotation
-    render = m_clrRender
-    elasticity = m_flElasticity
-    ground_entity = m_hGroundEntity
-    owner_handle = m_hOwnerEntity
-    team_index = m_iTeamNum
-    render_fx = m_nRenderFX
-    render_mode_prop = m_nRenderMode
-    move_type = movetype
-    parent_inthandle = m_pParent

addons/source-python/docs/source-python/source/developing/modules/players._base.rst

@@ -5,3 +5,8 @@ players._base module
     :members:
     :undoc-members:
     :show-inheritance:
+
+.. autoclass:: _players.PlayerMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:

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

@@ -55,6 +55,7 @@
 from memory import get_object_pointer
 from memory import make_object
 #   Players
+from _players import PlayerMixin
 from players.constants import PlayerStates
 from players.helpers import address_from_playerinfo
 from players.helpers import get_client_language
@@ -73,7 +74,7 @@
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class Player(Entity):
+class Player(Entity, PlayerMixin):
     """Class used to interact directly with players."""
 
     def __init__(self, index):
@@ -380,33 +381,12 @@ def set_eye_location(self, eye_location):
 
     eye_location = property(Entity.get_eye_location, set_eye_location)
 
-    @property
-    def view_vector(self):
-        """Return the view vector of the player.
-
-        :rtype: Vector
-        """
-        eye_angle = self.eye_angle
-
-        yaw = math.radians(eye_angle.y)
-        pitch = math.radians(eye_angle.x)
-
-        sy = math.sin(yaw)
-        cy = math.cos(yaw)
-        sp = math.sin(pitch)
-        cp = math.cos(pitch)
-
-        return Vector(cp * cy, cp * sy, -sp)
-
     def get_view_angle(self):
         """Return the player's view angle.
 
         :rtype: QAngle
         """
-        eye_angle = self.eye_angle
-        eye_angle_y = eye_angle.y
-        eye_angle_y = (eye_angle_y + 360) if eye_angle_y < 0 else eye_angle_y
-        return QAngle(eye_angle.x, eye_angle_y, self.rotation.z)
+        return super().view_angle
 
     def set_view_angle(self, angle):
         """Set the player's view angle."""

addons/source-python/packages/source-python/players/engines/csgo/__init__.py

@@ -43,7 +43,7 @@ class Player(_Player):
 
     def _get_kills(self):
         """Return the number of kills the player has."""
-        return self.__getattr__('kills')
+        return super().kills
 
     def _set_kills(self, value):
         """Set the number of kills the player has."""
@@ -54,7 +54,7 @@ def _set_kills(self, value):
 
     def _get_deaths(self):
         """Return the number of deaths the player has."""
-        return self.__getattr__('deaths')
+        return super().deaths
 
     def _set_deaths(self, value):
         """Set the number of deaths the player has."""
@@ -65,7 +65,7 @@ def _set_deaths(self, value):
 
     def _get_assists(self):
         """Return the number of assists the player has."""
-        return self.__getattr__('assists')
+        return super().assists
 
     def _set_assists(self, value):
         """Set the number of assists the player has."""

src/CMakeLists.txt

@@ -381,6 +381,7 @@ Set(SOURCEPYTHON_PHYSICS_MODULE_SOURCES
 # ------------------------------------------------------------------
 Set(SOURCEPYTHON_PLAYERS_MODULE_HEADERS
     core/modules/players/players_wrap.h
+    core/modules/players/players_entity.h
     core/modules/players/players_generator.h
     core/modules/players/${SOURCE_ENGINE}/players_constants_wrap.h
     core/modules/players/${SOURCE_ENGINE}/players_wrap.h
@@ -389,6 +390,7 @@ Set(SOURCEPYTHON_PLAYERS_MODULE_HEADERS
 Set(SOURCEPYTHON_PLAYERS_MODULE_SOURCES
     core/modules/players/players_bots_wrap.cpp
     core/modules/players/players_constants_wrap.cpp
+    core/modules/players/players_entity.cpp
     core/modules/players/players_helpers_wrap.cpp
     core/modules/players/players_wrap.cpp
     core/modules/players/players_generator.cpp

src/core/modules/entities/entities_entity.h

@@ -80,7 +80,7 @@ class IServerUnknownExt
 //-----------------------------------------------------------------------------
 class CBaseEntityWrapper: public IServerEntity
 {
-private:
+protected:
 	// Make sure that nobody can call the constructor/destructor
 	CBaseEntityWrapper() {}
 	~CBaseEntityWrapper() {}

src/core/modules/entities/entities_entity_wrap.cpp

@@ -328,6 +328,14 @@ void export_base_entity(scope _entity)
 		":rtype: int"
 	);
 
+	BaseEntity.add_property(
+		"parent_name",
+		&CBaseEntityWrapper::GetParentName,
+		&CBaseEntityWrapper::SetParentName,
+		"Get/set the entity's parent name.\n\n"
+		":rtype: str"
+	);
+
 	BaseEntity.add_property(
 		"shadow_cast_distance",
 		&CBaseEntityWrapper::GetShadowCastDistance,