Soundscape

A soundscape controller.

Methods

Soundscape:AddSting(soundName, instances, distance, frequency)

View source »

Adds a Sting, this is a sound that repeats at intervals.

Parameters

  • soundName string

    The sound file path.

  • instances int

    The number of occurances this has, this basically is equivalent to adding several stingers of the same sound.

  • distance int

    The distance this sound will play from the player.

  • frequency int

    The frequency this'll play in seconds.

Soundscape:GenerateTimerHash()

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

View source »

Used to generate timers for a soundscape.

Returns

Soundscape:Play()

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

View source »

Plays the soundscape.

Soundscape:Stop()

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

View source »

Stops the soundscape.