Register.lua: Throw error if node 'light_source' > core.LIGHT_MAX #4523
Conversation
|
Is the light source maximum documented? |
|
'default.LIGHT_MAX = 14' is set in MTGame, perhaps this should be added to builtin/game/constants? Although it seems weird because it's unlikely to change more than once every few years. Anyway i don't mind doing this. |
|
LIGHT_MAX should be builtin IMO, it's odd that it's a |
|
I agree, i'm adding it to builtin constants. |
paramat
changed the title
|
Updated. Now we can use core.LIGHT_MAX and slowly replace default.LIGHT_MAX. |
| @@ -20,3 +20,6 @@ core.EMERGE_GENERATED = 4 | |||
|
|
|||
| -- constants.h | |||
| core.MAP_BLOCKSIZE = 16 | |||
|
|
|||
| -- Maximum value for node 'light_source' parameter | |||
There was a problem hiding this comment.
It's from light.h, which could be noted here.
ShadowNinja's comment about noting it in the header file as well, can apply here too.
c8b4bed#commitcomment-18510949
|
Updated with request. |
| light_source = 0, -- Amount of light emitted by node (max. 14) | ||
| light_source = 0, --[[ | ||
| ^ Amount of light emitted by node (max. 14). | ||
| ^ A value of 15 causes a lighting bug. ]] |
There was a problem hiding this comment.
Might want to reword this documentation to use core.LIGHT_MAX.
I also think it's odd to point out the currently observed behavior when the value is out of range in a piece of official documentation. If anything at all, this should read "The effect of values outside the range of 0 through core.LIGHT_MAX is undefined"
There was a problem hiding this comment.
I considered that, but decided it was clearer to modders to mention the actual current values, as they will probably not be familiar with these constants as set in core code. They want to be able to instantly see the actual values to use in a mod. Luckily these values will not change often.
There was a problem hiding this comment.
Fair enough, but it should still be made known that core.LIGHT_MAX is the constant to use for maximum light. We certainly don't want modders to get in the habit of hard coding numeric literals for things that might change in a future version.
There was a problem hiding this comment.
Ah i see, will edit.
|
Updated lua_api.txt comments. |
Add 'core.LIGHT_MAX = 14' to builtin/game/constants.lua with the intention to replace misplaced 'default.LIGHT_MAX = 14' in Minetest Game. Add comment in light.h requiring the constant be changed in both places. Add lighting bug warning to note in lua_api.txt. There are hundreds of mod uses of 15 which causes a lighting bug.
|
👍 |
Add 'core.LIGHT_MAX = 14' to builtin/game/constants.lua with the intention
to replace misplaced 'default.LIGHT_MAX = 14' in Minetest Game.
Add comment in light.h requiring the constant be changed in both places.
Add lighting bug warning to note in lua_api.txt.
There are hundreds of mod uses of 15 which causes a lighting bug.
///////////////////////////////////////////////////
More thorough fix for #3964 than #4519
See #3964 (comment)
An error halts the game and notifies which node caused the error.