Skip to content
Permalink
Browse files

Add ModStorageAPI to client side modding (#5396)

mod storage is located into user_path / client / mod_storage
  • Loading branch information...
nerzhul committed Mar 16, 2017
1 parent 4627641 commit eb88e5dd4b181a90b382c036cf6c4f42e63e8cc2
Showing with 68 additions and 11 deletions.
  1. +3 −0 clientmods/preview/init.lua
  2. +42 −1 src/client.cpp
  3. +6 −0 src/client.h
  4. +4 −0 src/gamedef.h
  5. +1 −0 src/script/clientscripting.cpp
  6. +5 −6 src/script/lua_api/l_storage.cpp
  7. +4 −4 src/server.h
  8. +3 −0 src/unittest/test.cpp
@@ -1,4 +1,5 @@
local modname = core.get_current_modname() or "??"
local modstorage = core.get_mod_storage()

-- This is an example function to ensure it's working properly, should be removed before merge
core.register_on_shutdown(function()
@@ -49,6 +50,8 @@ core.register_chatcommand("test_node", {

core.after(2, function()
print("[PREVIEW] loaded " .. modname .. " mod")
modstorage:set_string("current_mod", modname)
print(modstorage:get_string("current_mod"))
end)

core.register_on_dignode(function(pos, node)
@@ -249,7 +249,8 @@ Client::Client(
m_removed_sounds_check_timer(0),
m_state(LC_Created),
m_localdb(NULL),
m_script(NULL)
m_script(NULL),
m_mod_storage_save_timer(10.0f)
{
// Add local player
m_env.setLocalPlayer(new LocalPlayer(this, playername));
@@ -730,6 +731,18 @@ void Client::step(float dtime)
}
}

m_mod_storage_save_timer -= dtime;
if (m_mod_storage_save_timer <= 0.0f) {
verbosestream << "Saving registered mod storages." << std::endl;
m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
for (UNORDERED_MAP<std::string, ModMetadata *>::const_iterator
it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
if (it->second->isModified()) {
it->second->save(getModStoragePath());
}
}
}

// Write server map
if (m_localdb && m_localdb_save_interval.step(dtime,
m_cache_save_interval)) {
@@ -1998,3 +2011,31 @@ scene::IAnimatedMesh* Client::getMesh(const std::string &filename)
smgr->getMeshCache()->removeMesh(mesh);
return mesh;
}

bool Client::registerModStorage(ModMetadata *storage)
{
if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
errorstream << "Unable to register same mod storage twice. Storage name: "
<< storage->getModName() << std::endl;
return false;
}

m_mod_storages[storage->getModName()] = storage;
return true;
}

void Client::unregisterModStorage(const std::string &name)
{
UNORDERED_MAP<std::string, ModMetadata *>::const_iterator it = m_mod_storages.find(name);
if (it != m_mod_storages.end()) {
// Save unconditionaly on unregistration
it->second->save(getModStoragePath());
m_mod_storages.erase(name);
}
}

std::string Client::getModStoragePath() const
{
return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";
}

@@ -554,6 +554,10 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
{ return checkPrivilege(priv); }
virtual scene::IAnimatedMesh* getMesh(const std::string &filename);

virtual std::string getModStoragePath() const;
virtual bool registerModStorage(ModMetadata *meta);
virtual void unregisterModStorage(const std::string &name);

// The following set of functions is used by ClientMediaDownloader
// Insert a media file appropriately into the appropriate manager
bool loadMedia(const std::string &data, const std::string &filename);
@@ -724,6 +728,8 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef

ClientScripting *m_script;
bool m_modding_enabled;
UNORDERED_MAP<std::string, ModMetadata *> m_mod_storages;
float m_mod_storage_save_timer;

DISABLE_CLASS_COPY(Client);
};
@@ -34,6 +34,7 @@ class MtEventManager;
class IRollbackManager;
class EmergeManager;
class Camera;
class ModMetadata;

namespace irr { namespace scene {
class IAnimatedMesh;
@@ -75,6 +76,9 @@ class IGameDef
virtual const std::vector<ModSpec> &getMods() const = 0;
virtual const ModSpec* getModSpec(const std::string &modname) const = 0;
virtual std::string getWorldPath() const { return ""; }
virtual std::string getModStoragePath() const = 0;
virtual bool registerModStorage(ModMetadata *storage) = 0;
virtual void unregisterModStorage(const std::string &name) = 0;
};

#endif
@@ -58,4 +58,5 @@ void ClientScripting::InitializeModApi(lua_State *L, int top)
ModApiStorage::Initialize(L, top);

LuaItemStack::Register(L);
StorageRef::Register(L);
}
@@ -33,10 +33,9 @@ int ModApiStorage::l_get_mod_storage(lua_State *L)
std::string mod_name = lua_tostring(L, -1);

ModMetadata *store = new ModMetadata(mod_name);
// For server side
if (Server *server = getServer(L)) {
store->load(server->getModStoragePath());
server->registerModStorage(store);
if (IGameDef *gamedef = getGameDef(L)) {
store->load(gamedef->getModStoragePath());
gamedef->registerModStorage(store);
} else {
assert(false); // this should not happen
}
@@ -70,8 +69,8 @@ int StorageRef::gc_object(lua_State *L)
{
StorageRef *o = *(StorageRef **)(lua_touserdata(L, 1));
// Server side
if (Server *server = getServer(L))
server->unregisterModStorage(getobject(o)->getModName());
if (IGameDef *gamedef = getGameDef(L))
gamedef->unregisterModStorage(getobject(o)->getModName());
delete o;
return 0;
}
@@ -299,8 +299,8 @@ class Server : public con::PeerHandler, public MapEventReceiver,
virtual const ModSpec* getModSpec(const std::string &modname) const;
void getModNames(std::vector<std::string> &modlist);
std::string getBuiltinLuaPath();
std::string getWorldPath() const { return m_path_world; }
std::string getModStoragePath() const;
virtual std::string getWorldPath() const { return m_path_world; }
virtual std::string getModStoragePath() const;

inline bool isSingleplayer()
{ return m_simple_singleplayer_mode; }
@@ -361,8 +361,8 @@ class Server : public con::PeerHandler, public MapEventReceiver,
void SendInventory(PlayerSAO* playerSAO);
void SendMovePlayer(u16 peer_id);

bool registerModStorage(ModMetadata *storage);
void unregisterModStorage(const std::string &name);
virtual bool registerModStorage(ModMetadata *storage);
virtual void unregisterModStorage(const std::string &name);

// Bind address
Address m_bind_addr;
@@ -65,6 +65,9 @@ class TestGameDef : public IGameDef {
return testmodspec;
}
virtual const ModSpec* getModSpec(const std::string &modname) const { return NULL; }
virtual std::string getModStoragePath() const { return "."; }
virtual bool registerModStorage(ModMetadata *meta) { return true; }
virtual void unregisterModStorage(const std::string &name) {}

private:
IItemDefManager *m_itemdef;

0 comments on commit eb88e5d

Please sign in to comment.
You can’t perform that action at this time.