No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
-->{{#if: {{{title|}}}<!-- Check for title | -->{{#if: {{{title|}}}<!-- Check for title | ||
-->| {{#if: {{{filename|}}}<!-- Check for filename | -->| {{#if: {{{filename|}}}<!-- Check for filename | ||
-->| {{#set: Has BGM={{{title}}};{{filepath:{{{filename}}}}};File:{{{filename}}};{{{label|}}};{{#invoke:SoundtrackTable|formatRecord|{{{soundroom|}}}}};{{{speed|}}} }}<!-- Create record | -->| {{#set: Has BGM={{{title}}};{{filepath:{{{filename}}}}};File:{{{filename}}};{{{label|}}};{{#invoke:SoundtrackTable|formatRecord|{{{soundroom|}}}}};{{{speed|}}};{{{author|}}} }}<!-- Create record | ||
-->{{#if:{{filepath:{{{filename}}}}}<!-- Check if file is uploaded | -->{{#if:{{filepath:{{{filename}}}}}<!-- Check if file is uploaded | ||
-->|[{{filepath:{{{filename}}}}} {{#tag:nowiki|{{{title}}}}}]<!-- Visible file link | -->|[{{filepath:{{{filename}}}}} {{#tag:nowiki|{{{title}}}}}]<!-- Visible file link |
Revision as of 20:10, 21 July 2024
Documentation (for the above template, sometimes hidden or invisible)
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 | suggested |
Sound Room ID | soundroom | If the BGM is featured in a Sound Room like in Yume 2kki, provide the ID exactly as seen in the Sound Room.
| String | optional |
Author | author | Credit the track's composer/author.
| String | suggested |
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)
Visit Template:BGM/doc to edit this text! (How does this work?)