widelands-dev team mailing list archive

[GunChleoc <fios@xxxxxxxxxxxxxxxxxxx>]

GunChleoc has proposed merging lp:~widelands-dev/widelands/terrain_doc into lp:widelands.

Requested reviews:
  Widelands Developers (widelands-dev)

For more details, see:
https://code.launchpad.net/~widelands-dev/widelands/terrain_doc/+merge/249747

I have added some documentation for the terrains.

Am I correct in assuming that "acid" and "dead" do the exact same thing? If so, will it break compatibility with existing maps if I change all the "acid" ones to "dead"?
-- 
Your team Widelands Developers is requested to review the proposed merge of lp:~widelands-dev/widelands/terrain_doc into lp:widelands.

=== modified file 'world/terrains/init.lua'
--- world/terrains/init.lua	2015-01-30 10:16:22 +0000
+++ world/terrains/init.lua	2015-02-14 09:45:15 +0000
@@ -38,6 +38,16 @@
    -- Type of terrain. Describes if the terrain is walkable, swimmable, if
    -- mines or buildings can be build on it, if flags can be build on it and so
    -- on.
+   --
+   -- The following properties are available:
+   -- "green": Allows building of normal buildings and roads
+   -- "mountain": Allows building of mines and roads
+   -- "dry": Allows building of roads only. Trees don't like this terrain.
+   -- "water": Nothing can be built here, but ships and aquatic animals can pass
+   -- "acid"/"dead": Nothing can be built here, and nothing can walk on it, and nothing will grow.
+   -- "unpassable": Nothing can be built here, and nothing can walk on it
+   --
+   -- Note that "is" also has implications for trees' terrain affinity.
    is = "green",
 
    -- The list resources that can be found in this terrain.