MapGeneratorWML - Revision history

Beetlenaut: Reworded the text at the top to make it current. Removed all the information about the cave generator tags that appeared before the note saying that it was removed.

2025-06-06T06:04:42Z

Reworded the text at the top to make it current. Removed all the information about the cave generator tags that appeared before the note saying that it was removed.

Soliton: YAMG was removed a long time ago.

2022-07-26T18:04:39Z

YAMG was removed a long time ago.

Octalot: /* Scenario vs map generation */ Don't provide either map_data or map_file.

2021-08-29T13:38:41Z

‎Scenario vs map generation: Don't provide either map_data or map_file.

Celtic Minstrel: /* The Cave Generator */ Further updates to how the cave map generator works in 1.14+

2021-07-12T06:20:39Z

‎The Cave Generator: Further updates to how the cave map generator works in 1.14+

Celtic Minstrel: /* The Cave Generator */ Update the 1.13+ info

2021-07-12T06:13:25Z

‎The Cave Generator: Update the 1.13+ info

Soliton: /* See Also */

2020-05-05T13:59:20Z

‎See Also

Celtic Minstrel: Fix link broken by page move

2018-12-12T01:09:14Z

Fix link broken by page move

Gfgtdf: /* See Also */

2018-12-11T14:06:16Z

‎See Also

Celtic Minstrel: /* Available Lua API */ Note that this Rng table is no longer in existence

2018-04-05T00:51:41Z

‎Available Lua API: Note that this Rng table is no longer in existence

Celtic Minstrel: /* The Default Generator */ Use the template for dev feature tags

2016-10-21T03:58:01Z

‎The Default Generator: Use the template for dev feature tags

@@ Line 20: / Line 20: @@
 == [generator] ==
-The exact things that should be placed in [generator] depend on what algorithm you pick. There are three kinds of generators, '''default''', '''cave''' (cave is removed in wesnoth 1.13.6), '''lua''' {{DevFeature1.13|0}}
+The exact things that should be placed in [generator] depend on what algorithm you pick. There are two kinds of generators, '''default''' and '''lua'''
 For which key to use and what value, see the section for the generator you want to use.
@@ Line 184: / Line 183: @@
 ===The Cave Generator===
-The cave generator generates a system of chambers and passages similar to the levels in dungeon crawling games like Rogue. It does not appear to have been written for multiplayer scenario game creation like the default generator was.  It is used in '''campaigns\Sceptre_of_Fire\scenarios\4_Gathering_Materials.cfg''' & '''campaigns\Heir_To_The_Throne\scenarios\ 17_Scepter_of_Fire.cfg '''. The data here is inferred from those scenarios and an inspection of cavegen.cpp
+The cave generator generates a system of chambers and passages similar to the levels in dungeon crawling games like Rogue.
 {{DevFeature1.13|6}}

@@ Line 236: / Line 236: @@
 * '''[items]''' is not supported. Use one or multiple '''[item_location]''' instead. This will generate starting locations or other special locations in the map data with the given id; '''place_castle = yes''' can be set in '''[item_location]''' to make the generator create a castle at this location.
 * '''[settings]'''  is not supported - '[event]s' and '[side]s' now go directly in '''[scenario]'''
 == Infrastructure ==

← Older revision		Revision as of 13:38, 29 August 2021
Line 15:		Line 15:

	You must additionally place a [generator] tag in your scenario, which contains the options to the map generator.		You must additionally place a [generator] tag in your scenario, which contains the options to the map generator.
		+
		+	The [scenario] tag must leave both '''map_data''' and '''map_file''' unset, or set them to empty strings, otherwise the behavior is implementation defined; the engine might assume that the generator has already been run, and skip running it.

	== [generator] ==		== [generator] ==

@@ Line 210: / Line 210: @@
 *** '''jagged''': a good value is probably between 1-10
 *** '''chance''': chance for the passage to be generated, between 0 and 100, 100 if key not present
 {{DevFeature1.13|6}}
-'''scenario_generation=cave''' and '''map_generation=cave''' is no longer supported. Instead use
+The cave map generator has been moved to Lua, so '''scenario_generation=cave''' and '''map_generation=cave''' are no longer supported. Use one of the following setups instead:
-'''map_generation=lua''' with either '''create_scenario=''' or '''create_map=''' set to '''<< <syntaxhighlight lang=lua inline>params = ...; return wesnoth.dofile("lua/cave_map_generator.lua")</syntaxhighlight> >>'''. The [generator] supports the same syntax if using '''create_scenario''', but has the following differences when using '''create_map''':
+* Map generation:
 * '''[items]''' is not supported. Use one or multiple '''[item_location]''' instead. This will generate starting locations or other special locations in the map data with the given id; '''place_castle = yes''' can be set in '''[item_location]''' to make the generator create a castle at this location.
 * '''[settings]'''  is not supported - '[event]s' and '[side]s' now go directly in '''[scenario]'''

@@ Line 211: / Line 211: @@
 *** '''chance''': chance for the passage to be generated, between 0 and 100, 100 if key not present
 {{DevFeature1.13|6}}
-'''scenario_generation=cave''' and '''map_generation=cave''' is no longer supported, instead use
+'''scenario_generation=cave''' and '''map_generation=cave''' is no longer supported. Instead use
-map_generation=lua with code = << params = ...; return wesnoth.dofile("lua/cave_map_generator.lua") >>, the [generator] has a similar syntax, the difference is that
+'''map_generation=lua''' with either '''create_scenario=''' or '''create_map=''' set to '''<< <syntaxhighlight lang=lua inline>params = ...; return wesnoth.dofile("lua/cave_map_generator.lua")</syntaxhighlight> >>'''. The [generator] supports the same syntax if using '''create_scenario''', but has the following differences when using '''create_map''':
-* '''[items]''' is no longer supported, use one or multiple '''[item_location]''' instead, this will generate starting locations or other special locations in the map data with the given id, '''place_castle = yes''' can be set in '''[item_location]''' to make the generator create a castle at this location.
+* '''[items]''' is not supported. Use one or multiple '''[item_location]''' instead. This will generate starting locations or other special locations in the map data with the given id; '''place_castle = yes''' can be set in '''[item_location]''' to make the generator create a castle at this location.
-* since the lua generator now prefers '''map_generation''' (instead of '''scenario_generation''') '[event]s' and '[side]s' now go directly in '''[scenario]''', '''[settings]'''  is no longer supported.
+* '''[settings]'''  is not supported - '[event]s' and '[side]s' now go directly in '''[scenario]'''
 === YAMG generator ===

@@ Line 233: / Line 233: @@
 == See Also ==
 * [[ScenarioWML]]
 * [[ReferenceWML]]
 [[Category: WML Reference]]

← Older revision		Revision as of 00:51, 5 April 2018
Line 45:		Line 45:

	It is highly recomended NOT to use the math.random function in random map generators, becasue math.random breaks the 'seed' function for random map generators in the editor.		It is highly recomended NOT to use the math.random function in random map generators, becasue math.random breaks the 'seed' function for random map generators in the editor.
		+
		+	{{DevFeature1.13}} In 1.13.x, this is no longer the case; much of the '''wesnoth''' table is available, including (but not limited to) '''wesnoth.random''' and '''wesnoth.find_path'''. However, there are still many things that are not available. You can open a Lua console to experiment and find out what's allowed by calling '''wesnoth.show_lua_console''' at some point in your map generator script. The '''Rng''' table no longer exists, having been superceded by '''wesnoth.random'''.

	===The Default Generator===		===The Default Generator===

@@ Line 105: / Line 105: @@
 ** '''min_distance''': all castles generated must be this number of hexes apart from each other
 * '''[naming]''': The names used to label landscape features (forests, lakes, etc.). This controls, for example, the "Sal" part of "Sal's Crossing". If this tag is empty, those labels should be suppressed. (Due to a bug, they are not suppressed prior to 1.11.1.) The predefined macro VILLAGE_NAMES is one option for the contents of this tag. If that macro is not used, this tag takes one key.
-** '''Changes in release 1.13.5''':
+** {{DevFeature1.13|5}}
 *** The new [[Context-free grammar|Context-free grammar name]] (CFG) generator is now supported
 *** '''male_names''' is now deprecated. Use '''base_names''' for the Markov-chain based or '''base_name_generator''' for the CFG generator instead
@@ Line 137: / Line 137: @@
 * '''[village_naming]''': The names used to label villages. This controls, for example, the "Fox" part of "Foxham". If this tag is empty, those labels should be suppressed. (Due to a bug, they are not suppressed prior to 1.11.1.) The predefined macro VILLAGE_NAMES is one option for the contents of this tag. If that macro is not used, this tag takes one key. The village naming depends on the adjacent landscape features, e.g. a village near a forest with the name "Rock Forest" may be named "Rockwood".
 ** '''male_names'''
-** '''Changes in release 1.13.5''':
+** {{DevFeature1.13|5}}
 *** The new [[Context-free grammar|Context-free grammar name]] (CFG) generator is now supported
 *** '''male_names''' is now deprecated. Use '''base_names''' for the Markov-chain based or '''base_name_generator''' for the CFG generator instead