Sounds.lua - Revision history

Gajop: /* External Examples */

2018-12-18T11:17:26Z

External Examples

← Older revision		Revision as of 12:17, 18 December 2018
Line 174:		Line 174:
	{{sourcelink\|file=cont/base/springcontent/gamedata/sounds.lua}} - The original default <code>sounds.lua</code>		{{sourcelink\|file=cont/base/springcontent/gamedata/sounds.lua}} - The original default <code>sounds.lua</code>

	[~~http~~://~~code.google~~.com/p/~~zero~~-~~k/source/browse/trunk~~/~~mods~~/zk/gamedata/sounds.lua ZeroK sounds.lua]		[https://github.com/ZeroK-RTS/Zero-K/blob/master/gamedata/sounds.lua ZeroK sounds.lua]

	==Further Reading==		==Further Reading==

Gajop at 23:11, 9 December 2018

2018-12-09T23:11:21Z

← Older revision		Revision as of 00:11, 10 December 2018
Line 103:		Line 103:
	===default sounds===		===default sounds===
	The following is the default <code>sounds.lua</code> supplied in the base content [[springcontent.sdz]] archive, with some of the comments removed (As the information is presented here).		The following is the default <code>sounds.lua</code> supplied in the base content [[springcontent.sdz]] archive, with some of the comments removed (As the information is presented here).
	~~<code>~~<pre>		<pre>
	local Sounds = {		local Sounds = {
	SoundItems = {		SoundItems = {
Line 149:		Line 149:

	return Sounds		return Sounds
	</pre>~~</code>~~		</pre>

	===Using PitchMod to prevent loud explosions====		===Using PitchMod to prevent loud explosions====
	Taken from this thread by jK: {{forumlink\|topic=28819\|title=Use PitchMod in sounds.lua to prevent loud explosions}}		Taken from this thread by jK: {{forumlink\|topic=28819\|title=Use PitchMod in sounds.lua to prevent loud explosions}}
Line 156:		Line 155:
	Explosions can sound louder than intended when they are started in the same simFrame and so are played in sync -> resonance. PitchMod now changes the playback time (e.g. with 0.3 the sounds should have a playback time of 100-130%) and so there isn't a resonance anymore even when the sound is started multiple times in the same simframe.		Explosions can sound louder than intended when they are started in the same simFrame and so are played in sync -> resonance. PitchMod now changes the playback time (e.g. with 0.3 the sounds should have a playback time of 100-130%) and so there isn't a resonance anymore even when the sound is started multiple times in the same simframe.

	~~<code>~~<pre>		<pre>
	local files = VFS.DirList("sounds/explosions/")		local files = VFS.DirList("sounds/explosions/")
	local t = Sounds.SoundItems		local t = Sounds.SoundItems
Line 168:		Line 167:
	}		}
	end		end
	</pre~~></code~~>		</pre>

8611: /* Example */ add PitchMod explosion examples. untested if that still works/is needed but the idea itself is good example. http://springrts.com/phpbb/viewtopic.php?t&t=28819

2015-04-13T12:22:49Z

Example: add PitchMod explosion examples. untested if that still works/is needed but the idea itself is good example. http://springrts.com/phpbb/viewtopic.php?t&t=28819

@@ Line 100: / Line 100: @@
 |description = The time in milliseconds the sound should loop for.}}
-==Example==
+==Examples==
 ===default sounds===
 The following is the default <code>sounds.lua</code> supplied in the base content [[springcontent.sdz]] archive, with some of the comments removed (As the information is presented here).
@@ Line 150: / Line 150: @@
 return Sounds
 </pre></code>
 ===External Examples===

Flozi: /* Source */

2014-10-02T17:02:35Z

Source

← Older revision		Revision as of 18:02, 2 October 2014
Line 9:		Line 9:

	* {{sourcelink\|file=rts/System/Sound/SoundItem.cpp}}		* {{sourcelink\|file=rts/System/Sound/SoundItem.cpp}}


	==Data Types==		==Data Types==

Flozi: /* Source */ data types

2014-10-02T17:01:46Z

Source: data types

← Older revision		Revision as of 18:01, 2 October 2014
Line 9:		Line 9:

	* {{sourcelink\|file=rts/System/Sound/SoundItem.cpp}}		* {{sourcelink\|file=rts/System/Sound/SoundItem.cpp}}


			==Data Types==
			{{DataTypes}}

	==Details==		==Details==

Flozi: /* Details */ update links

2013-10-28T22:33:06Z

Details: update links

← Older revision		Revision as of 23:33, 28 October 2013
Line 11:		Line 11:

	==Details==		==Details==
	Wherever a sound is played in Spring, be it associated with a [[~~Units-~~UnitDefs\|UnitDef]], [[~~Units-~~WeaponDefs\|WeaponDef]] or via the [[Lua_UnsyncedCtrl#Sounds\|lua API]], a '''SoundItem''' is used. If you access a raw sound file, a '''SoundItem''' with the defaults is created for you.		Wherever a sound is played in Spring, be it associated with a [[Gamedev:UnitDefs\|UnitDef]], [[Gamedev:WeaponDefs\|WeaponDef]] or via the [[Lua_UnsyncedCtrl#Sounds\|lua API]], a '''SoundItem''' is used. If you access a raw sound file, a '''SoundItem''' with the defaults is created for you.

	Additionally, multiple '''SoundItems''' can use one single file with different settings, this is very efficient, as they only use 1 shared buffer.		Additionally, multiple '''SoundItems''' can use one single file with different settings, this is very efficient, as they only use 1 shared buffer.

Flozi: /* Source */ reformat

2013-03-01T23:02:08Z

Source: reformat

← Older revision		Revision as of 00:02, 2 March 2013
Line 6:		Line 6:

	==Source==		==Source==
	The engine source code which parses the data from this file is viewable here: {{sourcelink\|file=rts/System/Sound/SoundItem.cpp}}		The engine source code which parses the data from this file is viewable here:

			* {{sourcelink\|file=rts/System/Sound/SoundItem.cpp}}

	==Details==		==Details==

Flozi: /* SoundItem Properties */ Template:Taglink

2012-10-27T16:44:28Z

SoundItem Properties: Template:Taglink

← Older revision		Revision as of 17:44, 27 October 2012
Line 39:		Line 39:
	\|type = float		\|type = float
	\|default = 0.0		\|default = 0.0
	\|description = If > <code>0.0</code> then this adds a random amount to ~~<code>~~gain~~</code>~~ each time the sound is played. Clamped between <code>0.0</code> and <code>1.0</code>. The result is in the range '''['''(~~<code>~~gain~~</code>~~ * (1 + ~~<code>~~gainMod~~</code>~~))''',''' (~~<code>~~gain~~</code>~~ * (1 - ~~<code>~~gainMod~~</code>~~))''']'''.}}		\|description = If > <code>0.0</code> then this adds a random amount to {{taglink\|gain}} each time the sound is played. Clamped between <code>0.0</code> and <code>1.0</code>. The result is in the range '''['''({{taglink\|gain}} * (1 + {{taglink\|gainMod}}))''',''' ({{taglink\|gain}} * (1 - {{taglink\|gainMod}}))''']'''.}}

	{{tag		{{tag
Line 51:		Line 51:
	\|type = float		\|type = float
	\|default = 0.0		\|default = 0.0
	\|description = If > <code>0.0</code> then this adds a random amount to ~~<code>~~pitch~~</code>~~ each time the sound is played. Clamped between <code>0.0</code> and <code>1.0</code>. The result is in the range '''['''(~~<code>~~pitch~~</code>~~ * (1 + ~~<code>~~pitchMod~~</code>~~))''',''' (~~<code>~~pitch~~</code>~~ * (1 - ~~<code>~~pitchMod~~</code>~~))''']'''.}}		\|description = If > <code>0.0</code> then this adds a random amount to {{taglink\|pitch}} each time the sound is played. Clamped between <code>0.0</code> and <code>1.0</code>. The result is in the range '''['''({{taglink\|pitch}} * (1 + {{taglink\|pitchMod}}))''',''' ({{taglink\|pitch}} * (1 - {{taglink\|pitchMod}}))''']'''.}}

	{{tag		{{tag
Line 63:		Line 63:
	\|type = int		\|type = int
	\|default = 0		\|default = 0
	\|description = When lots of sounds are played, sounds with lower ~~<code>~~priority~~</code>~~ are more likely to get cut off. A ~~<code>~~priority~~</code>~~ > <code>0</code> will never be cut of (priorities can be negative).}}		\|description = When lots of sounds are played, sounds with lower {{taglink\|priority}} are more likely to get cut off. A {{taglink\|priority}} > <code>0</code> will never be cut of (priorities can be negative).}}

	{{tag		{{tag

Flozi: /* SoundItem Properties */ elmos->elmo

2012-10-13T22:48:26Z

SoundItem Properties: elmos->elmo

← Older revision		Revision as of 23:48, 13 October 2012
Line 75:		Line 75:
	\|type = float		\|type = float
	\|default = MAX_FLOAT		\|default = MAX_FLOAT
	\|description = The cut-off distance (in [[~~elmos~~]]) at which this sound will no longer be played.}}		\|description = The cut-off distance (in [[elmo]]s) at which this sound will no longer be played.}}

	{{tag		{{tag

Jk: /* default sounds */

2012-06-24T16:41:54Z

default sounds

← Older revision		Revision as of 17:41, 24 June 2012
Line 136:		Line 136:
	default = {		default = {
	gainmod = 0.35,		gainmod = 0.35,
	pitchmod = 0.6,		pitchmod = 0.3,
			pitch = 0.7,
	in3d = true,		in3d = true,
	},		},
Line 144:		Line 145:
	return Sounds		return Sounds
	</pre></code>		</pre></code>

	===External Examples===		===External Examples===
	{{sourcelink\|file=cont/base/springcontent/gamedata/sounds.lua}} - The original default <code>sounds.lua</code>		{{sourcelink\|file=cont/base/springcontent/gamedata/sounds.lua}} - The original default <code>sounds.lua</code>