User:Kebap

From Mudlet
Jump to navigation Jump to search

About me

Mudlet user and script developer, hailing from MorgenGrauen (German).

Projects

Examples for Wiki formatting

functionName

functionName(arg1, arg2, [optionalArg3])
What the function does. In this case, it is just a non-existing function with the only purpose to show, how to write documentation for functions
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.
  • optionalArg3
(optional) The name needn't be telling. Relevant is to mark optional arguments at the start of this line (with text "optional" in brackets) and in the function definition line (with [these] brackets)


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>