HPL3/Amnesia: Rebirth/Scripting/iSoundEvent
< HPL3 | Amnesia: Rebirth | Scripting
Jump to navigation
Jump to search
 |
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!
Contents
- 1 Fields
- 2 Functions
- 3 Details
- 3.1 GetAudibility
- 3.2 GetData
- 3.3 GetElapsedTime
- 3.4 GetMaxDistance
- 3.5 GetMinDistance
- 3.6 GetName
- 3.7 GetParam
- 3.8 GetParam
- 3.9 GetPaused
- 3.10 GetPosition
- 3.11 GetPostionIsHeadRelative
- 3.12 GetReverbActive
- 3.13 GetReverbAmount
- 3.14 GetSpeakerSpread
- 3.15 GetSpeed
- 3.16 GetTotalTime
- 3.17 GetVelocity
- 3.18 GetVolume
- 3.19 Is3D
- 3.20 IsLoading
- 3.21 IsOneShot
- 3.22 IsPlaying
- 3.23 IsPriorityReleased
- 3.24 SetMaxDistance
- 3.25 SetMinDistance
- 3.26 SetParam
- 3.27 SetParam
- 3.28 SetPaused
- 3.29 SetPosition
- 3.30 SetPostionIsHeadRelative
- 3.31 SetReverbActive
- 3.32 SetReverbAmount
- 3.33 SetSpeakerSpread
- 3.34 SetSpeed
- 3.35 SetVelocity
- 3.36 SetVolume
- 3.37 Start
- 3.38 Stop
- 4 References
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
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
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
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