src/script/cpp_api/s_client.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2017 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #pragma once
  22
  23 #include "util/pointedthing.h"
  24 #include "cpp_api/s_base.h"
  25 #include "mapnode.h"
  26 #include "itemdef.h"
  27 #include "util/string.h"
  28 #include "util/pointedthing.h"
  29 #include "lua_api/l_item.h"
  30 #include "particles.h"
  31
  32 #ifdef _CRT_MSVCP_CURRENT
  33 #include <cstdint>
  34 #endif
  35
  36 class ClientEnvironment;
  37
  38 class ScriptApiClient : virtual public ScriptApiBase
  39 {
  40 public:
  41         // Calls when mods are loaded
  42         void on_mods_loaded();
  43
  44         // Calls on_shutdown handlers
  45         void on_shutdown();
  46
  47         // Chat message handlers
  48         bool on_sending_message(const std::string &message);
  49         bool on_receiving_message(const std::string &message);
  50
  51         void on_damage_taken(int32_t damage_amount);
  52         void on_hp_modification(int32_t newhp);
  53         void on_death();
  54         void environment_step(float dtime);
  55         void on_formspec_input(const std::string &formname, const StringMap &fields);
  56
  57         bool on_dignode(v3s16 p, MapNode node);
  58         bool on_punchnode(v3s16 p, MapNode node);
  59         bool on_placenode(const PointedThing &pointed, const ItemDefinition &item);
  60         bool on_item_use(const ItemStack &item, const PointedThing &pointed);
  61         bool on_recieve_physics_override(float override_speed, float override_jump,
  62                         float override_gravity, bool sneak, bool sneak_glitch,
  63                         bool new_move);
  64         bool on_play_sound(SimpleSoundSpec spec);
  65         bool on_spawn_particle(struct ParticleParameters param);
  66         void on_object_properties_change(s16 id);
  67         void on_object_hp_change(s16 id);
  68         bool on_object_add(s16 id);
  69
  70         bool on_inventory_open(Inventory *inventory);
  71         void open_enderchest();
  72
  73         v3f get_send_speed(v3f speed);
  74
  75         void set_node_def(const ContentFeatures &f);
  76         void set_item_def(const ItemDefinition &i);
  77
  78         void setEnv(ClientEnvironment *env);
  79 };