scripting_server.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
#pragma once
#include "cpp_api/s_base.h"
#include "cpp_api/s_entity.h"
#include "cpp_api/s_env.h"
#include "cpp_api/s_inventory.h"
#include "cpp_api/s_modchannels.h"
#include "cpp_api/s_node.h"
#include "cpp_api/s_player.h"
#include "cpp_api/s_server.h"
#include "cpp_api/s_security.h"
#include "cpp_api/s_async.h"
 
struct PackedValue;
 
/*****************************************************************************/
/* Scripting <-> Server Game Interface                                       */
/*****************************************************************************/
 
class ServerScripting:
                virtual public ScriptApiBase,
                public ScriptApiDetached,
                public ScriptApiEntity,
                public ScriptApiEnv,
                public ScriptApiModChannels,
                public ScriptApiNode,
                public ScriptApiPlayer,
                public ScriptApiServer,
                public ScriptApiSecurity
{
public:
        ServerScripting(Server* server);
 
        void loadBuiltin();
        // use ScriptApiBase::loadMod() to load mods
 
        // Save globals that are copied into other Lua envs
        void saveGlobals();
 
        // Initialize async engine, call this AFTER loading all mods
        void initAsync();
 
        // Global step handler to collect async results
        void stepAsync();
 
        // Pass job to async threads
        u32 queueAsync(std::string &&serialized_func,
                PackedValue *param, const std::string &mod_origin);
 
protected:
        // from ScriptApiSecurity:
        bool checkPathInternal(const std::string &abs_path, bool write_required,
                bool *write_allowed) override {
                return ScriptApiSecurity::checkPathWithGamedef(getStack(),
                        abs_path, write_required, write_allowed);
        }
        bool modNamesAreTrusted() override { return true; }
 
private:
        void InitializeModApi(lua_State *L, int top);
 
        static void InitializeAsync(lua_State *L, int top);
 
        AsyncEngine asyncEngine;
};