Differences

This shows you the differences between two versions of the page.

--- dcss:help:maps:lua:modules:dgn:clouds [2014-10-04 06:03]
infiniplex [place_cloud] Simplified example format
+++ dcss:help:maps:lua:modules:dgn:clouds [2014-10-04 06:31] (current)
infiniplex Added cloud_at
@@ Line 1: / Line 1: @@
 ====== Cloud Functions ======
+These functions are in [[https://gitorious.org/crawl/crawl/blobs/master/crawl-ref/source/l_dgn.cc|l_dgn.cc]].
 ===== apply_area_cloud =====
 ===== place_cloud =====
@@ Line 28: / Line 31: @@
 Valid colours are defined in the ''cols'' array in [[http://gitorious.org/crawl/crawl/blobs/master/crawl-ref/source/colour.cc|colour.cc]] around line 750.  As of 0.16, the valid colours were: "black", "blue", "green", "cyan", "red", "magenta", "brown", "lightgrey", "darkgrey", "lightblue", "lightgreen", "lightcyan", "lightred", "lightmagenta", "yellow", "white".
 ===== delete_cloud =====
+Syntax:
+<code lua>
+delete_cloud (x, y)
+</code>
+Parameters:
+  * ''x'' (int, required): The x coordinate
+  * ''y'' (int, required): The y coordinate
+Returns: N/A
+If there is a cloud at position ''(x, y)'', it is removed.  Otherwise, there is no effect.
+===== cloud_at =====
+Syntax:
+<code lua>
+cloud_at (x, y)
+</code>
+Parameters:
+  * ''x'' (int, required): The x coordinate
+  * ''y'' (int, required): The y coordinate
+Returns: ''"none"'' if there is no cloud.  Otherwise, the name of the cloud.  I don't know what that means either.