Skip to content

Reference sheet

When writing documentation, refer to this page for templates

Functions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
--- Function summary
-- @realm shared/client/server
-- @pluginwarning Area
-- @param a parameter
-- @tparam[opt="example"] type an optional parameter with a type
-- @return a returned value
-- @treturn type a returned value with a type
-- @see otherExample
-- @usage
-- local a, b, c = 1, 2, 3
-- local calcValue = exampleFunc(a, b, c)