Update lua api docs
This commit is contained in:
47
doc/lua.adoc
47
doc/lua.adoc
@@ -14,6 +14,22 @@ Example:
|
||||
|
||||
local str = nh.an("unicorn");
|
||||
|
||||
|
||||
=== debug_flags
|
||||
|
||||
Set debugging flags.
|
||||
|
||||
|===
|
||||
| mongen | boolean | Do monsters generate
|
||||
| hunger | boolean | Does hero's hunger-state increase
|
||||
| overwrite_stairs | boolean | Allow special-file commands overwrite the stairs
|
||||
|===
|
||||
|
||||
Example:
|
||||
|
||||
nh.debug_flags({ mongen = false, hunger = false });
|
||||
|
||||
|
||||
=== dnum_name
|
||||
|
||||
Returns the full dungeon name (as defined in dungeon.lua) for the dungeon
|
||||
@@ -23,6 +39,17 @@ Example:
|
||||
|
||||
local dungeon_name = nh.dnum_name(u.dnum);
|
||||
|
||||
|
||||
=== doturn
|
||||
|
||||
Execute gameloop once, or until multi-turn action is done if
|
||||
optional boolean parameter is true.
|
||||
|
||||
Example:
|
||||
|
||||
nh.doturn();
|
||||
|
||||
|
||||
=== dump_fmtstr
|
||||
|
||||
Returns a string replacing special format chars with game data.
|
||||
@@ -140,7 +167,6 @@ Example:
|
||||
nh.deltrap(x, y);
|
||||
|
||||
|
||||
|
||||
=== ing_suffix
|
||||
|
||||
Construct a gerund (a verb formed by appending "ing" to a noun).
|
||||
@@ -159,6 +185,7 @@ Example:
|
||||
|
||||
local diff = nh.level_difficulty();
|
||||
|
||||
|
||||
=== makeplural
|
||||
|
||||
Pluralize the given string.
|
||||
@@ -227,6 +254,14 @@ Example:
|
||||
nh.pline("Message text to show.");
|
||||
|
||||
|
||||
=== pushkey
|
||||
|
||||
Push a key into the command queue.
|
||||
|
||||
Example:
|
||||
|
||||
nh.pushkey("i");
|
||||
|
||||
=== random
|
||||
|
||||
Generate a random number.
|
||||
@@ -958,3 +993,13 @@ Example:
|
||||
| `"x"` | "transparent" - used for <<_map>> parts.
|
||||
| `"w"` | "any wall" - see <<_match>>
|
||||
|===
|
||||
|
||||
== Constants
|
||||
|
||||
These constants are in the `nhc` table.
|
||||
|
||||
|===
|
||||
| COLNO | Number of map columns
|
||||
| ROWNO | Number of map rows
|
||||
| DLB | 1 or 0, depending if NetHack is compiled with DLB
|
||||
|===
|
||||
|
||||
Reference in New Issue
Block a user