src/script/scripting_server.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #pragma once
  21 #include "cpp_api/s_base.h"
  22 #include "cpp_api/s_entity.h"
  23 #include "cpp_api/s_env.h"
  24 #include "cpp_api/s_inventory.h"
  25 #include "cpp_api/s_modchannels.h"
  26 #include "cpp_api/s_node.h"
  27 #include "cpp_api/s_player.h"
  28 #include "cpp_api/s_server.h"
  29 #include "cpp_api/s_security.h"
  30 #include "cpp_api/s_async.h"
  31
  32 struct PackedValue;
  33
  34 /*****************************************************************************/
  35 /* Scripting <-> Server Game Interface                                       */
  36 /*****************************************************************************/
  37
  38 class ServerScripting:
  39                 virtual public ScriptApiBase,
  40                 public ScriptApiDetached,
  41                 public ScriptApiEntity,
  42                 public ScriptApiEnv,
  43                 public ScriptApiModChannels,
  44                 public ScriptApiNode,
  45                 public ScriptApiPlayer,
  46                 public ScriptApiServer,
  47                 public ScriptApiSecurity
  48 {
  49 public:
  50         ServerScripting(Server* server);
  51
  52         // use ScriptApiBase::loadMod() to load mods
  53
  54         // Initialize async engine, call this AFTER loading all mods
  55         void initAsync();
  56
  57         // Global step handler to collect async results
  58         void stepAsync();
  59
  60         // Pass job to async threads
  61         u32 queueAsync(std::string &&serialized_func,
  62                 PackedValue *param, const std::string &mod_origin);
  63
  64 private:
  65         void InitializeModApi(lua_State *L, int top);
  66
  67         static void InitializeAsync(lua_State *L, int top);
  68
  69         AsyncEngine asyncEngine;
  70 };