HPL3/Amnesia: Rebirth/Scripting/cSoundEntity

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

Fields

cSoundEntity has no public fields.

Functions

Return Type	Function And Description
void	AddChild(iEntity3D@ apEntity)
void	FadeIn(float afSpeed)
void	FadeIn(float afSpeed, float afTargetVol)
void	FadeOut(float afSpeed)
void	FadeSpeedMul(float afDest, float afSpeed)
void	FadeVolumeMul(float afDest, float afSpeed)
void	GetAverageSpectrum(array<float> &out aDestArray, int alNumValues = 64)
cBoundingVolume	GetBoundingVolume()
cEntity3DIterator	GetChildIterator()
int	GetCreationID()
float	GetCustomMaxDistance()
float	GetCustomMinDistance()
eSoundEntityDataType	GetDataType()
float	GetElapsedTime()
iEntity3D	GetEntityParent()
eEntityType	GetEntityType()
tID	GetID()
cMatrixf	GetLocalMatrix()
cVector3f	GetLocalPosition()
float	GetMaxDistance()
float	GetMinDistance()
tString	GetName()
float	GetParam(int alIdx)
float	GetParam(const tString &in asName)
bool	GetRemoveWhenOver()
bool	GetReverbActive()
float	GetReverbAmount()
bool	GetScriptableIsSaved()
cSoundEntry	GetSoundEntry(bool abCheckEntryValidity)
tString	GetSoundFile()
bool	GetSoundFile3D()
bool	GetSoundFileBlockable()
float	GetSoundFileBlockMul()
eSoundEntryType	GetSoundFileEntryType()
bool	GetSoundFileLoop()
int	GetSoundFilePriority()
bool	GetSoundFileStream()
int	GetTransformUpdateCount()
int	GetUniqueID()
bool	GetUseCustomProperties()
float	GetVolume()
cMatrixf	GetWorldMatrix()
cVector3f	GetWorldPosition()
bool	HasParent()
bool	IsActive()
bool	IsChild(iEntity3D@ apEntity)
bool	IsFadingOut()
bool	IsOneShot()
bool	IsStopped()
void	Play()
void	RemoveChild(iEntity3D@ apEntity)
void	SetActive(bool abActive)
void	SetCustomMaxDistance(float afX)
void	SetCustomMinDistance(float afX)
void	SetElapsedTime(float afX)
void	SetMatrix(const cMatrixf &in a_mtxTransform)
void	SetName(const tString &in asName)
void	SetParam(int alIdx, float afValue)
void	SetParam(const tString &in asName, float afValue)
void	SetParamHash(int alHash, float afValue)
void	SetPosition(const cVector3f &in avPos)
void	SetReverbActive(bool abX)
void	SetReverbAmount(float afX)
void	SetScriptableIsSaved(bool abX)
void	SetSoundFile3D(bool abX)
void	SetSoundFileBlockable(bool abX)
void	SetSoundFileBlockMul(float afX)
void	SetSoundFileEntryType(eSoundEntryType aType)
void	SetSoundFileLoop(bool abX)
void	SetSoundFilePriority(int alX)
void	SetSoundFileStream(bool abX)
void	SetSpeakerSpread(float afX)
void	SetupSoundFile(const tString &in asFile, bool abLoop)
void	SetUseCustomProperties(bool abX)
void	SetVolume(float afX)
void	SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)
void	SetWorldPosition(const cVector3f &in avWorldPos)
void	Stop(bool abPlayEndSound)
void	UpdateLogic(float afTimeStep)

Details

AddChild

void AddChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• void

FadeIn

void FadeIn(float afSpeed)

Parameters

• afSpeed (float) —

Returns:

• void

FadeIn

void FadeIn(float afSpeed,
            float afTargetVol)

Parameters

• afSpeed (float) —
• afTargetVol (float) —

Returns:

• void

FadeOut

void FadeOut(float afSpeed)

Parameters

• afSpeed (float) —

Returns:

• void

FadeSpeedMul

void FadeSpeedMul(float afDest,
                  float afSpeed)

Parameters

• afDest (float) —
• afSpeed (float) —

Returns:

• void

FadeVolumeMul

void FadeVolumeMul(float afDest,
                   float afSpeed)

Parameters

• afDest (float) —
• afSpeed (float) —

Returns:

• void

GetAverageSpectrum

void GetAverageSpectrum(float &out aDestArray,
                        int alNumValues = 64)

Parameters

• aDestArray (float) —
• alNumValues (int) —

Returns:

• void

GetBoundingVolume

cBoundingVolume@+ GetBoundingVolume()

Returns:

• cBoundingVolume@+—

GetChildIterator

cEntity3DIterator@ GetChildIterator()

Returns:

• cEntity3DIterator@—

GetCreationID

int GetCreationID()

Returns:

• int—

GetCustomMaxDistance

float GetCustomMaxDistance()

Returns:

• float—

GetCustomMinDistance

float GetCustomMinDistance()

Returns:

• float—

GetDataType

eSoundEntityDataType GetDataType()

Returns:

• eSoundEntityDataType—

GetElapsedTime

float GetElapsedTime()

Returns:

• float—

GetEntityParent

iEntity3D@ GetEntityParent()

Returns:

• iEntity3D@—

GetEntityType

eEntityType GetEntityType()

Returns:

• eEntityType—

GetID

tID GetID()

Returns:

• tID—

GetLocalMatrix

cMatrixf& GetLocalMatrix()

Returns:

• cMatrixf&—

GetLocalPosition

cVector3f GetLocalPosition()

Returns:

• cVector3f—

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

• asName (tString) —

Returns:

• float—

GetRemoveWhenOver

bool GetRemoveWhenOver()

Returns:

• bool—

GetReverbActive

bool GetReverbActive()

Returns:

• bool—

GetReverbAmount

float GetReverbAmount()

Returns:

• float—

GetScriptableIsSaved

bool GetScriptableIsSaved()

Returns:

• bool—

GetSoundEntry

cSoundEntry@ GetSoundEntry(bool abCheckEntryValidity)

Parameters

• abCheckEntryValidity (bool) —

Returns:

• cSoundEntry@—

GetSoundFile

const tString& GetSoundFile()

Returns:

• const tString&—

GetSoundFile3D

bool GetSoundFile3D()

Returns:

• bool—

GetSoundFileBlockable

bool GetSoundFileBlockable()

Returns:

• bool—

GetSoundFileBlockMul

float GetSoundFileBlockMul()

Returns:

• float—

GetSoundFileEntryType

eSoundEntryType GetSoundFileEntryType()

Returns:

• eSoundEntryType—

GetSoundFileLoop

bool GetSoundFileLoop()

Returns:

• bool—

GetSoundFilePriority

int GetSoundFilePriority()

Returns:

• int—

GetSoundFileStream

bool GetSoundFileStream()

Returns:

• bool—

GetTransformUpdateCount

int GetTransformUpdateCount()

Returns:

• int—

GetUniqueID

int GetUniqueID()

Returns:

• int—

GetUseCustomProperties

bool GetUseCustomProperties()

Returns:

• bool—

GetVolume

float GetVolume()

Returns:

• float—

GetWorldMatrix

cMatrixf& GetWorldMatrix()

Returns:

• cMatrixf&—

GetWorldPosition

cVector3f GetWorldPosition()

Returns:

• cVector3f—

HasParent

bool HasParent()

Returns:

• bool—

IsActive

bool IsActive()

Returns:

• bool—

IsChild

bool IsChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• bool—

IsFadingOut

bool IsFadingOut()

Returns:

• bool—

IsOneShot

bool IsOneShot()

Returns:

• bool—

IsStopped

bool IsStopped()

Returns:

• bool—

Play

void Play()

Returns:

• void

RemoveChild

void RemoveChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• void

SetActive

void SetActive(bool abActive)

Parameters

• abActive (bool) —

Returns:

• void

SetCustomMaxDistance

void SetCustomMaxDistance(float afX)

Parameters

• afX (float) —

Returns:

• void

SetCustomMinDistance

void SetCustomMinDistance(float afX)

Parameters

• afX (float) —

Returns:

• void

SetElapsedTime

void SetElapsedTime(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform)

Parameters

• a_mtxTransform (cMatrixf) —

Returns:

• void

SetName

void SetName(const tString &in asName)

Parameters

• asName (tString) —

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

SetParamHash

void SetParamHash(int alHash,
                  float afValue)

Parameters

• alHash (int) —
• afValue (float) —

Returns:

• void

SetPosition

void SetPosition(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetReverbActive

void SetReverbActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetReverbAmount

void SetReverbAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetScriptableIsSaved

void SetScriptableIsSaved(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetSoundFile3D

void SetSoundFile3D(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetSoundFileBlockable

void SetSoundFileBlockable(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetSoundFileBlockMul

void SetSoundFileBlockMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSoundFileEntryType

void SetSoundFileEntryType(eSoundEntryType aType)

Parameters

• aType (eSoundEntryType) —

Returns:

• void

SetSoundFileLoop

void SetSoundFileLoop(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetSoundFilePriority

void SetSoundFilePriority(int alX)

Parameters

• alX (int) —

Returns:

• void

SetSoundFileStream

void SetSoundFileStream(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetSpeakerSpread

void SetSpeakerSpread(float afX)

Parameters

• afX (float) —

Returns:

• void

SetupSoundFile

void SetupSoundFile(const tString &in asFile,
                    bool abLoop)

Parameters

• asFile (tString) —
• abLoop (bool) —

Returns:

• void

SetUseCustomProperties

void SetUseCustomProperties(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetVolume

void SetVolume(float afX)

Parameters

• afX (float) —

Returns:

• void

SetWorldMatrix

void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)

Parameters

• a_mtxWorldTransform (cMatrixf) —

Returns:

• void

SetWorldPosition

void SetWorldPosition(const cVector3f &in avWorldPos)

Parameters

• avWorldPos (cVector3f) —

Returns:

• void

Stop

void Stop(bool abPlayEndSound)

Parameters

• abPlayEndSound (bool) —

Returns:

• void

UpdateLogic

void UpdateLogic(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxAgent ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxCritter ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxLiquidArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxProp ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxPushableFogArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxSoundscapeArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxVisibilityPortal ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cSoundEntityIterator ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cWorld ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iLuxEntity ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cScene ‎ (← links)

See all references...