This contains the source code documentation of the class DialogicNode_TypeSounds
.
DialogicNode_TypeSounds
Inherits: AudioStreamPlayer
Node that allows playing sounds when text characters are revealed. Should be the child of a DialogicNode_DialogText node!
Properties
Name | Type | Default |
---|---|---|
enabled | bool | true |
mode | int | 0 |
sounds | AudioStream[] | [] |
end_sound | AudioStream | |
play_every_character | int | 1 |
pitch_variance | float | 0.0 |
volume_variance | float | 0.0 |
ignore_characters | String | " .," |
characters_since_last_sound | int | 0 |
base_pitch | float | pitch_scale |
base_volume | float | volume_db |
RNG | RandomNumberGenerator | new() |
current_overwrite_data | Dictionary | {} |
Methods
Returns | Method |
---|---|
void | load_overwrite ( dictionary : Dictionary ) |
AudioStream[] | load_sounds_from_path ( path : String ) |
Constants
No description available.
No description available.
No description available.
Property Descriptions
Usefull if you want to change the sounds of different node's sounds
If true, interrupts the current sound to play a new one
Array of sounds. Will pick a random one each time.
A sound to be played as the last sound.
Determines how many characters are between each sound. Default is 1 for playing it every character.
Allows changing the pitch by a random value from (pitch - pitch_variance) to (pitch + pitch_variance)
Allows changing the volume by a random value from (volume - volume_variance) to (volume + volume_variance)
Characters that don't increase the 'characters_since_last_sound' variable, useful for the space or fullstop
var characters_since_last_sound = 0
No description available.
No description available.
No description available.
No description available.
var current_overwrite_data = {}
No description available.
Method Descriptions
func load_overwrite ( dictionary
: Dictionary ) ⇒ void
No description available.
func load_sounds_from_path ( path
: String ) ⇒ AudioStream[]
No description available.