Milestones for entering Ice Cave, Sewer and Ossuary. Document making these for portal vaults in level_design.txt.

git-svn-id: https://crawl-ref.svn.sourceforge.net/svnroot/crawl-ref/trunk@10348 c06c8d41-db1a-0410-9941-cceddc491573

1 files changed, 24 insertions, 1 deletions

diff --git a/crawl-ref/docs/level_design.txt b/crawl-ref/docs/level_design.txt
index 6bb1e88430..922774ba6a 100644
--- a/crawl-ref/docs/level_design.txt
+++ b/crawl-ref/docs/level_design.txt
@@ -1504,6 +1504,28 @@ You can then use this line in the map definition to execute the lua block:
 You can also set env.spawn_random_rate() to have monsters generated from the
 list during play.
 
+Milestones for portal vaults
+----------------------------
+
+This example is from icecave.des, defined in the lua preludes:
+
+{{
+function ice_cave_milestone(e)
+  crawl.mark_milestone("br.enter", "entered an Ice Cave.")
+end
+}}
+
+The function is called from each of the destination map definitions:
+
+: ice_cave_milestone(_G)
+
+This marks down entering the portal vault in the milestones. When the portal
+is entered, the destination map is chosen and the call to crawl.mark_milestone
+is executed along with the rest of the map definition.
+
+Adding milestones in a .des does have the slight catch of creating multiple
+milestones if the map fails validation for some reason, so it's best used
+in maps that will never fail validation.
 
 I.    Lua reference
 ===================
@@ -1810,7 +1832,8 @@ provide utility methods.
 mpr, mesclr, random2, coinflip, one_chance_in, redraw_screen,
 input_line, c_input_line, getch, kbhit, flush_input, sendkeys,
 playsound, runmacro, bindkey, setopt, msgch_num, msgch_name, regex,
-message_filter, trim, split, game_started, err_trace, args
+message_filter, trim, split, game_started, err_trace, args,
+mark_milestone
 
 
 Lua API - character information