oss/luanti
oss/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-06-27 16:36:03 +00:00
Code Wiki Activity

lua_api.md: More info in LBM run_at_every_load documentation (#15956)

Browse source
This commit is contained in:
grorp 2025-04-02 10:05:23 -04:00 • committed by GitHub
parent 47c75b3294
commit 7dbd3a0744
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 24 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

33
doc/lua_api.md
View file

@ -9498,17 +9498,29 @@ Used by `core.register_lbm`.
A loading block modifier (LBM) is used to define a function that is called for A loading block modifier (LBM) is used to define a function that is called for
specific nodes (defined by `nodenames`) when a mapblock which contains such nodes specific nodes (defined by `nodenames`) when a mapblock which contains such nodes
gets activated (**not loaded!**). gets **activated** (**not loaded!**).
*Note*: LBMs operate on a "snapshot" of node positions taken once before they are triggered. *Note*: LBMs operate on a "snapshot" of node positions taken once before they are triggered.
That means if an LBM callback adds a node, it won't be taken into account. That means if an LBM callback adds a node, it won't be taken into account.
However the engine guarantees that at the point in time when the callback is called However the engine guarantees that at the point in time when the callback is called
that all given positions contain a matching node. that all given positions contain a matching node.
*Note*: For maps generated in 5.11.0 or older, many newly generated blocks did not For `run_at_every_load = false` to work, both mapblocks and LBMs have timestamps
get a timestamp set. This means LBMs introduced between generation time and associated with them:
time of first activation will never run.
Currently the only workaround is to use `run_at_every_load`. * Each mapblock has a "last active" timestamp. It is also updated when the
mapblock is generated.
* For each LBM, an introduction timestamp is stored in the world data, identified
by the LBM's `name` field. If an LBM disappears, the corresponding timestamp
is cleared.
When a mapblock is activated, only LBMs whose introduction timestamp is newer
than the mapblock's timestamp are run.
*Note*: For maps generated in 5.11.0 or older, many newly generated mapblocks
did not get a timestamp set. This means LBMs introduced between generation time
and time of first activation will never run.
Currently the only workaround is to use `run_at_every_load = true`.
```lua ```lua
{ {
@ -9525,13 +9537,16 @@ Currently the only workaround is to use `run_at_every_load`.
-- will work as well. -- will work as well.
run_at_every_load = false, run_at_every_load = false,
-- Whether to run the LBM's action every time a block gets activated, -- If `false`: The LBM only runs on mapblocks the first time they are
-- and not only the first time the block gets activated after the LBM -- activated after the LBM was introduced.
-- was introduced. -- It never runs on mapblocks generated after the LBM's introduction.
-- See above for details.
--
-- If `true`: The LBM runs every time a mapblock is activated.
action = function(pos, node, dtime_s) end, action = function(pos, node, dtime_s) end,
-- Function triggered for each qualifying node. -- Function triggered for each qualifying node.
-- `dtime_s` is the in-game time (in seconds) elapsed since the block -- `dtime_s` is the in-game time (in seconds) elapsed since the mapblock
-- was last active (available since 5.7.0). -- was last active (available since 5.7.0).
bulk_action = function(pos_list, dtime_s) end, bulk_action = function(pos_list, dtime_s) end,