Sound

Description

Syntax

Parameters

name:

Name of the sound effect (without .wav/.ogg extension). Wildcards as used by WildcardMatch are used.

global:

[opt] Specifies wether the sound is played globally, i.e. independently of the object position always with the same loudness.

volume:

[opt] 0-100: volume for playback of the sound. A volume value of nil means playback at 100.

player:

[opt] Player number of the player for which the sound is to be played. In network games, the sound will thus not be audible for the other players. If nil (or not specified), the sound will be played for all players.

loop_count:

[opt] Increases or decreases the number of sounds running in a continuous loop. Value +1 will play this sound indefinitely until it is stopped by calling this function again with value -1. Value 0 will play the sound once normally.

custom_falloff_distance:

[opt] The further away the sound effect from the player, the more quiet it is played. By default, the sound will not be hearable anymore in a distance of 700 pixels. A custom distance can be specified here.

pitch:

[opt] Pitch modification between -90 and 1000. Values larger than zero let the sound play the faster and at a higher pitch. The resulting speed multiplication factor is (pitch + 100) / 100.

modifier:

[opt] Sound modifier for special effects such as reverb or echo. See Sound modifiers.

Remark

Example

FindObject(Find_ID(WindGenerator))->Sound("Fanfare", false, 50);