Contributing: Lua function

This guide gives you a Template and information on how to document a Lua function correctly. You can copy the source of this page for your own Lua pages.

This is the description of the function.

Syntax

MyLuaFunction(arg[, optionalArg])

• arg (type) Info
• Optional: optionalArg (type) Info
• Returns: data (type) Info

Example

This is my example, if it's self-explanatory you don't need to provide this text here.

local info = MyLuaFunction(1234)
print(info)

Related Pages

Specify Related Pages & Category here.