m (update templatedata to include soundroom) |
m (add soundroom to syntax) |
||
Line 38: | Line 38: | ||
== Syntax == | == Syntax == | ||
<pre> | <pre> | ||
{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = }} | {{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }} | ||
</pre> | </pre> | ||
Revision as of 00:02, 28 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 |
Sound Room ID | soundroom | If the BGM is from Yume 2kki, provide the ID as seen in the Sound Room.
| String | optional |
Syntax
{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }}
Sample output
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}
🔊 tonny31.6 – Budding Life World (No. 248D)