🟧
Sounds Good Documentation
Español
Español
  • ¡Bienvenido!
  • PRIMEROS PASOS
    • Crea tu primer sonido
  • Crea y usa salidas de audio
  • Prefabs incluidos
  • Actualizar de 1.0 a 2.0
  • DOCUMENTACIÓN
    • Assemblies y Namespaces
    • Prefijos
    • Objetos de audio
      • Sound
        • Propiedades
        • Métodos
      • Music
        • Propiedades
        • Métodos
      • Playlist
        • Propiedades
        • Métodos
      • DynamicMusic
        • Propiedades
        • Métodos
    • Ventanas de editor
      • Audio Creator
      • Audio Collection
      • Output Manager
    • SoundsGoodManager
  • Extras
    • Créditos
    • Agradecimientos
Powered by GitBook
On this page
  • 📌 Tabla resumen
  • 📘 Descripción detallada
  • Sound Sound()
  • Sound Sound(SFX sfx)
  • Sound Sound(string tag)
  • Sound SetVolume(float volume)
  • Sound SetHearDistance(float minHearDistance, float maxHearDistance)
  • Sound SetVolumeRolloffCurve(VolumeRolloffCurve curve)
  • Sound SetCustomVolumeRolloffCurve(AnimationCurve customCurve)
  • void ChangeVolume(float newVolume, float lerpTime)
  • Sound SetPitch(float pitch)
  • Sound SetRandomPitch()
  • Sound SetRandomPitch(Vector2 pitchRange)
  • Sound SetDopplerLevel(float dopplerLevel)
  • Sound SetId(string id)
  • Sound SetLoop(bool loop)
  • Sound SetClip(string tag)
  • Sound SetClip(SFX sfx)
  • Sound SetRandomClip(bool random)
  • Sound SetClipByIndex(int index)
  • Sound SetPlayProbability(float probability)
  • Sound SetPosition(Vector3 position)
  • Sound SetFollowTarget(Transform followTarget)
  • Sound SetSpatialSound(bool activate)
  • Sound SetFadeOut(float fadeOutTime)
  • Sound SetOutput(Output output)
  • Sound OnPlay(Action onPlay)
  • Sound OnComplete(Action onComplete)
  • Sound OnLoopCycleComplete(Action onLoopCycleComplete)
  • Sound OnPause(Action onPause)
  • Sound OnPauseComplete(Action onPauseComplete)
  • Sound OnResume(Action onResume)
  • void Play(float fadeInTime)
  • void Pause(float fadeOutTime)
  • void Resume(float fadeInTime)
  • void Stop(float fadeOutTime)
  1. DOCUMENTACIÓN
  2. Objetos de audio
  3. Sound

Métodos

📌 Tabla resumen

Método
Tipo
Descripción breve

Sound()

Sound

Constructor vacío.

Sound(SFX)

Sound

Constructor a partir de un enumerador SFX.

Sound(string)

Sound

Constructor a partir de un tag registrado.

SetVolume(float)

Sound

Establece el volumen inicial (0 – 1).

SetHearDistance(float, float)

Sound

Define distancias mínima y máxima de audición.

SetVolumeRolloffCurve(VolumeRolloffCurve)

Sound

Selecciona curva de atenuación logarítmica o lineal.

SetCustomVolumeRolloffCurve(AnimationCurve)

Sound

Aplica una curva de atenuación personalizada.

ChangeVolume(float, float)

void

Modifica el volumen en reproducción (con lerp opcional).

SetPitch(float)

Sound

Aplica un pitch fijo.

SetRandomPitch()

Sound

Aplica un pitch aleatorio entre 0.85 y 1.15.

SetRandomPitch(Vector2)

Sound

Pitch aleatorio dentro de un rango personalizado.

SetDopplerLevel(float)

Sound

Ajusta la intensidad del efecto Doppler.

SetId(string)

Sound

Asigna un identificador único al sonido.

SetLoop(bool)

Sound

Activa o desactiva el bucle infinito.

SetClip(string)

Sound

Asigna un clip por tag.

SetClip(SFX)

Sound

Asigna un clip por enumerador SFX.

SetRandomClip(bool)

Sound

Activa o desactiva la selección aleatoria de clips.

SetClipByIndex(int)

Sound

Fija un clip concreto por índice.

SetPlayProbability(float)

Sound

Probabilidad (0–1) de reproducirse al llamar a Play().

SetPosition(Vector3)

Sound

Define la posición 3D de la fuente.

SetFollowTarget(Transform)

Sound

Hace que la fuente siga a un objeto.

SetSpatialSound(bool)

Sound

Activa o desactiva el sonido espacial (3D).

SetFadeOut(float)

Sound

Define la duración del fade-out.

SetOutput(Output)

Sound

Envía el audio a una salida (AudioMixerGroup).

OnPlay(Action)

Sound

Callback al iniciar reproducción.

OnComplete(Action)

Sound

Callback al finalizar o detener.

OnLoopCycleComplete(Action)

Sound

Callback al completar un ciclo de loop.

OnPause(Action)

Sound

Callback al pausar el sonido.

OnPauseComplete(Action)

Sound

Callback tras el fade-out de pausa.

OnResume(Action)

Sound

Callback al reanudar.

Play(float)

void

Reproduce el sonido (fade-in opcional).

Pause(float)

void

Pausa con fade-out opcional.

Resume(float)

void

Reanuda con fade-in opcional.

Stop(float)

void

Detiene con fade-out opcional.


📘 Descripción detallada

Sound Sound()

Constructor vacío. Debe configurarse un clip o tag antes de llamar a Play().


Sound Sound(SFX sfx)

Construye el sonido usando el enumerador SFX generado por Audio Creator.


Sound Sound(string tag)

Construye el sonido a partir del tag registrado en Audio Creator.


Sound SetVolume(float volume)

Fija el volumen inicial (0 = silencio, 1 = máximo).


Sound SetHearDistance(float minHearDistance, float maxHearDistance)

Define la distancia a la que el sonido se oye al 100 % y la distancia a la que comienza a oírse.


Sound SetVolumeRolloffCurve(VolumeRolloffCurve curve)

Selecciona la curva Logarithmic o Linear para atenuar el volumen con la distancia.


Sound SetCustomVolumeRolloffCurve(AnimationCurve customCurve)

Permite usar una AnimationCurve propia para la atenuación.


void ChangeVolume(float newVolume, float lerpTime)

Modifica el volumen mientras suena. Con lerpTime > 0 la transición es suave.


Sound SetPitch(float pitch)

Cambia tono y velocidad de reproducción.


Sound SetRandomPitch()

Aplica automáticamente un pitch aleatorio entre 0.85 y 1.15.


Sound SetRandomPitch(Vector2 pitchRange)

Especifica un rango personalizado para el pitch aleatorio.


Sound SetDopplerLevel(float dopplerLevel)

Ajusta la intensidad del efecto Doppler (0 – 5).


Sound SetId(string id)

Asigna un identificador único a esta instancia para gestionarla mediante el SoundsGoodManager sin necesidad de una referencia directa.


Sound SetLoop(bool loop)

Activa (true) o desactiva (false) la reproducción en bucle.


Sound SetClip(string tag)

Asigna un clip usando su tag creado en Audio Creator.


Sound SetClip(SFX sfx)

Asigna un clip utilizando directamente el enumerador SFX.


Sound SetRandomClip(bool random)

Si está activo, seleccionará un clip aleatorio cada vez que se invoque Play().


Sound SetClipByIndex(int index)

Selecciona un clip concreto (por índice) dentro del grupo de clips asociados al tag.


Sound SetPlayProbability(float probability)

Establece la probabilidad (0 – 1) de que el sonido se reproduzca al llamar a Play().


Sound SetPosition(Vector3 position)

Define la posición en el espacio desde la que se emitirá el sonido.


Sound SetFollowTarget(Transform followTarget)

Hace que la fuente de audio siga en tiempo real el Transform indicado.


Sound SetSpatialSound(bool activate)

true → sonido 3D; false → sonido global (2D).


Sound SetFadeOut(float fadeOutTime)

Duración del desvanecimiento al detenerse o finalizar el clip.


Sound SetOutput(Output output)

Envía el sonido a un canal concreto gestionado por un Audio Mixer.


Sound OnPlay(Action onPlay)

Se dispara cuando el sonido comienza a reproducirse.


Sound OnComplete(Action onComplete)

Se dispara cuando el sonido termina o se detiene manualmente.


Sound OnLoopCycleComplete(Action onLoopCycleComplete)

Se ejecuta al completar cada ciclo si loop está activo.


Sound OnPause(Action onPause)

Callback inmediato al pausar el sonido.


Sound OnPauseComplete(Action onPauseComplete)

Se dispara tras finalizar el fade-out de la pausa.


Sound OnResume(Action onResume)

Callback al reanudar después de la pausa.


void Play(float fadeInTime)

Reproduce el sonido. Con fadeInTime > 0 se aplica un fade-in.


void Pause(float fadeOutTime)

Pausa el sonido; si fadeOutTime > 0, reduce gradualmente el volumen antes de pausar.


void Resume(float fadeInTime)

Reanuda la reproducción desde la pausa, aplicando fade-in si se indica.


void Stop(float fadeOutTime)

Detiene la reproducción. Si fadeOutTime > 0, realiza un fade-out; si es 0, se detiene de inmediato.


PreviousPropiedadesNextMusic

Last updated 18 days ago