FSoundConcurrencySettings Struct Reference

Public Member Functions
Functions
bool	GetbLimitToOwner () const
	Whether or not to limit the concurrency to per sound owner (i.e. the actor that plays the sound). If the sound doesn't have an owner, it falls back to global concurrency.
void	SetbLimitToOwner (bool Value)
	Whether or not to limit the concurrency to per sound owner (i.e. the actor that plays the sound). If the sound doesn't have an owner, it falls back to global concurrency.
bool	GetbVolumeScaleCanRelease () const
	Whether or not volume scaling can recover volume ducking behavior when concurrency group sounds stop (default scale mode only).
void	SetbVolumeScaleCanRelease (bool Value)
	Whether or not volume scaling can recover volume ducking behavior when concurrency group sounds stop (default scale mode only).
FSoundConcurrencySettings &	opAssign (FSoundConcurrencySettings Other)

Public Attributes
Concurrency
EMaxConcurrentResolutionRule	ResolutionRule
	Which concurrency resolution policy to use if max voice count is reached.
float32	RetriggerTime
	Amount of time to wait (in seconds) between different sounds which play with this concurrency. Sounds rejected from this will ignore virtualization settings.
int	MaxCount
	The max number of allowable concurrent active voices for voices playing in this concurrency group.
Voice Stealing
float32	VoiceStealReleaseTime
	Time taken to fade out if voice is evicted or culled due to another voice in the group starting.
Volume Scaling
EConcurrencyVolumeScaleMode	VolumeScaleMode
	Volume Scale mode designating how to scale voice volume based on number of member sounds active in group.
float32	VolumeScaleReleaseTime
	Time taken to recover volume scalar duck.
float32	VolumeScale
	Ducking factor to apply per older voice instance (generation), which compounds based on scaling mode and (optionally) revives them as they stop according to the provided attack/release times.
float32	VolumeScaleAttackTime
	Time taken to apply duck using volume scalar.
Variables
bool	bVolumeScaleCanRelease
bool	bLimitToOwner

Member Function Documentation

GetbLimitToOwner()

bool GetbLimitToOwner

(

)

const

Whether or not to limit the concurrency to per sound owner (i.e. the actor that plays the sound). If the sound doesn't have an owner, it falls back to global concurrency.

GetbVolumeScaleCanRelease()

bool GetbVolumeScaleCanRelease

(

)

const

Whether or not volume scaling can recover volume ducking behavior when concurrency group sounds stop (default scale mode only).

opAssign()

FSoundConcurrencySettings & opAssign

(

FSoundConcurrencySettings

Other

)

SetbLimitToOwner()

void SetbLimitToOwner

(

bool

Value

)

Whether or not to limit the concurrency to per sound owner (i.e. the actor that plays the sound). If the sound doesn't have an owner, it falls back to global concurrency.

SetbVolumeScaleCanRelease()

void SetbVolumeScaleCanRelease

(

bool

Value

)

Whether or not volume scaling can recover volume ducking behavior when concurrency group sounds stop (default scale mode only).

Member Data Documentation

bLimitToOwner

bool bLimitToOwner

bVolumeScaleCanRelease

bool bVolumeScaleCanRelease

MaxCount

int MaxCount

The max number of allowable concurrent active voices for voices playing in this concurrency group.

ResolutionRule

EMaxConcurrentResolutionRule ResolutionRule

Which concurrency resolution policy to use if max voice count is reached.

RetriggerTime

float32 RetriggerTime

Amount of time to wait (in seconds) between different sounds which play with this concurrency. Sounds rejected from this will ignore virtualization settings.

VoiceStealReleaseTime

float32 VoiceStealReleaseTime

Time taken to fade out if voice is evicted or culled due to another voice in the group starting.

VolumeScale

float32 VolumeScale

Ducking factor to apply per older voice instance (generation), which compounds based on scaling mode and (optionally) revives them as they stop according to the provided attack/release times.

Note: This is not applied until after StopQuietest rules are evaluated, in order to avoid thrashing sounds.

AppliedVolumeScale = Math.Pow(DuckingScale, VoiceGeneration)

VolumeScaleAttackTime

float32 VolumeScaleAttackTime

Time taken to apply duck using volume scalar.

VolumeScaleMode

EConcurrencyVolumeScaleMode VolumeScaleMode

Volume Scale mode designating how to scale voice volume based on number of member sounds active in group.

VolumeScaleReleaseTime

float32 VolumeScaleReleaseTime

Time taken to recover volume scalar duck.