3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "irrlichttypes_bloated.h"
23 #include "inventory.h"
24 #include "constants.h"
25 #include "network/networkprotocol.h"
26 #include "util/basic_macros.h"
30 #define PLAYERNAME_SIZE 20
32 #define PLAYERNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_"
33 #define PLAYERNAME_ALLOWED_CHARS_USER_EXPL "'a' to 'z', 'A' to 'Z', '0' to '9', '-', '_'"
43 PlayerControl() = default;
58 float a_sidew_move_joystick_axis,
59 float a_forw_move_joystick_axis
74 sidew_move_joystick_axis = a_sidew_move_joystick_axis;
75 forw_move_joystick_axis = a_forw_move_joystick_axis;
89 float sidew_move_joystick_axis = 0.0f;
90 float forw_move_joystick_axis = 0.0f;
95 bool free_move = false;
96 bool pitch_move = false;
97 bool fast_move = false;
98 bool continuous_forward = false;
99 bool always_fly_fast = false;
100 bool aux1_descends = false;
102 bool autojump = false;
104 const std::string setting_names[8] = {
105 "free_move", "pitch_move", "fast_move", "continuous_forward", "always_fly_fast",
106 "aux1_descends", "noclip", "autojump"
108 void readGlobalSettings();
112 struct CollisionInfo;
120 Player(const char *name, IItemDefManager *idef);
121 virtual ~Player() = 0;
123 DISABLE_CLASS_COPY(Player);
125 virtual void move(f32 dtime, Environment *env, f32 pos_max_d)
127 virtual void move(f32 dtime, Environment *env, f32 pos_max_d,
128 std::vector<CollisionInfo> *collision_info)
131 const v3f &getSpeed() const
136 void setSpeed(const v3f &speed)
141 const char *getName() const { return m_name; }
145 size_t size = hud.size();
146 for (size_t i = 0; i != size; i++) {
153 v3f eye_offset_first;
154 v3f eye_offset_third;
158 f32 movement_acceleration_default;
159 f32 movement_acceleration_air;
160 f32 movement_acceleration_fast;
161 f32 movement_speed_walk;
162 f32 movement_speed_crouch;
163 f32 movement_speed_fast;
164 f32 movement_speed_climb;
165 f32 movement_speed_jump;
166 f32 movement_liquid_fluidity;
167 f32 movement_liquid_fluidity_smooth;
168 f32 movement_liquid_sink;
169 f32 movement_gravity;
171 v2s32 local_animations[4];
172 float local_animation_speed;
174 std::string inventory_formspec;
175 std::string formspec_prepend;
177 PlayerControl control;
178 const PlayerControl& getPlayerControl() { return control; }
179 PlayerSettings &getPlayerSettings() { return m_player_settings; }
180 static void settingsChangedCallback(const std::string &name, void *data);
182 // Returns non-empty `selected` ItemStack. `hand` is a fallback, if specified
183 ItemStack &getWieldedItem(ItemStack *selected, ItemStack *hand) const;
184 void setWieldIndex(u16 index);
185 u16 getWieldIndex() const { return m_wield_index; }
187 void setFov(const PlayerFovSpec &spec)
192 const PlayerFovSpec &getFov() const
199 HudElement* getHud(u32 id);
200 u32 addHud(HudElement* hud);
201 HudElement* removeHud(u32 id);
205 s32 hud_hotbar_itemcount;
208 char m_name[PLAYERNAME_SIZE];
210 u16 m_wield_index = 0;
211 PlayerFovSpec m_fov_spec = { 0.0f, false };
213 std::vector<HudElement *> hud;
215 // Protect some critical areas
216 // hud for example can be modified by EmergeThread
219 PlayerSettings m_player_settings;