HPL3/Amnesia: Rebirth/Scripting/cLuxVoiceHandler

From Frictional Wiki
Jump to navigation Jump to search
Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

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

Fields

cLuxVoiceHandler has no public fields.

Functions

Return Type Function And Description
void AddCharacterSpeakingCallback(const tString &in asCharacter, const tString &in asCallback)
void AddClosedCaption(const tWString &in asText, float afTime)
void AdvanceFromCurrentSound(const tString &in asScene)
bool AnySceneIsActive()
bool CharacterIsSpeaking(const tString &in asName)
bool DoesSubjectHaveUnplayedLines(const tString &in asSubject)
void FadeSceneVolumeTo(const tString &in asScene, float afVolume, float afTime)
int GetCurrentSubjectLineIndex(const tString &in asName)
void GetSpectrumFromScene(const tString &in asScene, array<float> &out aDestArray, int alNumSamples = 64)
void GetSpectrumFromSpeakingCharacter(const tString &in asCharacter, array<float> &out aDestArray, int alNumSamples = 64)
int GetSubjectLineNumber(const tString &in asSubject)
bool GetSubjectLines(const tString &in asSubject, array<tWString> avOutLines)
tString GetSubjectSceneName(const tString &in asSubject)
float GetTimeLeftOnLastLineOfPlayingSubject(const tString &in asName)
bool GetUnderwaterEffectsActive()
bool LoadFromFile(const tString &in asFile)
bool Play(const tString &in asSubject, int alSpecificLine, const tString &in asCallback, int alPrio, bool abPlayWhilePaused)
void RemoveCharacterSpeakingCallback(const tString &in asCharacter)
bool SceneInvolvingCharacterIsActive(const tString &in asCharacter)
bool SceneIsActive(const tString &in asScene)
void SetFocusScene(const tString &in asScene)
void SetForceHideSubtitles(bool abX)
void SetPaused(const tString &in asScene, bool abX)
void SetPausedAll(bool abX)
void SetUnderwaterEffectsActive(bool abX)
void SkipCurrentLine(const tString &in asScene)
void SkipCurrentSound(const tString &in asScene)
void Stop(const tString &in asScene)
void StopAll()
void StopScenesWithCharacter(const tString &in asCharacter)
bool SubjectExists(const tString &in asSubject)
bool SubjectIsPlaying(const tString &in asName)

Details

AddCharacterSpeakingCallback

void AddCharacterSpeakingCallback(const tString &in asCharacter,
                                  const tString &in asCallback)


Parameters

Returns:

  • void

AddClosedCaption

void AddClosedCaption(const tWString &in asText,
                      float afTime)


Parameters

  • asText (tWString) —
  • afTime (float) —

Returns:

  • void

AdvanceFromCurrentSound

void AdvanceFromCurrentSound(const tString &in asScene)


Parameters

Returns:

  • void

AnySceneIsActive

bool AnySceneIsActive()

Returns:

  • bool—

CharacterIsSpeaking

bool CharacterIsSpeaking(const tString &in asName)


Parameters

Returns:

  • bool—

DoesSubjectHaveUnplayedLines

bool DoesSubjectHaveUnplayedLines(const tString &in asSubject)


Parameters

Returns:

  • bool—

FadeSceneVolumeTo

void FadeSceneVolumeTo(const tString &in asScene,
                       float afVolume,
                       float afTime)


Parameters

  • asScene (tString) —
  • afVolume (float) —
  • afTime (float) —

Returns:

  • void

GetCurrentSubjectLineIndex

int GetCurrentSubjectLineIndex(const tString &in asName)


Parameters

Returns:

  • int—

GetSpectrumFromScene

void GetSpectrumFromScene(const tString &in asScene,
                          float &out aDestArray,
                          int alNumSamples = 64)


Parameters

  • asScene (tString) —
  • aDestArray (float) —
  • alNumSamples (int) —

Returns:

  • void

GetSpectrumFromSpeakingCharacter

void GetSpectrumFromSpeakingCharacter(const tString &in asCharacter,
                                      float &out aDestArray,
                                      int alNumSamples = 64)


Parameters

  • asCharacter (tString) —
  • aDestArray (float) —
  • alNumSamples (int) —

Returns:

  • void

GetSubjectLineNumber

int GetSubjectLineNumber(const tString &in asSubject)


Parameters

Returns:

  • int—

GetSubjectLines

bool GetSubjectLines(const tString &in asSubject,
                     tWString avOutLines)


Parameters

Returns:

  • bool—

GetSubjectSceneName

const tString& GetSubjectSceneName(const tString &in asSubject)


Parameters

Returns:

  • const tString&—

GetTimeLeftOnLastLineOfPlayingSubject

float GetTimeLeftOnLastLineOfPlayingSubject(const tString &in asName)


Parameters

Returns:

  • float—

GetUnderwaterEffectsActive

bool GetUnderwaterEffectsActive()

Returns:

  • bool—

LoadFromFile

bool LoadFromFile(const tString &in asFile)


Parameters

Returns:

  • bool—

Play

bool Play(const tString &in asSubject,
          int alSpecificLine,
          const tString &in asCallback,
          int alPrio,
          bool abPlayWhilePaused)


Parameters

  • asSubject (tString) —
  • alSpecificLine (int) —
  • asCallback (tString) —
  • alPrio (int) —
  • abPlayWhilePaused (bool) —

Returns:

  • bool—

RemoveCharacterSpeakingCallback

void RemoveCharacterSpeakingCallback(const tString &in asCharacter)


Parameters

Returns:

  • void

SceneInvolvingCharacterIsActive

bool SceneInvolvingCharacterIsActive(const tString &in asCharacter)


Parameters

Returns:

  • bool—

SceneIsActive

bool SceneIsActive(const tString &in asScene)


Parameters

Returns:

  • bool—

SetFocusScene

void SetFocusScene(const tString &in asScene)


Parameters

Returns:

  • void

SetForceHideSubtitles

void SetForceHideSubtitles(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetPaused

void SetPaused(const tString &in asScene,
               bool abX)


Parameters

  • asScene (tString) —
  • abX (bool) —

Returns:

  • void

SetPausedAll

void SetPausedAll(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetUnderwaterEffectsActive

void SetUnderwaterEffectsActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SkipCurrentLine

void SkipCurrentLine(const tString &in asScene)


Parameters

Returns:

  • void

SkipCurrentSound

void SkipCurrentSound(const tString &in asScene)


Parameters

Returns:

  • void

Stop

void Stop(const tString &in asScene)


Parameters

Returns:

  • void

StopAll

void StopAll()

Returns:

  • void

StopScenesWithCharacter

void StopScenesWithCharacter(const tString &in asCharacter)


Parameters

Returns:

  • void

SubjectExists

bool SubjectExists(const tString &in asSubject)


Parameters

Returns:

  • bool—

SubjectIsPlaying

bool SubjectIsPlaying(const tString &in asName)


Parameters

Returns:

  • bool—

References

See all references...

Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cLuxVoiceHandler&oldid=5820"