51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef PLAYER_HEADER
-#define PLAYER_HEADER
+#pragma once
#include "irrlichttypes_bloated.h"
#include "inventory.h"
-#include "constants.h" // BS
-#include "threading/mutex.h"
+#include "constants.h"
+#include "network/networkprotocol.h"
+#include "util/basic_macros.h"
#include <list>
+#include <mutex>
#define PLAYERNAME_SIZE 20
#define PLAYERNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_"
#define PLAYERNAME_ALLOWED_CHARS_USER_EXPL "'a' to 'z', 'A' to 'Z', '0' to '9', '-', '_'"
+struct PlayerFovSpec
+{
+ f32 fov;
+
+ // Whether to multiply the client's FOV or to override it
+ bool is_multiplier;
+
+ // The time to be take to trasition to the new FOV value.
+ // Transition is instantaneous if omitted. Omitted by default.
+ f32 transition_time;
+};
+
struct PlayerControl
{
- PlayerControl()
- {
- up = false;
- down = false;
- left = false;
- right = false;
- jump = false;
- aux1 = false;
- sneak = false;
- LMB = false;
- RMB = false;
- pitch = 0;
- yaw = 0;
- sidew_move_joystick_axis = .0f;
- forw_move_joystick_axis = .0f;
- }
+ PlayerControl() = default;
PlayerControl(
bool a_up,
sidew_move_joystick_axis = a_sidew_move_joystick_axis;
forw_move_joystick_axis = a_forw_move_joystick_axis;
}
- bool up;
- bool down;
- bool left;
- bool right;
- bool jump;
- bool aux1;
- bool sneak;
- bool zoom;
- bool LMB;
- bool RMB;
- float pitch;
- float yaw;
- float sidew_move_joystick_axis;
- float forw_move_joystick_axis;
+ bool up = false;
+ bool down = false;
+ bool left = false;
+ bool right = false;
+ bool jump = false;
+ bool aux1 = false;
+ bool sneak = false;
+ bool zoom = false;
+ bool LMB = false;
+ bool RMB = false;
+ float pitch = 0.0f;
+ float yaw = 0.0f;
+ float sidew_move_joystick_axis = 0.0f;
+ float forw_move_joystick_axis = 0.0f;
+};
+
+struct PlayerSettings
+{
+ bool free_move = false;
+ bool pitch_move = false;
+ bool fast_move = false;
+ bool continuous_forward = false;
+ bool always_fly_fast = false;
+ bool aux1_descends = false;
+ bool noclip = false;
+ bool autojump = false;
+
+ const std::string setting_names[8] = {
+ "free_move", "pitch_move", "fast_move", "continuous_forward", "always_fly_fast",
+ "aux1_descends", "noclip", "autojump"
+ };
+ void readGlobalSettings();
};
class Map;
-class IGameDef;
struct CollisionInfo;
-class PlayerSAO;
struct HudElement;
class Environment;
-// IMPORTANT:
-// Do *not* perform an assignment or copy operation on a Player or
-// RemotePlayer object! This will copy the lock held for HUD synchronization
class Player
{
public:
Player(const char *name, IItemDefManager *idef);
virtual ~Player() = 0;
+ DISABLE_CLASS_COPY(Player);
+
virtual void move(f32 dtime, Environment *env, f32 pos_max_d)
{}
virtual void move(f32 dtime, Environment *env, f32 pos_max_d,
std::vector<CollisionInfo> *collision_info)
{}
- v3f getSpeed()
+ const v3f &getSpeed() const
{
return m_speed;
}
- void setSpeed(v3f speed)
+ void setSpeed(const v3f &speed)
{
m_speed = speed;
}
- v3f getPosition()
- {
- return m_position;
- }
-
- v3s16 getLightPosition() const;
-
- v3f getEyeOffset()
- {
- float eye_height = camera_barely_in_ceiling ? 1.5f : 1.625f;
- return v3f(0, BS * eye_height, 0);
- }
-
- v3f getEyePosition()
- {
- return m_position + getEyeOffset();
- }
-
- virtual void setPosition(const v3f &position)
- {
- m_position = position;
- }
-
- virtual void setPitch(f32 pitch)
- {
- m_pitch = pitch;
- }
-
- virtual void setYaw(f32 yaw)
- {
- m_yaw = yaw;
- }
-
- f32 getPitch() const { return m_pitch; }
- f32 getYaw() const { return m_yaw; }
- u16 getBreath() const { return m_breath; }
-
- virtual void setBreath(u16 breath) { m_breath = breath; }
-
- 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; }
u32 getFreeHudID()
{
return size;
}
- void setLocalAnimations(v2s32 frames[4], float frame_speed)
- {
- for (int i = 0; i < 4; i++)
- local_animations[i] = frames[i];
- local_animation_speed = frame_speed;
- }
-
- void getLocalAnimations(v2s32 *frames, float *frame_speed)
- {
- for (int i = 0; i < 4; i++)
- frames[i] = local_animations[i];
- *frame_speed = local_animation_speed;
- }
-
- virtual bool isLocal() const { return false; }
-
- bool camera_barely_in_ceiling;
v3f eye_offset_first;
v3f eye_offset_third;
v2s32 local_animations[4];
float local_animation_speed;
- u16 hp;
-
- u16 peer_id;
-
std::string inventory_formspec;
+ std::string formspec_prepend;
PlayerControl control;
const PlayerControl& getPlayerControl() { return control; }
+ PlayerSettings &getPlayerSettings() { return m_player_settings; }
+ static void settingsChangedCallback(const std::string &name, void *data);
- u32 keyPressed;
+ // Returns non-empty `selected` ItemStack. `hand` is a fallback, if specified
+ ItemStack &getWieldedItem(ItemStack *selected, ItemStack *hand) const;
+ void setWieldIndex(u16 index);
+ u16 getWieldIndex() const { return m_wield_index; }
+
+ void setFov(const PlayerFovSpec &spec)
+ {
+ m_fov_override_spec = spec;
+ }
+
+ const PlayerFovSpec &getFov() const
+ {
+ return m_fov_override_spec;
+ }
+
+ u32 keyPressed = 0;
HudElement* getHud(u32 id);
u32 addHud(HudElement* hud);
u32 hud_flags;
s32 hud_hotbar_itemcount;
+
protected:
char m_name[PLAYERNAME_SIZE];
- u16 m_breath;
- f32 m_pitch;
- f32 m_yaw;
v3f m_speed;
- v3f m_position;
- aabb3f m_collisionbox;
+ u16 m_wield_index = 0;
+ PlayerFovSpec m_fov_override_spec = { 0.0f, false, 0.0f };
std::vector<HudElement *> hud;
private:
// Protect some critical areas
// hud for example can be modified by EmergeThread
// and ServerThread
- Mutex m_mutex;
-};
-
-enum RemotePlayerChatResult {
- RPLAYER_CHATRESULT_OK,
- RPLAYER_CHATRESULT_FLOODING,
- RPLAYER_CHATRESULT_KICK,
+ std::mutex m_mutex;
+ PlayerSettings m_player_settings;
};
-/*
- Player on the server
-*/
-class RemotePlayer : public Player
-{
-public:
- RemotePlayer(const char *name, IItemDefManager *idef);
- virtual ~RemotePlayer() {}
-
- 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; }
- void setPosition(const v3f &position);
-
- const RemotePlayerChatResult canSendChatMessage();
-
- void setHotbarItemcount(s32 hotbar_itemcount)
- {
- hud_hotbar_itemcount = hotbar_itemcount;
- }
-
- s32 getHotbarItemcount() const { return hud_hotbar_itemcount; }
-
- void overrideDayNightRatio(bool do_override, float ratio)
- {
- m_day_night_ratio_do_override = do_override;
- m_day_night_ratio = ratio;
- }
-
- void getDayNightRatio(bool *do_override, float *ratio)
- {
- *do_override = m_day_night_ratio_do_override;
- *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> ¶ms)
- {
- 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;
- static u16 m_setting_chat_message_limit_trigger_kick;
-
- u32 m_last_chat_message_sent;
- float m_chat_message_allowance;
- u16 m_message_rate_overhead;
-
- 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
-