Возвращаемые значения

Функции, которые вы написали до сих пор, что-то выводят, и только. Но часто нужно, чтобы функция вычислила значение, с которым программа будет работать дальше: сложит, сравнит или сохранит его. Тогда функция возвращает значение с помощью return:

local function harvestValue(count, price)
    return count * price
end

local carrots = harvestValue(12, 5)
print("Морковь, монеты: " .. carrots)
print("Тыквы, монеты: " .. harvestValue(4, 20))

Программа выводит:

Морковь, монеты: 60
Тыквы, монеты: 80

Вызов harvestValue(12, 5) запускает функцию, а return отправляет 60 обратно на место вызова. Можно представить, что Lua заменяет вызов возвращённым значением, так что local carrots = harvestValue(12, 5) превращается в local carrots = 60. Это значение — возвращаемое значение функции. Вызов можно использовать везде, где можно написать значение: в переменной, в print, в вычислении или в условии, например if harvestValue(12, 5) > 50 then. Такие функции вы уже знаете: math.max(3, 8) возвращает 8, а tostring(5) возвращает "5".

return ещё и сразу завершает функцию. Вместе с условиями это даёт короткие функции, которые в разных случаях возвращают разные значения:

local function sellPrice(crop)
    if crop == "морковь" then
        return 5
    elseif crop == "картофель" then
        return 8
    end
    return 0
end

print(sellPrice("картофель"), sellPrice("морковь"), sellPrice("камень"))

Программа выводит:

8	5	0

Для "картофель" выполняется второй return, и функция заканчивается: до return 0 Lua не доходит. Он доходит до него, только когда ни одно условие не выполнено. В Lua return должен быть последней строкой своего блока (прямо перед end, else или elseif). Строка после него в том же блоке — синтаксическая ошибка: 'end' expected … near 'print'.

Новички часто путают print и return, ведь оба как будто «выдают» значение. Но print лишь показывает значение вам, в выводе, а программа с ним работать не может. return отдаёт значение программе. Посмотрите на функцию, которая выводит результат вместо того, чтобы вернуть его:

local function harvestValue(count, price)
    print(count * price)
end

local carrots = harvestValue(12, 5)
print(carrots)
print(carrots + 10)

Программа выводит:

60
nil
main.lua:7: attempt to perform arithmetic on a nil value (local 'carrots')

60 выводит print внутри функции. Но функция ничего не вернула, поэтому carrots равно nil, и вычисление завершается ошибкой. Если вы видите nil там, где ожидали результат функции, проверьте, есть ли в функции return. Хорошее правило: функция, которая что-то вычисляет, возвращает результат, а код, который её вызывает, решает, выводить его, сохранять или вычислять дальше.