Table of Contents

Interface ISoundPlayer

Namespace
Root
Assembly
SPZGameAssembly.dll
public interface ISoundPlayer
Extension Methods

Methods

PlayLoopingSound(SoundEffect, Action<SoundHandle>)

SoundHandle PlayLoopingSound(SoundEffect effect, Action<SoundHandle> onSoundStopped = null)

Parameters

effect SoundEffect
onSoundStopped Action<SoundHandle>

Returns

SoundHandle

PlayLoopingSound(SoundEffect, float, Action<SoundHandle>)

SoundHandle PlayLoopingSound(SoundEffect effect, float pitch, Action<SoundHandle> onSoundStopped = null)

Parameters

effect SoundEffect
pitch float
onSoundStopped Action<SoundHandle>

Returns

SoundHandle

PlayLoopingSound(SoundEffect, float3, Action<SoundHandle>)

SoundHandle PlayLoopingSound(SoundEffect effect, float3 position, Action<SoundHandle> onSoundStopped = null)

Parameters

effect SoundEffect
position float3
onSoundStopped Action<SoundHandle>

Returns

SoundHandle

PlayLoopingSound(SoundEffect, float3, float, Action<SoundHandle>)

SoundHandle PlayLoopingSound(SoundEffect effect, float3 position, float pitch, Action<SoundHandle> onSoundStopped = null)

Parameters

effect SoundEffect
position float3
pitch float
onSoundStopped Action<SoundHandle>

Returns

SoundHandle

PlaySound(SoundEffect, Action<SoundHandle>)

SoundHandle PlaySound(SoundEffect effect, Action<SoundHandle> onSoundStopped = null)

Parameters

effect SoundEffect
onSoundStopped Action<SoundHandle>

Returns

SoundHandle

PlaySound(SoundEffect, Action<SoundHandle>, float, double)

SoundHandle PlaySound(SoundEffect effect, Action<SoundHandle> onSoundStopped, float pitch, double startOffset = 0)

Parameters

effect SoundEffect
onSoundStopped Action<SoundHandle>
pitch float
startOffset double

Returns

SoundHandle

PlaySound(SoundEffect, float3, Action<SoundHandle>)

SoundHandle PlaySound(SoundEffect effect, float3 position, Action<SoundHandle> onSoundStopped = null)

Parameters

effect SoundEffect
position float3
onSoundStopped Action<SoundHandle>

Returns

SoundHandle

PlaySound(SoundEffect, float3, Action<SoundHandle>, float, double)

SoundHandle PlaySound(SoundEffect effect, float3 position, Action<SoundHandle> onSoundStopped, float pitch, double startOffset = 0)

Parameters

effect SoundEffect
position float3
onSoundStopped Action<SoundHandle>
pitch float
startOffset double

Returns

SoundHandle

PlaySoundDelayed(SoundEffect, Action<SoundHandle>, double, double, float)

SoundHandle PlaySoundDelayed(SoundEffect effect, Action<SoundHandle> onSoundStopped, double delay, double startOffset = 0, float pitch = 1)

Parameters

effect SoundEffect
onSoundStopped Action<SoundHandle>
delay double
startOffset double
pitch float

Returns

SoundHandle

PlaySoundDelayed(SoundEffect, float3, Action<SoundHandle>, double, double, float)

SoundHandle PlaySoundDelayed(SoundEffect effect, float3 position, Action<SoundHandle> onSoundStopped, double delay, double startOffset = 0, float pitch = 1)

Parameters

effect SoundEffect
position float3
onSoundStopped Action<SoundHandle>
delay double
startOffset double
pitch float

Returns

SoundHandle

TryStopSound(SoundHandle)

bool TryStopSound(SoundHandle soundHandle)

Parameters

soundHandle SoundHandle

Returns

bool