Template:Usage: Difference between revisions
Jump to navigation
Jump to search
m Cleanup |
fix 'params' |
||
| Line 1: | Line 1: | ||
<includeonly><div class="sph-usage">{{#if: {{{returns|}}} | ''{{{returns}}}''   | }}{{#if: {{{object|}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''(''{{{params | <includeonly><div class="sph-usage">{{#if: {{{returns|}}} | ''{{{returns}}}''   | }}{{#if: {{{object|}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''({{#if: {{{params|}}} | ''{{{params}}}'' | }});</div></includeonly> | ||
<noinclude>Use this template to demonstrate Sphere API. Template parameters include: | <noinclude>Use this template to demonstrate Sphere API. Template parameters include: | ||
* '''returns''' ''(optional)'' - The return type of the function | * '''returns''' ''(optional)'' - The return type of the function | ||
* '''object''' ''(optional)'' - The Sphere object this function is a member of, if any | * '''object''' ''(optional)'' - The Sphere object this function is a member of, if any; try to be exact, as this will also link to that object's article | ||
* '''func''' - The name of the function | * '''func''' - The name of the function | ||
* '''params''' ''(optional)'' - A comma-separated list of function parameters, if any | * '''params''' ''(optional)'' - A comma-separated list of function parameters, if any | ||
Revision as of 17:45, 21 May 2013
Use this template to demonstrate Sphere API. Template parameters include:
- returns (optional) - The return type of the function
- object (optional) - The Sphere object this function is a member of, if any; try to be exact, as this will also link to that object's article
- func - The name of the function
- params (optional) - A comma-separated list of function parameters, if any
For example, {{Usage|object=sound|func=play|params=repeat}} will result in:
sound.play(repeat);
And {{Usage|returns=WindowStyle|func=LoadWindowStyle|params=filename}} will result in:
WindowStyle LoadWindowStyle(filename);