XML:SNDD: Difference between revisions

* Oni/AE/AEInstaller2.exe > Tools > [[Anniversary Edition/Installer#Tools|Manage Tools]]

Usage: Oni/AE/Tools/VagoGUI/[[Vago (tool)|Vago.exe]]

* Target Platform: choose the desired mode

| <font color=#AAAAAA>OSBD</font>name<font color=#AAAAAA>.grp.oni</font>, file prefix and suffix aren't used

| <font color=#AAAAAA>OSBD</font>name<font color=#AAAAAA>.imp.oni</font>, file prefix and suffix aren't used

: PlayOnce – Don't loop this sound; mostly applied to dialogue. A few sound effects have it as well (does this serve a purpose?).

| PreventRepeat - do not play the same permutation twice in a row, if there is more than one permutation

| <[[wikt:permutation#Noun|Permutations]]>

| int32 array for the <Permutation> tags

| <font color=#AAAAAA>SNDD</font>name<font color=#AAAAAA>.oni</font>, file prefix and suffix aren't used

| Here you tell Oni where you want the sound to be located (see [[OBD talk:BINA/OBJC|HERE]] for help with that).

| <font color=#AAAAAA>SNDD</font>name<font color=#AAAAAA>.amb.oni</font>, file prefix and suffix aren't used

Here are the BSL commands you can use for music:<br>

'''sound_music_start name:string [volume:float]''', e.g. <tt><code>sound_music_start mus_asian 0.75</code></tt>

'''sound_music_stop name:string''', e.g. <tt><code>sound_music_stop mus_asian</code></tt><br>

'''sound_music_volume name:string volume:float [time:float]''', e.g. <tt><code>sound_music_volume mus_asian 0.35 1.0</code></tt><br>

# Call <tt>sound_music_stop</tt>.

# Fade out the music with <tt>sound_music_volume</tt> and then call <tt>sound_music_stop</tt> when the music has reached zero volume.

Thus it can be quite a while before the music really stops. If this lag time is a problem, you could:

# Fade out the music over the desired amount of time with <tt>sound_music_volume</tt>. Don't forget to call <tt>sound_music_stop</tt> after the fade-out finishes so that the sound system can stop playing the music.

Oni contains many music OSBDs that come in two variants – with and without the InterruptTracksOnStop flag – such as OSBDmus_amasian.amb and OSBDmus_amasian_hd.amb; they play the same actual SNDDs, but the "_hd" variant has the InterruptTracksOnStop flag. When <tt>sound_music_stop</tt> is called on a "_hd" OSBD, you will hear it immediately jump to the outro, which is slightly jarring but can be useful in some cases. An easily observed example is OSBDmus_fiteb_hd, which plays in {{C2}} when combat starts after the opening cutscene in the lobby. When the last blow is delivered to the last standing Striker, the music will immediately jump to its outro. Any discontinuity in the rhythm is masked by the final attack sound effect, and in fact the hard transition serves to punctuate the end of the action. By contrast, if a track was interrupted in this way during a quiet moment in the game it would probably sound awkwardly abrupt.

==How to register sounds for characters==

'''Let's see how sounds become picked up:'''<br>Schemata:

* The character performs a move/attack where the TRAM file holds a sound ID (<Vocalization>).

* A link (OSBD.amb name) in the ONCC file will be looked up based on the sound ID. Note that the ONCC file has also a probability value that decides whether a sound will be played or not.

* The game engine looks into OSBD.amb and follows the link into OSBD.grp.

* '''OSBD.grp can hold multiple links to SNDD files, called permutations.''' That's why Konoko can have multiple taunt sounds. Each permutation has its own "Weight" which determines its probability of playing. This probability is figured in relation to the total weight of all permutations, so if an OSBD has four permutations and the first one has a <Weight> of 30 and the other three have <Weight>s of 10, the first sound has a 50% chance of being picked. This feature is used to define rare taunts for some characters, such as the [[Comguy]]'s [[Easter eggs|Easter egg]] taunt, "Okay, okay, ''don't'' frog blast the vent core!"

| <CoverProbability> — Play this sounds when afraid (e.g. "Don't hurt me!")

As you can see, Konoko has multiple sounds to choose from.

Oni uses this feature in order to layer one music track over another, but only in one functioning OSBD: '''OSBDmus_xtr2''', the sorrowful string piece which plays in the Shinatama farewell scene in {{C8}} and at the conclusion of Hasegawa's monologue at the start of {{C11}}. The OSBD's use of <BaseTrack1> and <BaseTrack2> leads to the high string note SNDDmus_xtr2hi.aif playing continuously over the melody in SNDDmus_xtr2_[1-6].aif.

The benefit of this live-mix approach is that you can also use the individual tracks in other places, or in combination with a different second track; for instance, '''OSBDmus_choral1''' calls for the same SNDDmus_xtr2_[1-6].aif to be mixed with SNDDmus_choral1.aif (except that SNDDmus_choral1.aif doesn't exist and the OSBD is never called…).