PC Stable Documentation
 
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Private Member Functions | Private Attributes
DynamicMusicPlayer Class Reference

Private Member Functions

void DynamicMusicPlayer (DynamicMusicPlayerRegistry configuration)
 
void OnUpdate (float timeslice)
 
void SetCategory (EDynamicMusicPlayerCategory category, bool forced)
 
void RegisterDynamicLocation (notnull Entity caller, int locationType, float locationSize)
 
void UnregisterDynamicLocation (notnull Entity caller)
 
void OnGameEvent (EventType eventTypeId, Param params)
 
protected bool IsPriotitizedCategorySelected ()
 
protected void DetermineTrackByCategory (EDynamicMusicPlayerCategory category)
 
protected bool IsPlaybackActive ()
 
protected void OnProfileOptionChanged (EDayZProfilesOptions option, int value)
 
protected void OnCategorySet (EDynamicMusicPlayerCategory category, bool forced)
 
protected void OnTrackEnded ()
 
protected void OnTrackStopped ()
 
protected void OnNextTrackSelected (DynamicMusicTrackData track, float waitTime)
 
protected void OnLocationMatched (EDynamicMusicPlayerCategory category, bool isPriorityLocation)
 
protected void OnFadeoutFinished (EDynamicMusicPlayerCategory category)
 
private void PlayTrack (DynamicMusicTrackData track)
 
private void StopTrack ()
 
private void ResetWaitingQueue ()
 
private void FadeoutTrack (float fadeoutSeconds)
 
private void ProcessFadeOut ()
 
private bool PlayerInsideOfLocationFilter (array< ref DynamicMusicTrackData > locations)
 
private bool PlayerInsideOfLocationFilter (map< int, ref DynamicMusicLocationDynamicData > locations)
 
private bool SetSelectedTrackFromCategory (EDynamicMusicPlayerCategory category, notnull array< ref DynamicMusicTrackData > tracklist, int historyLookupType=DynamicMusicPlayerTrackHistoryLookupType.ANY)
 
private int SelectRandomTrackIndexFromCategoryPriorityFlagFirst (EDynamicMusicPlayerCategory category, notnull array< ref DynamicMusicTrackData > tracks)
 
private int SelectRandomTrackIndexFromCategory (EDynamicMusicPlayerCategory category, int lookupType, notnull array< ref DynamicMusicTrackData > tracks)
 
private void SetTimeOfDate ()
 
protected float GetWaitTimeForCategory (EDynamicMusicPlayerCategory category)
 
private float GetMinWaitTimePerCategory (EDynamicMusicPlayerCategory category)
 
private float GetMaxWaitTimePerCategory (EDynamicMusicPlayerCategory category)
 
private float GetPreviousTrackFadeoutSeconds (EDynamicMusicPlayerCategory category)
 
private void RefreshTracksCache ()
 

Private Attributes

protected const float TICK_TIME_OF_DATE_UPDATE_SECONDS = 300.0
 
protected const float TICK_LOCATION_CACHE_UPDATE_SECONDS = 120.0
 
protected const float TICK_LOCATION_UPDATE_SECONDS = 120.0
 
protected const float TICK_PRIORITY_LOCATION_UPDATE_SECONDS = 30.0
 
protected const float TICK_FADEOUT_PROCESSOR_SECONDS = 0.2
 
protected const int TRACKS_BUFFER_HISTORY_SIZE = 2
 
protected const float LOCATION_DISTANCE_MAX = 500
 
protected float m_TickTimeOfDateElapsed
 
protected float m_TickLocationCacheUpdateElapsed
 
protected float m_TickLocationUpdateElapsed
 
protected float m_TickPriorityLocationUpdateElapsed
 
protected float m_TickFadeOutProcessingElapsed
 
protected int m_ActualTimeOfDay protected EDynamicMusicPlayerCategory m_CategorySelected
 
protected DynamicMusicTrackData m_CurrentTrack
 
protected ref DynamicMusicPlayerRegistry m_DynamicMusicPlayerRegistry
 
protected ref map< int, ref DynamicMusicLocationDynamicData > m_LocationsDynamic private ref array< ref DynamicMusicTrackData > m_TracksLocationStaticCached
 map of dynamically registered locations during runtime
 
private ref array< ref DynamicMusicTrackData > m_TracksLocationStaticPrioritizedCached
 static + filtered by the distance between player and center of zone
 
protected ref array< ref DynamicMusicTrackData > m_TracksLocationMatchedPlayerInside
 static prio + filtered by the distance between player and center of zone
 
protected AbstractWave m_SoundPlaying
 
private bool m_WaitingForPlayback
 
private int m_RequestedPlaybackMode private ref map< EDynamicMusicPlayerCategory, ref SimpleCircularBuffer< int > > m_LastPlayedTrackBufferPerCategory
 gets the playback mode as set in sounds menu; 0 - all; 1 - menu only
 
private vector m_PlayerPosition
 
private float m_FadeoutTimeElapsed
 
private float m_FadeoutTimeRequested
 
private bool m_FadeoutInProgress
 
private bool m_Created
 

Constructor & Destructor Documentation

◆ DynamicMusicPlayer()

void DynamicMusicPlayer ( DynamicMusicPlayerRegistry  configuration)
inlineprivate

fadeout settings

References CALL_CATEGORY_SYSTEM, g_Game, ScriptInvoker::Insert(), m_CategorySelected, m_Created, m_DynamicMusicPlayerRegistry, m_FadeoutTimeElapsed, m_FadeoutTimeRequested, m_LastPlayedTrackBufferPerCategory, DayZProfilesOptions::m_OnIntOptionChanged, m_TracksLocationMatchedPlayerInside, m_TracksLocationStaticCached, m_TracksLocationStaticPrioritizedCached, OnProfileOptionChanged(), RefreshTracksCache(), SetTimeOfDate(), and TRACKS_BUFFER_HISTORY_SIZE.

Member Function Documentation

◆ DetermineTrackByCategory()

protected void DetermineTrackByCategory ( EDynamicMusicPlayerCategory  category)
inlineprivate

References CALL_CATEGORY_SYSTEM, DetermineTrackByCategory(), g_Game, IsPlaybackActive(), m_CategorySelected, m_DynamicMusicPlayerRegistry, DynamicMusicPlayerRegistry::m_TracksLocationDynamic, m_TracksLocationMatchedPlayerInside, DynamicMusicPlayerRegistry::m_TracksMenu, DynamicMusicPlayerRegistry::m_TracksTime, and SetSelectedTrackFromCategory().

Referenced by DetermineTrackByCategory(), OnCategorySet(), and OnUpdate().

◆ FadeoutTrack()

private void FadeoutTrack ( float  fadeoutSeconds)
inlineprivate

References m_CurrentTrack, m_FadeoutInProgress, m_FadeoutTimeRequested, m_SoundPlaying, and DynamicMusicTrackData::m_SoundSet.

Referenced by OnLocationMatched().

◆ GetMaxWaitTimePerCategory()

private float GetMaxWaitTimePerCategory ( EDynamicMusicPlayerCategory  category)
inlineprivate

References m_DynamicMusicPlayerRegistry, and DynamicMusicPlayerRegistry::m_SettingsByCategory.

Referenced by GetWaitTimeForCategory().

◆ GetMinWaitTimePerCategory()

private float GetMinWaitTimePerCategory ( EDynamicMusicPlayerCategory  category)
inlineprivate

References m_DynamicMusicPlayerRegistry, and DynamicMusicPlayerRegistry::m_SettingsByCategory.

Referenced by GetWaitTimeForCategory().

◆ GetPreviousTrackFadeoutSeconds()

private float GetPreviousTrackFadeoutSeconds ( EDynamicMusicPlayerCategory  category)
inlineprivate

References m_DynamicMusicPlayerRegistry, and DynamicMusicPlayerRegistry::m_SettingsByCategory.

Referenced by OnLocationMatched().

◆ GetWaitTimeForCategory()

protected float GetWaitTimeForCategory ( EDynamicMusicPlayerCategory  category)
inlineprivate

References GetMaxWaitTimePerCategory(), GetMinWaitTimePerCategory(), and Math::RandomFloatInclusive().

Referenced by SetSelectedTrackFromCategory().

◆ IsPlaybackActive()

protected bool IsPlaybackActive ( )
inlineprivate

References m_SoundPlaying, and m_WaitingForPlayback.

Referenced by DetermineTrackByCategory(), and OnUpdate().

◆ IsPriotitizedCategorySelected()

protected bool IsPriotitizedCategorySelected ( )
inlineprivate

References m_CategorySelected.

Referenced by OnFadeoutFinished(), OnLocationMatched(), and OnUpdate().

◆ OnCategorySet()

protected void OnCategorySet ( EDynamicMusicPlayerCategory  category,
bool  forced 
)
inlineprivate

References DetermineTrackByCategory(), and EnumTools::EnumToString().

Referenced by SetCategory().

◆ OnFadeoutFinished()

protected void OnFadeoutFinished ( EDynamicMusicPlayerCategory  category)
inlineprivate

References IsPriotitizedCategorySelected(), m_SoundPlaying, OnTrackEnded(), SetCategory(), and StopTrack().

Referenced by OnUpdate().

◆ OnGameEvent()

void OnGameEvent ( EventType  eventTypeId,
Param  params 
)
inlineprivate

References MPSessionPlayerReadyEventTypeID, SetCategory(), and SetTimeOfDate().

◆ OnLocationMatched()

protected void OnLocationMatched ( EDynamicMusicPlayerCategory  category,
bool  isPriorityLocation 
)
inlineprivate

play prio location track (no fadeout)

play location track (no fadeout)

References FadeoutTrack(), GetPreviousTrackFadeoutSeconds(), IsPriotitizedCategorySelected(), m_CategorySelected, m_SoundPlaying, m_WaitingForPlayback, ResetWaitingQueue(), and SetCategory().

Referenced by OnUpdate().

◆ OnNextTrackSelected()

protected void OnNextTrackSelected ( DynamicMusicTrackData  track,
float  waitTime 
)
inlineprivate

References CALL_CATEGORY_SYSTEM, g_Game, m_Created, m_CurrentTrack, DynamicMusicTrackData::m_SoundSet, m_WaitingForPlayback, and PlayTrack().

Referenced by SetSelectedTrackFromCategory().

◆ OnProfileOptionChanged()

protected void OnProfileOptionChanged ( EDayZProfilesOptions  option,
int  value 
)
inlineprivate

Events

References m_CategorySelected, ResetWaitingQueue(), and StopTrack().

Referenced by DynamicMusicPlayer().

◆ OnTrackEnded()

protected void OnTrackEnded ( )
inlineprivate

References m_CurrentTrack, m_SoundPlaying, DynamicMusicTrackData::m_SoundSet, and m_WaitingForPlayback.

Referenced by OnFadeoutFinished(), and PlayTrack().

◆ OnTrackStopped()

protected void OnTrackStopped ( )
inlineprivate

stopped only by fadeouts

References m_CurrentTrack, m_SoundPlaying, DynamicMusicTrackData::m_SoundSet, and m_WaitingForPlayback.

Referenced by PlayTrack().

◆ OnUpdate()

void OnUpdate ( float  timeslice)
inlineprivate

handle fadeouts

caching of locations based on distance from player (<= LOCATION_DISTANCE_MAX)

no playback at all OR playback of non-prioritized category

works as default category selector

menu only

References DetermineTrackByCategory(), g_Game, DiagMenu::GetBool(), IsPlaybackActive(), IsPriotitizedCategorySelected(), m_CategorySelected, m_DynamicMusicPlayerRegistry, m_FadeoutInProgress, m_FadeoutTimeElapsed, m_FadeoutTimeRequested, m_PlayerPosition, m_TickFadeOutProcessingElapsed, m_TickLocationCacheUpdateElapsed, m_TickLocationUpdateElapsed, m_TickPriorityLocationUpdateElapsed, m_TickTimeOfDateElapsed, m_TracksLocationStaticCached, m_TracksLocationStaticPrioritizedCached, OnFadeoutFinished(), OnLocationMatched(), PlayerInsideOfLocationFilter(), ProcessFadeOut(), RefreshTracksCache(), SetCategory(), SetTimeOfDate(), TICK_FADEOUT_PROCESSOR_SECONDS, TICK_LOCATION_CACHE_UPDATE_SECONDS, TICK_LOCATION_UPDATE_SECONDS, TICK_PRIORITY_LOCATION_UPDATE_SECONDS, and TICK_TIME_OF_DATE_UPDATE_SECONDS.

◆ PlayerInsideOfLocationFilter() [1/2]

private bool PlayerInsideOfLocationFilter ( array< ref DynamicMusicTrackData >  locations)
inlineprivate

References INDEX_NOT_FOUND, Math::IsPointInRectangle(), m_PlayerPosition, m_TracksLocationMatchedPlayerInside, and Math2D().

Referenced by OnUpdate().

◆ PlayerInsideOfLocationFilter() [2/2]

private bool PlayerInsideOfLocationFilter ( map< int, ref DynamicMusicLocationDynamicData >  locations)
inlineprivate

References Math::IsPointInRectangle(), and m_PlayerPosition.

◆ PlayTrack()

private void PlayTrack ( DynamicMusicTrackData  track)
inlineprivate

register callbacks

invalid sound set is used

References GetGame(), CGame::GetSoundScene(), m_CurrentTrack, m_SoundPlaying, DynamicMusicTrackData::m_SoundSet, m_WaitingForPlayback, OnTrackEnded(), OnTrackStopped(), AbstractSoundScene::Play2D(), SoundObject::SetKind(), SoundObjectBuilder(), and SoundParams().

Referenced by OnNextTrackSelected(), and ResetWaitingQueue().

◆ ProcessFadeOut()

private void ProcessFadeOut ( )
inlineprivate

References m_FadeoutTimeElapsed, m_FadeoutTimeRequested, and m_SoundPlaying.

Referenced by OnUpdate().

◆ RefreshTracksCache()

private void RefreshTracksCache ( )
inlineprivate

References Math::CenterOfRectangle(), vector::Distance(), LOCATION_DISTANCE_MAX, m_DynamicMusicPlayerRegistry, m_PlayerPosition, DynamicMusicPlayerRegistry::m_TracksLocationStatic, m_TracksLocationStaticCached, DynamicMusicPlayerRegistry::m_TracksLocationStaticPrioritized, and m_TracksLocationStaticPrioritizedCached.

Referenced by DynamicMusicPlayer(), and OnUpdate().

◆ RegisterDynamicLocation()

void RegisterDynamicLocation ( notnull Entity  caller,
int  locationType,
float  locationSize 
)
inlineprivate

References DynamicMusicLocationDynamicData::GetRectangularCoordsFromSize(), DynamicMusicLocationDynamicData::m_Max, DynamicMusicLocationDynamicData::m_Min, and DynamicMusicLocationDynamicData::m_Type.

◆ ResetWaitingQueue()

private void ResetWaitingQueue ( )
inlineprivate

References CALL_CATEGORY_SYSTEM, g_Game, m_CurrentTrack, m_WaitingForPlayback, and PlayTrack().

Referenced by OnLocationMatched(), and OnProfileOptionChanged().

◆ SelectRandomTrackIndexFromCategory()

private int SelectRandomTrackIndexFromCategory ( EDynamicMusicPlayerCategory  category,
int  lookupType,
notnull array< ref DynamicMusicTrackData >  tracks 
)
inlineprivate

References INDEX_NOT_FOUND, m_LastPlayedTrackBufferPerCategory, Math::RandomInt(), and TRACKS_BUFFER_HISTORY_SIZE.

Referenced by SetSelectedTrackFromCategory().

◆ SelectRandomTrackIndexFromCategoryPriorityFlagFirst()

private int SelectRandomTrackIndexFromCategoryPriorityFlagFirst ( EDynamicMusicPlayerCategory  category,
notnull array< ref DynamicMusicTrackData >  tracks 
)
inlineprivate

main menu priority tracks first

fallback in case there is no priority track

References INDEX_NOT_FOUND.

Referenced by SetSelectedTrackFromCategory().

◆ SetCategory()

void SetCategory ( EDynamicMusicPlayerCategory  category,
bool  forced 
)
inlineprivate

References m_CategorySelected, m_DynamicMusicPlayerRegistry, and OnCategorySet().

Referenced by OnFadeoutFinished(), OnGameEvent(), OnLocationMatched(), and OnUpdate().

◆ SetSelectedTrackFromCategory()

private bool SetSelectedTrackFromCategory ( EDynamicMusicPlayerCategory  category,
notnull array< ref DynamicMusicTrackData >  tracklist,
int  historyLookupType = DynamicMusicPlayerTrackHistoryLookupType.ANY 
)
inlineprivate

currently prioritize main menu track on DMP start

References GetWaitTimeForCategory(), INDEX_NOT_FOUND, m_Created, m_LastPlayedTrackBufferPerCategory, OnNextTrackSelected(), SelectRandomTrackIndexFromCategory(), and SelectRandomTrackIndexFromCategoryPriorityFlagFirst().

Referenced by DetermineTrackByCategory().

◆ SetTimeOfDate()

private void SetTimeOfDate ( )
inlineprivate

References g_Game.

Referenced by DynamicMusicPlayer(), OnGameEvent(), and OnUpdate().

◆ StopTrack()

private void StopTrack ( )
inlineprivate

References m_SoundPlaying.

Referenced by OnFadeoutFinished(), and OnProfileOptionChanged().

◆ UnregisterDynamicLocation()

void UnregisterDynamicLocation ( notnull Entity  caller)
inlineprivate

Field Documentation

◆ LOCATION_DISTANCE_MAX

protected const float LOCATION_DISTANCE_MAX = 500
private

Referenced by RefreshTracksCache().

◆ m_CategorySelected

protected int m_ActualTimeOfDay protected EDynamicMusicPlayerCategory m_CategorySelected
private

Referenced by DetermineTrackByCategory(), DynamicMusicPlayer(), IsPriotitizedCategorySelected(), OnLocationMatched(), OnProfileOptionChanged(), OnUpdate(), and SetCategory().

◆ m_Created

private bool m_Created
private

Referenced by DynamicMusicPlayer(), OnNextTrackSelected(), and SetSelectedTrackFromCategory().

◆ m_CurrentTrack

protected DynamicMusicTrackData m_CurrentTrack
private

Referenced by FadeoutTrack(), OnNextTrackSelected(), OnTrackEnded(), OnTrackStopped(), PlayTrack(), and ResetWaitingQueue().

◆ m_DynamicMusicPlayerRegistry

protected ref DynamicMusicPlayerRegistry m_DynamicMusicPlayerRegistry
private

Referenced by DetermineTrackByCategory(), DynamicMusicPlayer(), GetMaxWaitTimePerCategory(), GetMinWaitTimePerCategory(), GetPreviousTrackFadeoutSeconds(), OnUpdate(), RefreshTracksCache(), and SetCategory().

◆ m_FadeoutInProgress

private bool m_FadeoutInProgress
private

Referenced by FadeoutTrack(), and OnUpdate().

◆ m_FadeoutTimeElapsed

private float m_FadeoutTimeElapsed
private

Referenced by DynamicMusicPlayer(), OnUpdate(), and ProcessFadeOut().

◆ m_FadeoutTimeRequested

private float m_FadeoutTimeRequested
private

Referenced by DynamicMusicPlayer(), FadeoutTrack(), OnUpdate(), and ProcessFadeOut().

◆ m_LastPlayedTrackBufferPerCategory

private int m_RequestedPlaybackMode private ref map<EDynamicMusicPlayerCategory, ref SimpleCircularBuffer<int> > m_LastPlayedTrackBufferPerCategory
private

gets the playback mode as set in sounds menu; 0 - all; 1 - menu only

Referenced by DynamicMusicPlayer(), SelectRandomTrackIndexFromCategory(), and SetSelectedTrackFromCategory().

◆ m_PlayerPosition

private vector m_PlayerPosition
private

Referenced by OnUpdate(), PlayerInsideOfLocationFilter(), PlayerInsideOfLocationFilter(), and RefreshTracksCache().

◆ m_SoundPlaying

protected AbstractWave m_SoundPlaying
private

Referenced by FadeoutTrack(), IsPlaybackActive(), OnFadeoutFinished(), OnLocationMatched(), OnTrackEnded(), OnTrackStopped(), PlayTrack(), ProcessFadeOut(), and StopTrack().

◆ m_TickFadeOutProcessingElapsed

protected float m_TickFadeOutProcessingElapsed
private

Referenced by OnUpdate().

◆ m_TickLocationCacheUpdateElapsed

protected float m_TickLocationCacheUpdateElapsed
private

Referenced by OnUpdate().

◆ m_TickLocationUpdateElapsed

protected float m_TickLocationUpdateElapsed
private

Referenced by OnUpdate().

◆ m_TickPriorityLocationUpdateElapsed

protected float m_TickPriorityLocationUpdateElapsed
private

Referenced by OnUpdate().

◆ m_TickTimeOfDateElapsed

protected float m_TickTimeOfDateElapsed
private

Referenced by OnUpdate().

◆ m_TracksLocationMatchedPlayerInside

protected ref array<ref DynamicMusicTrackData> m_TracksLocationMatchedPlayerInside
private

static prio + filtered by the distance between player and center of zone

Referenced by DetermineTrackByCategory(), DynamicMusicPlayer(), and PlayerInsideOfLocationFilter().

◆ m_TracksLocationStaticCached

protected ref map<int, ref DynamicMusicLocationDynamicData> m_LocationsDynamic private ref array<ref DynamicMusicTrackData> m_TracksLocationStaticCached
private

map of dynamically registered locations during runtime

Referenced by DynamicMusicPlayer(), OnUpdate(), and RefreshTracksCache().

◆ m_TracksLocationStaticPrioritizedCached

private ref array<ref DynamicMusicTrackData> m_TracksLocationStaticPrioritizedCached
private

static + filtered by the distance between player and center of zone

Referenced by DynamicMusicPlayer(), OnUpdate(), and RefreshTracksCache().

◆ m_WaitingForPlayback

private bool m_WaitingForPlayback
private

Referenced by IsPlaybackActive(), OnLocationMatched(), OnNextTrackSelected(), OnTrackEnded(), OnTrackStopped(), PlayTrack(), and ResetWaitingQueue().

◆ TICK_FADEOUT_PROCESSOR_SECONDS

protected const float TICK_FADEOUT_PROCESSOR_SECONDS = 0.2
private

Referenced by OnUpdate().

◆ TICK_LOCATION_CACHE_UPDATE_SECONDS

protected const float TICK_LOCATION_CACHE_UPDATE_SECONDS = 120.0
private

Referenced by OnUpdate().

◆ TICK_LOCATION_UPDATE_SECONDS

protected const float TICK_LOCATION_UPDATE_SECONDS = 120.0
private

Referenced by OnUpdate().

◆ TICK_PRIORITY_LOCATION_UPDATE_SECONDS

protected const float TICK_PRIORITY_LOCATION_UPDATE_SECONDS = 30.0
private

Referenced by OnUpdate().

◆ TICK_TIME_OF_DATE_UPDATE_SECONDS

protected const float TICK_TIME_OF_DATE_UPDATE_SECONDS = 300.0
private

Referenced by OnUpdate().

◆ TRACKS_BUFFER_HISTORY_SIZE

protected const int TRACKS_BUFFER_HISTORY_SIZE = 2
private

Referenced by DynamicMusicPlayer(), and SelectRandomTrackIndexFromCategory().

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