lua：函数

你的名字 2022-09-15 11:50 150阅读 0赞

在lua中，函数是对语句和表示进行抽象的主要方法。既可以用来处理一些特殊的工作，也可以用来计算一些值。lua提供了很多内奸函数，你可以很方便的在程序中调用它们，比如print()函数可以将传入的参数打印在控制台上。

Lua函数主要有两种用途：

*  完成指定的任务，这种情况下函数作为调用语句使用
 *  计算并返回值值，这种情况下函数作为赋值语句的表达式使用

# 函数定义 #

optional_function_scope function function_name( argument1, argument2, argument3..., argumentn)
        function_body
        return result_params_comma_separated
    end

*  optional\_function\_scope：该参数是可选，指定函数时全局函数还是局部函数
    
     *  默认为全局函数
     *  如果需要设置函数为局部函数需要使用关键词`local`
 *  function\_name：函数的名称
 *  argument1, argument2, argument3…, argumentn:
    
     *  函数参数
     *  多个参数以`,`隔开
     *  函数可以不带参数
 *  function\_body：函数体，函数中需要执行的代码语句块
 *  result\_params\_comma\_separated：
    
     *  函数返回值
     *  lua语言函数可以返回多个值，每个值以`,`隔开

> 例子

--[[ 函数返回两个值的最大值 --]]
    function max(num1, num2)
    
       if (num1 > num2) then
          result = num1;
       else
          result = num2;
       end
    
       return result;
    end
    -- 调用函数
    print("两值比较最大值为 ",max(10,4))
    print("两值比较最大值为 ",max(5,6))

以上代码执行结果为：

两值比较最大值为     10
    两值比较最大值为     6

Lua 中我们可以将函数作为参数传递给函数，如下实例：

myprint = function(param)
       print("这是打印函数 -   ##",param,"##")
    end
    
    function add(num1,num2,functionPrint)
       result = num1 + num2
       -- 调用传递的函数参数
       functionPrint(result)
    end
    myprint(10)
    -- myprint 函数作为参数传递
    add(2,5,myprint)

以上代码执行结果为：

这是打印函数 -   ##    10    ##
    这是打印函数 -   ##    7    ##

# 多返回值 #

function maximum (a)
        local mi = 1             -- 最大值索引
        local m = a[mi]          -- 最大值
        for i,val in ipairs(a) do
           if val > m then
               mi = i
               m = val
           end
        end
        return m, mi
    end
    
    print(maximum({
        8,10,23,12,5}))

以上代码执行结果为：

23    3

# 可变参数 #

在函数参数列表中使用三点 … 表示函数有可变的参数。

function add(...)  
    local s = 0  
      for i, v in ipairs{
        ...} do   --> {...} 表示一个由所有变长参数构成的数组  
        s = s + v  
      end  
      return s  
    end  
    print(add(3,4,5,6,7))  --->25

我们可以将可变参数赋值给一个变量。

例如，我们计算几个数的平均值：

function average(...)
       result = 0
       local arg={
        ...}    --> arg 为一个表，局部变量
       for i,v in ipairs(arg) do
          result = result + v
       end
       print("总共传入 " .. #arg .. " 个数")
       return result/#arg
    end
    
    print("平均值为",average(10,5,3,4,5,6))

以上代码执行结果为：

总共传入 6 个数
    平均值为    5.5

我们也可以通过`select("#", ...)`来换取可变参数的数量

function average(...)
       result = 0
       local arg={
        ...}
       for i,v in ipairs(arg) do
          result = result + v
       end
       print("总共传入 " .. select("#",...) .. " 个数")
       return result/select("#",...)
    end
    
    print("平均值为",average(10,5,3,4,5,6))

以上代码执行结果为：

总共传入 6 个数
    平均值为    5.5

有时候我们可能需要几个固定参数加上可变参数，固定参数必须放在变长参数之前:

function fwrite(fmt, ...)  ---> 固定的参数fmt
        return io.write(string.format(fmt, ...))    
    end
    
    fwrite("runoob\n")       --->fmt = "runoob", 没有变长参数。  
    fwrite("%d%d\n", 1, 2)   --->fmt = "%d%d", 变长参数为 1 和 2

输出结果为：

runoob
    12

通常在遍历边长参数的时候只需要使用`{...}`，然而边长参数可能会包含一些`nil`，那么就可以用`select`函数来访问变长参数了：`select('#', ...)`或者`select(n, …)`

*  `select('#', ...)`返回可变参数的长度。
 *  `select(n, …)`用于返回从起点 n 开始到结束位置的所有参数列表。

调用 select 时，必须传入一个固定实参 selector(选择开关) 和一系列变长参数。如果 selector 为数字 n，那么 select 返回参数列表中从索引 n 开始到结束位置的所有参数列表，否则只能为字符串 \#，这样 select 返回变长参数的总数。

function f(...)
        a = select(3,...)  -->从第三个位置开始，变量 a 对应右边变量列表的第一个参数
        print (a)
        print (select(3,...)) -->打印所有列表参数
    end
    
    f(0,1,2,3,4,5)

输出结果为：

2
    2       3       4       5

再看个例子：

do  
        function foo(...)  
            for i = 1, select('#', ...) do  -->获取参数总数
                local arg = select(i, ...); -->读取参数，arg 对应的是右边变量列表的第一个参数
                print("arg", arg);  
            end  
        end  
     
        foo(1, 2, 3, 4);  
    end

输出结果为：

arg    1
    arg    2
    arg    3
    arg    4