aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBenoit Germain <benoit.germain@ubisoft.com>2024-06-12 11:26:38 +0200
committerBenoit Germain <benoit.germain@ubisoft.com>2024-06-12 11:26:38 +0200
commitfffa17d7e28f4a3147adf1f2ae2a73c4b0f7b945 (patch)
tree01f9bbebd6aab5f9be47597e4f62dd0f10853d3a /docs
parentf1c3401e80a3228ee3ef5110e73712e1aa879fca (diff)
downloadlanes-fffa17d7e28f4a3147adf1f2ae2a73c4b0f7b945.tar.gz
lanes-fffa17d7e28f4a3147adf1f2ae2a73c4b0f7b945.tar.bz2
lanes-fffa17d7e28f4a3147adf1f2ae2a73c4b0f7b945.zip
Add support for to-be-closed linda
Diffstat (limited to 'docs')
-rw-r--r--docs/index.html9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/index.html b/docs/index.html
index 10bf832..be8324c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -70,7 +70,7 @@
70 </p> 70 </p>
71 71
72 <p> 72 <p>
73 This document was revised on 15-May-24, and applies to version <tt>4.0.0</tt>. 73 This document was revised on 12-Jun-24, and applies to version <tt>4.0.0</tt>.
74 </p> 74 </p>
75 </font> 75 </font>
76 </center> 76 </center>
@@ -1196,13 +1196,16 @@
1196</p> 1196</p>
1197 1197
1198<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> 1198<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
1199 h = lanes.linda([opt_name, [opt_group]]) 1199 h = lanes.linda([name],[group],[close_handler])
1200</pre></td></tr></table> 1200</pre></td></tr></table>
1201 1201
1202<p> 1202<p>
1203 Arguments to <tt>lanes.linda()</tt> can be provided in any order, as long as there is a single string, a single number, and a single callable value (all are optional).<br />
1203 Converting the Linda to a string will yield the provided name prefixed by <tt>"Linda: "</tt>.<br /> 1204 Converting the Linda to a string will yield the provided name prefixed by <tt>"Linda: "</tt>.<br />
1204 If <tt>opt_name</tt> is omitted, it will evaluate to an hexadecimal number uniquely representing that Linda when the Linda is converted to a string. The value is the same as returned by <tt>linda:deep()</tt>.<br /> 1205 If <tt>opt_name</tt> is omitted, it will evaluate to an hexadecimal number uniquely representing that Linda when the Linda is converted to a string. The value is the same as returned by <tt>linda:deep()</tt>.<br />
1205 If <tt>opt_name</tt> is <tt>"auto"</tt>, Lanes will try to construct a name from the source location that called <tt>lanes.linda()</tt>. If that fails, the Linda name will be <tt>"&lt;unresolved&gt;"</tt>. 1206 If <tt>opt_name</tt> is <tt>"auto"</tt>, Lanes will try to construct a name from the source location that called <tt>lanes.linda()</tt>. If that fails, the Linda name will be <tt>"&lt;unresolved&gt;"</tt>.<br />
1207 If Lanes is configured with more than one Keeper state, <tt>group</tt> is mandatory.<br />
1208 If the Linda is to-be-closed (Lua 5.4+), and a <tt>close_handler</tt> is provided, it will be called with all the provided arguments. For older Lua versions, its presence will cause an error.
1206</p> 1209</p>
1207 1210
1208<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> 1211<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>