Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
wisp
GitHub Repository: wisp/impinj-reader-app
Path: blob/master/Resources/taoframework-2.1.0/bin/Tao.Lua.xml
178 views
1
<?xml version="1.0"?>
2
<doc>
3
<assembly>
4
<name>Tao.Lua</name>
5
</assembly>
6
<members>
7
<member name="T:Tao.Lua.Lua">
8
#region Class Documentation
9
<summary>
10
Lua bindings for .NET, implementing Lua 5.1.1 (http://www.lua.org).
11
</summary>
12
<remarks>
13
Lua is a powerful light-weight programming language designed for
14
extending applications. Lua is also frequently used as a
15
general-purpose, stand-alone language.
16
<p>More information can be found at the official website (http://www.lua.org).</p>
17
</remarks>
18
#endregion Class Documentation
19
</member>
20
<member name="F:Tao.Lua.Lua.LUA_VERSION">
21
<summary>
22
23
</summary>
24
</member>
25
<member name="F:Tao.Lua.Lua.LUA_RELEASE">
26
<summary>
27
28
</summary>
29
</member>
30
<member name="F:Tao.Lua.Lua.LUA_VERSION_NUM">
31
<summary>
32
33
</summary>
34
</member>
35
<member name="F:Tao.Lua.Lua.LUA_COPYRIGHT">
36
<summary>
37
38
</summary>
39
</member>
40
<member name="F:Tao.Lua.Lua.LUA_AUTHORS">
41
<summary>
42
43
</summary>
44
</member>
45
<member name="F:Tao.Lua.Lua.LUA_SIGNATURE">
46
<summary>
47
48
</summary>
49
</member>
50
<member name="F:Tao.Lua.Lua.LUA_MULTRET">
51
<summary>
52
53
</summary>
54
</member>
55
<member name="F:Tao.Lua.Lua.LUA_REGISTRYINDEX">
56
<summary>
57
58
</summary>
59
</member>
60
<member name="F:Tao.Lua.Lua.LUA_ENVIRONINDEX">
61
<summary>
62
63
</summary>
64
</member>
65
<member name="F:Tao.Lua.Lua.LUA_GLOBALSINDEX">
66
<summary>
67
68
</summary>
69
</member>
70
<member name="F:Tao.Lua.Lua.LUA_YIELDSTATUS">
71
<summary>
72
73
</summary>
74
</member>
75
<member name="F:Tao.Lua.Lua.LUA_ERRRUN">
76
<summary>
77
78
</summary>
79
</member>
80
<member name="F:Tao.Lua.Lua.LUA_ERRSYNTAX">
81
<summary>
82
83
</summary>
84
</member>
85
<member name="F:Tao.Lua.Lua.LUA_ERRMEM">
86
<summary>
87
88
</summary>
89
</member>
90
<member name="F:Tao.Lua.Lua.LUA_ERRERR">
91
<summary>
92
93
</summary>
94
</member>
95
<member name="F:Tao.Lua.Lua.LUA_TNONE">
96
<summary>
97
98
</summary>
99
</member>
100
<member name="F:Tao.Lua.Lua.LUA_TNIL">
101
<summary>
102
103
</summary>
104
</member>
105
<member name="F:Tao.Lua.Lua.LUA_TBOOLEAN">
106
<summary>
107
108
</summary>
109
</member>
110
<member name="F:Tao.Lua.Lua.LUA_TLIGHTUSERDATA">
111
<summary>
112
113
</summary>
114
</member>
115
<member name="F:Tao.Lua.Lua.LUA_TNUMBER">
116
<summary>
117
118
</summary>
119
</member>
120
<member name="F:Tao.Lua.Lua.LUA_TSTRING">
121
<summary>
122
123
</summary>
124
</member>
125
<member name="F:Tao.Lua.Lua.LUA_TTABLE">
126
<summary>
127
128
</summary>
129
</member>
130
<member name="F:Tao.Lua.Lua.LUA_TFUNCTION">
131
<summary>
132
133
</summary>
134
</member>
135
<member name="F:Tao.Lua.Lua.LUA_TUSERDATA">
136
<summary>
137
138
</summary>
139
</member>
140
<member name="F:Tao.Lua.Lua.LUA_TTHREAD">
141
<summary>
142
143
</summary>
144
</member>
145
<member name="F:Tao.Lua.Lua.LUA_MINSTACK">
146
<summary>
147
Minimum Lua stack available to a C function
148
</summary>
149
</member>
150
<member name="F:Tao.Lua.Lua.LUA_GCSTOP">
151
<summary>
152
153
</summary>
154
</member>
155
<member name="F:Tao.Lua.Lua.LUA_GCRESTART">
156
<summary>
157
158
</summary>
159
</member>
160
<member name="F:Tao.Lua.Lua.LUA_GCCOLLECT">
161
<summary>
162
163
</summary>
164
</member>
165
<member name="F:Tao.Lua.Lua.LUA_GCCOUNT">
166
<summary>
167
168
</summary>
169
</member>
170
<member name="F:Tao.Lua.Lua.LUA_GCCOUNTB">
171
<summary>
172
173
</summary>
174
</member>
175
<member name="F:Tao.Lua.Lua.LUA_GCSTEP">
176
<summary>
177
178
</summary>
179
</member>
180
<member name="F:Tao.Lua.Lua.LUA_GCSETPAUSE">
181
<summary>
182
183
</summary>
184
</member>
185
<member name="F:Tao.Lua.Lua.LUA_GCSETSTEPMUL">
186
<summary>
187
188
</summary>
189
</member>
190
<member name="F:Tao.Lua.Lua.LUA_HOOKCALL">
191
<summary>
192
193
</summary>
194
</member>
195
<member name="F:Tao.Lua.Lua.LUA_HOOKRET">
196
<summary>
197
198
</summary>
199
</member>
200
<member name="F:Tao.Lua.Lua.LUA_HOOKLINE">
201
<summary>
202
203
</summary>
204
</member>
205
<member name="F:Tao.Lua.Lua.LUA_HOOKCOUNT">
206
<summary>
207
208
</summary>
209
</member>
210
<member name="F:Tao.Lua.Lua.LUA_HOOKTAILRET">
211
<summary>
212
213
</summary>
214
</member>
215
<member name="F:Tao.Lua.Lua.LUA_MASKCALL">
216
<summary>
217
218
</summary>
219
</member>
220
<member name="F:Tao.Lua.Lua.LUA_MASKRET">
221
<summary>
222
223
</summary>
224
</member>
225
<member name="F:Tao.Lua.Lua.LUA_MASKLINE">
226
<summary>
227
228
</summary>
229
</member>
230
<member name="F:Tao.Lua.Lua.LUA_MASKCOUNT">
231
<summary>
232
233
</summary>
234
</member>
235
<member name="F:Tao.Lua.Lua.LUA_FILEHANDLE">
236
<summary>
237
238
</summary>
239
</member>
240
<member name="F:Tao.Lua.Lua.LUA_COLIBNAME">
241
<summary>
242
243
</summary>
244
</member>
245
<member name="F:Tao.Lua.Lua.LUA_TABLIBNAME">
246
<summary>
247
248
</summary>
249
</member>
250
<member name="F:Tao.Lua.Lua.LUA_IOLIBNAME">
251
<summary>
252
253
</summary>
254
</member>
255
<member name="F:Tao.Lua.Lua.LUA_OSLIBNAME">
256
<summary>
257
258
</summary>
259
</member>
260
<member name="F:Tao.Lua.Lua.LUA_STRLIBNAME">
261
<summary>
262
263
</summary>
264
</member>
265
<member name="F:Tao.Lua.Lua.LUA_MATHLIBNAME">
266
<summary>
267
268
</summary>
269
</member>
270
<member name="F:Tao.Lua.Lua.LUA_DBLIBNAME">
271
<summary>
272
273
</summary>
274
</member>
275
<member name="F:Tao.Lua.Lua.LUA_LOADLIBNAME">
276
<summary>
277
278
</summary>
279
</member>
280
<member name="F:Tao.Lua.Lua.LUA_ERRFILE">
281
<summary>
282
283
</summary>
284
</member>
285
<member name="F:Tao.Lua.Lua.LUA_NOREF">
286
<summary>
287
288
</summary>
289
</member>
290
<member name="F:Tao.Lua.Lua.LUA_RENIL">
291
<summary>
292
293
</summary>
294
</member>
295
<member name="F:Tao.Lua.Lua.LUA_IDSIZE">
296
<summary>
297
298
</summary>
299
</member>
300
<member name="F:Tao.Lua.Lua.UA_PROMPT">
301
<summary>
302
303
</summary>
304
</member>
305
<member name="F:Tao.Lua.Lua.LUA_PROMT2">
306
<summary>
307
308
</summary>
309
</member>
310
<member name="F:Tao.Lua.Lua.LUA_PROGNAME">
311
<summary>
312
313
</summary>
314
</member>
315
<member name="F:Tao.Lua.Lua.LUA_MAXINPUT">
316
<summary>
317
318
</summary>
319
</member>
320
<member name="F:Tao.Lua.Lua.LUAI_GCPAUSE">
321
<summary>
322
323
</summary>
324
</member>
325
<member name="F:Tao.Lua.Lua.LUAI_GCMUL">
326
<summary>
327
328
</summary>
329
</member>
330
<member name="F:Tao.Lua.Lua.LUA_COMPAT_LSTR">
331
<summary>
332
333
</summary>
334
</member>
335
<member name="F:Tao.Lua.Lua.LUAI_MAXCALLS">
336
<summary>
337
338
</summary>
339
</member>
340
<member name="F:Tao.Lua.Lua.LUAI_MAXCSTACK">
341
<summary>
342
343
</summary>
344
</member>
345
<member name="F:Tao.Lua.Lua.LUAI_MAXCCALLS">
346
<summary>
347
348
</summary>
349
</member>
350
<member name="F:Tao.Lua.Lua.LUAI_MAXVARS">
351
<summary>
352
353
</summary>
354
</member>
355
<member name="F:Tao.Lua.Lua.LUAI_MAXUPVALUES">
356
<summary>
357
358
</summary>
359
</member>
360
<member name="F:Tao.Lua.Lua.LUAL_BUFFERSIZE">
361
<summary>
362
363
</summary>
364
</member>
365
<member name="F:Tao.Lua.Lua.LUA_MAXCAPTURES">
366
<summary>
367
368
</summary>
369
</member>
370
<member name="F:Tao.Lua.Lua.LUAI_EXTRASPACE">
371
<summary>
372
373
</summary>
374
</member>
375
<member name="M:Tao.Lua.Lua.lua_upvalueindex(System.Int32)">
376
<summary>
377
378
</summary>
379
<param name="i"></param>
380
<returns></returns>
381
</member>
382
<member name="M:Tao.Lua.Lua.lua_newstate(Tao.Lua.Lua.lua_Alloc,System.IntPtr)">
383
<summary>
384
Creates a new, independent state.
385
</summary>
386
<param name="f">The argument f is the allocator function.</param>
387
<param name="ud">The second argument, ud, is an opaque pointer that Lua simply passes to the allocator in every call.</param>
388
<returns>Returns NULL if cannot create the state (due to lack of memory).</returns>
389
<remarks>Lua does all memory allocation for this state through this function.</remarks>
390
</member>
391
<member name="M:Tao.Lua.Lua.lua_close(System.IntPtr)">
392
<summary>
393
Destroys all objects in the given Lua state (calling the corresponding
394
garbage-collection metamethods, if any) and frees all dynamic memory used
395
by this state. On several platforms, you may not need to call this function,
396
because all resources are naturally released when the host program ends. On
397
the other hand, long-running programs, such as a daemon or a web server, might
398
need to release states as soon as they are not needed, to avoid growing too large.
399
</summary>
400
<param name="L"></param>
401
</member>
402
<member name="M:Tao.Lua.Lua.lua_newthread(System.IntPtr)">
403
<summary>
404
Creates a new thread, pushes it on the stack, and returns a pointer
405
to a lua_State that represents this new thread. The new state returned
406
by this function shares with the original state all global objects
407
(such as tables), but has an independent execution stack.
408
</summary>
409
<param name="L"></param>
410
<returns></returns>
411
<remarks>
412
There is no explicit function to close or to destroy a thread. Threads
413
are subject to garbage collection, like any Lua object.
414
</remarks>
415
</member>
416
<member name="M:Tao.Lua.Lua.lua_atpanic(System.IntPtr,Tao.Lua.Lua.lua_CFunction)">
417
<summary>
418
419
</summary>
420
<param name="L"></param>
421
<param name="panicf"></param>
422
<returns></returns>
423
</member>
424
<member name="M:Tao.Lua.Lua.lua_gettop(System.IntPtr)">
425
<summary>
426
Returns the index of the top element in the stack. Because indices
427
start at 1, this result is equal to the number of elements in the
428
stack (and so 0 means an empty stack).
429
</summary>
430
<param name="L"></param>
431
<returns></returns>
432
</member>
433
<member name="M:Tao.Lua.Lua.lua_settop(System.IntPtr,System.Int32)">
434
<summary>
435
Accepts any acceptable index, or 0, and sets the stack top to this index. If the new top is larger than the old one, then the new elements are filled with nil. If index is 0, then all stack elements are removed.
436
</summary>
437
<param name="L"></param>
438
<param name="idx"></param>
439
</member>
440
<member name="M:Tao.Lua.Lua.lua_pushvalue(System.IntPtr,System.Int32)">
441
<summary>
442
Pushes a copy of the element at the given valid index onto the stack.
443
</summary>
444
<param name="L"></param>
445
<param name="idx"></param>
446
</member>
447
<member name="M:Tao.Lua.Lua.lua_remove(System.IntPtr,System.Int32)">
448
<summary>
449
Removes the element at the given valid index, shifting down
450
the elements above this index to fill the gap. Cannot be called
451
with a pseudo-index, because a pseudo-index is not an actual
452
stack position.
453
</summary>
454
<param name="L"></param>
455
<param name="idx"></param>
456
</member>
457
<member name="M:Tao.Lua.Lua.lua_insert(System.IntPtr,System.Int32)">
458
<summary>
459
Moves the top element into the given valid index, shifting up
460
the elements above this index to open space. Cannot be called
461
with a pseudo-index, because a pseudo-index is not an actual
462
stack position.
463
</summary>
464
<param name="L"></param>
465
<param name="idx"></param>
466
</member>
467
<member name="M:Tao.Lua.Lua.lua_replace(System.IntPtr,System.Int32)">
468
<summary>
469
Moves the top element into the given position (and pops it), without shifting
470
any element (therefore replacing the value at the given position).
471
</summary>
472
<param name="L"></param>
473
<param name="idx"></param>
474
</member>
475
<member name="M:Tao.Lua.Lua.lua_checkstack(System.IntPtr,System.Int32)">
476
<summary>
477
Ensures that there are at least extra free stack slots in the stack. It returns
478
false if it cannot grow the stack to that size. This function never shrinks the
479
stack; if the stack is already larger than the new size, it is left unchanged.
480
</summary>
481
<param name="L"></param>
482
<param name="sz"></param>
483
<returns></returns>
484
</member>
485
<member name="M:Tao.Lua.Lua.lua_xmove(System.IntPtr,System.IntPtr,System.Int32)">
486
<summary>
487
Exchange values between different threads of the same global state.
488
</summary>
489
<param name="from"></param>
490
<param name="to"></param>
491
<param name="n"></param>
492
<remarks>
493
This function pops n values from the stack from, and pushes them onto the stack to.
494
</remarks>
495
</member>
496
<member name="M:Tao.Lua.Lua.lua_isnumber(System.IntPtr,System.Int32)">
497
<summary>
498
Returns 1 if the value at the given acceptable index is a number
499
or a string convertible to a number, and 0 otherwise.
500
</summary>
501
<param name="L"></param>
502
<param name="idx"></param>
503
<returns></returns>
504
</member>
505
<member name="M:Tao.Lua.Lua.lua_isstring(System.IntPtr,System.Int32)">
506
<summary>
507
Returns 1 if the value at the given acceptable index is a
508
string or a number (which is always convertible to a string),
509
and 0 otherwise.
510
</summary>
511
<param name="L"></param>
512
<param name="idx"></param>
513
<returns></returns>
514
</member>
515
<member name="M:Tao.Lua.Lua.lua_iscfunction(System.IntPtr,System.Int32)">
516
<summary>
517
Returns 1 if the value at the given acceptable index is
518
a C function, and 0 otherwise.
519
</summary>
520
<param name="L"></param>
521
<param name="idx"></param>
522
<returns></returns>
523
</member>
524
<member name="M:Tao.Lua.Lua.lua_isuserdata(System.IntPtr,System.Int32)">
525
<summary>
526
Returns 1 if the value at the given acceptable index is a
527
userdata (either full or light), and 0 otherwise.
528
</summary>
529
<param name="L"></param>
530
<param name="idx"></param>
531
<returns></returns>
532
</member>
533
<member name="M:Tao.Lua.Lua.lua_type(System.IntPtr,System.Int32)">
534
<summary>
535
Returns the type of the value in the given acceptable index, or LUA_TNONE for a non-valid index (that is, an index to an "empty" stack position). The types returned by lua_type are coded by the following constants defined in lua.h: LUA_TNIL, LUA_TNUMBER, LUA_TBOOLEAN, LUA_TSTRING, LUA_TTABLE, LUA_TFUNCTION, LUA_TUSERDATA, LUA_TTHREAD, and LUA_TLIGHTUSERDATA.
536
</summary>
537
<param name="L"></param>
538
<param name="idx"></param>
539
<returns></returns>
540
</member>
541
<member name="M:Tao.Lua.Lua.lua_typename(System.IntPtr,System.Int32)">
542
<summary>
543
Returns the name of the type encoded by the value tp, which must be one the values returned by lua_type.
544
</summary>
545
<param name="L"></param>
546
<param name="tp"></param>
547
<returns></returns>
548
</member>
549
<member name="M:Tao.Lua.Lua.lua_equal(System.IntPtr,System.Int32,System.Int32)">
550
<summary>
551
Returns 1 if the two values in acceptable indices index1
552
and index2 are equal, following the semantics of the Lua == operator
553
(that is, may call metamethods). Otherwise returns 0. Also returns
554
0 if any of the indices is non valid.
555
</summary>
556
<param name="L"></param>
557
<param name="idx1"></param>
558
<param name="idx2"></param>
559
<returns></returns>
560
</member>
561
<member name="M:Tao.Lua.Lua.lua_rawequal(System.IntPtr,System.Int32,System.Int32)">
562
<summary>
563
Returns 1 if the two values in acceptable indices index1 and index2
564
are primitively equal (that is, without calling metamethods). Otherwise
565
returns 0. Also returns 0 if any of the indices are non valid.
566
</summary>
567
<param name="L"></param>
568
<param name="idx1"></param>
569
<param name="idx2"></param>
570
<returns></returns>
571
</member>
572
<member name="M:Tao.Lua.Lua.lua_lessthan(System.IntPtr,System.Int32,System.Int32)">
573
<summary>
574
Returns 1 if the value at acceptable index index1 is smaller
575
than the value at acceptable index index2, following the semantics
576
of the Lua less then operator (that is, may call metamethods).
577
Otherwise returns 0. Also returns 0 if any of the indices is non valid.
578
</summary>
579
<param name="L"></param>
580
<param name="idx1"></param>
581
<param name="idx2"></param>
582
<returns></returns>
583
</member>
584
<member name="M:Tao.Lua.Lua.lua_tonumber(System.IntPtr,System.Int32)">
585
<summary>
586
Converts the Lua value at the given acceptable index to a number (see lua_Number). The Lua value must be a number or a string convertible to a number (see §2.2.1); otherwise, lua_tonumber returns 0.
587
</summary>
588
<param name="L"></param>
589
<param name="idx"></param>
590
<returns></returns>
591
</member>
592
<member name="M:Tao.Lua.Lua.lua_tointeger(System.IntPtr,System.Int32)">
593
<summary>
594
Converts the Lua value at the given acceptable index to the signed integral type lua_Integer. The Lua value must be a number or a string convertible to a number (see §2.2.1); otherwise, lua_tointeger returns 0.
595
</summary>
596
<param name="L"></param>
597
<param name="idx"></param>
598
<returns></returns>
599
<remarks>
600
If the number is not an integer, it is truncated in some non-specified way.
601
</remarks>
602
</member>
603
<member name="M:Tao.Lua.Lua.lua_toboolean(System.IntPtr,System.Int32)">
604
<summary>
605
Converts the Lua value at the given acceptable index to a C boolean value (0 or 1). Like all tests in Lua, lua_toboolean returns 1 for any Lua value different from false and nil; otherwise it returns 0. It also returns 0 when called with a non-valid index. (If you want to accept only actual boolean values, use lua_isboolean to test the value's type.)
606
</summary>
607
<param name="L"></param>
608
<param name="idx"></param>
609
<returns></returns>
610
</member>
611
<member name="M:Tao.Lua.Lua.lua_tolstring(System.IntPtr,System.Int32,System.Int32@)">
612
<summary>
613
Converts the Lua value at the given acceptable index to a string (const char*). If len is not NULL, it also sets *len with the string length. The Lua value must be a string or a number; otherwise, the function returns NULL. If the value is a number, then lua_tolstring also changes the actual value in the stack to a string. (This change confuses lua_next when lua_tolstring is applied to keys during a table traversal.)
614
</summary>
615
<param name="L"></param>
616
<param name="idx"></param>
617
<param name="len"></param>
618
<returns>
619
lua_tolstring returns a fully aligned pointer to a string inside the Lua state. This string always has a zero ('\0') after its last character (as in C), but may contain other zeros in its body. Because Lua has garbage collection, there is no guarantee that the pointer returned by lua_tolstring will be valid after the corresponding value is removed from the stack.
620
</returns>
621
</member>
622
<member name="M:Tao.Lua.Lua.lua_objlen(System.IntPtr,System.Int32)">
623
<summary>
624
Returns the "length" of the value at the given acceptable
625
index: for strings, this is the string length; for tables,
626
this is the result of the length operator ('#'); for userdata,
627
this is the size of the block of memory allocated for the
628
userdata; for other values, it is 0.
629
</summary>
630
<param name="L"></param>
631
<param name="idx"></param>
632
<returns></returns>
633
</member>
634
<member name="M:Tao.Lua.Lua.lua_tocfunction(System.IntPtr,System.Int32)">
635
<summary>
636
Converts a value at the given acceptable index to a C function. That value must be a C function; otherwise, returns NULL.
637
</summary>
638
<param name="L"></param>
639
<param name="idx"></param>
640
<returns></returns>
641
</member>
642
<member name="M:Tao.Lua.Lua.lua_touserdata(System.IntPtr,System.Int32)">
643
<summary>
644
If the value at the given acceptable index is a full userdata, returns its block address. If the value is a light userdata, returns its pointer. Otherwise, returns NULL.
645
</summary>
646
<param name="L"></param>
647
<param name="idx"></param>
648
<returns></returns>
649
</member>
650
<member name="M:Tao.Lua.Lua.lua_tothread(System.IntPtr,System.Int32)">
651
<summary>
652
Converts the value at the given acceptable index to a Lua thread (represented as lua_State*). This value must be a thread; otherwise, the function returns NULL.
653
</summary>
654
<param name="L"></param>
655
<param name="idx"></param>
656
<returns></returns>
657
</member>
658
<member name="M:Tao.Lua.Lua.lua_topointer(System.IntPtr,System.Int32)">
659
<summary>
660
Converts the value at the given acceptable index to a generic C pointer (void*). The value may be a userdata, a table, a thread, or a function; otherwise, lua_topointer returns NULL. Different objects will give different pointers. There is no way to convert the pointer back to its original value.
661
</summary>
662
<param name="L"></param>
663
<param name="idx"></param>
664
<returns></returns>
665
<remarks>
666
Typically this function is used only for debug information.
667
</remarks>
668
</member>
669
<member name="M:Tao.Lua.Lua.lua_pushnil(System.IntPtr)">
670
<summary>
671
Pushes a nil value onto the stack.
672
</summary>
673
<param name="L"></param>
674
</member>
675
<member name="M:Tao.Lua.Lua.lua_pushnumber(System.IntPtr,System.Double)">
676
<summary>
677
Pushes a number with value n onto the stack.
678
</summary>
679
<param name="L"></param>
680
<param name="n"></param>
681
</member>
682
<member name="M:Tao.Lua.Lua.lua_pushinteger(System.IntPtr,System.Int32)">
683
<summary>
684
Pushes a number with value n onto the stack.
685
</summary>
686
<param name="L"></param>
687
<param name="n"></param>
688
</member>
689
<member name="M:Tao.Lua.Lua.lua_pushlstring(System.IntPtr,System.String,System.UInt32)">
690
<summary>
691
Pushes the string pointed to by s with size len onto the stack. Lua
692
makes (or reuses) an internal copy of the given string, so the
693
memory at s can be freed or reused immediately after the function
694
returns. The string can contain embedded zeros.
695
</summary>
696
<param name="L"></param>
697
<param name="s"></param>
698
<param name="l"></param>
699
</member>
700
<member name="M:Tao.Lua.Lua.lua_pushstring(System.IntPtr,System.String)">
701
<summary>
702
Pushes the zero-terminated string pointed to by s onto the stack. Lua
703
makes (or reuses) an internal copy of the given string, so the memory
704
at s can be freed or reused immediately after the function returns. The
705
string cannot contain embedded zeros; it is assumed to end at the first zero.
706
</summary>
707
<param name="L"></param>
708
<param name="s"></param>
709
</member>
710
<member name="M:Tao.Lua.Lua.lua_pushcclosure(System.IntPtr,Tao.Lua.Lua.lua_CFunction,System.Int32)">
711
<summary>
712
Pushes a new C closure onto the stack.
713
</summary>
714
<param name="L"></param>
715
<param name="fn"></param>
716
<param name="n"></param>
717
<remarks>
718
When a C function is created, it is possible to associate some values
719
with it, thus creating a C closure (see §3.4); these values are then
720
accessible to the function whenever it is called. To associate values
721
with a C function, first these values should be pushed onto the stack
722
(when there are multiple values, the first value is pushed first).
723
Then lua_pushcclosure is called to create and push the C function onto
724
the stack, with the argument n telling how many values should be
725
associated with the function. lua_pushcclosure also pops these values
726
from the stack.
727
</remarks>
728
</member>
729
<member name="M:Tao.Lua.Lua.lua_pushboolean(System.IntPtr,System.Int32)">
730
<summary>
731
Pushes a boolean value with value b onto the stack.
732
</summary>
733
<param name="L"></param>
734
<param name="b"></param>
735
</member>
736
<member name="M:Tao.Lua.Lua.lua_pushlightuserdata(System.IntPtr,System.IntPtr)">
737
<summary>
738
Pushes a light userdata onto the stack.
739
</summary>
740
<param name="L"></param>
741
<param name="p"></param>
742
<remarks>
743
Userdata represents C values in Lua. A light userdata represents
744
a pointer. It is a value (like a number): you do not create it, it has
745
no individual metatable, and it is not collected (as it was never
746
created). A light userdata is equal to "any" light userdata with
747
the same C address.
748
</remarks>
749
</member>
750
<member name="M:Tao.Lua.Lua.lua_pushthread(System.IntPtr)">
751
<summary>
752
Pushes the thread represented by L onto the stack.
753
</summary>
754
<param name="L"></param>
755
<returns>
756
Returns 1 if this thread is the main thread of its state.
757
</returns>
758
</member>
759
<member name="M:Tao.Lua.Lua.lua_gettable(System.IntPtr,System.Int32)">
760
<summary>
761
Pushes onto the stack the value t[k], where t is the value at the given
762
valid index index and k is the value at the top of the stack.
763
</summary>
764
<param name="L"></param>
765
<param name="idx"></param>
766
<remarks>
767
This function pops the key from the stack (putting the resulting value in
768
its place). As in Lua, this function may trigger a metamethod for the
769
"index" event.
770
</remarks>
771
</member>
772
<member name="M:Tao.Lua.Lua.lua_getfield(System.IntPtr,System.Int32,System.String)">
773
<summary>
774
Pushes onto the stack the value t[k], where t is the value at the
775
given valid index index. As in Lua, this function may trigger a
776
metamethod for the "index" event
777
</summary>
778
<param name="L"></param>
779
<param name="idx"></param>
780
<param name="k"></param>
781
</member>
782
<member name="M:Tao.Lua.Lua.lua_rawget(System.IntPtr,System.Int32)">
783
<summary>
784
Similar to lua_gettable, but does a raw access (i.e., without
785
metamethods).
786
</summary>
787
<param name="L"></param>
788
<param name="idx"></param>
789
</member>
790
<member name="M:Tao.Lua.Lua.lua_rawgeti(System.IntPtr,System.Int32,System.Int32)">
791
<summary>
792
Pushes onto the stack the value t[n], where t is the value at the given
793
valid index index. The access is raw; that is, it does not invoke metamethods.
794
</summary>
795
<param name="L"></param>
796
<param name="idx"></param>
797
<param name="n"></param>
798
</member>
799
<member name="M:Tao.Lua.Lua.lua_createtable(System.IntPtr,System.Int32,System.Int32)">
800
<summary>
801
Creates a new empty table and pushes it onto the stack. The new table
802
has space pre-allocated for narr array elements and nrec non-array elements.
803
This pre-allocation is useful when you know exactly how many elements the table
804
will have. Otherwise you can use the function lua_newtable.
805
</summary>
806
<param name="L"></param>
807
<param name="narr"></param>
808
<param name="nrec"></param>
809
</member>
810
<member name="M:Tao.Lua.Lua.lua_newuserdata(System.IntPtr,System.UInt32)">
811
<summary>
812
This function allocates a new block of memory with the given
813
size, pushes onto the stack a new full userdata with the block
814
address, and returns this address.
815
</summary>
816
<param name="L"></param>
817
<param name="sz"></param>
818
<returns></returns>
819
<remarks>
820
Userdata represents C values in Lua. A full userdata represents
821
a block of memory. It is an object (like a table): you must create it,
822
it can have its own metatable, and you can detect when it is being
823
collected. A full userdata is only equal to itself (under raw equality).
824
825
When Lua collects a full userdata with a gc metamethod, Lua calls the
826
metamethod and marks the userdata as finalized. When this userdata is
827
collected again then Lua frees its corresponding memory.
828
</remarks>
829
</member>
830
<member name="M:Tao.Lua.Lua.lua_getmetatable(System.IntPtr,System.Int32)">
831
<summary>
832
Pushes onto the stack the metatable of the value at the given
833
acceptable index. If the index is not valid, or if the value
834
does not have a metatable, the function returns 0 and pushes
835
nothing on the stack.
836
</summary>
837
<param name="L"></param>
838
<param name="objindex"></param>
839
<returns></returns>
840
</member>
841
<member name="M:Tao.Lua.Lua.lua_getfenv(System.IntPtr,System.Int32)">
842
<summary>
843
Pushes onto the stack the environment table of the value at the given index.
844
</summary>
845
<param name="L"></param>
846
<param name="idx"></param>
847
</member>
848
<member name="M:Tao.Lua.Lua.lua_settable(System.IntPtr,System.Int32)">
849
<summary>
850
Does the equivalent to t[k] = v, where t is the value at the given valid index index, v is the value at the top of the stack, and k is the value just below the top.
851
</summary>
852
<param name="L"></param>
853
<param name="idx"></param>
854
<remarks>
855
This function pops both the key and the value from the stack. As in Lua, this function may trigger a metamethod for the "newindex" event
856
</remarks>
857
</member>
858
<member name="M:Tao.Lua.Lua.lua_setfield(System.IntPtr,System.Int32,System.String)">
859
<summary>
860
Does the equivalent to t[k] = v, where t is the value at the
861
given valid index index and v is the value at the top of the stack,
862
</summary>
863
<param name="L"></param>
864
<param name="idx"></param>
865
<param name="k"></param>
866
<remarks>
867
This function pops the value from the stack. As in Lua, this
868
function may trigger a metamethod for the "newindex" event
869
</remarks>
870
</member>
871
<member name="M:Tao.Lua.Lua.lua_rawset(System.IntPtr,System.Int32)">
872
<summary>
873
Similar to lua_settable, but does a raw assignment (i.e., without
874
metamethods).
875
</summary>
876
<param name="L"></param>
877
<param name="idx"></param>
878
</member>
879
<member name="M:Tao.Lua.Lua.lua_rawseti(System.IntPtr,System.Int32,System.Int32)">
880
<summary>
881
Does the equivalent of t[n] = v, where t is the value at the given valid index index and v
882
is the value at the top of the stack,
883
</summary>
884
<param name="L"></param>
885
<param name="idx"></param>
886
<param name="n"></param>
887
<remarks>
888
This function pops the value from the stack. The assignment is
889
raw; that is, it does not invoke metamethods.
890
</remarks>
891
</member>
892
<member name="M:Tao.Lua.Lua.lua_setmetatable(System.IntPtr,System.Int32)">
893
<summary>
894
Pops a table from the stack and sets it as the new metatable for the value at the given acceptable index.
895
</summary>
896
<param name="L"></param>
897
<param name="objindex"></param>
898
<returns></returns>
899
</member>
900
<member name="M:Tao.Lua.Lua.lua_setfenv(System.IntPtr,System.Int32)">
901
<summary>
902
Pops a table from the stack and sets it as the new
903
environment for the value at the given index.
904
</summary>
905
<param name="L"></param>
906
<param name="idx"></param>
907
<returns>
908
If the value at the given index is neither a function nor a
909
thread nor a userdata, lua_setfenv returns 0. Otherwise it returns 1.
910
</returns>
911
</member>
912
<member name="M:Tao.Lua.Lua.lua_call(System.IntPtr,System.Int32,System.Int32)">
913
<summary>
914
915
</summary>
916
<param name="L"></param>
917
<param name="nargs"></param>
918
<param name="nresults"></param>
919
</member>
920
<member name="M:Tao.Lua.Lua.lua_pcall(System.IntPtr,System.Int32,System.Int32,System.Int32)">
921
<summary>
922
Calls a function in protected mode.
923
</summary>
924
<param name="L"></param>
925
<param name="nargs">
926
Both nargs and nresults have the same meaning as in lua_call. If there are
927
no errors during the call, lua_pcall behaves exactly like lua_call. However,
928
if there is any error, lua_pcall catches it, pushes a single value on the
929
stack (the error message), and returns an error code. Like lua_call,
930
lua_pcall always removes the function and its arguments from the stack.
931
</param>
932
<param name="nresults">
933
Both nargs and nresults have the same meaning as in lua_call. If there are
934
no errors during the call, lua_pcall behaves exactly like lua_call. However,
935
if there is any error, lua_pcall catches it, pushes a single value on the
936
stack (the error message), and returns an error code. Like lua_call,
937
lua_pcall always removes the function and its arguments from the stack.
938
</param>
939
<param name="errfunc">
940
If errfunc is 0, then the error message returned on the stack is exactly
941
the original error message. Otherwise, errfunc is the stack index of an error
942
handler function. (In the current implementation, this index cannot be a
943
pseudo-index.) In case of runtime errors, this function will be called with
944
the error message and its return value will be the message returned on the
945
stack by lua_pcall.
946
</param>
947
<returns>
948
The lua_pcall function returns 0 in case of success or one of the following error codes (defined in lua.h):
949
LUA_ERRRUN: a runtime error.
950
LUA_ERRMEM: memory allocation error. For such errors, Lua does not call the error handler function.
951
LUA_ERRERR: error while running the error handler function.
952
</returns>
953
<remarks>
954
Typically, the error handler function is used to add more debug information
955
to the error message, such as a stack traceback. Such information cannot
956
be gathered after the return of lua_pcall, since by then the stack has unwound.
957
</remarks>
958
</member>
959
<member name="M:Tao.Lua.Lua.lua_cpcall(System.IntPtr,Tao.Lua.Lua.lua_CFunction,System.IntPtr)">
960
<summary>
961
Calls the C function func in protected mode. func starts with only one
962
element in its stack, a light userdata containing ud. In case of errors,
963
lua_cpcall returns the same error codes as lua_pcall, plus the error object
964
on the top of the stack; otherwise, it returns zero, and does not change
965
the stack. All values returned by func are discarded.
966
</summary>
967
<param name="L"></param>
968
<param name="func"></param>
969
<param name="ud"></param>
970
<returns></returns>
971
</member>
972
<member name="M:Tao.Lua.Lua.lua_load(System.IntPtr,Tao.Lua.Lua.lua_Reader,System.IntPtr,System.String)">
973
<summary>
974
Loads a Lua chunk. If there are no errors, lua_load pushes the compiled
975
chunk as a Lua function on top of the stack. Otherwise, it pushes an
976
error message.
977
</summary>
978
<param name="L"></param>
979
<param name="reader"></param>
980
<param name="data">The data argument is an opaque value passed to the reader function.</param>
981
<param name="chunkname">The chunkname argument gives a name to the chunk, which is used for error messages and in debug information.</param>
982
<returns>0: no errors. LUA_ERRSYNTAX: syntax error during pre-compilation. LUA_ERRMEM: memory allocation error.</returns>
983
<remarks>This function only loads a chunk; it does not run it. lua_load automatically detects whether the chunk is text or binary, and loads it accordingly (see program luac). lua_load uses a user-supplied reader function to read the chunk (see lua_Reader).</remarks>
984
</member>
985
<member name="M:Tao.Lua.Lua.lua_dump(System.IntPtr,Tao.Lua.Lua.lua_Writer,System.IntPtr)">
986
<summary>
987
Dumps a function as a binary chunk. Receives a Lua function on the
988
top of the stack and produces a binary chunk that, if loaded again,
989
results in a function equivalent to the one dumped. As it produces
990
parts of the chunk, lua_dump calls function writer (see lua_Writer)
991
with the given data to write them.
992
</summary>
993
<param name="L"></param>
994
<param name="writer"></param>
995
<param name="data"></param>
996
<returns>
997
The value returned is the error code returned by the last call to
998
the writer; 0 means no errors.
999
</returns>
1000
<remarks>
1001
This function does not pop the Lua function from the stack.
1002
</remarks>
1003
</member>
1004
<member name="M:Tao.Lua.Lua.lua_yield(System.IntPtr,System.Int32)">
1005
<summary>
1006
Yields a coroutine.
1007
</summary>
1008
<param name="L"></param>
1009
<param name="nresults"></param>
1010
<returns></returns>
1011
<remarks>
1012
When a C function calls lua_yield in that way, the running coroutine suspends its execution, and the call to lua_resume that started this coroutine returns. The parameter nresults is the number of values from the stack that are passed as results to lua_resume.
1013
</remarks>
1014
</member>
1015
<member name="M:Tao.Lua.Lua.lua_resume(System.IntPtr,System.Int32)">
1016
<summary>
1017
Starts and resumes a coroutine in a given thread.
1018
</summary>
1019
<param name="L"></param>
1020
<param name="narg"></param>
1021
<returns>
1022
When it returns, the stack contains all values passed to lua_yield, or
1023
all values returned by the body function. lua_resume returns LUA_YIELD
1024
if the coroutine yields, 0 if the coroutine finishes its execution without
1025
errors, or an error code in case of errors (see lua_pcall). In case of
1026
errors, the stack is not unwound, so you can use the debug API over it. The
1027
error message is on the top of the stack.
1028
</returns>
1029
<remarks>
1030
To start a coroutine, you first create a new thread (see lua_newthread);
1031
then you push onto its stack the main function plus any arguments;
1032
then you call lua_resume, with narg being the number of arguments.
1033
This call returns when the coroutine suspends or finishes its execution.
1034
To restart a coroutine, you put on its stack only the values to be passed
1035
as results from yield, and then call lua_resume.
1036
</remarks>
1037
</member>
1038
<member name="M:Tao.Lua.Lua.lua_status(System.IntPtr)">
1039
<summary>
1040
Returns the status of the thread L.
1041
</summary>
1042
<param name="L"></param>
1043
<returns></returns>
1044
<remarks>
1045
The status can be 0 for a normal thread, an error code if the thread finished its execution with an error, or LUA_YIELD if the thread is suspended.
1046
</remarks>
1047
</member>
1048
<member name="M:Tao.Lua.Lua.lua_gc(System.IntPtr,System.Int32,System.Int32)">
1049
<summary>
1050
Controls the garbage collector.
1051
</summary>
1052
<param name="L"></param>
1053
<param name="what"></param>
1054
<param name="data"></param>
1055
<returns></returns>
1056
<remarks>
1057
This function performs several tasks, according to the value of the parameter what:
1058
LUA_GCSTOP: stops the garbage collector.
1059
LUA_GCRESTART: restarts the garbage collector.
1060
LUA_GCCOLLECT: performs a full garbage-collection cycle.
1061
LUA_GCCOUNT: returns the current amount of memory (in Kbytes) in use by Lua.
1062
LUA_GCCOUNTB: returns the remainder of dividing the current amount of bytes of memory in use by Lua by 1024.
1063
LUA_GCSTEP: performs an incremental step of garbage collection. The step "size" is controlled by data (larger values mean more steps) in a non-specified way. If you want to control the step size you must experimentally tune the value of data. The function returns 1 if the step finished a garbage-collection cycle.
1064
LUA_GCSETPAUSE: sets data/100 as the new value for the pause of the collector (see §2.10). The function returns the previous value of the pause.
1065
LUA_GCSETSTEPMUL: sets arg/100 as the new value for the step multiplier of the collector (see §2.10). The function returns the previous value of the step multiplier.
1066
</remarks>
1067
</member>
1068
<member name="M:Tao.Lua.Lua.lua_error(System.IntPtr)">
1069
<summary>
1070
Generates a Lua error. The error message (which can actually
1071
be a Lua value of any type) must be on the stack top. This function
1072
does a long jump, and therefore never returns. (see luaL_error).
1073
</summary>
1074
<param name="L"></param>
1075
<returns></returns>
1076
</member>
1077
<member name="M:Tao.Lua.Lua.lua_next(System.IntPtr,System.Int32)">
1078
<summary>
1079
Pops a key from the stack, and pushes a key-value pair from the
1080
table at the given index (the "next" pair after the given key).
1081
</summary>
1082
<param name="L"></param>
1083
<param name="idx"></param>
1084
<returns>
1085
If there are no more elements in the table, then lua_next
1086
returns 0 (and pushes nothing).
1087
</returns>
1088
</member>
1089
<member name="M:Tao.Lua.Lua.lua_concat(System.IntPtr,System.Int32)">
1090
<summary>
1091
Concatenates the n values at the top of the stack, pops them, and leaves
1092
the result at the top. If n is 1, the result is the single string on
1093
the stack (that is, the function does nothing); if n is 0, the result
1094
is the empty string. Concatenation is done following the usual semantics
1095
of Lua.
1096
</summary>
1097
<param name="L"></param>
1098
<param name="n"></param>
1099
</member>
1100
<member name="M:Tao.Lua.Lua.lua_getallocf(System.IntPtr,System.IntPtr)">
1101
<summary>
1102
Returns the memory-allocation function of a given state.
1103
If ud is not NULL, Lua stores in *ud the opaque pointer
1104
passed to lua_newstate.
1105
</summary>
1106
<param name="L"></param>
1107
<param name="ud"></param>
1108
<returns></returns>
1109
</member>
1110
<member name="M:Tao.Lua.Lua.lua_setallocf(System.IntPtr,Tao.Lua.Lua.lua_Alloc,System.IntPtr)">
1111
<summary>
1112
Changes the allocator function of a given state to f with
1113
user data ud.
1114
</summary>
1115
<param name="L"></param>
1116
<param name="f"></param>
1117
<param name="ud"></param>
1118
<returns></returns>
1119
</member>
1120
<member name="M:Tao.Lua.Lua.lua_pop(System.IntPtr,System.Int32)">
1121
<summary>
1122
Pops n elements from the stack.
1123
</summary>
1124
<param name="L"></param>
1125
<param name="n"></param>
1126
</member>
1127
<member name="M:Tao.Lua.Lua.lua_newtable(System.IntPtr)">
1128
<summary>
1129
Creates a new empty table and pushes it onto the stack.
1130
</summary>
1131
<param name="L"></param>
1132
<remarks>It is equivalent to lua_createtable(L, 0, 0).</remarks>
1133
</member>
1134
<member name="M:Tao.Lua.Lua.lua_register(System.IntPtr,System.String,Tao.Lua.Lua.lua_CFunction)">
1135
<summary>
1136
Sets the C function f as the new value of global name.
1137
</summary>
1138
<param name="L"></param>
1139
<param name="n"></param>
1140
<param name="f"></param>
1141
</member>
1142
<member name="M:Tao.Lua.Lua.lua_pushcfunction(System.IntPtr,Tao.Lua.Lua.lua_CFunction)">
1143
<summary>
1144
Pushes a C function onto the stack. This function receives a pointer
1145
to a C function and pushes onto the stack a Lua value of type function
1146
that, when called, invokes the corresponding C function.
1147
</summary>
1148
<param name="L"></param>
1149
<param name="f"></param>
1150
<remarks>
1151
Any function to be registered in Lua must follow the correct protocol
1152
to receive its parameters and return its results
1153
</remarks>
1154
</member>
1155
<member name="M:Tao.Lua.Lua.lua_strlen(System.IntPtr,System.Int32)">
1156
<summary>
1157
1158
</summary>
1159
<param name="L"></param>
1160
<param name="i"></param>
1161
<returns></returns>
1162
</member>
1163
<member name="M:Tao.Lua.Lua.lua_isfunction(System.IntPtr,System.Int32)">
1164
<summary>
1165
Returns 1 if the value at the given acceptable index is a
1166
function (either C or Lua), and 0 otherwise.
1167
</summary>
1168
<param name="L"></param>
1169
<param name="n"></param>
1170
<returns></returns>
1171
</member>
1172
<member name="M:Tao.Lua.Lua.lua_istable(System.IntPtr,System.Int32)">
1173
<summary>
1174
Returns 1 if the value at the given acceptable index is a
1175
table, and 0 otherwise.
1176
</summary>
1177
<param name="L"></param>
1178
<param name="n"></param>
1179
<returns></returns>
1180
</member>
1181
<member name="M:Tao.Lua.Lua.lua_islightuserdata(System.IntPtr,System.Int32)">
1182
<summary>
1183
Returns 1 if the value at the given acceptable index is a light
1184
userdata, and 0 otherwise.
1185
</summary>
1186
<param name="L"></param>
1187
<param name="n"></param>
1188
<returns></returns>
1189
</member>
1190
<member name="M:Tao.Lua.Lua.lua_isnil(System.IntPtr,System.Int32)">
1191
<summary>
1192
Returns 1 if the value at the given acceptable index is nil,
1193
and 0 otherwise.
1194
</summary>
1195
<param name="L"></param>
1196
<param name="n"></param>
1197
<returns></returns>
1198
</member>
1199
<member name="M:Tao.Lua.Lua.lua_isboolean(System.IntPtr,System.Int32)">
1200
<summary>
1201
Returns 1 if the value at the given acceptable index has type boolean, and 0 otherwise.
1202
</summary>
1203
<param name="L"></param>
1204
<param name="n"></param>
1205
<returns></returns>
1206
</member>
1207
<member name="M:Tao.Lua.Lua.lua_isthread(System.IntPtr,System.Int32)">
1208
<summary>
1209
Returns 1 if the value at the given acceptable index is a
1210
thread, and 0 otherwise.
1211
</summary>
1212
<param name="L"></param>
1213
<param name="n"></param>
1214
<returns></returns>
1215
</member>
1216
<member name="M:Tao.Lua.Lua.lua_isnone(System.IntPtr,System.Int32)">
1217
<summary>
1218
1219
</summary>
1220
<param name="L"></param>
1221
<param name="n"></param>
1222
<returns></returns>
1223
</member>
1224
<member name="M:Tao.Lua.Lua.lua_isnoneornil(System.IntPtr,System.Int32)">
1225
<summary>
1226
1227
</summary>
1228
<param name="L"></param>
1229
<param name="n"></param>
1230
<returns></returns>
1231
</member>
1232
<member name="M:Tao.Lua.Lua.lua_pushliteral(System.IntPtr,System.String)">
1233
<summary>
1234
1235
</summary>
1236
<param name="L"></param>
1237
<param name="s"></param>
1238
</member>
1239
<member name="M:Tao.Lua.Lua.lua_setglobal(System.IntPtr,System.String)">
1240
<summary>
1241
Pops a value from the stack and sets it as the new value of global name.
1242
</summary>
1243
<param name="L"></param>
1244
<param name="s"></param>
1245
</member>
1246
<member name="M:Tao.Lua.Lua.lua_getglobal(System.IntPtr,System.String)">
1247
<summary>
1248
Pushes onto the stack the value of the global name.
1249
</summary>
1250
<param name="L"></param>
1251
<param name="s"></param>
1252
</member>
1253
<member name="M:Tao.Lua.Lua.lua_tostring(System.IntPtr,System.Int32)">
1254
<summary>
1255
Equivalent to lua_tolstring with len equal to NULL.
1256
</summary>
1257
<param name="L"></param>
1258
<param name="i"></param>
1259
<returns></returns>
1260
</member>
1261
<member name="M:Tao.Lua.Lua.lua_open">
1262
<summary>
1263
1264
</summary>
1265
<returns></returns>
1266
</member>
1267
<member name="M:Tao.Lua.Lua.lua_getregistry(System.IntPtr)">
1268
<summary>
1269
1270
</summary>
1271
<param name="L"></param>
1272
</member>
1273
<member name="M:Tao.Lua.Lua.lua_getgccount(System.IntPtr)">
1274
<summary>
1275
1276
</summary>
1277
<param name="L"></param>
1278
<returns></returns>
1279
</member>
1280
<member name="M:Tao.Lua.Lua.lua_getstack(System.IntPtr,System.Int32,Tao.Lua.Lua.lua_Debug@)">
1281
<summary>
1282
Get information about the interpreter runtime stack.
1283
</summary>
1284
<param name="L"></param>
1285
<param name="level"></param>
1286
<param name="ar"></param>
1287
<returns>When there are no errors, lua_getstack returns 1; when called with a level greater than the stack depth, it returns 0.</returns>
1288
<remarks>This function fills parts of a lua_Debug structure with an identification of the activation record of the function executing at a given level. Level 0 is the current running function, whereas level n+1 is the function that has called level n.</remarks>
1289
</member>
1290
<member name="M:Tao.Lua.Lua.lua_getinfo(System.IntPtr,System.String,Tao.Lua.Lua.lua_Debug@)">
1291
<summary>
1292
Returns information about a specific function or function invocation.
1293
</summary>
1294
<param name="L"></param>
1295
<param name="what"></param>
1296
<param name="ar"></param>
1297
<returns></returns>
1298
<remarks>
1299
To get information about a function invocation, the parameter ar must be a valid activation record that was filled by a previous call to lua_getstack or given as argument to a hook (see lua_Hook).
1300
</remarks>
1301
</member>
1302
<member name="M:Tao.Lua.Lua.lua_getlocal(System.IntPtr,Tao.Lua.Lua.lua_Debug@,System.Int32)">
1303
<summary>
1304
Gets information about a local variable of a given activation record.
1305
</summary>
1306
<param name="L"></param>
1307
<param name="ar">The parameter ar must be a valid activation record that was filled by a previous call to lua_getstack or given as argument to a hook (see lua_Hook).</param>
1308
<param name="n">The index n selects which local variable to inspect (1 is the first parameter or active local variable, and so on, until the last active local variable). lua_getlocal pushes the variable's value onto the stack and returns its name.</param>
1309
<returns>Returns NULL (and pushes nothing) when the index is greater than the number of active local variables.</returns>
1310
<remarks>
1311
Variable names starting with '(' (open parentheses) represent internal variables (loop control variables, temporaries, and C function locals).
1312
</remarks>
1313
</member>
1314
<member name="M:Tao.Lua.Lua.lua_setlocal(System.IntPtr,Tao.Lua.Lua.lua_Debug@,System.Int32)">
1315
<summary>
1316
Sets the value of a local variable of a given activation record
1317
</summary>
1318
<param name="L"></param>
1319
<param name="ar">Parameters ar and n are as in lua_getlocal (see lua_getlocal). lua_setlocal assigns the value at the top of the stack to the variable and returns its name. It also pops the value from the stack.</param>
1320
<param name="n">Parameters ar and n are as in lua_getlocal (see lua_getlocal). lua_setlocal assigns the value at the top of the stack to the variable and returns its name. It also pops the value from the stack.</param>
1321
<returns>Returns NULL (and pops nothing) when the index is greater than the number of active local variables.</returns>
1322
</member>
1323
<member name="M:Tao.Lua.Lua.lua_getupvalue(System.IntPtr,System.Int32,System.Int32)">
1324
<summary>
1325
Gets information about a closure's upvalue. (For Lua functions, upvalues are the external local variables that the function uses, and that are consequently included in its closure.) lua_getupvalue gets the index n of an upvalue, pushes the upvalue's value onto the stack, and returns its name. funcindex points to the closure in the stack. (Upvalues have no particular order, as they are active through the whole function. So, they are numbered in an arbitrary order.)
1326
</summary>
1327
<param name="L"></param>
1328
<param name="funcindex"></param>
1329
<param name="n"></param>
1330
<returns>Returns NULL (and pushes nothing) when the index is greater than the number of upvalues. For C functions, this function uses the empty string "" as a name for all upvalues.</returns>
1331
</member>
1332
<member name="M:Tao.Lua.Lua.lua_setupvalue(System.IntPtr,System.Int32,System.Int32)">
1333
<summary>
1334
Sets the value of a closure's upvalue. Parameters funcindex and n are as in lua_getupvalue (see lua_getupvalue). It assigns the value at the top of the stack to the upvalue and returns its name. It also pops the value from the stack.
1335
</summary>
1336
<param name="L"></param>
1337
<param name="funcindex"></param>
1338
<param name="n"></param>
1339
<returns>Returns NULL (and pops nothing) when the index is greater than the number of upvalues.</returns>
1340
</member>
1341
<member name="M:Tao.Lua.Lua.lua_sethook(System.IntPtr,Tao.Lua.Lua.lua_Hook,System.Int32,System.Int32)">
1342
<summary>
1343
Sets the debugging hook function.
1344
</summary>
1345
<param name="L"></param>
1346
<param name="func">func is the hook function.</param>
1347
<param name="mask">mask specifies on which events the hook will be called: it is formed by a bitwise or of the constants LUA_MASKCALL, LUA_MASKRET, LUA_MASKLINE, and LUA_MASKCOUNT.</param>
1348
<param name="count">The count argument is only meaningful when the mask includes LUA_MASKCOUNT.</param>
1349
<returns></returns>
1350
<remarks>
1351
For each event, the hook is called as explained below:
1352
* The call hook: is called when the interpreter calls a function. The hook is called just after Lua enters the new function, before the function gets its arguments.
1353
* The return hook: is called when the interpreter returns from a function. The hook is called just before Lua leaves the function. You have no access to the values to be returned by the function.
1354
* The line hook: is called when the interpreter is about to start the execution of a new line of code, or when it jumps back in the code (even to the same line). (This event only happens while Lua is executing a Lua function.)
1355
* The count hook: is called after the interpreter executes every count instructions. (This event only happens while Lua is executing a Lua function.)
1356
A hook is disabled by setting mask to zero.
1357
</remarks>
1358
</member>
1359
<member name="M:Tao.Lua.Lua.lua_gethook(System.IntPtr)">
1360
<summary>
1361
Returns the current hook function.
1362
</summary>
1363
<param name="L"></param>
1364
<returns></returns>
1365
</member>
1366
<member name="M:Tao.Lua.Lua.lua_gethookmask(System.IntPtr)">
1367
<summary>
1368
Returns the current hook mask.
1369
</summary>
1370
<param name="L"></param>
1371
<returns></returns>
1372
</member>
1373
<member name="M:Tao.Lua.Lua.lua_gethookcount(System.IntPtr)">
1374
<summary>
1375
Returns the current hook count.
1376
</summary>
1377
<param name="L"></param>
1378
<returns></returns>
1379
</member>
1380
<member name="M:Tao.Lua.Lua.luaopen_base(System.IntPtr)">
1381
<summary>
1382
1383
</summary>
1384
<param name="L"></param>
1385
<returns></returns>
1386
</member>
1387
<member name="M:Tao.Lua.Lua.luaopen_table(System.IntPtr)">
1388
<summary>
1389
1390
</summary>
1391
<param name="L"></param>
1392
<returns></returns>
1393
</member>
1394
<member name="M:Tao.Lua.Lua.luaopen_io(System.IntPtr)">
1395
<summary>
1396
1397
</summary>
1398
<param name="L"></param>
1399
<returns></returns>
1400
</member>
1401
<member name="M:Tao.Lua.Lua.luaopen_os(System.IntPtr)">
1402
<summary>
1403
1404
</summary>
1405
<param name="L"></param>
1406
<returns></returns>
1407
</member>
1408
<member name="M:Tao.Lua.Lua.luaopen_string(System.IntPtr)">
1409
<summary>
1410
1411
</summary>
1412
<param name="L"></param>
1413
<returns></returns>
1414
</member>
1415
<member name="M:Tao.Lua.Lua.luaopen_math(System.IntPtr)">
1416
<summary>
1417
1418
</summary>
1419
<param name="L"></param>
1420
<returns></returns>
1421
</member>
1422
<member name="M:Tao.Lua.Lua.luaopen_debug(System.IntPtr)">
1423
<summary>
1424
1425
</summary>
1426
<param name="L"></param>
1427
<returns></returns>
1428
</member>
1429
<member name="M:Tao.Lua.Lua.luaopen_package(System.IntPtr)">
1430
<summary>
1431
1432
</summary>
1433
<param name="L"></param>
1434
<returns></returns>
1435
</member>
1436
<member name="M:Tao.Lua.Lua.luaL_openlibs(System.IntPtr)">
1437
<summary>
1438
Opens all standard Lua libraries into the given state.
1439
</summary>
1440
<param name="L"></param>
1441
<returns></returns>
1442
</member>
1443
<member name="M:Tao.Lua.Lua.lua_asset(System.Object)">
1444
<summary>
1445
1446
</summary>
1447
<param name="x"></param>
1448
<returns></returns>
1449
</member>
1450
<member name="M:Tao.Lua.Lua.luaL_getn(System.IntPtr,System.Int32)">
1451
<summary>
1452
1453
</summary>
1454
<param name="L"></param>
1455
<param name="t"></param>
1456
<returns></returns>
1457
</member>
1458
<member name="M:Tao.Lua.Lua.luaL_setn(System.IntPtr,System.Int32,System.Int32)">
1459
<summary>
1460
1461
</summary>
1462
<param name="L"></param>
1463
<param name="t"></param>
1464
<param name="n"></param>
1465
</member>
1466
<member name="M:Tao.Lua.Lua.luaI_openlib(System.IntPtr,System.String,Tao.Lua.Lua.luaL_Reg@,System.Int32)">
1467
<summary>
1468
1469
</summary>
1470
<param name="L"></param>
1471
<param name="libname"></param>
1472
<param name="l"></param>
1473
<param name="nup"></param>
1474
</member>
1475
<member name="M:Tao.Lua.Lua.luaL_register(System.IntPtr,System.String,Tao.Lua.Lua.luaL_Reg@)">
1476
<summary>
1477
Opens a library.
1478
</summary>
1479
<param name="L"></param>
1480
<param name="libname"></param>
1481
<param name="l"></param>
1482
<remarks>When called with libname equal to NULL, it simply registers all functions in the list l (see luaL_Reg) into the table on the top of the stack.
1483
When called with a non-null libname, creates a new table t, sets it as the value of the global variable libname, sets it as the value of package.loaded[libname], and registers on it all functions in the list l. If there is a table in package.loaded[libname] or in variable libname, reuses this table instead of creating a new one.
1484
In any case the function leaves the table on the top of the stack. </remarks>
1485
</member>
1486
<member name="M:Tao.Lua.Lua.luaL_getmetafield(System.IntPtr,System.Int32,System.String)">
1487
<summary>
1488
Pushes onto the stack the field e from the metatable of the object at index obj. If the object does not have a metatable, or if the metatable does not have this field, returns 0 and pushes nothing.
1489
</summary>
1490
<param name="L"></param>
1491
<param name="obj"></param>
1492
<param name="e"></param>
1493
<returns></returns>
1494
</member>
1495
<member name="M:Tao.Lua.Lua.luaL_callmeta(System.IntPtr,System.Int32,System.String)">
1496
<summary>
1497
Calls a metamethod.
1498
</summary>
1499
<param name="L"></param>
1500
<param name="obj"></param>
1501
<param name="e"></param>
1502
<returns></returns>
1503
<remarks>
1504
If the object at index obj has a metatable and this metatable has a field e, this function calls this field and passes the object as its only argument. In this case this function returns 1 and pushes onto the stack the value returned by the call. If there is no metatable or no metamethod, this function returns 0 (without pushing any value on the stack).
1505
</remarks>
1506
</member>
1507
<member name="M:Tao.Lua.Lua.luaL_typerror(System.IntPtr,System.Int32,System.String)">
1508
<summary>
1509
Generates an error with a message.
1510
</summary>
1511
<param name="L"></param>
1512
<param name="narg"></param>
1513
<param name="tname"></param>
1514
<returns></returns>
1515
<remarks>Generates an error with a message like:
1516
[location]: bad argument [narg] to [function] ([tname] expected, got [realt])
1517
where [location] is produced by luaL_where, [function] is the name of the current function, and [realt] is the type name of the actual argument. </remarks>
1518
</member>
1519
<member name="M:Tao.Lua.Lua.luaL_argerror(System.IntPtr,System.Int32,System.String)">
1520
<summary>
1521
Raises an error with the following message, where func is retrieved from the call stack:
1522
<code>bad argument #[numarg] to [func] ([extramsg])</code>
1523
</summary>
1524
<param name="L"></param>
1525
<param name="numarg"></param>
1526
<param name="extramsg"></param>
1527
<returns>This function never returns, but it is an idiom to use it in C functions as return luaL_argerror(args).</returns>
1528
</member>
1529
<member name="M:Tao.Lua.Lua.luaL_checklstring(System.IntPtr,System.Int32,System.UInt32@)">
1530
<summary>
1531
Checks whether the function argument narg is a string and returns this string; if l is not NULL fills *l with the string's length.
1532
</summary>
1533
<param name="L"></param>
1534
<param name="numArg"></param>
1535
<param name="l"></param>
1536
<returns></returns>
1537
</member>
1538
<member name="M:Tao.Lua.Lua.luaL_optlstring(System.IntPtr,System.Int32,System.String,System.UInt32@)">
1539
<summary>
1540
If the function argument narg is a string, returns this string. If this argument is absent or is nil, returns d. Otherwise, raises an error. If l is not NULL, fills the position *l with the results's length.
1541
</summary>
1542
<param name="L"></param>
1543
<param name="numArg"></param>
1544
<param name="def"></param>
1545
<param name="l"></param>
1546
<returns></returns>
1547
</member>
1548
<member name="M:Tao.Lua.Lua.luaL_checknumber(System.IntPtr,System.Int32)">
1549
<summary>
1550
Checks whether the function argument narg is a number and returns this number.
1551
</summary>
1552
<param name="L"></param>
1553
<param name="numArg"></param>
1554
<returns></returns>
1555
</member>
1556
<member name="M:Tao.Lua.Lua.luaL_optnumber(System.IntPtr,System.Int32,System.Double)">
1557
<summary>
1558
If the function argument narg is a number, returns this number. If this argument is absent or is nil, returns d. Otherwise, raises an error.
1559
</summary>
1560
<param name="L"></param>
1561
<param name="nArg"></param>
1562
<param name="def"></param>
1563
<returns></returns>
1564
</member>
1565
<member name="M:Tao.Lua.Lua.luaL_checkinteger(System.IntPtr,System.Int32)">
1566
<summary>
1567
Checks whether the function argument narg is a number and returns this number cast to a lua_Integer.
1568
</summary>
1569
<param name="L"></param>
1570
<param name="numArg"></param>
1571
<returns></returns>
1572
</member>
1573
<member name="M:Tao.Lua.Lua.luaL_optinteger(System.IntPtr,System.Int32,System.Int32)">
1574
<summary>
1575
If the function argument narg is a number, returns this number cast to a lua_Integer. If this argument is absent or is nil, returns d. Otherwise, raises an error.
1576
</summary>
1577
<param name="L"></param>
1578
<param name="nArg"></param>
1579
<param name="def"></param>
1580
<returns></returns>
1581
</member>
1582
<member name="M:Tao.Lua.Lua.luaL_checkstack(System.IntPtr,System.Int32,System.String)">
1583
<summary>
1584
Grows the stack size to top + sz elements, raising an error if the stack cannot grow to that size. msg is an additional text to go into the error message.
1585
</summary>
1586
<param name="L"></param>
1587
<param name="sz"></param>
1588
<param name="msg"></param>
1589
</member>
1590
<member name="M:Tao.Lua.Lua.luaL_checktype(System.IntPtr,System.Int32,System.Int32)">
1591
<summary>
1592
Checks whether the function argument narg has type t.
1593
</summary>
1594
<param name="L"></param>
1595
<param name="narg"></param>
1596
<param name="t"></param>
1597
</member>
1598
<member name="M:Tao.Lua.Lua.luaL_checkany(System.IntPtr,System.Int32)">
1599
<summary>
1600
Checks whether the function has an argument of any type (including nil) at position narg.
1601
</summary>
1602
<param name="L"></param>
1603
<param name="narg"></param>
1604
</member>
1605
<member name="M:Tao.Lua.Lua.luaL_newmetatable(System.IntPtr,System.String)">
1606
<summary>
1607
If the registry already has the key tname, returns 0. Otherwise, creates a new table to be used as a metatable for userdata, adds it to the registry with key tname, and returns 1.
1608
</summary>
1609
<param name="L"></param>
1610
<param name="tname"></param>
1611
<returns></returns>
1612
<remarks>In both cases pushes onto the stack the final value associated with tname in the registry.</remarks>
1613
</member>
1614
<member name="M:Tao.Lua.Lua.luaL_checkudata(System.IntPtr,System.Int32,System.String)">
1615
<summary>
1616
Checks whether the function argument narg is a userdata of the type tname (see luaL_newmetatable).
1617
</summary>
1618
<param name="L"></param>
1619
<param name="ud"></param>
1620
<param name="tname"></param>
1621
<returns></returns>
1622
</member>
1623
<member name="M:Tao.Lua.Lua.luaL_where(System.IntPtr,System.Int32)">
1624
<summary>
1625
Pushes onto the stack a string identifying the current position of the control at level lvl in the call stack. Typically this string has the format {chunkname}:{currentline}:. Level 0 is the running function, level 1 is the function that called the running function, etc.
1626
</summary>
1627
<param name="L"></param>
1628
<param name="lvl"></param>
1629
<remarks>This function is used to build a prefix for error messages.</remarks>
1630
</member>
1631
<member name="M:Tao.Lua.Lua.luaL_checkoption(System.IntPtr,System.Int32,System.String,System.String[])">
1632
<summary>
1633
Checks whether the function argument narg is a string and searches for this string in the array lst (which must be NULL-terminated). Returns the index in the array where the string was found. Raises an error if the argument is not a string or if the string cannot be found.
1634
</summary>
1635
<param name="L"></param>
1636
<param name="narg"></param>
1637
<param name="def"></param>
1638
<param name="lst"></param>
1639
<returns></returns>
1640
<remarks>
1641
If def is not NULL, the function uses def as a default value when there is no argument narg or if this argument is nil.
1642
This is a useful function for mapping strings to C enums. (The usual convention in Lua libraries is to use strings instead of numbers to select options.)
1643
</remarks>
1644
</member>
1645
<member name="M:Tao.Lua.Lua.luaL_ref(System.IntPtr,System.Int32)">
1646
<summary>
1647
Creates and returns a reference, in the table at index t, for the object at the top of the stack (and pops the object).
1648
</summary>
1649
<param name="L"></param>
1650
<param name="t"></param>
1651
<returns></returns>
1652
<remarks>A reference is a unique integer key. As long as you do not manually add integer keys into table t, luaL_ref ensures the uniqueness of the key it returns. You can retrieve an object referred by reference r by calling lua_rawgeti(L, t, r). Function luaL_unref frees a reference and its associated object.
1653
If the object at the top of the stack is nil, luaL_ref returns the constant LUA_REFNIL. The constant LUA_NOREF is guaranteed to be different from any reference returned by luaL_ref.
1654
</remarks>
1655
</member>
1656
<member name="M:Tao.Lua.Lua.luaL_unref(System.IntPtr,System.Int32,System.Int32)">
1657
<summary>
1658
Releases reference ref from the table at index t (see luaL_ref). The entry is removed from the table, so that the referred object can be collected. The reference ref is also freed to be used again.
1659
</summary>
1660
<param name="L"></param>
1661
<param name="t"></param>
1662
<param name="rf">If rf is LUA_NOREF or LUA_REFNIL, luaL_unref does nothing.</param>
1663
</member>
1664
<member name="M:Tao.Lua.Lua.luaL_loadfile(System.IntPtr,System.String)">
1665
<summary>
1666
Loads a file as a Lua chunk. This function uses lua_load to load the chunk in the file named filename. If filename is NULL, then it loads from the standard input. The first line in the file is ignored if it starts with a #.
1667
</summary>
1668
<param name="L"></param>
1669
<param name="filename"></param>
1670
<returns></returns>
1671
<remarks>This function returns the same results as lua_load, but it has an extra error code LUA_ERRFILE if it cannot open/read the file. As lua_load, this function only loads the chunk; it does not run it.</remarks>
1672
</member>
1673
<member name="M:Tao.Lua.Lua.luaL_loadbuffer(System.IntPtr,System.String,System.UInt32,System.String)">
1674
<summary>
1675
Loads a buffer as a Lua chunk. This function uses lua_load to load the chunk in the buffer pointed to by buff with size sz.
1676
</summary>
1677
<param name="L"></param>
1678
<param name="buff"></param>
1679
<param name="sz"></param>
1680
<param name="name"></param>
1681
<returns></returns>
1682
<remarks>This function returns the same results as lua_load. name is the chunk name, used for debug information and error messages.</remarks>
1683
</member>
1684
<member name="M:Tao.Lua.Lua.luaL_loadstring(System.IntPtr,System.String)">
1685
<summary>
1686
Loads a string as a Lua chunk. This function uses lua_load to load the chunk in the zero-terminated string s.
1687
</summary>
1688
<param name="L"></param>
1689
<param name="s"></param>
1690
<returns></returns>
1691
<remarks>This function returns the same results as lua_load. Also as lua_load, this function only loads the chunk; it does not run it.</remarks>
1692
</member>
1693
<member name="M:Tao.Lua.Lua.luaL_newstate">
1694
<summary>
1695
Creates a new Lua state, calling lua_newstate with an allocation function based on the standard C realloc function and setting a panic function (see lua_atpanic) that prints an error message to the standard error output in case of fatal errors.
1696
</summary>
1697
<returns>Returns the new state, or NULL if there is a memory allocation error.</returns>
1698
</member>
1699
<member name="M:Tao.Lua.Lua.luaL_gsub(System.IntPtr,System.String,System.String,System.String)">
1700
<summary>
1701
Creates a copy of string s by replacing any occurrence of the string p with the string r. Pushes the resulting string on the stack and returns it.
1702
</summary>
1703
<param name="L"></param>
1704
<param name="s"></param>
1705
<param name="p"></param>
1706
<param name="r"></param>
1707
<returns></returns>
1708
</member>
1709
<member name="M:Tao.Lua.Lua.luaL_findtable(System.IntPtr,System.Int32,System.String,System.Int32)">
1710
<summary>
1711
1712
</summary>
1713
<param name="L"></param>
1714
<param name="idx"></param>
1715
<param name="fname"></param>
1716
<param name="szhint"></param>
1717
<returns></returns>
1718
</member>
1719
<member name="M:Tao.Lua.Lua.luaL_argcheck(System.IntPtr,System.Int32,System.Int32,System.String)">
1720
<summary>
1721
Checks whether cond is true. If not, raises an error with the following message, where func is retrieved from the call stack:
1722
<code>bad argument #[numarg] to [func] ([extramsg])</code>
1723
</summary>
1724
<param name="L"></param>
1725
<param name="cond"></param>
1726
<param name="numarg"></param>
1727
<param name="extramsg"></param>
1728
<returns></returns>
1729
</member>
1730
<member name="M:Tao.Lua.Lua.luaL_checkstring(System.IntPtr,System.Int32)">
1731
<summary>
1732
Checks whether the function argument narg is a string and returns this string.
1733
</summary>
1734
<param name="L"></param>
1735
<param name="n"></param>
1736
<returns></returns>
1737
</member>
1738
<member name="M:Tao.Lua.Lua.luaL_optstring(System.IntPtr,System.Int32,System.String)">
1739
<summary>
1740
If the function argument narg is a string, returns this string. If this argument is absent or is nil, returns d. Otherwise, raises an error.
1741
</summary>
1742
<param name="L"></param>
1743
<param name="n"></param>
1744
<param name="d"></param>
1745
<returns></returns>
1746
</member>
1747
<member name="M:Tao.Lua.Lua.luaL_checkint(System.IntPtr,System.Int32)">
1748
<summary>
1749
Checks whether the function argument narg is a number and returns this number cast to an int.
1750
</summary>
1751
<param name="L"></param>
1752
<param name="n"></param>
1753
<returns></returns>
1754
</member>
1755
<member name="M:Tao.Lua.Lua.luaL_optint(System.IntPtr,System.Int32,System.Int32)">
1756
<summary>
1757
If the function argument narg is a number, returns this number cast to an int.
1758
</summary>
1759
<param name="L"></param>
1760
<param name="n"></param>
1761
<param name="d"></param>
1762
<returns>If this argument is absent or is nil, returns d. Otherwise, raises an error.</returns>
1763
</member>
1764
<member name="M:Tao.Lua.Lua.luaL_checklong(System.IntPtr,System.Int32)">
1765
<summary>
1766
Checks whether the function argument narg is a number and returns this number cast to a long.
1767
</summary>
1768
<param name="L"></param>
1769
<param name="n"></param>
1770
<returns></returns>
1771
</member>
1772
<member name="M:Tao.Lua.Lua.luaL_optlong(System.IntPtr,System.Int32,System.Int32)">
1773
<summary>
1774
If the function argument narg is a number, returns this number cast to a long. If this argument is absent or is nil, returns d. Otherwise, raises an error.
1775
</summary>
1776
<param name="L"></param>
1777
<param name="n"></param>
1778
<param name="d"></param>
1779
<returns></returns>
1780
</member>
1781
<member name="M:Tao.Lua.Lua.luaL_typename(System.IntPtr,System.Int32)">
1782
<summary>
1783
Returns the name of the type of the value at index idx.
1784
</summary>
1785
<param name="L"></param>
1786
<param name="i"></param>
1787
<returns></returns>
1788
</member>
1789
<member name="M:Tao.Lua.Lua.luaL_dofile(System.IntPtr,System.String)">
1790
<summary>
1791
Loads and runs the given file.
1792
</summary>
1793
<param name="L"></param>
1794
<param name="fn"></param>
1795
<returns>It returns 0 if there are no errors or 1 in case of errors.</returns>
1796
</member>
1797
<member name="M:Tao.Lua.Lua.luaL_dostring(System.IntPtr,System.String)">
1798
<summary>
1799
Loads and runs the given string.
1800
</summary>
1801
<param name="L"></param>
1802
<param name="s"></param>
1803
<returns>It returns 0 if there are no errors or 1 in case of errors.</returns>
1804
</member>
1805
<member name="M:Tao.Lua.Lua.luaL_getmetatable(System.IntPtr,System.String)">
1806
<summary>
1807
Pushes onto the stack the metatable associated with name tname in the registry (see luaL_newmetatable).
1808
</summary>
1809
<param name="L"></param>
1810
<param name="n"></param>
1811
</member>
1812
<member name="M:Tao.Lua.Lua.luaL_opt(System.IntPtr,System.Int32,System.Int32,System.Int32)">
1813
<summary>
1814
1815
</summary>
1816
<param name="L"></param>
1817
<param name="f"></param>
1818
<param name="n"></param>
1819
<param name="d"></param>
1820
</member>
1821
<member name="M:Tao.Lua.Lua.luaL_addchar(Tao.Lua.Lua.luaL_Buffer@,System.Char)">
1822
<summary>
1823
Adds the character c to the buffer B (see luaL_Buffer).
1824
</summary>
1825
<param name="B"></param>
1826
<param name="c"></param>
1827
</member>
1828
<member name="M:Tao.Lua.Lua.luaL_putchar(Tao.Lua.Lua.luaL_Buffer@,System.Char)">
1829
<summary>
1830
1831
</summary>
1832
<param name="B"></param>
1833
<param name="c"></param>
1834
</member>
1835
<member name="M:Tao.Lua.Lua.luaL_addsize(Tao.Lua.Lua.luaL_Buffer,System.Int32)">
1836
<summary>
1837
Adds a string of length n previously copied to the buffer area (see luaL_prepbuffer) to the buffer B (see luaL_Buffer).
1838
</summary>
1839
<param name="B"></param>
1840
<param name="n"></param>
1841
</member>
1842
<member name="M:Tao.Lua.Lua.luaL_buffinit(System.IntPtr,Tao.Lua.Lua.luaL_Buffer@)">
1843
<summary>
1844
Initializes a buffer B. This function does not allocate any space; the buffer must be declared as a variable (see luaL_Buffer).
1845
</summary>
1846
<param name="L"></param>
1847
<param name="B"></param>
1848
</member>
1849
<member name="M:Tao.Lua.Lua.luaL_prepbuffer(Tao.Lua.Lua.luaL_Buffer@)">
1850
<summary>
1851
Returns an address to a space of size LUAL_BUFFERSIZE where you can copy a string to be added to buffer B (see luaL_Buffer). After copying the string into this space you must call luaL_addsize with the size of the string to actually add it to the buffer.
1852
</summary>
1853
<param name="B"></param>
1854
<returns></returns>
1855
</member>
1856
<member name="M:Tao.Lua.Lua.luaL_addlstring(Tao.Lua.Lua.luaL_Buffer@,System.String,System.UInt32)">
1857
<summary>
1858
Adds the string pointed to by s with length l to the buffer B (see luaL_Buffer). The string may contain embedded zeros.
1859
</summary>
1860
<param name="B"></param>
1861
<param name="s"></param>
1862
<param name="l"></param>
1863
</member>
1864
<member name="M:Tao.Lua.Lua.luaL_addstring(Tao.Lua.Lua.luaL_Buffer@,System.String)">
1865
<summary>
1866
Adds the zero-terminated string pointed to by s to the buffer B (see luaL_Buffer). The string may not contain embedded zeros.
1867
</summary>
1868
<param name="B"></param>
1869
<param name="s"></param>
1870
</member>
1871
<member name="M:Tao.Lua.Lua.luaL_addvalue(Tao.Lua.Lua.luaL_Buffer@)">
1872
<summary>
1873
Adds the value at the top of the stack to the buffer B (see luaL_Buffer). Pops the value.
1874
</summary>
1875
<param name="B"></param>
1876
<remarks>This is the only function on string buffers that can (and must) be called with an extra element on the stack, which is the value to be added to the buffer.</remarks>
1877
</member>
1878
<member name="M:Tao.Lua.Lua.luaL_pushresult(Tao.Lua.Lua.luaL_Buffer@)">
1879
<summary>
1880
Finishes the use of buffer B leaving the final string on the top of the stack.
1881
</summary>
1882
<param name="B"></param>
1883
</member>
1884
<member name="M:Tao.Lua.Lua.lua_ref(System.IntPtr,System.Boolean)">
1885
<summary>
1886
1887
</summary>
1888
<param name="L"></param>
1889
<param name="lockit"></param>
1890
<returns></returns>
1891
</member>
1892
<member name="M:Tao.Lua.Lua.lua_unref(System.IntPtr,System.Int32)">
1893
<summary>
1894
1895
</summary>
1896
<param name="L"></param>
1897
<param name="reference"></param>
1898
</member>
1899
<member name="M:Tao.Lua.Lua.lua_getref(System.IntPtr,System.Int32)">
1900
<summary>
1901
1902
</summary>
1903
<param name="L"></param>
1904
<param name="reference"></param>
1905
</member>
1906
<member name="T:Tao.Lua.Lua.lua_CFunction">
1907
<summary>
1908
Type for C functions.
1909
</summary>
1910
<param name="L"></param>
1911
<remarks>
1912
In order to communicate properly with Lua, a C function must use the following
1913
protocol, which defines the way parameters and results are passed: a C function
1914
receives its arguments from Lua in its stack in direct order (the first argument
1915
is pushed first). So, when the function starts, lua_gettop(L) returns the number
1916
of arguments received by the function. The first argument (if any) is at index 1
1917
and its last argument is at index lua_gettop(L). To return values to Lua, a C
1918
function just pushes them onto the stack, in direct order (the first result is
1919
pushed first), and returns the number of results. Any other value in the stack
1920
below the results will be properly discarded by Lua. Like a Lua function, a C
1921
function called by Lua can also return many results.
1922
</remarks>
1923
<returns></returns>
1924
</member>
1925
<member name="T:Tao.Lua.Lua.lua_Reader">
1926
<summary>
1927
The reader function used by lua_load.
1928
</summary>
1929
<param name="L"></param>
1930
<param name="ud"></param>
1931
<param name="sz"></param>
1932
<returns>
1933
To signal the end of the chunk, the reader must return NULL. The reader
1934
function may return pieces of any size greater than zero.
1935
</returns>
1936
<remarks>
1937
Every time it needs another piece of the chunk, lua_load calls the reader,
1938
passing along its data parameter. The reader must return a pointer to a
1939
block of memory with a new piece of the chunk and set size to the block size.
1940
The block must exist until the reader function is called again.
1941
</remarks>
1942
</member>
1943
<member name="T:Tao.Lua.Lua.lua_Writer">
1944
<summary>
1945
The writer function used by lua_dump. Every time it produces another piece of chunk, lua_dump calls the writer, passing along the buffer to be written (p), its size (sz), and the data parameter supplied to lua_dump.
1946
</summary>
1947
<param name="L"></param>
1948
<param name="p"></param>
1949
<param name="sz"></param>
1950
<param name="ud"></param>
1951
<returns>
1952
The writer returns an error code: 0 means no errors; any other value means an error and stops lua_dump from calling the writer again.
1953
</returns>
1954
</member>
1955
<member name="T:Tao.Lua.Lua.lua_Alloc">
1956
<summary>
1957
1958
</summary>
1959
<param name="ud"></param>
1960
<param name="ptr"></param>
1961
<param name="osize"></param>
1962
<param name="nsize"></param>
1963
<returns></returns>
1964
</member>
1965
<member name="T:Tao.Lua.Lua.lua_Hook">
1966
<summary>
1967
Type for debugging hook functions.
1968
</summary>
1969
<param name="L"></param>
1970
<param name="ar"></param>
1971
<remarks>
1972
Whenever a hook is called, its ar argument has its field event set to the specific event that triggered the hook. Lua identifies these events with the following constants: LUA_HOOKCALL, LUA_HOOKRET, LUA_HOOKTAILRET, LUA_HOOKLINE, and LUA_HOOKCOUNT. Moreover, for line events, the field currentline is also set. To get the value of any other field in ar, the hook must call lua_getinfo. For return events, event may be LUA_HOOKRET, the normal value, or LUA_HOOKTAILRET. In the latter case, Lua is simulating a return from a function that did a tail call; in this case, it is useless to call lua_getinfo.
1973
While Lua is running a hook, it disables other calls to hooks. Therefore, if a hook calls back Lua to execute a function or a chunk, this execution occurs without any calls to hooks.
1974
</remarks>
1975
</member>
1976
<member name="T:Tao.Lua.Lua.lua_Debug">
1977
<summary>
1978
A structure used to carry different pieces of information about an active function. lua_getstack fills only the private part of this structure, for later use. To fill the other fields of lua_Debug with useful information, call lua_getinfo.
1979
</summary>
1980
</member>
1981
<member name="F:Tao.Lua.Lua.lua_Debug.Event">
1982
<summary>
1983
1984
</summary>
1985
</member>
1986
<member name="F:Tao.Lua.Lua.lua_Debug.name">
1987
<summary>
1988
a reasonable name for the given function. Because functions in Lua are first-class values, they do not have a fixed name: some functions may be the value of multiple global variables, while others may be stored only in a table field. The lua_getinfo function checks how the function was called to find a suitable name. If it cannot find a name, then name is set to NULL.
1989
</summary>
1990
</member>
1991
<member name="F:Tao.Lua.Lua.lua_Debug.namewhat">
1992
<summary>
1993
explains the name field. The value of namewhat can be "global", "local", "method", "field", "upvalue", or "" (the empty string), according to how the function was called. (Lua uses the empty string when no other option seems to apply.)
1994
</summary>
1995
</member>
1996
<member name="F:Tao.Lua.Lua.lua_Debug.what">
1997
<summary>
1998
the string "Lua" if the function is a Lua function, "C" if it is a C function, "main" if it is the main part of a chunk, and "tail" if it was a function that did a tail call. In the latter case, Lua has no other information about the function.
1999
</summary>
2000
</member>
2001
<member name="F:Tao.Lua.Lua.lua_Debug.source">
2002
<summary>
2003
If the function was defined in a string, then source is that string. If the function was defined in a file, then source starts with a '@' followed by the file name.
2004
</summary>
2005
</member>
2006
<member name="F:Tao.Lua.Lua.lua_Debug.currentline">
2007
<summary>
2008
the current line where the given function is executing. When no line information is available, currentline is set to -1.
2009
</summary>
2010
</member>
2011
<member name="F:Tao.Lua.Lua.lua_Debug.nups">
2012
<summary>
2013
the number of upvalues of the function.
2014
</summary>
2015
</member>
2016
<member name="F:Tao.Lua.Lua.lua_Debug.linedefined">
2017
<summary>
2018
the line number where the definition of the function starts.
2019
</summary>
2020
</member>
2021
<member name="F:Tao.Lua.Lua.lua_Debug.short_src">
2022
<summary>
2023
a "printable" version of source, to be used in error messages.
2024
</summary>
2025
</member>
2026
<member name="F:Tao.Lua.Lua.lua_Debug.i_ci">
2027
<summary>
2028
2029
</summary>
2030
</member>
2031
<member name="T:Tao.Lua.Lua.luaL_Reg">
2032
<summary>
2033
Type for arrays of functions to be registered by luaL_register. name is the function name and func is a pointer to the function. Any array of luaL_Reg must end with an sentinel entry in which both name and func are NULL.
2034
</summary>
2035
</member>
2036
<member name="F:Tao.Lua.Lua.luaL_Reg.name">
2037
<summary>
2038
2039
</summary>
2040
</member>
2041
<member name="F:Tao.Lua.Lua.luaL_Reg.func">
2042
<summary>
2043
2044
</summary>
2045
</member>
2046
<member name="T:Tao.Lua.Lua.luaL_Buffer">
2047
<summary>
2048
Type for a string buffer.
2049
</summary>
2050
<remarks>
2051
A string buffer allows C code to build Lua strings piecemeal. Its pattern of use is as follows:
2052
* First you declare a variable b of type luaL_Buffer.
2053
* Then you initialize it with a call luaL_buffinit(L, &amp;b).
2054
* Then you add string pieces to the buffer calling any of the luaL_add* functions.
2055
* You finish by calling luaL_pushresult(&amp;b). This call leaves the final string on the top of the stack.
2056
During its normal operation, a string buffer uses a variable number of stack slots. So, while using a buffer, you cannot assume that you know where the top of the stack is. You can use the stack between successive calls to buffer operations as long as that use is balanced; that is, when you call a buffer operation, the stack is at the same level it was immediately after the previous buffer operation. (The only exception to this rule is luaL_addvalue.) After calling luaL_pushresult the stack is back to its level when the buffer was initialized, plus the final string on its top.
2057
</remarks>
2058
</member>
2059
<member name="F:Tao.Lua.Lua.luaL_Buffer.p">
2060
<summary>
2061
2062
</summary>
2063
</member>
2064
<member name="F:Tao.Lua.Lua.luaL_Buffer.lvl">
2065
<summary>
2066
2067
</summary>
2068
</member>
2069
<member name="F:Tao.Lua.Lua.luaL_Buffer.L">
2070
<summary>
2071
2072
</summary>
2073
</member>
2074
<member name="F:Tao.Lua.Lua.luaL_Buffer.buffer">
2075
<summary>
2076
2077
</summary>
2078
</member>
2079
</members>
2080
</doc>
2081
2082