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



YumeWiki
YumeWiki
3,035Articles
in:
Template documentation

Template:BGM/doc: Difference between revisions

m (add soundroom to syntax)
(speed now uses the Number type)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Description ==
{{CategorySetting|On [[Collective Unconscious:Collective Unconscious Wiki|''Collective Unconscious'']] pages, it adds [[:Category:Missing BGM author]] if no author is specified.}}
<noinclude>[[Category:Template documentation]]</noinclude>
{{PropertySetting}}
==Description==
<templatedata>
<templatedata>
{
{
"description": "Renders a link (if provided) to an area's BGM, and sets a record that can be queried.",
"format": "inline",
"params": {
"params": {
"title": {
"title": {
"label": "Title",
"label": "Title",
"description": "The BGM's title, to be displayed. This could either be an official title, or the original filename exclusive of extension.",
"description": "The BGM's title to be displayed. This could either be an official title, or the original filename exclusive of extension.",
"example": "いかる ひのやま",
"example": "いかる ひのやま",
"type": "string",
"type": "string",
Line 14: Line 17:
"label": "Filename",
"label": "Filename",
"description": "The audio's filename, pointing to the file as uploaded. If left blank, no link will be displayed.",
"description": "The audio's filename, pointing to the file as uploaded. If left blank, no link will be displayed.",
"example": "FC BGM 008.ogg",
"example": "CU maple-clicking 60.ogg",
"type": "string",
"type": "string",
"suggested": true
"suggested": true
Line 20: Line 23:
"label": {
"label": {
"label": "Label",
"label": "Label",
"description": "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",
"description": "A label describing where or when the BGM would play. This could be a sub-area, an event, or the area under different conditions.",
"example": "FC Overworld",
"example": "FC Overworld",
"type": "string"
"type": "string"
Line 26: Line 29:
"soundroom": {
"soundroom": {
"label": "Sound Room ID",
"label": "Sound Room ID",
"description": "If the BGM is from Yume 2kki, provide the ID as seen in the Sound Room.",
"description": "If the BGM is featured in a Sound Room like in Yume 2kki, provide the ID as seen in the Sound Room.",
"example": "307C",
"example": "307C",
"type": "string"
},
"speed": {
"label": "Speed",
"description": "The speed at which the track is set to play in-game.",
"example": "60",
"type": "number",
"required": true
},
"author": {
"label": "Author",
"description": "Credit the track's composer/author. Usually only applicable to collaborative games.",
"example": "MadameMimic",
"type": "string"
"type": "string"
}
}
},
}
"description": "Renders a link (if provided) to an area's BGM, and sets a subobject that can be queried.",
"format": "inline"
}
}
</templatedata>
</templatedata>


== Syntax ==
==Semantic properties==
This template exposes the following semantic properties.
{| class="wikitable" style="width:100%;"
!Property name
!Description
!Data type
!Cardinality
|-
|[[Property:Has BGM|Has BGM]]
|The main record that holds all the other properties.
|[[Special:Types/Record|Record]]
|Single
|-
|[[Property:BGM/Title|BGM/Title]]
|The title of the BGM, either official or from the game files.
|[[Special:Types/Text|Text]]
|Single
|-
|[[Property:Has media path|Has media path]]
|The path leading to the audio file on the wiki.
|[[Special:Types/URL|URL]]
|Single
|-
|[[Property:BGM/Audio|BGM/Audio]]
|The wiki page of the audio file.
|[[Special:Types/Page|Page]]
|Single
|-
|[[Property:BGM/Label|BGM/Label]]
|A label describing the BGM, usually where it plays in the location.
|[[Special:Types/Text|Text]]
|Single
|-
|[[Property:BGM/Soundroom|BGM/Soundroom]]
|The ID of the track in the game's Sound Room or equivalent feature, if one is present in the game.
|[[Special:Types/Text|Text]]
|Multiple
|-
|[[Property:BGM/Speed|BGM/Speed]]
|The speed at which the BGM is set to play in the location. This should correspond to the audio file on the wiki.
|[[Special:Types/Number|Number]]
|Single
|-
|[[Property:BGM/Author|BGM/Author]]
|The author(s) who created the BGM. Usually only applicable to collaborative games.
|[[Special:Types/Text|Text]]
|Multiple
|}
 
==Syntax==
<pre>
<pre>
{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }}
{{BGM|title= |filename= |label= |speed= |soundroom= |author= }}
</pre>
</pre>


== Sample output ==
==Sample==
The following input:
<pre>
<pre>
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}
{{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|soundroom = 248D}}
 
Produces:
 
{{BGMDisplay|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}
 
''Note: This sample uses {{t|BGMDisplay}} to avoid creating a record property.''
 
<noinclude>[[Category:Template documentation]]</noinclude>
<includeonly>__NOEDITSECTION__
[[Category:Location templates]]
</includeonly>

Latest revision as of 16:34, 9 August 2024

Notice CategorySetting.png This template conditionally sets categories on pages. Please only use this template as intended.
Conditions: On Collective Unconscious pages, it adds Category:Missing BGM author if no author is specified.
Notice PropertySetting.png This template automatically sets Semantic MediaWiki properties on pages. This may include creating subobjects. Please only use this template as intended.

Description

Renders a link (if provided) to an area's BGM, and sets a record 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
CU maple-clicking 60.ogg
Stringsuggested
Labellabel

A label describing where or when the BGM would play. This could be a sub-area, an event, or the area under different conditions.

Example
FC Overworld
Stringoptional
Sound Room IDsoundroom

If the BGM is featured in a Sound Room like in Yume 2kki, provide the ID as seen in the Sound Room.

Example
307C
Stringoptional
Speedspeed

The speed at which the track is set to play in-game.

Example
60
Numberrequired
Authorauthor

Credit the track's composer/author. Usually only applicable to collaborative games.

Example
MadameMimic
Stringoptional

Semantic properties

This template exposes the following semantic properties.

Property name Description Data type Cardinality
Has BGM The main record that holds all the other properties. Record Single
BGM/Title The title of the BGM, either official or from the game files. Text Single
Has media path The path leading to the audio file on the wiki. URL Single
BGM/Audio The wiki page of the audio file. Page Single
BGM/Label A label describing the BGM, usually where it plays in the location. Text Single
BGM/Soundroom The ID of the track in the game's Sound Room or equivalent feature, if one is present in the game. Text Multiple
BGM/Speed The speed at which the BGM is set to play in the location. This should correspond to the audio file on the wiki. Number Single
BGM/Author The author(s) who created the BGM. Usually only applicable to collaborative games. Text Multiple

Syntax

{{BGM|title= |filename= |label= |speed= |soundroom= |author= }}

Sample

The following input: 

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

Produces:

tonny31.6 (??%) (No. 248D): Budding Life World

Note: This sample uses {{BGMDisplay}} to avoid creating a record property.

Retrieved from "https://yume.wiki/index.php?title=Template:BGM/doc&oldid=487235"