H7SoundController¶

Class in MMH7Game · MMH7Game.H7SoundController · native, config

Object › H7SoundController

Using it from Lua

h7.find_all("H7SoundController")            -- live instances
h7.find_class("MMH7Game.H7SoundController")   -- the class
h7.hook("MMH7Game.H7SoundController.AdventureMapCellInput", fn)

Properties¶

Name	Type	Notes
`cAmbientSoundSetting`	`bool`	config, protected
`cAmbientSoundVolume`	`float`	config, protected
`cMasterSetting`	`bool`	config, protected
`cMasterVolume`	`float`	globalconfig, protected
`cMusicSetting`	`bool`	config, protected
`cMusicVolume`	`float`	config, protected
`cSoundSetting`	`bool`	config, protected
`cSoundVolume`	`float`	config, protected
`cVoiceOverSetting`	`bool`	config, protected
`cVoiceOverVolume`	`float`	config, protected
`mAcademyTownIsPlaying`	`bool`	protected
`mAdventureController`	`H7AdventureController`	transient, protected
`mBasicAmbientStop`	`AkEvent`	protected
`mBlockMasterUpdate`	`bool`	protected
`mCamera`	`H7Camera`	transient, protected
`mCombatMusic`	`AkEvent`	protected
`mCombatMusicIsPlaying`	`bool`	protected
`mCurrentAmbientEvent`	`AkEvent`	protected
`mCurrentAttenuationDistance`	`float`	protected
`mCurrentMapType`	`string`	protected
`mCurrentMusicEvent`	`AkEvent`	protected
`mCurrentTileName`	`name`	protected
`mCurrentTownScreenFaction`	`string`	protected
`mCurrentUnitUndergroundName`	`name`	protected
`mDefeatMusic`	`AkEvent`	protected
`mDungeonTownIsPlaying`	`bool`	protected
`mExecMusicTargetTime`	`float`	protected
`mFortressTownIsPlaying`	`bool`	protected
`mFoWAmbientEvent`	`AkEvent`	protected
`mHavenTownIsPlaying`	`bool`	protected
`mInCinematicMode`	`bool`	protected
`mIsMusicPlaying`	`bool`	protected
`mLastAmbientEvent`	`AkEvent`	protected
`mLastMusicEvent`	`AkEvent`	protected
`mLastVisitedCell`	`H7AdventureLayerCellProperty`	protected
`mMainMusic`	`AkEvent`	protected
`mMusicDuckingValue`	`float`	protected
`mMusicIsPlaying`	`bool`	protected
`mNecropolisTownIsPlaying`	`bool`	protected
`mNextTurn`	`bool`	protected
`mPauseAllMusic`	`AkEvent`	protected
`mPlayAcademyTownMusic`	`AkEvent`	protected
`mPlayAITurnMusic`	`AkEvent`	protected
`mPlayCreditsMusic`	`AkEvent`	protected
`mPlayDungeonTownMusic`	`AkEvent`	protected
`mPlayedMusicEvents`	`array<AkEvent>`	protected
`mPlayFortressTownMusic`	`AkEvent`	protected
`mPlayHavenTownMusic`	`AkEvent`	protected
`mPlayNecropolisTownMusic`	`AkEvent`	protected
`mPlayStrongholdTownMusic`	`AkEvent`	protected
`mPlaySylvanTownMusic`	`AkEvent`	protected
`mResumeAcademyTownMusic`	`AkEvent`	protected
`mResumeAITurnMusic`	`AkEvent`	protected
`mResumeCombatMusic`	`AkEvent`	protected
`mResumeDungeonTownMusic`	`AkEvent`	protected
`mResumeFortressTownMusic`	`AkEvent`	protected
`mResumeHavenTownMusic`	`AkEvent`	protected
`mResumeMainMusic`	`AkEvent`	protected
`mResumeMusicEvent`	`AkEvent`	protected
`mResumeNecropolisTownMusic`	`AkEvent`	protected
`mResumeStrongholdTownMusic`	`AkEvent`	protected
`mResumeSylvanTownMusic`	`AkEvent`	protected
`mShouldUpdateConfig`	`bool`	protected
`mStopAllCombatMusic`	`AkEvent`	protected
`mStopAllExceptMusic`	`AkEvent`	protected
`mStopAllMusic`	`AkEvent`	protected
`mStrongholdTownIsPlaying`	`bool`	protected
`mSylvanTownIsPlaying`	`bool`	protected
`mVictoryMusic`	`AkEvent`	protected
`mVoiceOverStop`	`AkEvent`	protected

Functions¶

Name	Declaration
`AdventureMapCellInput`	`function AdventureMapCellInput(optional H7AdventureMapCell hoverCell = none)`
`Destroyed`	`singular event Destroyed()`
`EnableAmbientChannel`	`function EnableAmbientChannel(bool Enable)`
`EnableSoundChannel`	`function EnableSoundChannel(bool Enable)`
`EnableSoundCutsceneChannel`	`function EnableSoundCutsceneChannel(bool Enable)`
`EnableVoiceChannel`	`function EnableVoiceChannel(bool Enable)`
`FogOfWarIsRevealedCheck`	`native function bool FogOfWarIsRevealedCheck(optional Vector objectLocation)`
`GetAdventureController`	`native function H7AdventureController GetAdventureController()`
`GetAmbientSoundSettings`	`function bool GetAmbientSoundSettings()`
`GetAmbientSoundVolume`	`function float GetAmbientSoundVolume()`
`GetBasicAmbientStopEvent`	`function AkEvent GetBasicAmbientStopEvent()`
`GetCamera`	`native function H7Camera GetCamera()`
`GetCombatMusic`	`native function AkEvent GetCombatMusic()`
`GetCreditsMusicEvent`	`function AkEvent GetCreditsMusicEvent()`
`GetDefeatMusic`	`native function AkEvent GetDefeatMusic()`
`GetInstance`	`static function H7SoundController GetInstance()`
`GetLastAmbientEvent`	`function AkEvent GetLastAmbientEvent()`
`GetMainMusic`	`native function AkEvent GetMainMusic()`
`GetMainMusicResumeEvent`	`function AkEvent GetMainMusicResumeEvent()`
`GetMasterSettings`	`function bool GetMasterSettings()`
`GetMasterVolumeSettings`	`function float GetMasterVolumeSettings()`
`GetMusicSetting`	`function bool GetMusicSetting()`
`GetMusicVolume`	`function float GetMusicVolume()`
`GetPlayAITurnMusic`	`native function AkEvent GetPlayAITurnMusic()`
`GetResumeAITurnMusic`	`native function AkEvent GetResumeAITurnMusic()`
`GetSoundManager`	`function H7SoundManager GetSoundManager()`
`GetSoundSetting`	`function bool GetSoundSetting()`
`GetSoundVolume`	`function float GetSoundVolume()`
`GetStopAllExceptMusicEvent`	`function AkEvent GetStopAllExceptMusicEvent()`
`GetVictoryMusic`	`native function AkEvent GetVictoryMusic()`
`GetVoiceOverSetting`	`function bool GetVoiceOverSetting()`
`GetVoiceOverStopAllEvent`	`function AkEvent GetVoiceOverStopAllEvent()`
`GetVoiceOverVolume`	`function float GetVoiceOverVolume()`
`InCinematicMode`	`function InCinematicMode(bool val)`
`Initialize`	`function Initialize(optional bool silentSFX = false)`
`LoadingScreenEnabled`	`function LoadingScreenEnabled(bool val)`
`PlayAdventureMapMusic`	`function PlayAdventureMapMusic()`
`PlayGlobalAkEvent`	`static function PlayGlobalAkEvent(AkEvent InSoundCue, optional bool bNotReplicated, optional bool bNoRepToOwner, optional bool bStopWhenOwnerDestroyed, optional Vector SoundLocation, optional bool bNoRepToRelevant)`
`PlayPauseMusic`	`function PlayPauseMusic()`
`PostEvent`	`function PostEvent(AkEvent NewEvent, bool stopWhenOwnerDestroyed)`
`ResetLastAmbientEvent`	`function ResetLastAmbientEvent()`
`ResetLastMusicEvent`	`function ResetLastMusicEvent()`
`ResetMusicVariables`	`function ResetMusicVariables()`
`ResetOptions`	`function ResetOptions()`
`SetAmbientSoundSettings`	`function SetAmbientSoundSettings(bool bVal)`
`SetAmbientSoundSettingsBool`	`function SetAmbientSoundSettingsBool(bool bVal)`
`SetAmbientSoundVolume`	`function SetAmbientSoundVolume(float fVol)`
`SetDistanceAttenuationValue`	`function SetDistanceAttenuationValue(float Value)`
`SetLastAmbientEvent`	`function SetLastAmbientEvent(AkEvent Event)`
`SetMasterSettings`	`function SetMasterSettings(bool bVal)`
`SetMasterVolumeSettings`	`function SetMasterVolumeSettings(float fVol)`
`SetMusicEvents`	`native function SetMusicEvents()`
`SetMusicSetting`	`function SetMusicSetting(bool val)`
`SetMusicVolume`	`function SetMusicVolume(float Value)`
`SetNextTurn`	`function SetNextTurn(bool val)`
`SetShouldUpdateConfig`	`function SetShouldUpdateConfig(bool Value)`
`SetSoundSetting`	`function SetSoundSetting(bool bVal)`
`SetSoundVolume`	`function SetSoundVolume(float Value)`
`SetVoiceOverSetting`	`function SetVoiceOverSetting(bool val)`
`SetVoiceOverVolume`	`function SetVoiceOverVolume(float Value)`
`StartMusicDucking`	`function StartMusicDucking()`
`SwitchTownScreenMusic`	`function SwitchTownScreenMusic(string Faction)`
`UpdateCameraDistanceAttenuation`	`function UpdateCameraDistanceAttenuation(float currentDistance, float cameraMin, float cameraMax)`
`UpdateHearableAmbientSoundNodes`	`event UpdateHearableAmbientSoundNodes()`
`UpdateMasterSetting`	`function UpdateMasterSetting()`
`UpdateMusicGameStateSwitch`	`function UpdateMusicGameStateSwitch(string maptype, optional string Faction)`

Default values¶

mShouldUpdateConfig=true
cMusicSetting=true
cSoundSetting=true
cVoiceOverSetting=true
cMasterSetting=true
cAmbientSoundSetting=true
mMusicDuckingValue=-48.0000000
cMusicVolume=1.0000000
cSoundVolume=1.0000000
cVoiceOverVolume=1.0000000
cMasterVolume=1.0000000
cAmbientSoundVolume=1.0000000

Inherited¶

From	Members
Object	13 properties, 308 functions