2010-11-29 19:13:04 +01:00
|
|
|
/*
|
2013-02-24 18:40:43 +01:00
|
|
|
Minetest
|
2013-02-24 19:38:45 +01:00
|
|
|
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
|
2010-11-29 19:13:04 +01:00
|
|
|
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
2012-06-05 16:56:56 +02:00
|
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
2010-11-29 19:13:04 +01:00
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2012-06-05 16:56:56 +02:00
|
|
|
GNU Lesser General Public License for more details.
|
2010-11-29 19:13:04 +01:00
|
|
|
|
2012-06-05 16:56:56 +02:00
|
|
|
You should have received a copy of the GNU Lesser General Public License along
|
2010-11-29 19:13:04 +01:00
|
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
*/
|
|
|
|
|
2017-08-17 22:19:39 +02:00
|
|
|
#pragma once
|
2010-11-27 00:02:21 +01:00
|
|
|
|
2012-06-17 03:00:31 +02:00
|
|
|
#include "irrlichttypes_bloated.h"
|
2010-11-27 00:02:21 +01:00
|
|
|
#include "inventory.h"
|
2017-06-18 19:55:15 +02:00
|
|
|
#include "constants.h"
|
2017-09-27 19:47:36 +02:00
|
|
|
#include "network/networkprotocol.h"
|
2017-08-14 10:52:59 +02:00
|
|
|
#include "util/basic_macros.h"
|
2014-04-15 19:49:32 +02:00
|
|
|
#include <list>
|
2017-06-06 16:29:28 +02:00
|
|
|
#include <mutex>
|
2024-01-14 17:46:29 +01:00
|
|
|
#include <functional>
|
2024-02-29 14:56:13 +01:00
|
|
|
#include <tuple>
|
2010-11-27 00:02:21 +01:00
|
|
|
|
|
|
|
#define PLAYERNAME_SIZE 20
|
2011-05-29 20:11:16 +02:00
|
|
|
|
|
|
|
#define PLAYERNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_"
|
2015-07-25 07:43:32 +02:00
|
|
|
#define PLAYERNAME_ALLOWED_CHARS_USER_EXPL "'a' to 'z', 'A' to 'Z', '0' to '9', '-', '_'"
|
2011-05-16 17:13:17 +02:00
|
|
|
|
2018-07-15 02:26:30 +02:00
|
|
|
struct PlayerFovSpec
|
|
|
|
{
|
|
|
|
f32 fov;
|
2020-05-02 12:52:11 +02:00
|
|
|
|
|
|
|
// Whether to multiply the client's FOV or to override it
|
2018-07-15 02:26:30 +02:00
|
|
|
bool is_multiplier;
|
2020-05-02 12:52:11 +02:00
|
|
|
|
|
|
|
// The time to be take to trasition to the new FOV value.
|
|
|
|
// Transition is instantaneous if omitted. Omitted by default.
|
2024-02-29 14:56:13 +01:00
|
|
|
f32 transition_time = 0;
|
|
|
|
|
|
|
|
inline bool operator==(const PlayerFovSpec &other) const {
|
|
|
|
// transition_time is compared here since that could be relevant
|
|
|
|
// when aborting a running transition.
|
|
|
|
return fov == other.fov && is_multiplier == other.is_multiplier &&
|
|
|
|
transition_time == other.transition_time;
|
|
|
|
}
|
|
|
|
inline bool operator!=(const PlayerFovSpec &other) const {
|
|
|
|
return !(*this == other);
|
|
|
|
}
|
2018-07-15 02:26:30 +02:00
|
|
|
};
|
|
|
|
|
2012-11-22 20:01:31 +01:00
|
|
|
struct PlayerControl
|
|
|
|
{
|
2017-08-19 14:25:35 +02:00
|
|
|
PlayerControl() = default;
|
2013-03-31 05:30:32 +02:00
|
|
|
|
2012-11-22 20:01:31 +01:00
|
|
|
PlayerControl(
|
2022-01-09 18:46:36 +01:00
|
|
|
bool a_up, bool a_down, bool a_left, bool a_right,
|
|
|
|
bool a_jump, bool a_aux1, bool a_sneak,
|
2013-03-31 05:30:32 +02:00
|
|
|
bool a_zoom,
|
2022-01-09 18:46:36 +01:00
|
|
|
bool a_dig, bool a_place,
|
|
|
|
float a_pitch, float a_yaw,
|
|
|
|
float a_movement_speed, float a_movement_direction
|
2012-11-22 20:01:31 +01:00
|
|
|
)
|
|
|
|
{
|
2022-01-09 18:46:36 +01:00
|
|
|
// Encode direction keys into a single value so nobody uses it accidentally
|
|
|
|
// as movement_{speed,direction} is supposed to be the source of truth.
|
|
|
|
direction_keys = (a_up&1) | ((a_down&1) << 1) |
|
|
|
|
((a_left&1) << 2) | ((a_right&1) << 3);
|
2012-11-22 20:01:31 +01:00
|
|
|
jump = a_jump;
|
|
|
|
aux1 = a_aux1;
|
|
|
|
sneak = a_sneak;
|
2013-03-31 05:30:32 +02:00
|
|
|
zoom = a_zoom;
|
2020-06-05 15:06:35 +02:00
|
|
|
dig = a_dig;
|
|
|
|
place = a_place;
|
2012-11-22 20:01:31 +01:00
|
|
|
pitch = a_pitch;
|
|
|
|
yaw = a_yaw;
|
2021-08-27 20:24:24 +02:00
|
|
|
movement_speed = a_movement_speed;
|
|
|
|
movement_direction = a_movement_direction;
|
2012-11-22 20:01:31 +01:00
|
|
|
}
|
2022-01-09 18:46:36 +01:00
|
|
|
|
|
|
|
#ifndef SERVER
|
|
|
|
// For client use
|
|
|
|
u32 getKeysPressed() const;
|
|
|
|
inline bool isMoving() const { return movement_speed > 0.001f; }
|
|
|
|
#endif
|
|
|
|
|
|
|
|
// For server use
|
|
|
|
void unpackKeysPressed(u32 keypress_bits);
|
|
|
|
|
|
|
|
u8 direction_keys = 0;
|
2017-06-18 19:55:15 +02:00
|
|
|
bool jump = false;
|
|
|
|
bool aux1 = false;
|
|
|
|
bool sneak = false;
|
|
|
|
bool zoom = false;
|
2020-06-05 15:06:35 +02:00
|
|
|
bool dig = false;
|
|
|
|
bool place = false;
|
2022-01-09 18:46:36 +01:00
|
|
|
// Note: These four are NOT available on the server
|
2017-06-18 19:55:15 +02:00
|
|
|
float pitch = 0.0f;
|
|
|
|
float yaw = 0.0f;
|
2021-08-27 20:24:24 +02:00
|
|
|
float movement_speed = 0.0f;
|
|
|
|
float movement_direction = 0.0f;
|
2012-11-22 20:01:31 +01:00
|
|
|
};
|
|
|
|
|
2022-08-12 11:17:02 +02:00
|
|
|
struct PlayerPhysicsOverride
|
|
|
|
{
|
|
|
|
float speed = 1.f;
|
|
|
|
float jump = 1.f;
|
|
|
|
float gravity = 1.f;
|
|
|
|
|
|
|
|
bool sneak = true;
|
|
|
|
bool sneak_glitch = false;
|
|
|
|
// "Temporary" option for old move code
|
|
|
|
bool new_move = true;
|
2023-09-15 20:10:08 +02:00
|
|
|
|
|
|
|
float speed_climb = 1.f;
|
|
|
|
float speed_crouch = 1.f;
|
|
|
|
float liquid_fluidity = 1.f;
|
|
|
|
float liquid_fluidity_smooth = 1.f;
|
|
|
|
float liquid_sink = 1.f;
|
|
|
|
float acceleration_default = 1.f;
|
|
|
|
float acceleration_air = 1.f;
|
2024-02-29 14:56:13 +01:00
|
|
|
|
|
|
|
private:
|
|
|
|
auto tie() const {
|
|
|
|
// Make sure to add new members to this list!
|
|
|
|
return std::tie(
|
|
|
|
speed, jump, gravity, sneak, sneak_glitch, new_move, speed_climb, speed_crouch,
|
|
|
|
liquid_fluidity, liquid_fluidity_smooth, liquid_sink, acceleration_default,
|
|
|
|
acceleration_air
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
public:
|
|
|
|
bool operator==(const PlayerPhysicsOverride &other) const {
|
|
|
|
return tie() == other.tie();
|
|
|
|
};
|
|
|
|
bool operator!=(const PlayerPhysicsOverride &other) const {
|
|
|
|
return tie() != other.tie();
|
|
|
|
};
|
2022-08-12 11:17:02 +02:00
|
|
|
};
|
|
|
|
|
2018-04-18 20:56:01 +02:00
|
|
|
struct PlayerSettings
|
|
|
|
{
|
|
|
|
bool free_move = false;
|
2018-12-31 01:07:30 +01:00
|
|
|
bool pitch_move = false;
|
2018-04-18 20:56:01 +02:00
|
|
|
bool fast_move = false;
|
|
|
|
bool continuous_forward = false;
|
|
|
|
bool always_fly_fast = false;
|
|
|
|
bool aux1_descends = false;
|
|
|
|
bool noclip = false;
|
2018-11-22 22:47:15 +01:00
|
|
|
bool autojump = false;
|
2018-04-18 20:56:01 +02:00
|
|
|
|
2018-12-01 10:01:32 +01:00
|
|
|
const std::string setting_names[8] = {
|
2018-12-31 01:07:30 +01:00
|
|
|
"free_move", "pitch_move", "fast_move", "continuous_forward", "always_fly_fast",
|
2018-11-22 22:47:15 +01:00
|
|
|
"aux1_descends", "noclip", "autojump"
|
2018-06-24 14:35:29 +02:00
|
|
|
};
|
2018-04-18 20:56:01 +02:00
|
|
|
void readGlobalSettings();
|
|
|
|
};
|
|
|
|
|
2010-11-27 00:02:21 +01:00
|
|
|
class Map;
|
2012-01-23 20:23:56 +01:00
|
|
|
struct CollisionInfo;
|
2013-05-20 03:26:08 +02:00
|
|
|
struct HudElement;
|
2014-04-15 19:49:32 +02:00
|
|
|
class Environment;
|
2010-11-27 00:02:21 +01:00
|
|
|
|
|
|
|
class Player
|
|
|
|
{
|
|
|
|
public:
|
2011-05-16 11:41:19 +02:00
|
|
|
|
2016-10-08 17:56:38 +02:00
|
|
|
Player(const char *name, IItemDefManager *idef);
|
2012-03-19 03:04:16 +01:00
|
|
|
virtual ~Player() = 0;
|
2010-11-27 00:02:21 +01:00
|
|
|
|
2017-08-14 10:52:59 +02:00
|
|
|
DISABLE_CLASS_COPY(Player);
|
|
|
|
|
2014-04-15 19:49:32 +02:00
|
|
|
virtual void move(f32 dtime, Environment *env, f32 pos_max_d)
|
|
|
|
{}
|
|
|
|
virtual void move(f32 dtime, Environment *env, f32 pos_max_d,
|
2015-04-01 05:33:30 +02:00
|
|
|
std::vector<CollisionInfo> *collision_info)
|
2012-03-19 03:04:16 +01:00
|
|
|
{}
|
2010-11-27 00:02:21 +01:00
|
|
|
|
2023-06-16 20:15:21 +02:00
|
|
|
// in BS-space
|
2022-06-07 21:27:05 +02:00
|
|
|
v3f getSpeed() const
|
2010-11-27 00:02:21 +01:00
|
|
|
{
|
|
|
|
return m_speed;
|
|
|
|
}
|
|
|
|
|
2023-06-16 20:15:21 +02:00
|
|
|
// in BS-space
|
2022-06-07 21:27:05 +02:00
|
|
|
void setSpeed(v3f speed)
|
2010-11-27 00:02:21 +01:00
|
|
|
{
|
|
|
|
m_speed = speed;
|
|
|
|
}
|
2015-04-01 05:33:30 +02:00
|
|
|
|
2016-10-08 17:56:38 +02:00
|
|
|
const char *getName() const { return m_name; }
|
2010-11-27 00:02:21 +01:00
|
|
|
|
2016-10-08 17:56:38 +02:00
|
|
|
u32 getFreeHudID()
|
2015-07-03 05:14:30 +02:00
|
|
|
{
|
2013-08-11 04:09:45 +02:00
|
|
|
size_t size = hud.size();
|
|
|
|
for (size_t i = 0; i != size; i++) {
|
|
|
|
if (!hud[i])
|
|
|
|
return i;
|
|
|
|
}
|
|
|
|
return size;
|
|
|
|
}
|
|
|
|
|
2015-05-26 14:10:08 +02:00
|
|
|
v3f eye_offset_first;
|
|
|
|
v3f eye_offset_third;
|
2023-10-02 13:44:03 +02:00
|
|
|
v3f eye_offset_third_front;
|
2015-04-01 05:33:30 +02:00
|
|
|
|
2010-11-27 00:02:21 +01:00
|
|
|
Inventory inventory;
|
|
|
|
|
2013-02-08 21:54:01 +01:00
|
|
|
f32 movement_acceleration_default;
|
|
|
|
f32 movement_acceleration_air;
|
|
|
|
f32 movement_acceleration_fast;
|
|
|
|
f32 movement_speed_walk;
|
|
|
|
f32 movement_speed_crouch;
|
|
|
|
f32 movement_speed_fast;
|
|
|
|
f32 movement_speed_climb;
|
|
|
|
f32 movement_speed_jump;
|
|
|
|
f32 movement_liquid_fluidity;
|
|
|
|
f32 movement_liquid_fluidity_smooth;
|
|
|
|
f32 movement_liquid_sink;
|
|
|
|
f32 movement_gravity;
|
|
|
|
|
2014-04-12 13:50:22 +02:00
|
|
|
v2s32 local_animations[4];
|
2014-01-08 13:47:53 +01:00
|
|
|
float local_animation_speed;
|
|
|
|
|
2012-07-19 13:09:16 +02:00
|
|
|
std::string inventory_formspec;
|
2018-03-28 17:04:41 +02:00
|
|
|
std::string formspec_prepend;
|
2015-04-01 05:33:30 +02:00
|
|
|
|
2012-11-22 20:01:31 +01:00
|
|
|
PlayerControl control;
|
2016-10-08 10:38:04 +02:00
|
|
|
const PlayerControl& getPlayerControl() { return control; }
|
2022-08-12 11:17:02 +02:00
|
|
|
PlayerPhysicsOverride physics_override;
|
2018-04-18 20:56:01 +02:00
|
|
|
PlayerSettings &getPlayerSettings() { return m_player_settings; }
|
|
|
|
static void settingsChangedCallback(const std::string &name, void *data);
|
2015-04-01 05:33:30 +02:00
|
|
|
|
2019-08-07 19:16:31 +02:00
|
|
|
// 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; }
|
|
|
|
|
2024-02-29 14:56:13 +01:00
|
|
|
bool setFov(const PlayerFovSpec &spec)
|
2018-07-15 02:26:30 +02:00
|
|
|
{
|
2024-02-29 14:56:13 +01:00
|
|
|
if (m_fov_override_spec == spec)
|
|
|
|
return false;
|
2020-05-02 12:52:11 +02:00
|
|
|
m_fov_override_spec = spec;
|
2024-02-29 14:56:13 +01:00
|
|
|
return true;
|
2018-07-15 02:26:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
const PlayerFovSpec &getFov() const
|
|
|
|
{
|
2020-05-02 12:52:11 +02:00
|
|
|
return m_fov_override_spec;
|
2018-07-15 02:26:30 +02:00
|
|
|
}
|
|
|
|
|
2014-05-25 14:34:32 +02:00
|
|
|
HudElement* getHud(u32 id);
|
2024-01-14 17:46:29 +01:00
|
|
|
void hudApply(std::function<void(const std::vector<HudElement*>&)> f);
|
2014-05-25 14:34:32 +02:00
|
|
|
u32 addHud(HudElement* hud);
|
|
|
|
HudElement* removeHud(u32 id);
|
|
|
|
void clearHud();
|
|
|
|
|
2013-04-24 12:52:46 +02:00
|
|
|
u32 hud_flags;
|
2013-05-04 02:08:52 +02:00
|
|
|
s32 hud_hotbar_itemcount;
|
2018-07-15 02:26:30 +02:00
|
|
|
|
2010-11-27 00:02:21 +01:00
|
|
|
protected:
|
|
|
|
char m_name[PLAYERNAME_SIZE];
|
2023-06-16 20:15:21 +02:00
|
|
|
v3f m_speed; // velocity; in BS-space
|
2019-08-07 19:16:31 +02:00
|
|
|
u16 m_wield_index = 0;
|
2020-05-02 12:52:11 +02:00
|
|
|
PlayerFovSpec m_fov_override_spec = { 0.0f, false, 0.0f };
|
2013-06-28 16:06:34 +02:00
|
|
|
|
2014-05-25 14:34:32 +02:00
|
|
|
std::vector<HudElement *> hud;
|
2015-03-22 20:09:44 +01:00
|
|
|
private:
|
|
|
|
// Protect some critical areas
|
|
|
|
// hud for example can be modified by EmergeThread
|
|
|
|
// and ServerThread
|
2017-06-06 16:29:28 +02:00
|
|
|
std::mutex m_mutex;
|
2018-04-18 20:56:01 +02:00
|
|
|
PlayerSettings m_player_settings;
|
2010-11-27 00:02:21 +01:00
|
|
|
};
|