From aa7c82580f2493052d119b1f27d5255c1609aa19 Mon Sep 17 00:00:00 2001 From: archshift Date: Tue, 10 Jun 2014 23:16:38 -0700 Subject: Player.h: Moved doxy-comments to Entity.h Moved doxy-comments to the defining function in Entity.h rather than the overloaded functions in Player.h Comment for each function (instead of assumed encapsulating comments) @deprecated tag for ForceSetSpeed() --- src/Entities/Entity.h | 7 +++++++ src/Entities/Player.h | 6 +++--- 2 files changed, 10 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/Entities/Entity.h b/src/Entities/Entity.h index ed67465a3..ecd26b194 100644 --- a/src/Entities/Entity.h +++ b/src/Entities/Entity.h @@ -220,11 +220,18 @@ public: Vector3d m_Speed; // tolua_begin + /** Sets the speed of the entity and moves them in the given speed. */ virtual void SetSpeed (double a_SpeedX, double a_SpeedY, double a_SpeedZ); + /** Sets the speed of the entity and moves them in the given speed. */ void SetSpeed (const Vector3d & a_Speed) { SetSpeed(a_Speed.x, a_Speed.y, a_Speed.z); } + + /** Sets the speed for the X axis */ virtual void SetSpeedX (double a_SpeedX); + /** Sets the speed for the Y axis */ virtual void SetSpeedY (double a_SpeedY); + /** Sets the speed for the Z axis */ virtual void SetSpeedZ (double a_SpeedZ); + void SetWidth (double a_Width); void AddPosX (double a_AddPosX); diff --git a/src/Entities/Player.h b/src/Entities/Player.h index 0f4773893..0fcf767e9 100644 --- a/src/Entities/Player.h +++ b/src/Entities/Player.h @@ -191,14 +191,14 @@ public: // Sets the current gamemode, doesn't check validity, doesn't send update packets to client void LoginSetGameMode(eGameMode a_GameMode); - /** Forces the player to move in the given direction. DEPRECATED! Use SetSpeed instead */ + /** Forces the player to move in the given direction. + * @deprecated Use SetSpeed instead. + */ void ForceSetSpeed(const Vector3d & a_Speed); // tolua_export /** Sets the speed of the player and moves them in the given speed. */ void SetSpeed (const Vector3d & a_Speed); virtual void SetSpeed (double a_SpeedX, double a_SpeedY, double a_SpeedZ) override; - - /** Sets the speed for the X, Y or Z axis */ virtual void SetSpeedX (double a_SpeedX) override; virtual void SetSpeedY (double a_SpeedY) override; virtual void SetSpeedZ (double a_SpeedZ) override; -- cgit v1.2.3