Wrapper class for managing sound through SEffectManager. More...

Inheritance diagram for EffectSound:

Protected Member Functions
EffectType
Information about what type of effect the Effect is, without the need for casting
override EffectType	GetEffectType ()
	Get what type of effect the Effect is.
override bool	IsSound ()
	Check whether the Effect is EffectSound without casting.
Playback
Methods to Play/Stop sound Generally, SEffectManager.PlaySound methods are used instead of SoundPlay
bool	SoundPlayEx (out SoundParams params)
	Plays sound.
bool	SoundPlay ()
	Plays sound.
override void	Start ()
	Plays sound.
void	SoundStop ()
	Stops sound.
override void	Stop ()
	Stops sound.
void	SoundReset ()
	Resets EffectSound.
bool	IsSoundPlaying ()
	Get whether EffectSound is currently playing.
override bool	IsPlaying ()
	Returns true when the effect is playing, false otherwise.
Sound load
Methods regarding the loading of the sound, used in SoundPlay
bool	SoundLoadEx (out SoundParams params)
	Loads in the sound when it is requested for playing through 'SoundPlayEx'.
bool	SoundLoad ()
	Loads in the sound when it is requested for playing.
bool	IsSoundValid ()
	Helper for checking if params are valid.
void	ValidateSoundWave ()
	Gets called to fill in the necessary data when the header has finished loading.
bool	SoundWaveValidation ()
	Validation of fade settings.
void	UpdateEvents ()
	Enables the frame event on the EffectSound.
Events
Various events that can be overriden for custom behaviour
override void	Event_OnFrameUpdate (float time_delta)
	Event called on frame when enabled by SetEnableEventFrame(true).
override void	Event_OnRegistered (int id)
	Event called from SEffectManager when the Effect is registered.
override void	Event_OnUnregistered ()
	Event called from SEffectManager when the Effect is unregistered.
void	Event_OnSoundWaveStarted ()
	Event called when sound starts playing.
void	Event_OnSoundWaveEnded ()
	Event called when sound stops playing.
void	Event_OnSoundFadeInStopped ()
	Event called when sound fade in stops.
void	Event_OnSoundFadeOutStarted ()
	Event called when sound fade out starts.
AutoDestroy
Methods regarding automatic cleanup on stop
override void	SetAutodestroy (bool auto_destroy)
	Sets whether Effect automatically cleans up when it stops.
override bool	IsAutodestroy ()
	Get whether Effect automatically cleans up when it stops.
void	SetSoundAutodestroy (bool auto_destroy)
	Sets whether EffectSound automatically cleans up when sound stops.
bool	IsSoundAutodestroy ()
	Get whether EffectSound automatically cleans up when sound stops.
override bool	CanDestroy ()
Generic API
Setters and getters for generic data and properties
override void	SetParent (Object parent_obj, int pivot)
	Set parent for the sound to follow.
override Object	GetParent ()
	Get parent for the EffectSound.
override int	GetPivotIndex ()
	Get parent pivot of the Effect, only valid when there is some GetParent.
override Object	GetCurrentParent ()
	Get parent for the EffectSound.
override void	SetCurrentPosition (vector pos, bool updateCached=true)
	Set the world position of the managed sound.
override vector	GetCurrentPosition ()
	Get the current world position of the managed sound.
override void	SetCurrentLocalPosition (vector pos, bool updateCached=true)
	Set the current local position of the managed sound.
override vector	GetCurrentLocalPosition ()
	Get the current local position of the managed sound.
void	SetSoundWaveKind (WaveKind wave_kind)
	Set WaveKind for the sound.
void	SetSoundSet (string snd)
	Set soundset for the sound.
string	GetSoundSet ()
	Get soundset for the sound.
void	SetSoundLoop (bool loop)
	Set if the sound loops.
void	SetEnviromentVariables (bool setEnvVariables)
	Sets whether AddEnvSoundVariables needs to be called during Loading.
float	GetSoundWaveLenght ()
	Get the sound wave length.
float	GetSoundWaveLength ()
	Get the sound wave length.
void	SetSoundVolume (float volume)
	Set the RELATIVE volume for the sound.
float	GetSoundVolume ()
	Get the RELATIVE volume set by 'SetSoundVolume'.
void	SetSoundMaxVolume (float volume)
	Set the sound max volume.
float	GetSoundWaveTime ()
	Get the time since EffectSound started playing.
void	SetSoundFadeIn (float fade_in)
	Set the sound fade in duration.
void	SetSoundFadeOut (float fade_out)
	Set the sound fade out duration.
void	SetDoppler (bool setDoppler)
	Set if the sound has the doppler effect enabled.
void	SoundError (string err_msg)
	Helper for throwing sound errors.

Protected Attributes
Sound objects and structures
Objects and structures for the sound
ref SoundParams	m_SoundParams
ref SoundObjectBuilder	m_SoundObjectBuilder
ref SoundObject	m_SoundObject
AbstractWave	m_SoundWaveObject
Generic data
Generic data for the sound
WaveKind	m_SoundWaveKind
string	m_SoundSetName
bool	m_SoundLoop
bool	m_SetEnvVariables
bool	m_SoundAutodestroy
bool	m_SoundWaveIsPlaying
float	m_SoundWaveLenght
float	m_SoundWaveVolume
float	m_SoundWaveVolumeMax
float	m_SoundWaveTime
int	m_SoundDoppler

Private Attributes
Event invokers
ScriptInvonkers for certain events
ref ScriptInvoker	Event_OnSoundWaveStarted = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveEnded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundFadeInStopped = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundFadeOutStarted = new ScriptInvoker()

Fading data
Data for fadein/fadeout for the sound
bool	m_SoundWaveStarting
bool	m_SoundWaveStopping
bool	m_SoundFadedOut
float	m_SoundFadeInDuration
float	m_SoundFadeOutStartTime
float	m_SoundFadeOutDuration
float	m_SoundFadeOutInitVolume
void	EffectSound ()
	ctor
void	~EffectSound ()
	dtor
override void	InitEffect ()
	init
override string	GetDebugName ()
	Override when getting debug information.

Detailed Description

Wrapper class for managing sound through SEffectManager.

Definition at line 4 of file effectsound.c.

Constructor & Destructor Documentation

◆ EffectSound()

void EffectSound ( )

inlineprotected

ctor

Definition at line 63 of file effectsound.c.

References m_SoundAutodestroy, m_SoundDoppler, m_SoundFadedOut, m_SoundWaveKind, m_SoundWaveStopping, m_SoundWaveVolume, and m_SoundWaveVolumeMax.

◆ ~EffectSound()

void ~EffectSound ( )

inlineprotected

dtor

Definition at line 77 of file effectsound.c.

Member Function Documentation

◆ CanDestroy()

override bool CanDestroy ( )

inlineprotected

Definition at line 636 of file effectsound.c.

References m_SoundFadeOutDuration, and m_SoundWaveIsPlaying.

◆ Event_OnFrameUpdate()

override void Event_OnFrameUpdate ( float time_delta )

inlineprotected

Event called on frame when enabled by SetEnableEventFrame(true).

Note: Is always enabled on sound; Called from SEffectManager.Event_OnFrameUpdate in MissionGameplay.OnUpdate

Parameters

time_delta float Time passed since the previous frame

Definition at line 460 of file effectsound.c.

References Event_OnSoundFadeInStopped, Event_OnSoundFadeOutStarted, GetSoundVolume(), IsSoundPlaying(), m_SoundDoppler, m_SoundFadedOut, m_SoundFadeInDuration, m_SoundFadeOutDuration, m_SoundFadeOutInitVolume, m_SoundWaveObject, m_SoundWaveStarting, m_SoundWaveStopping, m_SoundWaveTime, m_SoundWaveVolumeMax, and SetSoundVolume().

◆ Event_OnRegistered()

override void Event_OnRegistered ( int id )

inlineprotected

Event called from SEffectManager when the Effect is registered.

Note: Should only ever be called by SEffectManager!

Parameters

id	`int` ID registered in SEffectManager

Definition at line 527 of file effectsound.c.

References Event_OnSoundWaveEnded, and SEffectManager::Event_OnSoundWaveEnded().

◆ Event_OnSoundFadeInStopped()

void Event_OnSoundFadeInStopped ( )

inlineprotected

Event called when sound fade in stops.

Note: Called from Event_OnFrameUpdate

Definition at line 575 of file effectsound.c.

References Event_OnSoundFadeInStopped.

◆ Event_OnSoundFadeOutStarted()

void Event_OnSoundFadeOutStarted ( )

inlineprotected

Event called when sound fade out starts.

Note: Called from Event_OnFrameUpdate

Definition at line 584 of file effectsound.c.

References Event_OnSoundFadeOutStarted.

◆ Event_OnSoundWaveEnded()

void Event_OnSoundWaveEnded ( )

inlineprotected

Event called when sound stops playing.

Note: Inserted into events of m_SoundWaveObject

Definition at line 562 of file effectsound.c.

References Event_OnEffectEnded, Event_OnSoundWaveEnded, and m_SoundWaveIsPlaying.

◆ Event_OnSoundWaveStarted()

void Event_OnSoundWaveStarted ( )

inlineprotected

Event called when sound starts playing.

Note: Inserted into events of m_SoundWaveObject

Definition at line 549 of file effectsound.c.

References Event_OnEffectStarted, Event_OnSoundWaveStarted, and m_SoundWaveIsPlaying.

◆ Event_OnUnregistered()

override void Event_OnUnregistered ( )

inlineprotected

Event called from SEffectManager when the Effect is unregistered.

Note: Should only ever be called by SEffectManager!

Definition at line 538 of file effectsound.c.

References Event_OnSoundWaveEnded, and SEffectManager::Event_OnSoundWaveEnded().

◆ GetCurrentLocalPosition()

override vector GetCurrentLocalPosition ( )

inlineprotected

Get the current local position of the managed sound.

Returns: vector The current local position of the managed sound

Definition at line 756 of file effectsound.c.

References GetLocalPosition(), GetParent(), GetPosition(), m_SoundObject, and vector::Zero.

Referenced by SoundPlayEx().

◆ GetCurrentParent()

override Object GetCurrentParent ( )

inlineprotected

Get parent for the EffectSound.

Note: There is no real parenting with sound, so the setters and getters for parents do the exact same

Returns: Object The parent for the EffectSound

Definition at line 694 of file effectsound.c.

References m_SoundObject.

◆ GetCurrentPosition()

override vector GetCurrentPosition ( )

inlineprotected

Get the current world position of the managed sound.

Returns: vector The current world position of the managed sound

Definition at line 726 of file effectsound.c.

References GetPosition(), m_ParentObject, and m_SoundObject.

◆ GetDebugName()

override string GetDebugName ( )

inlineprotected

Override when getting debug information.

Definition at line 97 of file effectsound.c.

References string::Format(), and m_SoundSetName.

◆ GetEffectType()

override EffectType GetEffectType ( )

inlineprotected

Get what type of effect the Effect is.

Returns: EffectType What type of effect the Effect is

Definition at line 123 of file effectsound.c.

◆ GetParent()

override Object GetParent ( )

inlineprotected

Get parent for the EffectSound.

Returns: Object The parent for the EffectSound

Definition at line 668 of file effectsound.c.

References m_SoundObject.

Referenced by GetCurrentLocalPosition(), and SetCurrentPosition().

◆ GetPivotIndex()

override int GetPivotIndex ( )

inlineprotected

Get parent pivot of the Effect, only valid when there is some GetParent.

Warning: Only gets the cached variable

Returns: int The parent pivot of the Effect

Definition at line 681 of file effectsound.c.

References m_SoundObject.

◆ GetSoundSet()

string GetSoundSet ( )

inlineprotected

Get soundset for the sound.

Returns: string Name of the soundset

Definition at line 803 of file effectsound.c.

References m_SoundSetName.

◆ GetSoundVolume()

float GetSoundVolume ( )

inlineprotected

Get the RELATIVE volume set by 'SetSoundVolume'.

Returns: float The relative volume for the sound set by 'SetSoundVolume'

Definition at line 863 of file effectsound.c.

References m_SoundWaveVolume.

Referenced by Event_OnFrameUpdate().

◆ GetSoundWaveLenght()

float GetSoundWaveLenght ( )

inlineprotected

Get the sound wave length.

Note: Legacy, exists for backwards compatibility

Returns: float The sound wave length

Definition at line 834 of file effectsound.c.

References GetSoundWaveLength().

◆ GetSoundWaveLength()

float GetSoundWaveLength ( )

inlineprotected

Get the sound wave length.

Returns: float The sound wave length

Definition at line 843 of file effectsound.c.

References m_SoundWaveLenght.

Referenced by GetSoundWaveLenght(), and SoundWaveValidation().

◆ GetSoundWaveTime()

float GetSoundWaveTime ( )

inlineprotected

Get the time since EffectSound started playing.

Warning: May not reflect the actual time of the sound, as it can start at negative time to simulate speed of sound

Returns: float The time since EffectSound started playing

Definition at line 886 of file effectsound.c.

References m_SoundWaveTime.

◆ InitEffect()

override void InitEffect ( )

inlineprotected

init

Definition at line 85 of file effectsound.c.

References Event_OnEffectEnded, Event_OnEffectStarted, Event_OnStarted, and Event_OnStopped.

◆ IsAutodestroy()

override bool IsAutodestroy ( )

inlineprotected

Get whether Effect automatically cleans up when it stops.

Returns: bool Whether Effect automatically cleans up when it stops

Definition at line 613 of file effectsound.c.

References IsSoundAutodestroy().

◆ IsPlaying()

override bool IsPlaying ( )

inlineprotected

Returns true when the effect is playing, false otherwise.

Definition at line 282 of file effectsound.c.

References IsSoundPlaying().

◆ IsSound()

override bool IsSound ( )

inlineprotected

Check whether the Effect is EffectSound without casting.

Returns: bool Whether the Effect is EffectSound

Definition at line 132 of file effectsound.c.

◆ IsSoundAutodestroy()

bool IsSoundAutodestroy ( )

inlineprotected

Get whether EffectSound automatically cleans up when sound stops.

Returns: bool Whether EffectSound automatically cleans up when sound stops

Definition at line 631 of file effectsound.c.

References m_SoundAutodestroy.

Referenced by IsAutodestroy().

◆ IsSoundPlaying()

bool IsSoundPlaying ( )

inlineprotected

Get whether EffectSound is currently playing.

Returns: bool Whether EffectSound is currently playing

Definition at line 274 of file effectsound.c.

References m_SoundWaveIsPlaying.

Referenced by Event_OnFrameUpdate(), IsPlaying(), Car::PlaySoundEx(), and SoundStop().

◆ IsSoundValid()

bool IsSoundValid ( )

inlineprotected

Helper for checking if params are valid.

Definition at line 356 of file effectsound.c.

References m_SoundParams.

◆ SetAutodestroy()

override void SetAutodestroy ( bool auto_destroy )

inlineprotected

Sets whether Effect automatically cleans up when it stops.

Note: This means that it will be unregistered from SEffectManager as well

Parameters

auto_destroy bool Whether Effect automatically cleans up when it stops

Definition at line 603 of file effectsound.c.

References m_SoundAutodestroy.

Referenced by Car::CreateSoundForAnimationSource(), CGame::DelayedMidAirDetonation(), ManBase::EEHitByRemote(), House::EEInit(), Car::HandleEngineSound(), Land_WarheadStorage_Main::OnDoorCloseFinish(), Land_WarheadStorage_Main::OnDoorOpenStart(), Weapon::OnFireModeChange(), ManBase::OnPlayerRecievedHit(), Land_WarheadStorage_Main::OnPowerOnClient(), CGame::OnRPC(), OnSteppedOn(), Land_WarheadStorage_PowerStation::OnVariablesSynchronized(), OnVariablesSynchronized(), InventoryItemSuper::OnWasAttached(), InventoryItemSuper::OnWasDetached(), SpookyEventBase::Perform(), ActionBuildShelter::PlayActionFinishSound(), ActionBuildShelter::PlayActionStartSound(), InventoryItem::PlayAttachSound(), PlayItemSoundClient(), Land_WarheadStorage_PowerStation::PlayLeverSound(), BoatScript::PlaySound(), PlaySoundActivate(), TrapBase::PlaySoundBiteEmpty(), TrapBase::PlaySoundBiteLeg(), Car::PlaySoundEx(), TrapBase::PlaySoundOpen(), IEntity::PlaySoundSet(), SetSoundAutodestroy(), Entity::SoundHardBushFallingPlay(), Entity::SoundHardTreeFallingPlay(), Entity::SoundSoftBushFallingPlay(), Entity::SoundSoftTreeFallingPlay(), and StopEmptyingLoopSound().

◆ SetCurrentLocalPosition()

override void SetCurrentLocalPosition	(	vector	pos,
		bool	updateCached = true )

inlineprotected

Set the current local position of the managed sound.

Parameters

pos	`vector` The current local position for the managed sound
updateCached	`bool` Whether to update the cached variable

Definition at line 742 of file effectsound.c.

References m_SoundObject.

Referenced by SoundPlayEx().

◆ SetCurrentPosition()

override void SetCurrentPosition	(	vector	pos,
		bool	updateCached = true )

inlineprotected

Set the world position of the managed sound.

Parameters

pos	`vector` The world position of the managed sound
updateCached	`bool` Whether to update the cached variable

Definition at line 707 of file effectsound.c.

References GetParent(), and m_SoundObject.

◆ SetDoppler()

void SetDoppler ( bool setDoppler )

inlineprotected

Set if the sound has the doppler effect enabled.

Parameters

setDoppler float If the doppler effect is enabled

bool is a fancy int, ensure the bool is 0 or 1 and don't allow -1 here since resetting isn't supported

Definition at line 913 of file effectsound.c.

References m_SoundDoppler.

◆ SetEnviromentVariables()

void SetEnviromentVariables ( bool setEnvVariables )

inlineprotected

Sets whether AddEnvSoundVariables needs to be called during Loading.

Parameters

setEnvVariables bool Whether AddEnvSoundVariables is called

Definition at line 824 of file effectsound.c.

References m_SetEnvVariables.

Referenced by SEffectManager::CreateSound().

◆ SetParent()

override void SetParent	(	Object	parent_obj,
		int	pivot )

inlineprotected

Set parent for the sound to follow.

Parameters

parent_obj Object The parent for the sound to follow

Definition at line 654 of file effectsound.c.

References m_SoundObject.

Referenced by Car::CreateSoundForAnimationSource(), Car::HandleEngineSound(), and SEffectManager::PlaySoundOnObject().

◆ SetSoundAutodestroy()

void SetSoundAutodestroy ( bool auto_destroy )

inlineprotected

Sets whether EffectSound automatically cleans up when sound stops.

Parameters

auto_destroy bool Whether EffectSound automatically cleans up when sound stops

Definition at line 622 of file effectsound.c.

References SetAutodestroy().

◆ SetSoundFadeIn()

void SetSoundFadeIn ( float fade_in )

inlineprotected

Set the sound fade in duration.

Parameters

fade_in float The fade in duration

Definition at line 895 of file effectsound.c.

References m_SoundFadeInDuration.

Referenced by SEffectManager::CreateSound(), and CarScript::OnAnimationPhaseStarted().

◆ SetSoundFadeOut()

void SetSoundFadeOut ( float fade_out )

inlineprotected

Set the sound fade out duration.

Parameters

fade_out float The fade out duration

Definition at line 904 of file effectsound.c.

References m_SoundFadeOutDuration.

Referenced by SEffectManager::CreateSound(), Car::HandleEngineSound(), CarScript::OnAnimationPhaseStarted(), and StopItemSoundClient().

◆ SetSoundLoop()

void SetSoundLoop ( bool loop )

inlineprotected

Set if the sound loops.

Parameters

loop	`bool` Whether the sound should loop

Definition at line 812 of file effectsound.c.

References m_SoundLoop, and m_SoundWaveObject.

Referenced by SEffectManager::CreateSound(), and ValidateSoundWave().

◆ SetSoundMaxVolume()

void SetSoundMaxVolume ( float volume )

inlineprotected

Set the sound max volume.

Warning: Seems to purely be used for fade in effect, rather than really setting the max volume...; Adjusts the current volume to this value as well

Parameters

volume float The maximum volume for the sound

Definition at line 874 of file effectsound.c.

References m_SoundWaveObject, m_SoundWaveVolume, and m_SoundWaveVolumeMax.