Template:Function

This is a WIP, feedback is appreciated. To retain readability a lot of HTML comments are used, they shouldn't impact the working of the template, but could add to the confusion a bit.

{{Function
 origin            = whether the function came from the CS itself or was added by OBSE.
                     valid values: CS1 (TES CS 1.0), CS1.1 (TES CS 1.1), CS1.2 (TES CS 1.2), OBSE
 summary           = description of the function
 name              = the name of the function. The page name is the default value.
 alias             = An abbreviated version of the function name that can be
                     used instead of the long name.
 altName           = the name of an alternate version of a function (e.g. the "C" Magic Effect functions)
 altAlias          = the alias of the alternate function.
 returnVal         = what the function returns.
 returnType        = the type of the returned value.
 referenceType     = if appropriate, the type of reference that the function may be called
                     on with the dot syntax
 referenceOpt      = if can take a reference, whether it must take a reference.
 arguments         = List of arguments specified using the {{FunctionArgument}} template,
                     or any other wiki syntax.
 altArgs           = List of arguments for the alternate version of the function.
 example           = optionally, the function used as part of a script to serve as an example
 CategoryList      = the list of categories to which the page belongs
}}

Example

{{Function
 |origin = CS1
 |summary = Plays the visuals of the specified Magic Effect on the calling reference.
 |name = PlayMagicEffectVisuals
 |alias = pme
 |returnVal = nothing
 |returnType = void
 |referenceType = [Actor, Activator]
 |arguments = 
  {{FunctionArgument
   |Name = mgefID
   |Type = ref
  }}{{FunctionArgument
   |Name = duration
   |Type = short
   |Optional = y
  }}
 |example = PlayMagicEffectVisuals FIDG
 pme FTHR 10
}}

Result

A function included in the TES CS v1.0.

Syntax:

(void)[Actor, Activator].PlayMagicEffectVisuals  
 (void)[Actor, Activator].pme  

Plays the visuals of the specified Magic Effect on the calling reference.

Example

PlayMagicEffectVisuals FIDG
pme FTHR 10