Template:AudioMethod
From OxeyeWiki
(Difference between revisions)
(Created page with '{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;" |- |style="background:#e0e0c7; font-size:150%;" colspan="3"|'''{{{1}}}''' |- |cols...') |
m |
||
| Line 1: | Line 1: | ||
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;" | {| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;" | ||
|- | |- | ||
| - | |style="background:# | + | |style="background:#e1c9a8; font-size:150%;" colspan="3"|'''{{{1}}}''' |
|- | |- | ||
|colspan="3"| {{{2}}} | |colspan="3"| {{{2}}} | ||
|- | |- | ||
| - | |style="background:# | + | |style="background:#e1c9a8"| '''Parameter''' |
| - | |style="background:# | + | |style="background:#e1c9a8"| '''Expected Type''' |
| - | |style="background:# | + | |style="background:#e1c9a8"| '''Description''' |
|- | |- | ||
{{{3}}} | {{{3}}} | ||
| - | |style="background:# | + | |style="background:#e1c9a8" colspan="3"| '''Returns''' |
|- | |- | ||
|colspan="3"| {{{4}}} | |colspan="3"| {{{4}}} | ||
Latest revision as of 12:37, 18 January 2010
| {{{1}}} | ||
| {{{2}}} | ||
| Parameter | Expected Type | Description |
| Returns | ||
| {{{4}}} | ||
| Daisymoon Audio Lib |
|---|
|
audio.exampleMethod(soundFile, volume) | ||
|
This is an example usage of the AudioMethod template. Audio methods should contain this template, with the paramters for method name, description, parameter list and return values, and then an example of how the method is used. | ||
| Parameter | Expected Type | Description |
| soundFile | A String | This is a parameter using the MethodParam template. |
| volume | A number | Here's a second parameter. If a method has 0 parameters, you can use the NoParams template instead. |
| Returns | ||
|
The fourth parameter is a description of the method's return value or values, if any. | ||
| Daisymoon Audio Lib |
|---|
