HPL3/Amnesia: Rebirth/Scripting/iSoundEventData

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

iSoundEventData has no public fields.

Functions

Return Type Function And Description
void DecUserCount()
float GetMaxDistance()
float GetMinDistance()
tString GetName()
cSoundEventParamInfo GetParam(int alIdx)
cSoundEventParamInfo GetParamFromName(const tString &in asName)
int GetParamNum()
uint GetTimeStamp()
bool HasUsers()
void IncUserCount()
bool Is3D()
bool IsHeadRelative()
bool IsOneShot()
void SetDefaultOrientation(const cVector3f &in avOrientation)
void SetDefaultPosition(const cVector3f &in avPostion)
void SetDefaultVolume(float afVolume)

Details

DecUserCount

void DecUserCount()

Returns:

  • void

GetMaxDistance

float GetMaxDistance()

Returns:

  • float

GetMinDistance

float GetMinDistance()

Returns:

  • float

GetName

const tString& GetName()

Returns:

  • const tString&

GetParam

cSoundEventParamInfo@ GetParam(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • cSoundEventParamInfo@

GetParamFromName

cSoundEventParamInfo@ GetParamFromName(const tString &in asName)


Parameters

Returns:

  • cSoundEventParamInfo@

GetParamNum

int GetParamNum()

Returns:

  • int

GetTimeStamp

uint GetTimeStamp()

Returns:

  • uint

HasUsers

bool HasUsers()

Returns:

  • bool

IncUserCount

void IncUserCount()

Returns:

  • void

Is3D

bool Is3D()

Returns:

  • bool

IsHeadRelative

bool IsHeadRelative()

Returns:

  • bool

IsOneShot

bool IsOneShot()

Returns:

  • bool

SetDefaultOrientation

void SetDefaultOrientation(const cVector3f &in avOrientation)


Parameters

Returns:

  • void

SetDefaultPosition

void SetDefaultPosition(const cVector3f &in avPostion)


Parameters

Returns:

  • void

SetDefaultVolume

void SetDefaultVolume(float afVolume)


Parameters

  • afVolume (float) —

Returns:

  • void

References

See all references...