Heroes of Hammerwatch wiki - User contributions [en]

Creating dynamic sounds with FMOD

2020-11-07T23:30:12Z

The Slad: /* Adding a parameter to your sound event in FMOD */

It is possible to create dynamic sounds and music for you mod using parameters in FMOD.

This page assumes you already have FMOD set up for your Heroes of Hammerwatch mod. See [[Adding custom sounds and music]] for more information.

__FORCETOC__

==Adding a parameter to your sound event in FMOD==

1. Open your event in FMOD and use the "+" tab above the tracks to add a new parameter.

[[File:AddingFmodParameter.png]]

2. If you haven't created the effect that you want to be dynamic, go ahead and do that now.

NOTE: your effect must come before (on the left of) the Spatializer (the effect with 'distance attenuation') if using a 3dEvent!

[[File:AddingFmodEffect.png]]

3. Right-click on the knob that you want to be dynamically controlled, and select "Add Automation". Your should now see a track for that setting in the track deck.

In the new tab for your parameter, add you desired control points to determine how the setting is changed based on the parameter. There is a scale above the tracks showing the range of your parameter, and above that is a knob for your parameter to test how different values sound.You can also set a default value by right clicking on your parameter knob.

[[File:ParameterTabExample.png]]

==Controlling the parameter in your mod scripts==

You will need to use you own sValue parameter rather than the standard ones. For example: If you are creating a new projectile unit and want to have a dynamic shoot sound, do not use the "shoot-snd" parameter because this used by the base projectile classes and would be difficult to alter how it is controlled.

BAD:

<string name="shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

GOOD:

<string name="custom-shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

Continuing with the dynamic shoot sound example, you would need to have a custom projectile script that extends the desired type of projectile. Load in your sound sVal parameter, override the Initialize method, call the base class' Initialize method, then play your sound by calling PlaySound3D with a dictionary of your parameter:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

float paramValue = 0.7 // <---- your beautiful dynamic parameter logic here

dictionary params = { { "MyParameter", paramValue } };
PlaySound3D(customShootSound, m_unit.GetPosition(), params);
}
}

==Controlling an on-going sound==
It is also possible to control an FMOD parameter while the sound is playing. Instead of using PlaySound3D, you can call PlayTracked directly on your SoundEvent which will return a SoundInstance. With a reference to the SoundInstance you can execute more control over how the sound plays out. See the [https://docs.heroesofhammerwatch.com/engine/class_sound_instance.html SoundInstance] documentation for all the options. Then you can alter the sound instance as you please in an update method:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;
SoundInstance@ = myCustomSoundInstance;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

@myCustomSoundInstance = customShootSound.PlayTracked(m_unit.GetPosition());
}

void Update(int dt) override
{
BeamProjectile::Update(dt);

float param = 0.7 // <--- you got this, champ.

myCustomSoundInstance.SetPosition(m_unit.GetPosition());
myCustomSoundInstance.SetParameter("myParameter", param);
{
}

{{Template:BaseNav}}

Creating dynamic sounds with FMOD

2020-11-07T23:29:57Z

The Slad: /* Adding a parameter to your sound event in FMOD */

It is possible to create dynamic sounds and music for you mod using parameters in FMOD.

This page assumes you already have FMOD set up for your Heroes of Hammerwatch mod. See [[Adding custom sounds and music]] for more information.

__FORCETOC__

==Adding a parameter to your sound event in FMOD==

1. Open your event in FMOD and use the "+" tab above the tracks to add a new parameter.

[[File:AddingFmodParameter.png]]

2. If you haven't created the effect that you want to be dynamic, go ahead and do that now.
NOTE: your effect must come before (on the left of) the Spatializer (the effect with 'distance attenuation') if using a 3dEvent!

[[File:AddingFmodEffect.png]]

3. Right-click on the knob that you want to be dynamically controlled, and select "Add Automation". Your should now see a track for that setting in the track deck.

In the new tab for your parameter, add you desired control points to determine how the setting is changed based on the parameter. There is a scale above the tracks showing the range of your parameter, and above that is a knob for your parameter to test how different values sound.You can also set a default value by right clicking on your parameter knob.

[[File:ParameterTabExample.png]]

==Controlling the parameter in your mod scripts==

You will need to use you own sValue parameter rather than the standard ones. For example: If you are creating a new projectile unit and want to have a dynamic shoot sound, do not use the "shoot-snd" parameter because this used by the base projectile classes and would be difficult to alter how it is controlled.

BAD:

<string name="shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

GOOD:

<string name="custom-shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

Continuing with the dynamic shoot sound example, you would need to have a custom projectile script that extends the desired type of projectile. Load in your sound sVal parameter, override the Initialize method, call the base class' Initialize method, then play your sound by calling PlaySound3D with a dictionary of your parameter:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

float paramValue = 0.7 // <---- your beautiful dynamic parameter logic here

dictionary params = { { "MyParameter", paramValue } };
PlaySound3D(customShootSound, m_unit.GetPosition(), params);
}
}

==Controlling an on-going sound==
It is also possible to control an FMOD parameter while the sound is playing. Instead of using PlaySound3D, you can call PlayTracked directly on your SoundEvent which will return a SoundInstance. With a reference to the SoundInstance you can execute more control over how the sound plays out. See the [https://docs.heroesofhammerwatch.com/engine/class_sound_instance.html SoundInstance] documentation for all the options. Then you can alter the sound instance as you please in an update method:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;
SoundInstance@ = myCustomSoundInstance;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

@myCustomSoundInstance = customShootSound.PlayTracked(m_unit.GetPosition());
}

void Update(int dt) override
{
BeamProjectile::Update(dt);

float param = 0.7 // <--- you got this, champ.

myCustomSoundInstance.SetPosition(m_unit.GetPosition());
myCustomSoundInstance.SetParameter("myParameter", param);
{
}

{{Template:BaseNav}}

Creating dynamic sounds with FMOD

2020-11-07T14:34:40Z

The Slad: removed superfluous line of code.

It is possible to create dynamic sounds and music for you mod using parameters in FMOD.

This page assumes you already have FMOD set up for your Heroes of Hammerwatch mod. See [[Adding custom sounds and music]] for more information.

__FORCETOC__

==Adding a parameter to your sound event in FMOD==

1. Open your event in FMOD and use the "+" tab above the tracks to add a new parameter.

[[File:AddingFmodParameter.png]]

2. If you haven't created the effect that you want to be dynamic, go ahead and do that now.

[[File:AddingFmodEffect.png]]

3. Right-click on the knob that you want to be dynamically controlled, and select "Add Automation". Your should now see a track for that setting in the track deck.

In the new tab for your parameter, add you desired control points to determine how the setting is changed based on the parameter. There is a scale above the tracks showing the range of your parameter, and above that is a knob for your parameter to test how different values sound.You can also set a default value by right clicking on your parameter knob.

[[File:ParameterTabExample.png]]

==Controlling the parameter in your mod scripts==

You will need to use you own sValue parameter rather than the standard ones. For example: If you are creating a new projectile unit and want to have a dynamic shoot sound, do not use the "shoot-snd" parameter because this used by the base projectile classes and would be difficult to alter how it is controlled.

BAD:

<string name="shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

GOOD:

<string name="custom-shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

Continuing with the dynamic shoot sound example, you would need to have a custom projectile script that extends the desired type of projectile. Load in your sound sVal parameter, override the Initialize method, call the base class' Initialize method, then play your sound by calling PlaySound3D with a dictionary of your parameter:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

float paramValue = 0.7 // <---- your beautiful dynamic parameter logic here

dictionary params = { { "MyParameter", paramValue } };
PlaySound3D(customShootSound, m_unit.GetPosition(), params);
}
}

==Controlling an on-going sound==
It is also possible to control an FMOD parameter while the sound is playing. Instead of using PlaySound3D, you can call PlayTracked directly on your SoundEvent which will return a SoundInstance. With a reference to the SoundInstance you can execute more control over how the sound plays out. See the [https://docs.heroesofhammerwatch.com/engine/class_sound_instance.html SoundInstance] documentation for all the options. Then you can alter the sound instance as you please in an update method:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;
SoundInstance@ = myCustomSoundInstance;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

@myCustomSoundInstance = customShootSound.PlayTracked(m_unit.GetPosition());
}

void Update(int dt) override
{
BeamProjectile::Update(dt);

float param = 0.7 // <--- you got this, champ.

myCustomSoundInstance.SetPosition(m_unit.GetPosition());
myCustomSoundInstance.SetParameter("myParameter", param);
{
}

{{Template:BaseNav}}

Creating dynamic sounds with FMOD

2020-11-07T04:49:43Z

The Slad: /* Controlling the parameter in your mod scripts */

It is possible to create dynamic sounds and music for you mod using parameters in FMOD.

This page assumes you already have FMOD set up for your Heroes of Hammerwatch mod. See [[Adding custom sounds and music]] for more information.

==Adding a parameter to your sound event in FMOD==
Open your event in FMOD and use the "+" tab above the tracks to add a new parameter.

[[File:AddingFmodParameter.png]]

If you haven't created the effect that you want to be dynamic, go ahead and do that now.

[[File:AddingFmodEffect.png]]

Right-click on the knob that you want to be dynamically controlled, and select "Add Automation". Your should now see a track for that setting in the track deck.

In the new tab for your parameter, add you desired control points to determine how the setting is changed based on the parameter. There is a scale above the tracks showing the range of your parameter, and above that is a knob for your parameter to test how different values sound. you can also set a default value by right clicking on your parameter knob.

[[File:ParameterTabExample.png]]

==Controlling the parameter in your mod scripts==

You will need to use you own sValue parameter rather than the standard ones. For example: If you are creating a new projectile unit and want to have a dynamic shoot sound, do not use the "shoot-snd" parameter because this used by the base projectile classes and would be difficult to alter how it is controlled.

BAD:

<string name="shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

GOOD:

<string name="custom-shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

Continuing with the dynamic shoot sound example, you would need to have a custom projectile script that extends the desired type of projectile. Load in your sound sVal parameter, override the Initialize method, call the base class' Initialize method, then play your sound by calling PlaySound3D with a dictionary of your parameter:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

m_pos = xy(m_unit.GetPosition());

float paramValue = 0.7 // <---- your beautiful dynamic parameter logic here

dictionary params = { { "MyParameter", paramValue } };
PlaySound3D(customShootSound, m_unit.GetPosition(), params);
}
}

==Controlling an on-going sound==
It is also possible to control an FMOD parameter while the sound is playing. Instead of using PlaySound3D, you can call PlayTracked directly on your SoundEvent which will return a SoundInstance. With a reference to the SoundInstance you can execute more control over how the sound plays out. See the [https://docs.heroesofhammerwatch.com/engine/class_sound_instance.html SoundInstance] documentation for all the options. Then you can alter the sound instance as you please in an update method:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;
SoundInstance@ = myCustomSoundInstance;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

@myCustomSoundInstance = customShootSound.PlayTracked(m_unit.GetPosition());
}

void Update(int dt) override
{
BeamProjectile::Update(dt);

float param = 0.7 // <--- you got this, champ.

myCustomSoundInstance.SetPosition(m_unit.GetPosition());
myCustomSoundInstance.SetParameter("myParameter", param);
{
}

{{Template:BaseNav}}

Creating dynamic sounds with FMOD

2020-11-07T04:46:06Z

The Slad:

It is possible to create dynamic sounds and music for you mod using parameters in FMOD.

This page assumes you already have FMOD set up for your Heroes of Hammerwatch mod. See [[Adding custom sounds and music]] for more information.

==Adding a parameter to your sound event in FMOD==
Open your event in FMOD and use the "+" tab above the tracks to add a new parameter.

[[File:AddingFmodParameter.png]]

If you haven't created the effect that you want to be dynamic, go ahead and do that now.

[[File:AddingFmodEffect.png]]

Right-click on the knob that you want to be dynamically controlled, and select "Add Automation". Your should now see a track for that setting in the track deck.

In the new tab for your parameter, add you desired control points to determine how the setting is changed based on the parameter. There is a scale above the tracks showing the range of your parameter, and above that is a knob for your parameter to test how different values sound. you can also set a default value by right clicking on your parameter knob.

[[File:ParameterTabExample.png]]

==Controlling the parameter in your mod scripts==

You will need to use you own sValue parameter rather than the standard ones. For example: If you want to have a dynamic shoot sound, do not use the "shoot-snd" parameter because this used by the base projectile classes and would be difficult to alter how it is controlled.

BAD:

<string name="shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

GOOD:

<string name="custom-shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

Continuing with the dynamic shoot sound example, you would need to have a custom projectile script that extends the desired type of projectile. Load in your sound sVal parameter, override the Initialize method, call the base class' Initialize method, then play your sound by calling PlaySound3D with a dictionary of your parameter:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

m_pos = xy(m_unit.GetPosition());

float paramValue = 0.7 // <---- your beautiful dynamic parameter logic here

dictionary params = { { "MyParameter", paramValue } };
PlaySound3D(customShootSound, m_unit.GetPosition(), params);
}
}

==Controlling an on-going sound==
It is also possible to control an FMOD parameter while the sound is playing. Instead of using PlaySound3D, you can call PlayTracked directly on your SoundEvent which will return a SoundInstance. With a reference to the SoundInstance you can execute more control over how the sound plays out. See the [https://docs.heroesofhammerwatch.com/engine/class_sound_instance.html SoundInstance] documentation for all the options. Then you can alter the sound instance as you please in an update method:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;
SoundInstance@ = myCustomSoundInstance;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

@myCustomSoundInstance = customShootSound.PlayTracked(m_unit.GetPosition());
}

void Update(int dt) override
{
BeamProjectile::Update(dt);

float param = 0.7 // <--- you got this, champ.

myCustomSoundInstance.SetPosition(m_unit.GetPosition());
myCustomSoundInstance.SetParameter("myParameter", param);
{
}

{{Template:BaseNav}}

Creating dynamic sounds with FMOD

2020-11-07T04:45:43Z

The Slad:

It is possible to create dynamic sounds and music for you mod using parameters in FMOD.

This page assumes you already have FMOD set up for your Heroes of Hammerwatch mod. See [[Adding custom sounds and music]] for more information.

==Adding a parameter to your sound event in FMOD==
Open your event in FMOD use the "+" tab above the tracks to add a new parameter.

[[File:AddingFmodParameter.png]]

If you haven't created the effect that you want to be dynamic, go ahead and do that now.

[[File:AddingFmodEffect.png]]

Right-click on the knob that you want to be dynamically controlled, and select "Add Automation". Your should now see a track for that setting in the track deck.

In the new tab for your parameter, add you desired control points to determine how the setting is changed based on the parameter. There is a scale above the tracks showing the range of your parameter, and above that is a knob for your parameter to test how different values sound. you can also set a default value by right clicking on your parameter knob.

[[File:ParameterTabExample.png]]

==Controlling the parameter in your mod scripts==

You will need to use you own sValue parameter rather than the standard ones. For example: If you want to have a dynamic shoot sound, do not use the "shoot-snd" parameter because this used by the base projectile classes and would be difficult to alter how it is controlled.

BAD:

<string name="shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

GOOD:

<string name="custom-shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

Continuing with the dynamic shoot sound example, you would need to have a custom projectile script that extends the desired type of projectile. Load in your sound sVal parameter, override the Initialize method, call the base class' Initialize method, then play your sound by calling PlaySound3D with a dictionary of your parameter:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

m_pos = xy(m_unit.GetPosition());

float paramValue = 0.7 // <---- your beautiful dynamic parameter logic here

dictionary params = { { "MyParameter", paramValue } };
PlaySound3D(customShootSound, m_unit.GetPosition(), params);
}
}

==Controlling an on-going sound==
It is also possible to control an FMOD parameter while the sound is playing. Instead of using PlaySound3D, you can call PlayTracked directly on your SoundEvent which will return a SoundInstance. With a reference to the SoundInstance you can execute more control over how the sound plays out. See the [https://docs.heroesofhammerwatch.com/engine/class_sound_instance.html SoundInstance] documentation for all the options. Then you can alter the sound instance as you please in an update method:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;
SoundInstance@ = myCustomSoundInstance;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

@myCustomSoundInstance = customShootSound.PlayTracked(m_unit.GetPosition());
}

void Update(int dt) override
{
BeamProjectile::Update(dt);

float param = 0.7 // <--- you got this, champ.

myCustomSoundInstance.SetPosition(m_unit.GetPosition());
myCustomSoundInstance.SetParameter("myParameter", param);
{
}

{{Template:BaseNav}}

Adding custom sounds and music

2020-11-07T04:42:26Z

The Slad: /* Alternatively - use Fmod */

Adding in custom sounds and music to your scenarios requires the usage of '''.sbnk''' files. While your computer likely doesn't recognize this file type, it is really a glorified text file and can be opened with any simple text editor, such as [https://notepad-plus-plus.org/ Notepad++].

The sound files themselves must be presented in any of the following formats: '''.wav, .ogg, .mp3, .mod, .it, .s3d, .xm'''. Each file format has its own benefits: .ogg files are relatively small, at the cost of some audio quality, while .wav files will take up more space but with good amount of quality. In the end, it is recommended to use .ogg for music, and .wav for sounds. An audio editing program such as [http://www.audacityteam.org/ Audacity] can convert most common audio filetypes into most of these formats.

You can also use Fmod Studio to build your soundbank, that way you're not limited to the features of text-file sbnk files. This also allows you to add dynamic music, and add other kinds of effects to your sounds. See further in this article for more information.

== Exporting sound files to .ogg ==
If your sound file is not already in any of the supported file formats, follow these steps to do so. Using ''Audacity'', drag the sound file of your choice into the gray area. If successful, you will see the audio channel appear. You may now edit the sound file if you wish, otherwise, click the "File" tab and then the "Export" button. Select the file type you wish to use and export it to anywhere in your scenario folder, preferablly a dedicated folder called "sound". Continue to do this for all the sound files you need.

== Creating the .sbnk file ==
With your sound files ready, you must now create an .sbnk file at which you can configure some parameters. Simply open a text editor like Notepad++, then copy this example code

<pre>
<soundbank>
<sound category="sfx" name="healgun_loop" volume="1" is3d="true" looping="true">
<source res="sounds/healgun.wav" />
</sound>
</soundbank>
</pre>

You can edit the following parameters:
*''name'': The name that the sound will appear in while using the editor.
*''volume'': The volume of the sound file. 1 is the standard volume, but you can only make it quieter.
*''is3d'': boolean. If set to true, the sound will only play in an area around the PlaySound WorldScript that it is assigned to. If false, it will play across the entire level.
*''looping'': boolean. If set to true, the sound file will keep playing everytime it finishes. If false, it will only play once.
If you wish to add in more sound files, simply copy and paste the <sound> parameters and edit them accordingly. You can use as many as needed.
When done, save the file as .sbnk.

== Using the sound files in the editor ==
Open up a level, and navigate to the WorldScripts tab. Spawn in a PlaySound WorldScript. Select it, then in the "Sound" parameter, type in the name of your .sbnk file, or the name you gave the sound, and it will show up. You can do the same for the PlayMusic WorldScript.

== Alternatively - use Fmod ==
The game uses Fmod internally to do all of its sounds. These kinds of sound effects start with the <code>event:/</code> prefix instead of directly pointing to an .sbnk file. They are therefore found within a .bank file instead. It is possible to create your own Fmod Studio soundbanks for your scenarios.

Download Fmod Studio 1.10.8 from [http://www.fmod.org/download/ this page]. Then, download [http://www.heroesofhammerwatch.com/hoh_fmod_project.zip this Fmod skeleton project] to get your started. The reason this skeleton project is needed is because your settings must match ours exactly, which is what this does.

You will need to remove all the existing events and assets and create an additional mod_bank bank
Add your events to your mod_bank. Export this and you'll be able to reference events from your bank in game using their GUID (which you can get in fmod by right clicking and event and picking Copy GUID)

for example: <pre> <string name="Music">{a78f74fa-fd1b-417d-a598-41c94e552470}</string> </pre>

If using Fmod, you can dynamically control the sounds using parameters in your scripts. See [[Creating dynamic sounds with FMOD]] for more info.

{{Template:BaseNav}}

Creating dynamic sounds with FMOD

2020-11-07T04:40:25Z

The Slad: /* Controlling an on-going sound */

It is possible to create dynamic sounds and music for you mod using parameters in FMOD.

This page assumes you already have FMOD set up for you Heroes of Hammerwatch mod. See [[Adding custom sounds and music]] for more information.

==Adding a parameter to your sound event in FMOD==
Open your event in FMOD use the "+" tab above the tracks to add a new parameter.

[[File:AddingFmodParameter.png]]

If you haven't created the effect that you want to be dynamic, go ahead and do that now.

[[File:AddingFmodEffect.png]]

Right-click on the knob that you want to be dynamically controlled, and select "Add Automation". Your should now see a track for that setting in the track deck.

In the new tab for your parameter, add you desired control points to determine how the setting is changed based on the parameter. There is a scale above the tracks showing the range of your parameter, and above that is a knob for your parameter to test how different values sound. you can also set a default value by right clicking on your parameter knob.

[[File:ParameterTabExample.png]]

==Controlling the parameter in your mod scripts==

You will need to use you own sValue parameter rather than the standard ones. For example: If you want to have a dynamic shoot sound, do not use the "shoot-snd" parameter because this used by the base projectile classes and would be difficult to alter how it is controlled.

BAD:

<string name="shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

GOOD:

<string name="custom-shoot-snd">{5567e7f1-bf44-420c-a7b8-fc8c1ee2f628}</string>

Continuing with the dynamic shoot sound example, you would need to have a custom projectile script that extends the desired type of projectile. Load in your sound sVal parameter, override the Initialize method, call the base class' Initialize method, then play your sound by calling PlaySound3D with a dictionary of your parameter:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

m_pos = xy(m_unit.GetPosition());

float paramValue = 0.7 // <---- your beautiful dynamic parameter logic here

dictionary params = { { "MyParameter", paramValue } };
PlaySound3D(customShootSound, m_unit.GetPosition(), params);
}
}

==Controlling an on-going sound==
It is also possible to control an FMOD parameter while the sound is playing. Instead of using PlaySound3D, you can call PlayTracked directly on your SoundEvent which will return a SoundInstance. With a reference to the SoundInstance you can execute more control over how the sound plays out. See the [https://docs.heroesofhammerwatch.com/engine/class_sound_instance.html SoundInstance] documentation for all the options. Then you can alter the sound instance as you please in an update method:

class DynamicSoundBeam : BeamProjectile
{
SoundEvent@ customShootSound;
SoundInstance@ = myCustomSoundInstance;

DynamicSoundBeam(UnitPtr unit, SValue& params)
{
super(unit, params);

@customShootSound = Resources::GetSoundEvent(GetParamString(unit, params, "custom-shoot-snd", false));
}

void Initialize(Actor@ owner, vec2 dir, float intensity, bool husk, Actor@ target, uint weapon) override
{
BeamProjectile::Initialize(owner, dir, intensity, husk, target, weapon);

@myCustomSoundInstance = customShootSound.PlayTracked(m_unit.GetPosition());
}

void Update(int dt) override
{
BeamProjectile::Update(dt);

float param = 0.7 // <--- you got this, champ.

myCustomSoundInstance.SetPosition(m_unit.GetPosition());
myCustomSoundInstance.SetParameter("myParameter", param);
{
}

{{Template:BaseNav}}

Creating dynamic sounds with FMOD

2020-11-07T04:33:49Z

The Slad: /* Controlling an on-going sound */

Creating dynamic sounds with FMOD

2020-11-07T04:18:24Z

The Slad:

Creating dynamic sounds with FMOD

2020-11-07T04:17:27Z

The Slad: /* Controlling the parameter in your mod scripts */

Creating dynamic sounds with FMOD

2020-11-07T03:47:13Z

The Slad: page created.

File:ParameterTabExample.png

2020-11-07T03:42:16Z

The Slad:

File:AddingFmodEffect.png

2020-11-07T03:33:45Z

The Slad:

File:AddingFmodParameter.png

2020-11-07T03:27:28Z

The Slad: