"Soundscript" container - Revision history

Pw3r: /* sound-asset */

2026-06-05T07:06:20Z

sound-asset

← Older revision		Revision as of 07:06, 5 June 2026
Line 71:		Line 71:
	:Type: KUID		:Type: KUID
	:Compulsory: No		:Compulsory: No
	:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset. ~~''Unfortunately, it does not exist and is not supported.''~~		:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset.

	====trigger====		====trigger====

Ciceronmt: /* sound-asset */

2019-09-07T06:21:38Z

sound-asset

← Older revision		Revision as of 06:21, 7 September 2019
Line 71:		Line 71:
	:Type: KUID		:Type: KUID
	:Compulsory: No		:Compulsory: No
	:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset.		:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset. ''Unfortunately, it does not exist and is not supported.''
	'''Unfortunately, it does not exist and is not supported.'''

	====trigger====		====trigger====

Ciceronmt: /* sound-asset */

2019-09-07T06:20:51Z

sound-asset

← Older revision		Revision as of 06:20, 7 September 2019
Line 72:		Line 72:
	:Compulsory: No		:Compulsory: No
	:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset.		:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset.
			'''Unfortunately, it does not exist and is not supported.'''

	====trigger====		====trigger====

Windwalkr: /* distance */

2019-06-12T01:50:46Z

distance

← Older revision		Revision as of 01:50, 12 June 2019
Line 35:		Line 35:
	:Default: 50,150		:Default: 50,150
	:Compulsory: No		:Compulsory: No
	:Desc: ~~Distance range from the source~~, in meters~~, where the sound is audible. The minimum distance~~ defines the radius within which the sound remains at 100% volume. Beyond that distance, the sound volume will begin to decay naturally. The maximum distance defines a radius beyond which the game ~~will~~ no longer play the sound. This does not mean that the sound will fade to zero by the maximum distance, but rather that the sound ~~will~~ cut off abruptly at that point. It is up to the content creator to choose an appropriate distance - smaller is better for performance.		:Desc: The minimum distance (first value, in meters) defines the radius within which the sound remains at 100% volume. Beyond that distance, the sound volume will begin to decay naturally. The maximum distance (second value, in meters) defines a radius beyond which the game need no longer play the sound. This does not mean that the sound will fade to zero by the maximum distance, but rather that the sound may cut off abruptly beyond that point. It is up to the content creator to choose an appropriate maximum distance - smaller is better for performance, but overly small values may result in the sound audibly cutting off. Many Trainz editions ignore the configured maximum distance value and instead perform their own optimized calculation of the appropriate value.

	====nostartdelay====		====nostartdelay====

Gdennish: /* Example Config.txt */

2018-10-26T05:06:57Z

Example Config.txt

← Older revision		Revision as of 05:06, 26 October 2018
Line 106:		Line 106:
	sound		sound
	{		{
	0 ctry_day_1.wav		0 "ctry_day_1.wav"
	1 ctry_day_2.wav		1 "ctry_day_2.wav"
	}		}
	}		}
Line 117:		Line 117:
	sound		sound
	{		{
	0 night_loop.wav		0 "night_loop.wav"
	}		}
	}		}
	}		}


	==Categories==		==Categories==
	[[Category:Config Container\|Soundscript container]]		[[Category:Config Container\|Soundscript container]]
	{{ORP-bot\|Soundscript container}}		{{ORP-bot\|Soundscript container}}

Pw3r: /* sound */

2018-08-02T05:42:39Z

sound

← Older revision		Revision as of 05:42, 2 August 2018
Line 59:		Line 59:
	:Default: {}		:Default: {}
	:Compulsory: Yes		:Compulsory: Yes
	:Desc: Contains ~~a key/string~~ list of the sound files to play. If the list has more than one entry then one file will be picked at random from the list. The value of each tag in this container is the filename of a WAV sound file. Filenames are relative to the base directory of the asset, i.e. relative to the location of the config file. The keys used within the list are not important: Trainz convention for lists like this is to numerically number each option from zero, and while it is strongly recommended to follow this convention, there is no technical requirement to do so.		:Desc: Contains list of the sound files to play. If the list has more than one entry then one file will be picked at random from the list. The value of each tag in this container is the filename of a WAV sound file. Filenames are relative to the base directory of the asset, i.e. relative to the location of the config file.

	:Valid WAV files are:		:Valid WAV files are:
	:* Uncompressed.		:* Uncompressed.
	:* 8 or 16 bit		:* 8 or 16 bit
	:* Mono, Stereo or Surround ~~(As of build 3.7 Surround is not fully tested)~~		:* Mono, Stereo or Surround

	:Sampling rate can be 22kHz (22,050Hz) or 44kHz (44,100Hz). The higher sampling rate doubles the size of the file for no significant improvement in quality, and is not recommended. For some purposes there are additional requirements - for instance directional sounds must be mono.		:Sampling rate can be 22kHz (22,050Hz) or 44kHz (44,100Hz). The higher sampling rate doubles the size of the file for no significant improvement in quality, and is not recommended. For some purposes there are additional requirements - for instance directional sounds must be mono.

Pw3r at 05:41, 2 August 2018

2018-08-02T05:41:07Z

← Older revision		Revision as of 05:41, 2 August 2018
Line 14:		Line 14:
	volume 1		volume 1
	value-range 0,0		value-range 0,0
			sound-asset
	sound		sound
	{		{
Line 44:		Line 45:
	====priority====		====priority====
	:Type: Integer		:Type: Integer
			:Default: 1
			:Compulsory: No
	:Desc: Sets the priority of the sound, if their are not enough sound channels available higher priority sounds will be played first. Defaults to 1, can be negative.		:Desc: Sets the priority of the sound, if their are not enough sound channels available higher priority sounds will be played first. Defaults to 1, can be negative.

Line 49:		Line 52:
	:Type: Decimal Pair		:Type: Decimal Pair
	:Default: 0,0		:Default: 0,0
	:Compulsory: ~~Yes (3.4)~~		:Compulsory: No
	:Desc: Time range (in seconds) to delay, after the sound finishes playing, before playing the sound again. To set a constant delay either set both these values the same or only provide one of them, otherwise a random value between them will be chosen. When used with a trigger event (see the 'trigger' tag), a positive value indicates that the sound should not repeat, but should wait until triggered again.		:Desc: Time range (in seconds) to delay, after the sound finishes playing, before playing the sound again. To set a constant delay either set both these values the same or only provide one of them, otherwise a random value between them will be chosen. When used with a trigger event (see the 'trigger' tag), a positive value indicates that the sound should not repeat, but should wait until triggered again.

Line 64:		Line 67:

	:Sampling rate can be 22kHz (22,050Hz) or 44kHz (44,100Hz). The higher sampling rate doubles the size of the file for no significant improvement in quality, and is not recommended. For some purposes there are additional requirements - for instance directional sounds must be mono.		:Sampling rate can be 22kHz (22,050Hz) or 44kHz (44,100Hz). The higher sampling rate doubles the size of the file for no significant improvement in quality, and is not recommended. For some purposes there are additional requirements - for instance directional sounds must be mono.

			====sound-asset====
			:Type: KUID
			:Compulsory: No
			:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset.

	====trigger====		====trigger====

Vincentrh at 03:51, 28 September 2015

2015-09-28T03:51:07Z

← Older revision		Revision as of 03:51, 28 September 2015
Line 69:		Line 69:
	:Default: ""		:Default: ""
	:Compulsory: No		:Compulsory: No
	:Desc: The 'trigger' tag gives your sound a name that can allow it to be played from [[Scripting\|TrainzScript]], animations and certain predefined events. (At least one of these "predefined events" is to use the word "toggle" when including a soundscript container in the config.txt of a "MOjunction". This will make the sound fire each time the turnout is switched)		:Desc: The 'trigger' tag gives your sound a name that can allow it to be played from [[Scripting\|TrainzScript]] (see: Class MapObject), animations and certain predefined events. (At least one of these "predefined events" is to use the word "toggle" when including a soundscript container in the config.txt of a "MOjunction". This will make the sound fire each time the turnout is switched)

	====value-range====		====value-range====

Pcas1986: Added value-range. This tag could use a better description as the current is a bit vague.

2014-03-17T04:44:58Z

Added value-range. This tag could use a better description as the current is a bit vague.

@@ Line 13: / Line 13: @@
    trigger       ""
    volume        1
    sound
+   {
+   }
 ====ambient====
 :Type: Boolean
 :Desc: If true this is an 'ambient' sound, ambient sounds are played in 2D and do not make use of 3D positioning in the world other than to affect volume. Unlike positional sounds, ambient sounds may be stereo.
 ====attachment====
-:Type: String
+:Type: Attachment point
 :Desc: Point to attach the sound source to. Attachment points are specified in the mesh file during creation.
 ====nostartdelay====
 :Type: Boolean
 :Desc: If added and true this tag specifies that the sound will play immediately once triggered. By default sounds have a random start delay between 0 & 4 seconds. Start delay should be left active in most cases, as turning it off may cause significant audio artifacts when several identical sounds are in proximity.
@@ Line 40: / Line 45: @@
 :Type: Integer
 :Desc: Sets the priority of the sound, if their are not enough sound channels available higher priority sounds will be played first. Defaults to 1, can be negative.
 ====trigger====
 :Type: String
 :Desc: The 'trigger' tag gives your sound a name that can allow it to be played from [[Scripting|TrainzScript]], animations and certain predefined events. (At least one of these "predefined events" is to use the word "toggle" when including a soundscript container in the config.txt of a "MOjunction".  This will make the sound fire each time the turnout is switched)
 ====volume====
 :Type: Decimal
 :Desc: Specifies the volume gain of the sound. Defaults to 1 (100%).
 ==Example Config.txt==

Builderbob: /* sound */

2014-01-02T01:20:18Z

sound

← Older revision		Revision as of 01:20, 2 January 2014
Line 51:		Line 51:
	====sound====		====sound====
	:Type: Container		:Type: Container
	:Desc: Contains a list of the sound files to play. If ~~th elist~~ has more than one entry then one file will be picked at random from the list. The value of each tag in this container is the filename of a WAV sound file. Filenames are relative to the base directory of the asset, i.e. relative to the location of the config file. The keys used within the list are not important: Trainz convention for lists like this is to numerically number each option from zero, and while it is strongly recommended to follow this convention, there is no technical requirement to do so.		:Desc: Contains a key/string list of the sound files to play. If the list has more than one entry then one file will be picked at random from the list. The value of each tag in this container is the filename of a WAV sound file. Filenames are relative to the base directory of the asset, i.e. relative to the location of the config file. The keys used within the list are not important: Trainz convention for lists like this is to numerically number each option from zero, and while it is strongly recommended to follow this convention, there is no technical requirement to do so.

	Valid WAV files are:		Valid WAV files are: