第10章：LUA的函数

什么是函数

在Lua中，函数是对语句和表达式进行抽象的主要方法。既可以用来处理一些特殊的工作，也可以用来计算一些值。

Lua 提供了许多的内建函数，你可以很方便的在程序中调用它们，如print()函数可以将传入的参数打印在控制台上。

Lua 函数主要有两种用途：

1.完成指定的任务，这种情况下函数作为调用语句使用；

2.计算并返回值，这种情况下函数作为赋值语句的表达式使用。

函数定义

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语言函数可以返回多个值，每个值以逗号隔开。

案例1：

以下实例定义了函数 max()，参数为 num1, num2，用于比较两值的大小，并返回最大值：

--[[ 函数返回两个值的最大值 --]]

function max(num1, num2)

 

   if (num1 > num2) then

      result = num1;

   else

      result = num2;

   end

 

   return result;

end

-- 调用函数

Chat:sendSystemMsg("两值比较最大值为:"..max(10,4).."",0)

Chat:sendSystemMsg("两值比较最大值为:"..max(5,6).."",0)

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

myprint = function(param)

   Chat:sendSystemMsg("param的值：" ..param.. "",0)

 

end

 

function add(num1,num2,functionPrint)

   result = num1 + num2

   -- 调用传递的函数参数

   functionPrint(result)

end

myprint(10)

-- myprint 函数作为参数传递

add(2,5,myprint)

多返回值

Lua函数可以返回多个结果值，比如string.find，其返回匹配串"开始和结束的下标"（如果不存在匹配串返回nil）。

案例： Lua函数中，在return后列出要返回的值的列表即可返回多值，如：

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}))

--由于Chat:sendSystemMsg输出机制只能输出一个值，只能用print打印来看输出的返回值

可变参数

Lua函数可以接受可变数目的参数，和 C 语言类似，在函数参数列表中使用三点 ... 表示函数有可变的参数。

案例1：拼接

-- 上段代码由于Chat:sendSystemMsg只能输出1个值，所以无法输出函数的两个返回值

-- 我们可以用可变参数来做拼接功能

function dump_args(...)

        local buffer = ''

        local size = select('#', ...)

    for idx = 1, select('#', ...) do

            local arg = select(idx, ...)

            local ends = idx==size and "" or ", "

            buffer = buffer..tostring(arg)..ends

    end

    return buffer

end

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

 

Chat:sendSystemMsg(dump_args(maximum({8,10,23,12,5})),0)

--这样调用可变参数dump_args，就可以打印出多个函数返回值了

LuaCopy

Copied!

案例2：求平均值

function average(...)

   result = 0

   local arg={...} --> arg 为一个表，局部变量

   for i,v in ipairs(arg) do

      result = result + v

   end

   Chat:sendSystemMsg("总共传入 " .. #arg .. " 个数",0)

   return result/#arg

end

Chat:sendSystemMsg("平均值为" ..average(10,5,3,4,5,6).. " ",0)

LuaCopy

Copied!

案例3：求平均值

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

 

function average(...)

   result = 0

   local arg={...}

   for i,v in ipairs(arg) do

      result = result + v

   end

   print("总共传入 " .. select("#",...) .. " 个数")

   return result/select("#",...)

end

Chat:sendSystemMsg("平均值为"..average(10,5,3,4,5,6).." ",0)