Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A function can be declared as local to limit the scope of the function. A function is global by default.

It's good practice to use local whenever possible to limit the scope of functions and variables to where they are needed. It allows for a flexible and modular approach in designing functions.

Expand
titleExample of a global function

If you were to create a simple APP.lua file and add a function called APPadd like below:

Code Block
languagelua
function APPadd(a,b)
   local sum = a + b
   return sum
end

In main you can then call APPadd and get the sum:

Image Added
Expand
titleExample of a local function

In the same APP.lua file, now alter the function to be local.

Code Block
languagelua
local function APPadd(a,b)
   local sum = a + b
   return sum
end

return APPadd 

The function is now local, but we have also returned the APPadd function.

In main, you can capture the returned function in your require statement and use it:

Image Added