Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
imported>SnakeChomp (Stop complaining if no return type is specified for the template; sometimes we just don't know) |
imported>SnakeChomp (Update returnType docs to indicate its optional and don't mention void anymore.) |
||
Line 11: | Line 11: | ||
summary = description of the function | summary = description of the function | ||
''name'' = the name of the function. The page name is the default value. | ''name'' = the name of the function. The page name is the default value. | ||
''alias'' | ''alias'' = An abbreviated version of the function name that can be | ||
used instead of the long name. | used instead of the long name. | ||
''returnVal '' = what the function returns | ''returnVal '' = what the function returns. | ||
returnType = the type of the returned | ''returnType'' = the type of the returned value. | ||
''referenceType'' = if appropriate, the type of reference that the function may be called | ''referenceType'' = if appropriate, the type of reference that the function may be called | ||
on with the dot syntax | on with the dot syntax |
Revision as of 13:55, 10 February 2009
This article is incomplete. You can help by filling in any blank descriptions. Further information might be found in a section of the discussion page. Please remove this message when no longer necessary. |
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. Example in the Sandbox.
{{Function CSWikiPage = name of corresponding page on the TES CS Wiki origin = whether the function came from the GECK itself or was added by FOSE. valid values: GECK1 (GECK 1.1), FOSE0001 (FOSE v0001) 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. 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 arguments = List of arguments specified using the Template:FunctionArgument template, or any other wiki syntax. 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 |name = Test |origin = GECK1 |alias = tst |summary = Does stuff |returnType = void |arguments = {{FunctionArgument |Name = Count |Type = int }}{{FunctionArgument |Name = Target |Type = ref |Optional = y }} }}
Result
A function included in the GECK version 1.1.0.36.
Description
Does stuff
Syntax
Test Count:int Target:ref
Or:
tst Count:int Target:ref