Skip to content

Commit 78cf1dc

Browse files
committed
Formatting and typo fixes
1 parent 87d78a5 commit 78cf1dc

File tree

1 file changed

+16
-12
lines changed
  • modules/ROOT/pages/Development/Satisfactory

1 file changed

+16
-12
lines changed

modules/ROOT/pages/Development/Satisfactory/Audio.adoc

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,7 @@ otherwise it will continue to play with no way to stop it.
296296

297297
image:Satisfactory/Wwise/Wwise_UEAkEvent_EndPlay.png[Wwise_UEAkEvent_EndPlay, 100%]
298298

299+
[id="UpdateWwiseRTPCValues"]
299300
=== Updating Wwise Values From Your Mod
300301

301302
Wwise uses a feature called Real-Time Parameter Control (RTPC) that allows game engines like Unreal or Unity to change values on Wwise assets in real-time.
@@ -439,13 +440,15 @@ combobox ranging from 0.0 to 1.0 and multiplying it with the other relevant volu
439440
Unreal's play sound nodes take volume as a float parameter.
440441
Follow the steps in the main Volume Options section to combine the relevant volume slider values to obtain the final input volume.
441442

442-
== Creating a new volume slider
443+
=== Volume with Wwise
443444

444445
The game's master volume slider is automatically applied to any sounds played through Wwise.
445446

446447
You will need to create your own volume slider to be able to control Wwise audio for your mod.
447448

448-
=== Creating the Volume slider data asset
449+
== Creating a Modded Wwise Volume Slider
450+
451+
=== Create the Volume Slider Data Asset
449452

450453
To add a new volume slider to the games user settings you will need to create a new `FGUserSetting` Data Asset
451454

@@ -459,25 +462,25 @@ image:Satisfactory/Wwise/Wwise_Volume/Wwise_Volume_UE_DataAsset_Settings.png[Wwi
459462

460463
* **Str Id**: The user setting id (Recommend using RTPC.Menu_Volume_<ModName>)
461464
* **Display Name**: The display name that will appear on the options menu.
465+
This should include the friendly name of your mod so users can tell what mod added the setting.
462466
* **Tool Tip**: Give a descriptive tool tip for the slider.
463467
* **Category Class**: Set this to `USC_Audio`
464-
* **Sub Category Class**: Set this to relevant sub category (Search for USubC_Audio_)
465-
* **Menu Priority**: Set this to a high value to not interfer with the games options e.g. 50+
468+
* **Sub Category Class**: Set this to relevant sub category (Search for `USubC_Audio_`)
469+
* **Menu Priority**: Set this to a high value to not interfere with the game's options e.g. 50+
466470
* **Apply Type**: Set this to `FGUserSettingApplyType_UpdateInstantly`
467471
* **Value Selector**: Set this to what is presented in the image above.
468472
* **Manager Type Availability**: Set this to `FGGameUserSettings`
469473
* **Show In Builds**: Set this to `PublicBuilds`
470474

471475
This will add a slider to the audio options menu. Now you need to bind the slider to the Wwise sounds.
472476

473-
=== Creating the Wwise Audio Bus
477+
=== Create the Wwise Audio Bus
474478

475479
Create a new audio bus in Wwise by going to the `Audio` tab.
476480
Go to `Master-Mixer Hierarchy` -> `Default Work Unit` -> `Master Audio Bus` Right click and `New Child` -> `Audio Bus`
477481

478482
image:Satisfactory/Wwise/Wwise_Volume/Wwise_Volume_Wwise_CreateAudioBus.png[Wwise_Volume_Wwise_CreateAudioBus, 700]
479483

480-
481484
Set the name to anything that you want.
482485

483486
Now link the audio bus to the Wwise audio:
@@ -490,14 +493,15 @@ Select the new Audio Bus.
490493

491494
=== Create the RTPC for the Audio Bus
492495

493-
Create a new RTPC in Wwise using the documentation above: link:#_updating_wwise_values_from_your_mod[Updating Wwise Values From Your Mod].
496+
Create a new RTPC in Wwise using the documentation above:
497+
link:#UpdateWwiseRTPCValues[Updating Wwise Values From Your Mod].
494498

495499
[IMPORTANT]
496500
====
497501
Make sure that the RTPC min/max values are 0.0 -> 1.0
498502
====
499503

500-
Name the RTPC something like `RTPC_<ModName>_Volume`
504+
Name the RTPC something like `RTPC_<ModReference>_Volume`
501505

502506
=== Link the RTPC to the Audio Bus
503507

@@ -506,7 +510,7 @@ Go to the `Audio` tab in Wwise and click on the new Audio Bus that you created.
506510
Click the first `>>` and select `Bus Volume`
507511
Click the second `>>` and go to `Game Parameters` then select the newly created RTPC
508512

509-
You should then have the following graph going from 0 to 1
513+
You should then have the following graph going from 0 to 1:
510514

511515
image:Satisfactory/Wwise/Wwise_Volume/Wwise_Volume_Wwise_LinkAudioBus.png[Wwise_Volume_Wwise_LinkAudioBus, 700]
512516

@@ -518,10 +522,10 @@ image:Satisfactory/Wwise/Wwise_UE_RTPC_Create.png[Wwise_UE_RTPC_Create, 700]
518522

519523
Name the RTPC in Unreal Engine exactly the same as what you named in Wwise.
520524

521-
In your `GameWorldModule` as part of the construction stage link the slider to the RTPC using the following:
525+
Add code to your `GameWorldModule` as part of the construction stage to link the slider to the RTPC using the following:
522526

523527
image:Satisfactory/Wwise/Wwise_Volume/Wwise_Volume_UE_LinkRTPC.png[Wwise_Volume_UE_LinkRTPC, 700]
524528

525-
Once this has been done you should see the volume slider in the audio options:
529+
Once this has been done you should see the volume slider in the game's audio options:
526530

527-
image:Satisfactory/Wwise/Wwise_Volume/Wwise_Volume_GamePreview.png[Wwise_Volume_GamePreview, 700]
531+
image:Satisfactory/Wwise/Wwise_Volume/Wwise_Volume_GamePreview.png[Wwise_Volume_GamePreview, 700]

0 commit comments

Comments
 (0)