Template:SoundTable/doc

From Aether Project Wiki
Jump to navigation Jump to search
This is the documentation page. It should be transcluded into the main template page. See Template:Documentation for more information
Lua.svg
This template uses Module:SoundTable, a script written in Lua.

Usage

A SoundTable takes one or more calls to {{SoundLine}} and forms them into a table for sounds..

Java edition table:

Sounds
SoundSubtitlesSourceDescriptionResource locationTranslation keyVolumePitchAttenuation
distance

Historical table:

Sounds
SoundSourceDescriptionResource locationVolumePitchAttenuation
distance

Bedrock edition table:

Sounds
SoundSourceDescriptionResource locationVolumePitch

Arguments

Parameter Function
type java, bedrock, dungeons, legends, historical or simple. Inserting a table with a type parameter, see above for corresponding output.
forcecollapsed Forces the table to begin collapsed.
nocat Stops table from inserting categories
templatepage Adds navbar with the link to the original call


A template that automatically generates a table for sounds.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
typetype

Type of the table (mostly based on edition/game)

Suggested values
java bedrock dungeons legends historical simple
Stringrequired
forcecollapsedforcecollapsed

Foces the table to begin collapsed.

Suggested values
1
Example
1
Booleanoptional
nocatnocat

Stops table from inserting categories

Suggested values
1
Example
1
Booleanoptional
templatepagetemplatepage

Links to original template call with navbar

Stringoptional