SCR_BaseAudioScriptedUserAction Class Reference

A scripted action class having optional logic for playing audio as well as checking if the faction is valid. More...

Inheritance diagram for SCR_BaseAudioScriptedUserAction:

Protected Member Functions
	if (SCR_StringHelper.IsEmptyOrWhiteSpace(m_sActionSoundEffectEventName)) return
	if (soundComponent)
	if (SCR_StringHelper.IsEmptyOrWhiteSpace(m_sActionSoundEffectFile)) return
	if (!soundManager) return
	if (!audioSource) return
soundManager	PlayAudioSource (audioSource)

Protected Attributes
string	m_sActionSoundEffectEventName
ResourceName	m_sActionSoundEffectFile
SoundComponent	soundComponent = SoundComponent.Cast(pOwnerEntity.FindComponent(SoundComponent))
SCR_SoundManagerModule	soundManager = SCR_SoundManagerModule.GetInstance(pOwnerEntity.GetWorld())
SCR_AudioSourceConfiguration	audioConfig = new SCR_AudioSourceConfiguration()
audioConfig	m_sSoundProject = m_sActionSoundEffectFile
audioConfig	m_sSoundEventName = m_sActionSoundEffectEventName
audioConfig	m_eFlags = SCR_Enum.RemoveFlag(audioConfig.m_eFlags, EAudioSourceConfigurationFlag.Static)
SCR_AudioSource	audioSource = soundManager.CreateAudioSource(pOwnerEntity, audioConfig, GetWorldPositionAction())

Detailed Description

A scripted action class having optional logic for playing audio as well as checking if the faction is valid.

Definition at line 2 of file SCR_BaseAudioScriptedUserAction.c.

Member Function Documentation

if() [1/5]

SCR_BaseAudioScriptedUserAction::if ( ! audioSource )

protected

if() [2/5]

SCR_BaseAudioScriptedUserAction::if ( ! soundManager )

protected

if() [3/5]

SCR_BaseAudioScriptedUserAction::if ( SCR_StringHelper. IsEmptyOrWhiteSpacem_sActionSoundEffectEventName )

protected

if() [4/5]

SCR_BaseAudioScriptedUserAction::if ( SCR_StringHelper. IsEmptyOrWhiteSpacem_sActionSoundEffectFile )

protected

if() [5/5]

SCR_BaseAudioScriptedUserAction::if ( soundComponent )

inlineprotected

Definition at line 29 of file SCR_BaseAudioScriptedUserAction.c.

PlayAudioSource()

soundManager SCR_BaseAudioScriptedUserAction::PlayAudioSource ( audioSource )

protected

Member Data Documentation

audioConfig

SCR_AudioSourceConfiguration SCR_BaseAudioScriptedUserAction::audioConfig = new SCR_AudioSourceConfiguration()

protected

Definition at line 52 of file SCR_BaseAudioScriptedUserAction.c.

audioSource

SCR_AudioSource SCR_BaseAudioScriptedUserAction::audioSource = soundManager.CreateAudioSource(pOwnerEntity, audioConfig, GetWorldPositionAction())

protected

Definition at line 58 of file SCR_BaseAudioScriptedUserAction.c.

m_eFlags

audioConfig SCR_BaseAudioScriptedUserAction::m_eFlags = SCR_Enum.RemoveFlag(audioConfig.m_eFlags, EAudioSourceConfigurationFlag.Static)

protected

Definition at line 55 of file SCR_BaseAudioScriptedUserAction.c.

m_sActionSoundEffectEventName

string SCR_BaseAudioScriptedUserAction::m_sActionSoundEffectEventName

protected

Definition at line 5 of file SCR_BaseAudioScriptedUserAction.c.

m_sActionSoundEffectFile

ResourceName SCR_BaseAudioScriptedUserAction::m_sActionSoundEffectFile

protected

Definition at line 8 of file SCR_BaseAudioScriptedUserAction.c.

m_sSoundEventName

audioConfig SCR_BaseAudioScriptedUserAction::m_sSoundEventName = m_sActionSoundEffectEventName

protected

Definition at line 54 of file SCR_BaseAudioScriptedUserAction.c.

m_sSoundProject

audioConfig SCR_BaseAudioScriptedUserAction::m_sSoundProject = m_sActionSoundEffectFile

protected

Definition at line 53 of file SCR_BaseAudioScriptedUserAction.c.

soundComponent

SoundComponent SCR_BaseAudioScriptedUserAction::soundComponent = SoundComponent.Cast(pOwnerEntity.FindComponent(SoundComponent))

protected

Definition at line 26 of file SCR_BaseAudioScriptedUserAction.c.

soundManager

SCR_SoundManagerModule SCR_BaseAudioScriptedUserAction::soundManager = SCR_SoundManagerModule.GetInstance(pOwnerEntity.GetWorld())

protected

Definition at line 47 of file SCR_BaseAudioScriptedUserAction.c.

---

The documentation for this class was generated from the following file:

• scripts/Game/UserActions/SCR_BaseAudioScriptedUserAction.c