Template:BGM/doc: Difference between revisions

Revision as of 23:58, 27 July 2023

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.
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. Example いかるひのやま	String	required
Filename	`filename`	The audio's filename, pointing to the file as uploaded. If left blank, no link will be displayed. Example FC BGM 008.ogg	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 Example FC Overworld	String	optional
Sound Room ID	`soundroom`	If the BGM is from Yume 2kki, provide the ID as seen in the Sound Room. Example 307C	String	optional

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

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

🔊 tonny31.6 – Budding Life World (No. 248D)

@@ Line 22: / Line 22: @@
 			"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",
 			"example": "FC Overworld",
+			"type": "string"
+		},
+		"soundroom": {
+			"label": "Sound Room ID",
+			"description": "If the BGM is from Yume 2kki, provide the ID as seen in the Sound Room.",
+			"example": "307C",
 			"type": "string"
 		}