Luaterp: introductory comments and renaming.

To use, set "delay_message_clear = true" and call wizard mode Ctrl+T.

To echo return values from statements, prefix them with '=' and
define the global __echo. (__echo = crawl.mpr will work for single
return values.)

1 files changed, 8 insertions, 2 deletions

diff --git a/crawl-ref/source/luaterp.cc b/crawl-ref/source/luaterp.cc
index 5ccbfffbc1..1b60e1d013 100644
--- a/crawl-ref/source/luaterp.cc
+++ b/crawl-ref/source/luaterp.cc
@@ -3,6 +3,13 @@
  * Summary:  An interactive lua interpreter.
  *
  * Based heavily on lua.c from the Lua distribution.
+ *
+ * Deficiencies:
+ * - Currently requires defining a global function __echo
+ *   to echo results.
+ * - Currently requires prefixing with '=' if you want results echoed.
+ * - Appears to require delay_message_clear = true.
+ * - Old input lines are not visible.
  */
 
 #include "AppHdr.h"
@@ -122,8 +129,7 @@ void run_clua_interpreter(lua_State *ls)
     lua_settop(ls, 0); // clear stack
 }
 
-void debug_call_dlua()
+void debug_terp_dlua()
 {
     run_clua_interpreter(dlua);
 }
-