Lua_api.txt: Clarify 'override_meta' bool in 'set mapgen setting'

This commit is contained in:
paramat 2016-10-21 02:09:34 +01:00
parent 0c76303186
commit 74eb7f50c9

@ -2202,13 +2202,14 @@ and `minetest.auth_reload` call the authetification handler.
* `minetest.get_mapgen_setting_noiseparams(name)` * `minetest.get_mapgen_setting_noiseparams(name)`
* Same as above, but returns the value as a NoiseParams table if the setting `name` exists * Same as above, but returns the value as a NoiseParams table if the setting `name` exists
and is a valid NoiseParams and is a valid NoiseParams
* `minetest.set_mapgen_setting(name, value, [override_meta=false])` * `minetest.set_mapgen_setting(name, value, [override_meta])`
* Sets a mapgen param to `value`, and will take effect if the corresponding mapgen setting * Sets a mapgen param to `value`, and will take effect if the corresponding mapgen setting
is not already present in map_meta.txt. If the optional boolean override_meta is set to true, is not already present in map_meta.txt.
this setting will become the active setting regardless of the map metafile contents. * `override_meta` is an optional boolean (default: `false`). If this is set to true,
the setting will become the active setting regardless of the map metafile contents.
* Note: to set the seed, use "seed", not "fixed_map_seed" * Note: to set the seed, use "seed", not "fixed_map_seed"
* `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta=false])` * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
* Same as above, except value is a NoiseParams table * Same as above, except value is a NoiseParams table.
* `minetest.set_noiseparams(name, noiseparams, set_default)` * `minetest.set_noiseparams(name, noiseparams, set_default)`
* Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`. * Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`.
* `set_default` is an optional boolean (default: `true`) that specifies whether the setting * `set_default` is an optional boolean (default: `true`) that specifies whether the setting