Made world data paths adjustable, and added API to temporarily disable saving chunks to disk. #3912
Conversation
…ath creation recursive.
|
I'm not too happy about having the world config split into two separate sections. But I can't think of a better way. |
|
Ditto. On further thought, maybe another idea would be: Where [Worlds] just specifies the paths, but then the [Server] section gets muddied with the DefaultWorld tag. |
|
The [WorldPaths] is optional, so it should only appear in the rare instances where the paths are not the default. (the default for name would be Worlds/name for the architecture change) |
|
Migration to that format would be non-trivial. If only we already had Lua-based config files, we could simply do: Worlds =
{
world =
{
Path = "Worlds/world",
SomeOtherParam = 3.1415,
},
-- ...
},
DefaultWorld = "world", |
|
If I make the config files lua-based (in a future PR), can I make the crafting/brewing/etc files lua-based too? |
|
Yes, but please discuss this first in the forum, we have had some discussions there already and there are some ideas that you might want to consider before diving in :) |
| @@ -8,8 +8,7 @@ return | |||
| Cuberite calls this function when a chunk is about to be unloaded from the memory. A plugin may | |||
| force Cuberite to keep the chunk in memory by returning true.</p> | |||
| <p> | |||
| FIXME: The return value should be used only for event propagation stopping, not for the actual | |||
| decision whether to unload. | |||
| CAUTION: Preventing the server from unloading chunks can cause the server to use too much RAM, which will adversly affect both performance and stability (i.e. your computer will get slow and crash). Return true sparingly. | |||
src/Root.h
Outdated
| @@ -137,6 +137,9 @@ class cRoot | |||
| /** Saves all chunks in all worlds */ | |||
| void SaveAllChunks(void); // tolua_export | |||
|
|
|||
| /** Sets whether saving chunks is enabled */ | |||
src/World.h
Outdated
| @@ -111,6 +112,12 @@ class cWorld : | |||
|
|
|||
| // tolua_begin | |||
|
|
|||
| /** Get whether saving chunks is enabled */ | |||
| bool GetSavingEnabled(void) const { return m_SavingEnabled; } | |||
There was a problem hiding this comment.
Rename to IsSavingEnabled and m_IsSavingEnabled
src/World.h
Outdated
| @@ -871,6 +881,9 @@ class cWorld : | |||
|
|
|||
| AString m_WorldName; | |||
|
|
|||
| /** The path to the root directory for the world files */ | |||
There was a problem hiding this comment.
Doesn't contain the trailing path separator.
|
Alright, made some fixes and pulled the latest master. I'll start working on Lua config files once all the file architecture dust settles. :-) |
|
Alright, now it passes CI. |
|
Resolved the conflict, just waiting for CI to pass then merge. |
This PR makes the data path that world data is saved in adjustable at world creation time (via constructor parameter and settings.ini parameter), which will be useful for restructuring the world files (as in #3426). The Anvil format, player stats, and maps are all modified to accommodate this change.
It adds the optional [WorldPaths] section to the settings.ini file, which specifies the directories that various worlds are stored in, for example:
This PR also adds the SetSavingEnabled method to cWorld and cRoot, which permits disabling saving chunk files to disk (note that it doesn't prevent writing the ini file to disk). This allows implementing the /save-off and /save-on commands. It will also allow easily resetting maps, I think will be useful for minigames (resetting the map then just becomes an issue of reloading the world).
m_SavingEnabled is atomic, so that cRoot can access it from its thread safely for console commands.
Tweaked the HOOK_CHUNK_UNLOADING documentation to say that the ability for the plugin to actually prevent the chunk from unloading is a feature not a bug.