From 3713c5ea9eaab262be1d08a92781f62bbb6cf95a Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Sun, 2 Sep 2012 14:10:58 +0400 Subject: Add some APIs required by steam engine to the core. --- Lua API.html | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'Lua API.html') diff --git a/Lua API.html b/Lua API.html index b9f09cf9..63a4c854 100644 --- a/Lua API.html +++ b/Lua API.html @@ -1019,9 +1019,16 @@ the container itself.
Adds a regular announcement with given text, color, and brightness. The is_bright boolean actually seems to invert the brightness.
+dfhack.gui.showZoomAnnouncement(type,pos,text,color[,is_bright])
+Like above, but also specifies a position you can zoom to from the announcement menu.
+dfhack.gui.showPopupAnnouncement(text,color[,is_bright])
Pops up a titan-style modal announcement window.
dfhack.gui.showAutoAnnouncement(type,pos,text,color[,is_bright])
+Uses the type to look up options from announcements.txt, and calls the +above operations accordingly. If enabled, pauses and zooms to position.
+dfhack.maps.getBlock(x,y,z)
Returns a map block object for given x,y,z in local block coordinates.
dfhack.maps.isValidTilePos(coords), or isValidTilePos(x,y,z)``
+Checks if the given df::coord or x,y,z in local tile coordinates are valid.
+dfhack.maps.getTileBlock(coords), or getTileBlock(x,y,z)
Returns a map block object for given df::coord or x,y,z in local tile coordinates.
dfhack.maps.enableBlockUpdates(block[,flow,temperature])
Enables updates for liquid flow or temperature, unless already active.
dfhack.maps.spawnFlow(pos,type,mat_type,mat_index,dimension)
+Spawns a new flow (i.e. steam/mist/dust/etc) at the given pos, and with +the given parameters. Returns it, or nil if unsuccessful.
+dfhack.maps.getGlobalInitFeature(index)
Returns the global feature object with the given index.