Difference between revisions of "Template:Usage"
From Spherical
(Doc) |
m (Cleanup) |
||
Line 1: | Line 1: | ||
− | <includeonly><div class="sph-usage">{{#if: {{{returns|}}} | | + | <includeonly><div class="sph-usage">{{#if: {{{returns|}}} | ''{{{returns}}}'' | }}{{#if: {{{object|}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''(''{{{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: |
Revision as of 19:26, 20 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
- 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);