HPL3/Amnesia: Rebirth/Scripting/cLuxMusicHandler

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cLuxMusicHandler has no public fields.

Functions

Return Type	Function And Description
void	AddDynamicTrack(tID a_idEntity, int alTrackPrio, int alMusicPrio, const tString &in asFile, float afVolume, float afFadeInTime, float afFadeOutTime)
bool	IsSongPlaying(const tString &in asFile)
void	Play(const tString &in asFile, bool abLoop, float afVolume, float afFreq, float afVolumeFadeTime, float afFreqFadeTime, int alPrio, bool abResume, bool abSpecialEffect)
void	RemoveDynamicTrack(tID a_idEntity)
void	Stop(float afFadeTime, int alPrio)

Details

AddDynamicTrack

void AddDynamicTrack(tID a_idEntity,
                     int alTrackPrio,
                     int alMusicPrio,
                     const tString &in asFile,
                     float afVolume,
                     float afFadeInTime,
                     float afFadeOutTime)

Parameters

• a_idEntity (tID) —
• alTrackPrio (int) —
• alMusicPrio (int) —
• asFile (tString) —
• afVolume (float) —
• afFadeInTime (float) —
• afFadeOutTime (float) —

Returns:

• void

IsSongPlaying

bool IsSongPlaying(const tString &in asFile)

Parameters

• asFile (tString) —

Returns:

• bool—

Play

void Play(const tString &in asFile,
          bool abLoop,
          float afVolume,
          float afFreq,
          float afVolumeFadeTime,
          float afFreqFadeTime,
          int alPrio,
          bool abResume,
          bool abSpecialEffect)

Parameters

• asFile (tString) —
• abLoop (bool) —
• afVolume (float) —
• afFreq (float) —
• afVolumeFadeTime (float) —
• afFreqFadeTime (float) —
• alPrio (int) —
• abResume (bool) —
• abSpecialEffect (bool) —

Returns:

• void

RemoveDynamicTrack

void RemoveDynamicTrack(tID a_idEntity)

Parameters

• a_idEntity (tID) —

Returns:

• void

Stop

void Stop(float afFadeTime,
          int alPrio)

Parameters

• afFadeTime (float) —
• alPrio (int) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)

See all references...