hpl3:game:voicehandler
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
hpl3:game:voicehandler [2014/02/25 12:32] thomas [Sound] |
hpl3:game:voicehandler [2015/09/17 10:53] (current) ian.thomas [File Format] |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| ====== Setup ====== | ====== Setup ====== | ||
| - | Before calling a subject the source of the sound should be set up. This is done with SetVoiceSource() in cVoiceHandler, or better the helper function Voice_SetSource(). This sets up the entity (which can be something moving) which will emit the voice coming from the specified character. It will also set up the distance that the voice can be heard. Do this in OnEnter in the map script file. | + | Before calling a subject the source of the sound should be set up. This is best done inside the VoiceHandler editor itself, but can also be done using the helper function Voice_SetSource(). This sets up the entity (which can be something moving) which will emit the voice coming from the specified character. It will also set up the distance that the voice can be heard. If using the function, it's best to do this in ''OnEnter'' in the map script file. |
| ====== Properties ====== | ====== Properties ====== | ||
| Line 23: | Line 23: | ||
| **EntryType**\\ | **EntryType**\\ | ||
| The type of the sounds (and extrasounds) that are played for this character. Is either World, WorldClean or GUI. | The type of the sounds (and extrasounds) that are played for this character. Is either World, WorldClean or GUI. | ||
| + | |||
| + | **Volume** \\ | ||
| + | Volume of the sound files. Gets multiplied with other volume properties. | ||
| + | |||
| + | **ReverbVolume** \\ | ||
| + | The amount of reverb used for the sounds. Gets multiplied with other ReverbVolume properties. | ||
| Line 37: | Line 43: | ||
| This is the priority for a voice to into focus, meaning that is subtittles are shown and any other voice playing gets its volume lowered. To beat a currently playing voice, FocusPrio must be higher.\\ | This is the priority for a voice to into focus, meaning that is subtittles are shown and any other voice playing gets its volume lowered. To beat a currently playing voice, FocusPrio must be higher.\\ | ||
| When a subject starts playing it is checked if another sound is playing and FocusPrio determines if the new subject gets into focus. Also when a subject stops playing a certain amount of time is waited (default 2 seconds) and then there is a check to see if there is any playing voice that should come into focus. If there are many playing, FocusPrio determines which one. The reason for waiting a litte while is in case there is a conversiation in one scene containing many subjects, and if so it would not sound good if the focus was constantly switched (ie unrelated subtitles popping up for a second). | When a subject starts playing it is checked if another sound is playing and FocusPrio determines if the new subject gets into focus. Also when a subject stops playing a certain amount of time is waited (default 2 seconds) and then there is a check to see if there is any playing voice that should come into focus. If there are many playing, FocusPrio determines which one. The reason for waiting a litte while is in case there is a conversiation in one scene containing many subjects, and if so it would not sound good if the focus was constantly switched (ie unrelated subtitles popping up for a second). | ||
| + | |||
| + | |||
| + | **Volume** \\ | ||
| + | Volume of the sound and effect files. Gets multiplied with other volume properties. | ||
| + | |||
| + | **ReverbVolume** \\ | ||
| + | The amount of reverb used for the sounds. Gets multiplied with other ReverbVolume properties. | ||
| + | |||
| ===== Effect ===== | ===== Effect ===== | ||
| This defines certain effect that should be played on the voice, be that echo, noise or whatnot. \\ | This defines certain effect that should be played on the voice, be that echo, noise or whatnot. \\ | ||
| Line 109: | Line 123: | ||
| **Volume** \\ | **Volume** \\ | ||
| - | Volume of the sound and effect file. | + | Volume of the sound and effect file. Gets multiplied with other volume properties. |
| + | |||
| + | **ReverbVolume** \\ | ||
| + | The amount of reverb used for the sounds. Gets multiplied with other ReverbVolume properties. | ||
| **VoiceOffset** \\ | **VoiceOffset** \\ | ||
| Line 117: | Line 134: | ||
| Number of seconds before the subtitles show up. | Number of seconds before the subtitles show up. | ||
| - | **ExtraSoundOffset** \\ | + | **ExtraEffectOffset** \\ |
| Number of seconds before the effect file starts to play. | Number of seconds before the effect file starts to play. | ||
| - | **ExtraSoundFile** \\ | + | **ExtraEffectFile** \\ |
| File path to an extra sound file that is played along with the voice. | File path to an extra sound file that is played along with the voice. | ||
| - | **EndsAfterExtraSound** \\ | + | **EndsAfterExtraEffect** \\ |
| If the sound should end when the extra sound file is done playing (and not the voice). | If the sound should end when the extra sound file is done playing (and not the voice). | ||
| Line 168: | Line 185: | ||
| INFO: The solution is to use the file on the screw, can have slight hint for that.\\ | INFO: The solution is to use the file on the screw, can have slight hint for that.\\ | ||
| ====== File Format ====== | ====== File Format ====== | ||
| + | |||
| + | (You shouldn't need this - everything can be edited using the VoiceHandler exe!) | ||
| <code xml> | <code xml> | ||
hpl3/game/voicehandler.1393331533.txt.gz · Last modified: 2014/02/25 12:32 by thomas
