×
Create a new article
Write your page title here:
We currently have 2,806 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



YumeWiki
2,806Articles

Template:BGM/doc: Difference between revisions

(Created page with " <templatedata> { "params": { "title": { "label": "Title", "description": "The BGM's title, to be displayed. This could either be an official title, or the original f...")
 
(added syntax + example output)
Line 1: Line 1:
 
== Description ==
<noinclude>[[Category:Template documentation]]</noinclude>
<templatedata>
<templatedata>
{
{
Line 28: Line 29:
}
}
</templatedata>
</templatedata>
== Syntax ==
<pre>
{{BGM
| title = (e.g. examplesong)
| filename = (e.g. Example.ogg)
| label =
}}
</pre>
== Sample output ==
<pre>
{{LocationMap
| title = tonny31.6
| filename = Tonny31.6 (284D).ogg
| label = Budding Life World
}}
</pre>
{{LocationMap
| title = tonny31.6
| filename = Tonny31.6 (284D).ogg
| label = Budding Life World
}}

Revision as of 16:25, 1 December 2022

Description

Renders a link (if provided) to an area's BGM, and sets a subobject that can be queried.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

The BGM's title, to be displayed. This could either be an official title, or the original filename exclusive of extension.

Example
いかる ひのやま
Stringrequired
Filenamefilename

The audio's filename, pointing to the file as uploaded. If left blank, no link will be displayed.

Example
FC BGM 008.ogg
Stringsuggested
Labellabel

A label describing where or when the area would play.

Example
FC Overworld
Stringoptional

Syntax

{{BGM
| title = (e.g. examplesong)
| filename = (e.g. Example.ogg)
| label =
}}

Sample output

{{LocationMap
| title = tonny31.6
| filename = Tonny31.6 (284D).ogg
| label = Budding Life World
}}