flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

Player.h: Moved doxy-comments to Entity.h

Browse Source 
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()
This commit is contained in:
archshift 2014-06-10 23:16:38 -07:00
parent 5e90976cd9
commit aa7c82580f
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/Entities/Entity.h
View File

@ -220,11 +220,18 @@ public:
Vector3d m_Speed; Vector3d m_Speed;
// tolua_begin // 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); 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); } 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); virtual void SetSpeedX (double a_SpeedX);
/** Sets the speed for the Y axis */
virtual void SetSpeedY (double a_SpeedY); virtual void SetSpeedY (double a_SpeedY);
/** Sets the speed for the Z axis */
virtual void SetSpeedZ (double a_SpeedZ); virtual void SetSpeedZ (double a_SpeedZ);
void SetWidth (double a_Width); void SetWidth (double a_Width);
void AddPosX (double a_AddPosX); void AddPosX (double a_AddPosX);

6
src/Entities/Player.h
View File

@ -191,14 +191,14 @@ public:
// Sets the current gamemode, doesn't check validity, doesn't send update packets to client // Sets the current gamemode, doesn't check validity, doesn't send update packets to client
void LoginSetGameMode(eGameMode a_GameMode); 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 void ForceSetSpeed(const Vector3d & a_Speed); // tolua_export
/** Sets the speed of the player and moves them in the given speed. */ /** Sets the speed of the player and moves them in the given speed. */
void SetSpeed (const Vector3d & a_Speed); void SetSpeed (const Vector3d & a_Speed);
virtual void SetSpeed (double a_SpeedX, double a_SpeedY, double a_SpeedZ) override; 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 SetSpeedX (double a_SpeedX) override;
virtual void SetSpeedY (double a_SpeedY) override; virtual void SetSpeedY (double a_SpeedY) override;
virtual void SetSpeedZ (double a_SpeedZ) override; virtual void SetSpeedZ (double a_SpeedZ) override;