diff options
| author | Alexander Gavrilov | 2012-05-04 20:59:06 +0400 |
|---|---|---|
| committer | Alexander Gavrilov | 2012-05-04 20:59:06 +0400 |
| commit | 7e01b004e9675fec417bee0eead7d3d0702395e6 (patch) | |
| tree | 5d37f646154b15659e2db4cb5f3a515080aabc87 /Lua API.html | |
| parent | d4d6349f48d01b31f59f94238d6656e3b5d08508 (diff) | |
| download | dfhack-7e01b004e9675fec417bee0eead7d3d0702395e6.tar.gz dfhack-7e01b004e9675fec417bee0eead7d3d0702395e6.tar.bz2 dfhack-7e01b004e9675fec417bee0eead7d3d0702395e6.tar.xz | |
Implement timeouts in the core lua context, and quicksave script.
Diffstat (limited to 'Lua API.html')
| -rw-r--r-- | Lua API.html | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/Lua API.html b/Lua API.html index 40706d14..b96d1215 100644 --- a/Lua API.html +++ b/Lua API.html @@ -855,6 +855,12 @@ One notable difference is that these explicit wrappers allow argument count adjustment according to the usual lua rules, so trailing false/nil arguments can be omitted.</p> <ul> +<li><p class="first"><tt class="docutils literal">dfhack.isWorldLoaded()</tt></p> +<p>Checks if the world is loaded.</p> +</li> +<li><p class="first"><tt class="docutils literal">dfhack.isMapLoaded()</tt></p> +<p>Checks if the world and map are loaded.</p> +</li> <li><p class="first"><tt class="docutils literal"><span class="pre">dfhack.TranslateName(name[,in_english,only_last_name])</span></tt></p> <p>Convert a language_name or only the last name part to string.</p> </li> @@ -1151,6 +1157,17 @@ only context that can receive events from DF and plugins.</p> <li><p class="first"><tt class="docutils literal">dfhack.is_core_context</tt></p> <p>Boolean value; <em>true</em> in the core context.</p> </li> +<li><p class="first"><tt class="docutils literal">dfhack.timeout(time,mode,callback)</tt></p> +<p>Arranges for the callback to be called once the specified +period of time passes. The <tt class="docutils literal">mode</tt> argument specifies the +unit of time used, and may be one of <tt class="docutils literal">'frames'</tt> (raw FPS), +<tt class="docutils literal">'ticks'</tt> (unpaused FPS), <tt class="docutils literal">'days'</tt>, <tt class="docutils literal">'months'</tt>, +<tt class="docutils literal">'years'</tt> (in-game time). All timers other than +<tt class="docutils literal">'frames'</tt> are cancelled when the world is unloaded, +and cannot be queued until it is loaded again. +Returns the timer id, or <em>nil</em> if unsuccessful due to +world being unloaded.</p> +</li> <li><p class="first"><tt class="docutils literal">dfhack.onStateChange.foo = function(code)</tt></p> <p>Event. Receives the same codes as plugin_onstatechange in C++.</p> </li> |
