RemotePlayer/LocalPlayer Player base class proper separation (code cleanup) (patch 3 of X)

* remove IGameDef from Player class, only LocalPlayer has it now
* move many attributes/functions only used by LocalPlayer from Player to LocalPlayer
* move many attributes/functions only used by RemotePlayer from Player to RemotePlayer
* make some functions const
* hudGetHotbarSelectedImage now returns const ref
* RemotePlayer getHotbarSelectedImage now returns const ref
* various code style fixes

1 files changed, 107 insertions, 163 deletions

diff --git a/src/player.h b/src/player.h
index fbd88fc71..1980a86a3 100644
--- a/src/player.h
+++ b/src/player.h
@@ -112,7 +112,7 @@ class Player
 {
 public:
 
-	Player(IGameDef *gamedef, const char *name);
+	Player(const char *name, IItemDefManager *idef);
 	virtual ~Player() = 0;
 
 	virtual void move(f32 dtime, Environment *env, f32 pos_max_d)
@@ -151,80 +151,32 @@ public:
 
 	virtual void setPosition(const v3f &position)
 	{
-		if (position != m_position)
-			m_dirty = true;
 		m_position = position;
 	}
 
-	void setPitch(f32 pitch)
+	virtual void setPitch(f32 pitch)
 	{
-		if (pitch != m_pitch)
-			m_dirty = true;
 		m_pitch = pitch;
 	}
 
 	virtual void setYaw(f32 yaw)
 	{
-		if (yaw != m_yaw)
-			m_dirty = true;
 		m_yaw = yaw;
 	}
 
-	f32 getPitch()
-	{
-		return m_pitch;
-	}
-
-	f32 getYaw()
-	{
-		return m_yaw;
-	}
-
-	u16 getBreath()
-	{
-		return m_breath;
-	}
-
-	virtual void setBreath(u16 breath)
-	{
-		if (breath != m_breath)
-			m_dirty = true;
-		m_breath = breath;
-	}
-
-	// Deprecated
-	f32 getRadPitchDep()
-	{
-		return -1.0 * m_pitch * core::DEGTORAD;
-	}
-
-	// Deprecated
-	f32 getRadYawDep()
-	{
-		return (m_yaw + 90.) * core::DEGTORAD;
-	}
-
-	f32 getRadPitch()
-	{
-		return m_pitch * core::DEGTORAD;
-	}
+	f32 getPitch() const { return m_pitch; }
+	f32 getYaw() const { return m_yaw; }
+	u16 getBreath() const { return m_breath; }
 
-	f32 getRadYaw()
-	{
-		return m_yaw * core::DEGTORAD;
-	}
+	virtual void setBreath(u16 breath) { m_breath = breath; }
 
-	const char *getName() const
-	{
-		return m_name;
-	}
+	f32 getRadPitch() const { return m_pitch * core::DEGTORAD; }
+	f32 getRadYaw() const { return m_yaw * core::DEGTORAD; }
+	const char *getName() const { return m_name; }
+	aabb3f getCollisionbox() const { return m_collisionbox; }
 
-	aabb3f getCollisionbox()
+	u32 getFreeHudID()
 	{
-		return m_collisionbox;
-	}
-
-	u32 getFreeHudID() {
 		size_t size = hud.size();
 		for (size_t i = 0; i != size; i++) {
 			if (!hud[i])
@@ -233,41 +185,6 @@ public:
 		return size;
 	}
 
-	void setHotbarImage(const std::string &name)
-	{
-		hud_hotbar_image = name;
-	}
-
-	std::string getHotbarImage()
-	{
-		return hud_hotbar_image;
-	}
-
-	void setHotbarSelectedImage(const std::string &name)
-	{
-		hud_hotbar_selected_image = name;
-	}
-
-	std::string getHotbarSelectedImage() {
-		return hud_hotbar_selected_image;
-	}
-
-	void setSky(const video::SColor &bgcolor, const std::string &type,
-		const std::vector<std::string> &params)
-	{
-		m_sky_bgcolor = bgcolor;
-		m_sky_type = type;
-		m_sky_params = params;
-	}
-
-	void getSky(video::SColor *bgcolor, std::string *type,
-		std::vector<std::string> *params)
-	{
-		*bgcolor = m_sky_bgcolor;
-		*type = m_sky_type;
-		*params = m_sky_params;
-	}
-
 	void setLocalAnimations(v2s32 frames[4], float frame_speed)
 	{
 		for (int i = 0; i < 4; i++)
@@ -282,49 +199,8 @@ public:
 		*frame_speed = local_animation_speed;
 	}
 
-	virtual bool isLocal() const
-	{
-		return false;
-	}
+	virtual bool isLocal() const { return false; }
 
-	virtual void setPlayerSAO(PlayerSAO *sao)
-	{
-		FATAL_ERROR("FIXME");
-	}
-
-	/*
-		serialize() writes a bunch of text that can contain
-		any characters except a '\0', and such an ending that
-		deSerialize stops reading exactly at the right point.
-	*/
-	void serialize(std::ostream &os);
-	void deSerialize(std::istream &is, std::string playername);
-
-	bool checkModified() const
-	{
-		return m_dirty || inventory.checkModified();
-	}
-
-	void setModified(const bool x)
-	{
-		m_dirty = x;
-		if (!x)
-			inventory.setModified(x);
-	}
-
-	// Use a function, if isDead can be defined by other conditions
-	bool isDead() { return hp == 0; }
-
-	bool got_teleported;
-	bool touching_ground;
-	// This oscillates so that the player jumps a bit above the surface
-	bool in_liquid;
-	// This is more stable and defines the maximum speed of the player
-	bool in_liquid_stable;
-	// Gets the viscosity of water to calculate friction
-	u8 liquid_viscosity;
-	bool is_climbing;
-	bool swimming_vertical;
 	bool camera_barely_in_ceiling;
 	v3f eye_offset_first;
 	v3f eye_offset_third;
@@ -344,21 +220,11 @@ public:
 	f32 movement_liquid_sink;
 	f32 movement_gravity;
 
-	float physics_override_speed;
-	float physics_override_jump;
-	float physics_override_gravity;
-	bool physics_override_sneak;
-	bool physics_override_sneak_glitch;
-
 	v2s32 local_animations[4];
 	float local_animation_speed;
 
 	u16 hp;
 
-	float hurt_tilt_timer;
-	float hurt_tilt_strength;
-
-	u16 protocol_version;
 	u16 peer_id;
 
 	std::string inventory_formspec;
@@ -368,7 +234,6 @@ public:
 
 	u32 keyPressed;
 
-
 	HudElement* getHud(u32 id);
 	u32         addHud(HudElement* hud);
 	HudElement* removeHud(u32 id);
@@ -376,11 +241,7 @@ public:
 
 	u32 hud_flags;
 	s32 hud_hotbar_itemcount;
-	std::string hud_hotbar_image;
-	std::string hud_hotbar_selected_image;
 protected:
-	IGameDef *m_gamedef;
-
 	char m_name[PLAYERNAME_SIZE];
 	u16 m_breath;
 	f32 m_pitch;
@@ -389,13 +250,7 @@ protected:
 	v3f m_position;
 	aabb3f m_collisionbox;
 
-	bool m_dirty;
-
 	std::vector<HudElement *> hud;
-
-	std::string m_sky_type;
-	video::SColor m_sky_bgcolor;
-	std::vector<std::string> m_sky_params;
 private:
 	// Protect some critical areas
 	// hud for example can be modified by EmergeThread
@@ -414,15 +269,14 @@ enum RemotePlayerChatResult {
 class RemotePlayer : public Player
 {
 public:
-	RemotePlayer(IGameDef *gamedef, const char *name);
+	RemotePlayer(const char *name, IItemDefManager *idef);
 	virtual ~RemotePlayer() {}
 
-	void save(std::string savedir);
+	void save(std::string savedir, IGameDef *gamedef);
+	void deSerialize(std::istream &is, const std::string &playername);
 
-	PlayerSAO *getPlayerSAO()
-	{ return m_sao; }
-	void setPlayerSAO(PlayerSAO *sao)
-	{ m_sao = sao; }
+	PlayerSAO *getPlayerSAO() { return m_sao; }
+	void setPlayerSAO(PlayerSAO *sao) { m_sao = sao; }
 	void setPosition(const v3f &position);
 
 	const RemotePlayerChatResult canSendChatMessage();
@@ -446,8 +300,92 @@ public:
 		*ratio = m_day_night_ratio;
 	}
 
+	// Use a function, if isDead can be defined by other conditions
+	bool isDead() const { return hp == 0; }
+
+	void setHotbarImage(const std::string &name)
+	{
+		hud_hotbar_image = name;
+	}
+
+	std::string getHotbarImage() const
+	{
+		return hud_hotbar_image;
+	}
+
+	void setHotbarSelectedImage(const std::string &name)
+	{
+		hud_hotbar_selected_image = name;
+	}
+
+	const std::string &getHotbarSelectedImage() const
+	{
+		return hud_hotbar_selected_image;
+	}
+
+	// Deprecated
+	f32 getRadPitchDep() const { return -1.0 * m_pitch * core::DEGTORAD; }
+
+	// Deprecated
+	f32 getRadYawDep() const { return (m_yaw + 90.) * core::DEGTORAD; }
+
+	void setSky(const video::SColor &bgcolor, const std::string &type,
+				const std::vector<std::string> &params)
+	{
+		m_sky_bgcolor = bgcolor;
+		m_sky_type = type;
+		m_sky_params = params;
+	}
+
+	void getSky(video::SColor *bgcolor, std::string *type,
+				std::vector<std::string> *params)
+	{
+		*bgcolor = m_sky_bgcolor;
+		*type = m_sky_type;
+		*params = m_sky_params;
+	}
+
+	bool checkModified() const { return m_dirty || inventory.checkModified(); }
+
+	void setModified(const bool x)
+	{
+		m_dirty = x;
+		if (!x)
+			inventory.setModified(x);
+	}
+
+	virtual void setBreath(u16 breath)
+	{
+		if (breath != m_breath)
+			m_dirty = true;
+		Player::setBreath(breath);
+	}
+
+	virtual void setPitch(f32 pitch)
+	{
+		if (pitch != m_pitch)
+			m_dirty = true;
+		Player::setPitch(pitch);
+	}
+
+	virtual void setYaw(f32 yaw)
+	{
+		if (yaw != m_yaw)
+			m_dirty = true;
+		Player::setYaw(yaw);
+	}
+
+	u16 protocol_version;
 private:
+	/*
+		serialize() writes a bunch of text that can contain
+		any characters except a '\0', and such an ending that
+		deSerialize stops reading exactly at the right point.
+	*/
+	void serialize(std::ostream &os);
+
 	PlayerSAO *m_sao;
+	bool m_dirty;
 
 	static bool m_setting_cache_loaded;
 	static float m_setting_chat_message_limit_per_10sec;
@@ -459,6 +397,12 @@ private:
 
 	bool m_day_night_ratio_do_override;
 	float m_day_night_ratio;
+	std::string hud_hotbar_image;
+	std::string hud_hotbar_selected_image;
+
+	std::string m_sky_type;
+	video::SColor m_sky_bgcolor;
+	std::vector<std::string> m_sky_params;
 };
 
 #endif