HPL3/Amnesia: Rebirth/Scripting/iSoundEvent

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 23:51, 15 November 2020 by Abion47 (talk | contribs) (Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== iSoundEvent has no public fields. ==Funct...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

iSoundEvent has no public fields.

Functions

Return Type Function And Description
float GetAudibility()
iSoundEventData GetData()
float GetElapsedTime()
float GetMaxDistance()
float GetMinDistance()
tString GetName()
float GetParam(int alIdx)
float GetParam(const tString &in asName)
bool GetPaused()
cVector3f GetPosition()
bool GetPostionIsHeadRelative()
bool GetReverbActive()
float GetReverbAmount()
float GetSpeakerSpread()
float GetSpeed()
float GetTotalTime()
cVector3f GetVelocity()
float GetVolume()
bool Is3D()
bool IsLoading()
bool IsOneShot()
bool IsPlaying()
bool IsPriorityReleased()
void SetMaxDistance(float fMax)
void SetMinDistance(float fMin)
void SetParam(int alIdx, float afValue)
void SetParam(const tString &in asName, float afValue)
void SetPaused(bool abX)
void SetPosition(const cVector3f &in avPos)
void SetPostionIsHeadRelative(bool abX)
void SetReverbActive(bool abX)
void SetReverbAmount(float afX)
void SetSpeakerSpread(float afX)
void SetSpeed(float afSpeed)
void SetVelocity(const cVector3f &in avVel)
void SetVolume(float afVolume)
void Start()
void Stop(bool abPlayEnd)

Details

GetAudibility

float GetAudibility()

Returns:

  • float—

GetData

iSoundEventData@ GetData()

Returns:

  • iSoundEventData@—

GetElapsedTime

float GetElapsedTime()

Returns:

  • float—

GetMaxDistance

float GetMaxDistance()

Returns:

  • float—

GetMinDistance

float GetMinDistance()

Returns:

  • float—

GetName

const tString& GetName()

Returns:

  • const tString&—

GetParam

float GetParam(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • float—

GetParam

float GetParam(const tString &in asName)


Parameters

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—

GetTotalTime

float GetTotalTime()

Returns:

  • float—

GetVelocity

const cVector3f& GetVelocity()

Returns:

  • const cVector3f&—

GetVolume

float GetVolume()

Returns:

  • float—

Is3D

bool Is3D()

Returns:

  • bool—

IsLoading

bool IsLoading()

Returns:

  • bool—

IsOneShot

bool IsOneShot()

Returns:

  • bool—

IsPlaying

bool IsPlaying()

Returns:

  • bool—

IsPriorityReleased

bool IsPriorityReleased()

Returns:

  • bool—

SetMaxDistance

void SetMaxDistance(float fMax)


Parameters

  • fMax (float) —

Returns:

  • void

SetMinDistance

void SetMinDistance(float fMin)


Parameters

  • fMin (float) —

Returns:

  • void

SetParam

void SetParam(int alIdx,
              float afValue)


Parameters

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

Returns:

  • void

SetParam

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


Parameters

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

Returns:

  • void

SetPaused

void SetPaused(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPos)


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 afSpeed)


Parameters

  • afSpeed (float) —

Returns:

  • void

SetVelocity

void SetVelocity(const cVector3f &in avVel)


Parameters

Returns:

  • void

SetVolume

void SetVolume(float afVolume)


Parameters

  • afVolume (float) —

Returns:

  • void

Start

void Start()

Returns:

  • void

Stop

void Stop(bool abPlayEnd)


Parameters

  • abPlayEnd (bool) —

Returns:

  • void

References

See all references...

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