No edit summary |
m (add soundroom param to sample) |
||
Line 37: | Line 37: | ||
== Sample output == | == Sample output == | ||
<pre> | <pre> | ||
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World}} | {{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}} | ||
</pre> | </pre> | ||
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World}} | {{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}} |
Revision as of 23:55, 27 July 2023
Description
Renders a link (if provided) to an area's BGM, and sets a subobject that can be queried.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Title | title | The BGM's title, to be displayed. This could either be an official title, or the original filename exclusive of extension.
| String | required |
Filename | filename | The audio's filename, pointing to the file as uploaded. If left blank, no link will be displayed.
| String | suggested |
Label | label | A label describing where or when the area would play. This could be a sub-area or an event, or the area under different conditions
| String | optional |
Syntax
{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = }}
Sample output
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}
🔊 tonny31.6 – Budding Life World (No. 248D)