Difference between revisions of "User:Demonnic"

From Mudlet
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Proposed template for lua functions
 
 
 
 
==functionName==
 
==functionName==
;functionName(arg1, arg1)
+
;functionName(arg1, arg2)
 
: What the function does.
 
: What the function does.
 +
: Returns whatever the function returns.
 
: See also: [[Manual:Lua_Functions#paste|paste]]
 
: See also: [[Manual:Lua_Functions#paste|paste]]
 
<br/>
 
<br/>
Line 15: Line 13:
 
<br/>
 
<br/>
  
;Usage
+
;Examples
 
<lua>
 
<lua>
 
--a small example snippet of the function in action
 
--a small example snippet of the function in action

Latest revision as of 13:35, 12 June 2011

functionName

functionName(arg1, arg2)
What the function does.
Returns whatever the function returns.
See also: paste


Parameters
  • arg1:
What arg1 is/does. Passed as a string.
  • arg2:
What arg2 is/does. Passed as a string.


Examples

<lua> --a small example snippet of the function in action --the comments up top should introduce it/explain what the snippet does functionName("arg1", "arg2") </lua>