HPL3/Amnesia: Rebirth/Scripting/cSoundEntry

From Frictional Wiki
Jump to navigation Jump to search

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

Fields

cSoundEntry has no public fields.

Functions

Return Type Function And Description
void FadeIn(float afVolumeMul, float afSpeed)
void FadeOut(float afSpeed)
void FadeSpeedMulTo(float afDestMul, float afSpeed)
void FadeVolumeMulTo(float afDestMul, float afSpeed)
float GetAudibility()
eSoundEntryDataType GetDataType()
float GetElapsedTime()
int GetId()
float GetMaxDistance()
float GetMinDistance()
tString GetName()
float GetParamMax(int alIdx)
float GetParamMin(int alIdx)
tString GetParamName(int alIdx)
int GetParamNum()
float GetParamValue(int alIdx)
bool GetPaused()
cVector3f GetPosition()
bool GetPostionIsHeadRelative()
bool GetReverbActive()
float GetReverbAmount()
float GetSpeakerSpread()
float GetSpeed()
float GetSpeedMul()
bool GetStopDisabled()
float GetTotalTime()
eSoundEntryType GetType()
float GetVolume()
float GetVolumeMul()
bool Is3D()
bool IsFirstTime()
bool IsOneShot()
bool IsPlaying()
bool IsPriorityReleased()
bool IsVirtual()
void SetBlockable(bool abX)
void SetBlockVolumeMul(float afX)
void SetElapsedTime(float afTime)
void SetParam(const tString &in asName, float afValue)
void SetParam(int alIdx, float afValue)
void SetPaused(bool abX)
void SetPosition(const cVector3f &in avPosition)
void SetPostionIsHeadRelative(bool abX)
void SetReverbActive(bool abX)
void SetReverbAmount(float afX)
void SetSpeakerSpread(float afX)
void SetSpeed(float afX)
void SetSpeedMul(float afMul)
void SetStopDisabled(bool abX)
void SetVelocity(const cVector3f &in avVelocity)
void SetVolume(float afX)
void SetVolumeMul(float afMul)
void Stop(bool abPlayEnd)

Details

FadeIn

void FadeIn(float afVolumeMul,
            float afSpeed)


Parameters

  • afVolumeMul (float) —
  • afSpeed (float) —

Returns:

  • void

FadeOut

void FadeOut(float afSpeed)


Parameters

  • afSpeed (float) —

Returns:

  • void

FadeSpeedMulTo

void FadeSpeedMulTo(float afDestMul,
                    float afSpeed)


Parameters

  • afDestMul (float) —
  • afSpeed (float) —

Returns:

  • void

FadeVolumeMulTo

void FadeVolumeMulTo(float afDestMul,
                     float afSpeed)


Parameters

  • afDestMul (float) —
  • afSpeed (float) —

Returns:

  • void

GetAudibility

float GetAudibility()

Returns:

  • float

GetDataType

eSoundEntryDataType GetDataType()

Returns:

  • eSoundEntryDataType

GetElapsedTime

float GetElapsedTime()

Returns:

  • float

GetId

int GetId()

Returns:

  • int

GetMaxDistance

float GetMaxDistance()

Returns:

  • float

GetMinDistance

float GetMinDistance()

Returns:

  • float

GetName

const tString& GetName()

Returns:

  • const tString&

GetParamMax

float GetParamMax(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • float

GetParamMin

float GetParamMin(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • float

GetParamName

const tString& GetParamName(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • const tString&

GetParamNum

int GetParamNum()

Returns:

  • int

GetParamValue

float GetParamValue(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • float

GetPaused

bool GetPaused()

Returns:

  • bool

GetPosition

const cVector3f& GetPosition()

Returns:

  • const cVector3f&

GetPostionIsHeadRelative

bool GetPostionIsHeadRelative()

Returns:

  • bool

GetReverbActive

bool GetReverbActive()

Returns:

  • bool

GetReverbAmount

float GetReverbAmount()

Returns:

  • float

GetSpeakerSpread

float GetSpeakerSpread()

Returns:

  • float

GetSpeed

float GetSpeed()

Returns:

  • float

GetSpeedMul

float GetSpeedMul()

Returns:

  • float

GetStopDisabled

bool GetStopDisabled()

Returns:

  • bool

GetTotalTime

float GetTotalTime()

Returns:

  • float

GetType

eSoundEntryType GetType()

Returns:

  • eSoundEntryType

GetVolume

float GetVolume()

Returns:

  • float

GetVolumeMul

float GetVolumeMul()

Returns:

  • float

Is3D

bool Is3D()

Returns:

  • bool

IsFirstTime

bool IsFirstTime()

Returns:

  • bool

IsOneShot

bool IsOneShot()

Returns:

  • bool

IsPlaying

bool IsPlaying()

Returns:

  • bool

IsPriorityReleased

bool IsPriorityReleased()

Returns:

  • bool

IsVirtual

bool IsVirtual()

Returns:

  • bool

SetBlockable

void SetBlockable(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetBlockVolumeMul

void SetBlockVolumeMul(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetElapsedTime

void SetElapsedTime(float afTime)


Parameters

  • afTime (float) —

Returns:

  • void

SetParam

void SetParam(const tString &in asName,
              float afValue)


Parameters

  • asName (tString) —
  • afValue (float) —

Returns:

  • void

SetParam

void SetParam(int alIdx,
              float afValue)


Parameters

  • alIdx (int) —
  • afValue (float) —

Returns:

  • void

SetPaused

void SetPaused(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPosition)


Parameters

Returns:

  • void

SetPostionIsHeadRelative

void SetPostionIsHeadRelative(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetReverbActive

void SetReverbActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetReverbAmount

void SetReverbAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSpeakerSpread

void SetSpeakerSpread(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSpeed

void SetSpeed(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSpeedMul

void SetSpeedMul(float afMul)


Parameters

  • afMul (float) —

Returns:

  • void

SetStopDisabled

void SetStopDisabled(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetVelocity

void SetVelocity(const cVector3f &in avVelocity)


Parameters

Returns:

  • void

SetVolume

void SetVolume(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetVolumeMul

void SetVolumeMul(float afMul)


Parameters

  • afMul (float) —

Returns:

  • void

Stop

void Stop(bool abPlayEnd)


Parameters

  • abPlayEnd (bool) —

Returns:

  • void

References

See all references...