summaryrefslogtreecommitdiff
path: root/server/meta/Lua 5.4/basic.lua
blob: 7fa412de1562be4650228e693dbea29c41da49f3 (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
--- 独立版Lua的启动参数。
arg = {}

--- 如果其参数 `v` 的值为假,它就调用 `error`。
---@overload fun(v:any):any
---@param v any
---@param message any {optional = 'self'}
---@return any
function assert(v, message) end

---@overload fun()
---@overload fun(opt:GCOption):any
---@param opt GCOption {optional = 'after'}
---@param arg integer {optional = 'self'}
---@return any
function collectgarbage(opt, arg) end

--- 打开该名字的文件,并执行文件中的 Lua 代码块。
---@overload fun():any
---@param filename string {optional = 'self', special = 'dofile:1'}
---@return any
function dofile(filename) end

--- 中止上一次保护函数调用,将错误对象 `message` 返回。
---@overload fun(message:any)
---@param message any
---@param level integer {optional = 'self'}
function error(message, level) end

--- 内部储存有全局环境。
_G = {}

--- 返回该对象的元表。
---@param object any
---@return table {name = 'metatable'}
function getmetatable(object) end

--- 能迭代表 `t` 中序列的键值对。
---|```lua
---|for i, v in ipairs(t) do
---|    -- body
---|end
---|```
---@param t table
---@return         {name = 'iterator'}
---@return table   {name = 't'}
---@return integer {name = 'i'}
function ipairs(t)
    --- 返回该键的下一个键及其关联的值。
    ---@overload fun(t:table):integer,any
    ---@param t table
    ---@param index any {optional = 'self'}
    ---@return integer {name = 'index'}
    ---@return any     {name = 'value'}
    local function iterator(t, index) end

    return iterator, t, nil
end

--- 加载一个代码块。
---@overload fun():function,string
---@overload fun(chunk:string|function):function,string
---@overload fun(chunk:string|function, chunkname:string):function,string
---@overload fun(chunk:string|function, chunkname:string, mode:loadOption):function,string
---@param chunk     string|function
---@param chunkname string          {optional = 'after'}
---@param mode      loadOption      {optional = 'after'}
---@param env       table           {optional = 'self'}
---@return        {name = 'init'}
---@return string {name = 'errMessage', optional = 'self'}
function load(chunk, chunkname, mode, env)
    return function (...) end
end

--- 返回该键的下一个键及其关联的值。
---@overload fun(t:table):any, any
---@param t table
---@param index any {optional = 'self'}
---@return any {name = 'key'}
---@return any {name = 'value'}
function next(t, index) end

--- 能迭代表 `t` 中的所有键值对。
---|```lua
---|for k, v in pairs(t) do
---|    -- body
---|end
---|```
---@param t table
---@return       {name = 'next'}
---@return table {name = 't'}
---@return any   {name = 'key'}
function pairs(t)
    --- 返回该键的下一个键及其关联的值。
    ---@overload fun(t:table):any, any
    ---@param t table
    ---@param index any {optional = 'self'}
    ---@return any {name = 'key'}
    ---@return any {name = 'value'}
    local function next(t, index) end

    return next, t, nil
end

--- 当前解释器版本号。
_VERSION = 'Lua 5.4'