blob: 719324ce9cad88d6478d93ac2177031779ffc37b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
[assert]
description = 'Calls error if the value of its argument is false.'
[collectgarbage]
[[.enums]]
name = 'opt'
enum = 'collect'
description = 'Performs a full garbage-collection cycle.'
[[.enums]]
name = 'opt'
enum = 'stop'
description = 'Stops automatic execution.'
[[.enums]]
name = 'opt'
enum = 'restart'
description = 'Restarts automatic execution.'
[[.enums]]
name = 'opt'
enum = 'count'
description = 'Returns the total memory in Kbytes.'
[[.enums]]
name = 'opt'
enum = 'step'
description = 'Performs a garbage-collection step.'
[[.enums]]
name = 'opt'
enum = 'setpause'
description = 'Set pause.'
[[.enums]]
name = 'opt'
enum = 'setstepmul'
description = 'Set step multiplier.'
[[.enums]]
name = 'opt'
enum = 'isrunning'
description = 'Returns whether the collector is running.'
[dofile]
description = 'Opens the named file and executes its contents as a Lua chunk.'
[error]
description = 'Terminates the last protected function called and returns message as the error object.'
[_G]
description = 'Holds the global environment.'
[getmetatable]
description = 'Returns the metatable of the given object.'
[ipairs]
description = [[
----------------
```lua
for i, v in ipairs(t) do
body
end
```
]]
[load]
description = 'Loads a chunk.'
[[.enums]]
name = 'mode'
enum = 'b'
description = 'Only binary chunks.'
[[.enums]]
name = 'mode'
enum = 't'
description = 'Only text chunks.'
[[.enums]]
name = 'mode'
enum = 'bt'
description = 'Both binary and text.'
[loadfile]
description = 'Loads a chunk from file.'
[[.enums]]
name = 'mode'
enum = 'b'
description = 'Only binary chunks.'
[[.enums]]
name = 'mode'
enum = 't'
description = 'Only text chunks.'
[[.enums]]
name = 'mode'
enum = 'bt'
description = 'Both binary and text.'
[next]
description = 'Returns the next index of the table and its associated value.'
[pairs]
description = [[
----------------
```lua
for k, v in pairs(t) do
body
end
```
]]
[pcall]
description = 'Calls function with the given arguments in protected mode.'
[print]
description = 'Receives any number of arguments and prints their values to stdout.'
[rawequal]
description = 'Checks whether v1 is equal to v2.'
[rawget]
description = 'Gets the real value of table[index].'
[rawlen]
description = 'Returns the length of the object v.'
[rawset]
description = 'Sets the real value of table[index] to value.'
[select]
[[.enums]]
name = 'index'
enum = '#'
description = 'Returns the total number of extra arguments.'
[[.enums]]
name = 'index'
code = 'integer'
description = 'Returns all arguments after number index.'
[setmetatable]
description = 'Sets the metatable for the given table.'
[tonumber]
description = 'Tries to convert its argument to a number.'
[tostring]
description = 'Receives a value of any type and converts it to a string in a human-readable format.'
[type]
description = 'Returns the type of its only argument, coded as a string.'
[_VERSION]
description = 'Running Lua version.'
[xpcall]
description = 'Calls function f with the given arguments in protected mode with a new message handler.'
[require]
description = 'Loads the given module.'
|
