Triggers/Category Sound

From SC2Mapster Wiki
Jump to: navigation, search

Scenes[edit | edit source]

Play Sound Scene[edit | edit source]

  • Action. Plays a sound for the specified players, and plays the specified animation on the specified units. The animation on the units will be sync'd up with the sound.

Play Sound Scene File[edit | edit source]

  • Action. Plays a sound with the specified scene file for the specified player group. Scene files can be set up using the Previewer module.

Sound Channels[edit | edit source]

Set All Sound Channel Volumes[edit | edit source]

  • Action. Sets the volume for all sound channels for the specified player group.

Mute/Unmute Sound Channel[edit | edit source]

  • Action. Mutes or unmutes a sound channel for the specified player group.

Pause Sound Channel[edit | edit source]

  • Action. Pauses all sounds in a sound channel for the specified player group.

Set Sound Channel Volume[edit | edit source]

  • Action. Sets a specified sound channel to a volume for the specified player group.

Stop Sound Channel[edit | edit source]

  • Action. Stops all sounds in a sound channel for the specified players.

Sound Properties[edit | edit source]

Mark Sound For Duration Preload[edit | edit source]

  • Action. The duration for the given sound will be preloaded during the loading screen. Any sounds that are explicitly referenced in triggers will automatically be preloaded. The Info parameter must specify a direct sound value, not a variable or function call. Sound lengths marked for duration preload are network-sync'd, allowing them to be safely used for multiplayer.

Query Sound Duration[edit | edit source]

  • Action. Send a network query for the duration of a sound. This will allow the sound duration to be accessed even if the sound duration has not been preloaded. Use "Wait For Sound Durations" to ensure that all results are received before attempting to access the duration value.

Wait For Sound Durations[edit | edit source]

  • Action. Waits until all queries sent with "Query Sound Duration" have been received for all players.

Sound Duration[edit | edit source]

  • Function. Returns the duration of the sound.

Sound Link[edit | edit source]

  • Function. Returns a Sound Link for a given sound ID and asset index. Sound Links are used to refer to specific sounds. Sound links are comprised of a sound ID (to identify the sound data entry) and an asset index (to identify the asset within that data entry).

Sound Asset Index[edit | edit source]

  • Function. Returns the sound asset index for a Sound Link. Sound Links are used to refer to specific sounds. Sound links are comprised of a sound ID (to identify the sound data entry) and an asset index (to identify the asset within that data entry).

Sound ID[edit | edit source]

  • Function. Returns the sound ID for a given Sound Link. Sound Links are used to refer to specific sounds. Sound links are comprised of a sound ID (to identify the sound data entry) and an asset index (to identify the asset within that data entry).

Sound Subtitle Text[edit | edit source]

  • Function. Returns Subtitle text for the given Sound Link.

Sound Settings[edit | edit source]

Set Sound Factors[edit | edit source]

  • Action. Sets sound factors for distance, doppler, and rolloff.

Set Sound Reverb[edit | edit source]

  • Action. Sets sound reverb.

Sounds[edit | edit source]

Last Played Sound[edit | edit source]

  • Function. Returns the last sound played via a "Play Sound" action.

Play Sound[edit | edit source]

  • Action. Plays a sound for the specified player group. Use the "Last Played Sound" function to refer to this sound.

Play Sound At Point[edit | edit source]

  • Action. Plays a sound at a point for the specified player group. Use the "Last Played Sound" function to refer to this sound.

Play Sound On Unit[edit | edit source]

  • Action. Plays a sound at a unit for the specified player group. Use the "Last Played Sound" function to refer to this sound.

Skip To Sound Offset[edit | edit source]

  • Action. Skip to a specific time within a sound.

Move Sound[edit | edit source]

  • Action. Moves a sound to the specified location.

Set Sound Volume[edit | edit source]

  • Action. Sets sound volume.

Stop Sound[edit | edit source]

  • Action. Stops a sound.

Stop All Model Sounds[edit | edit source]

  • Action. Stops all model sounds.

Stop All Trigger Sounds[edit | edit source]

  • Action. Stops all sounds explicitly played through triggers.

Wait For Sound[edit | edit source]

  • Action. Waits for a sound is a certain amount of seconds from the offset type.

Soundtracks[edit | edit source]

Set Default Soundtrack[edit | edit source]

  • Action. Sets the default soundtrack. The default soundtrack will play when there are no other soundtracks being played.

Pause Soundtrack[edit | edit source]

  • Action. Pauses a soundtrack for the specified player group.

Play Soundtrack[edit | edit source]

  • Action. Plays a soundtrack for the specified player group. If the Make Default parameter is set to Do, then the default soundtrack will be set to this soundtrack. If this soundtrack is not continuous, it will repeat from the beginning when it ends, after the delay time.

Enable/Disable Soundtrack Continuous[edit | edit source]

  • Action. Sets a soundtrack to play once or play continuously.

Set Soundtrack Delay[edit | edit source]

  • Action. Sets the amount of time between when one soundtrack finishes and another one begins.

Enable/Disable Soundtrack Shuffle[edit | edit source]

  • Action. Enables or disables cue and/or index shuffling for a soundtrack. Index shuffling corresponds to the asset array in the sound data. Cue shuffling corresponds to the array of sounds in each soundtrack data.

Stop Soundtrack[edit | edit source]

  • Action. Stops a soundtrack for the specified player group.

Wait For Soundtrack[edit | edit source]

  • Action. Waits for soundtrack playback to end.