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語言函式可以
返回多個值，每個值以逗號隔開。

例項
以下例項定義了函式 max()，引數為 num1, num2，用於比較兩值的大小，並返回最大值：

--[[ 函式返回兩個值的最大值 --]]
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    ##

多返回值
Lua函式可以返回多個結果值，比如string.find，其返回匹配串”開始和結束的下標”（如果不存在匹配串返回nil）

> s, e = string.find("www.runoob.com", "runoob") 
> print(s, e)
5    10
這邊要注意一下lua的字串從1開始計算的

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

以上程式碼執行結果為：
23    3

可變引數

Lua 函式可以接受可變數目的引數，和 C 語言類似，在函式引數列表中使用三點 … 表示函式有可變的引數。

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(‘#’,…) 的引數
呼叫select時，必須傳入一個固定實參selector(選擇開關)和一系列變長引數。如果selector為數字n,那麼select返回它的第n個可變實參，否則只能為字串”#”,這樣select會返回變長引數的總數。例子程式碼：

do  
    function foo(...)  
        for i = 1, select('#', ...) do  -->獲取引數總數
            local arg = select(i, ...); -->讀取引數
            print("arg", arg);  
        end  
    end  

    foo(1, 2, 3, 4);  
end

輸出結果為：
arg    1
arg    2
arg    3
arg    4