new Lua module: enable-util #4401
Conversation
There was a problem hiding this comment.
reducing boilerplate is good. I'm having trouble seeing exactly how existing use cases would be served by this abstraction, though. It might be useful to prototype conversions of a set of representative scripts to be sure the API is going to serve their needs
| return | ||
| end | ||
|
|
||
| if sc ~= SC_MAP_LOADED or df.global.gamemode ~= df.game_mode.DWARF then |
There was a problem hiding this comment.
especially as adventure mode is expected soon, this will need to become more flexible.
| end | ||
|
|
||
| -- map was loaded, restore global data and reschedule | ||
| global_store = dfhack.persistent.getSiteData(global_key, {enabled=false}) |
There was a problem hiding this comment.
this isn't going to affect the copy of global_store in the client script. maybe utils.assign, but you'd also have to manually clear out old contents before assigning to the table.
|
|
||
| local repeatUtil = require('repeat-util') | ||
|
|
||
| function assignPersistentGlobal(global_key, global_store, key, value) |
There was a problem hiding this comment.
I don't think this is flexible enough in practice. scripts may be modifying fields deep in the state table. The pattern I've usually seen is "make a batch of changes to the state, then persist from the top". However, with that pattern, this function reduces to just the call to dfhack.persistent.saveSiteData and the value of abstracting that out into an enable-util function becomes questionable
|
closing this for now since I think the API isn't quite flexible enough for current script needs |
This is obviously not yet ready to be merged. However, I would like to know what you think of the idea, and what would you needed to merge this. Feel free to just edit this as you see fit.