https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FcSoundEntity HPL3/Amnesia: Rebirth/Scripting/cSoundEntity - Revision history 2026-05-03T11:09:16Z Revision history for this page on the wiki MediaWiki 1.34.2 https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cSoundEntity&diff=5870&oldid=prev Abion47: Created page with "{{ScriptingStub}} 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. ==Func..." 2020-11-15T21:56:26Z <p>Created page with &quot;{{ScriptingStub}} 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. ==Func...&quot;</p> <p><b>New page</b></p><div>{{ScriptingStub}}<br /> <br /> Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br /> <br /> ==Fields==<br /> cSoundEntity has no public fields.<br /> <br /> ==Functions==<br /> {{CodeDocSummaryTop|Return Type|Function And Description}}<br /> {{CodeDocSummaryItem|void|[[#AddChild|AddChild]]([[../iEntity3D|iEntity3D@]] apEntity)|}}<br /> {{CodeDocSummaryItem|void|[[#FadeIn|FadeIn]](float afSpeed)|}}<br /> {{CodeDocSummaryItem|void|[[#FadeIn|FadeIn]](float afSpeed, float afTargetVol)|}}<br /> {{CodeDocSummaryItem|void|[[#FadeOut|FadeOut]](float afSpeed)|}}<br /> {{CodeDocSummaryItem|void|[[#FadeSpeedMul|FadeSpeedMul]](float afDest, float afSpeed)|}}<br /> {{CodeDocSummaryItem|void|[[#FadeVolumeMul|FadeVolumeMul]](float afDest, float afSpeed)|}}<br /> {{CodeDocSummaryItem|void|[[#GetAverageSpectrum|GetAverageSpectrum]]([[../array|array]]&lt;float&gt; &amp;out aDestArray, int alNumValues &lt;nowiki&gt;=&lt;/nowiki&gt; 64)|}}<br /> {{CodeDocSummaryItem|[[../cBoundingVolume|cBoundingVolume]]|[[#GetBoundingVolume|GetBoundingVolume]]()|}}<br /> {{CodeDocSummaryItem|[[../cEntity3DIterator|cEntity3DIterator]]|[[#GetChildIterator|GetChildIterator]]()|}}<br /> {{CodeDocSummaryItem|int|[[#GetCreationID|GetCreationID]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetCustomMaxDistance|GetCustomMaxDistance]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetCustomMinDistance|GetCustomMinDistance]]()|}}<br /> {{CodeDocSummaryItem|[[../eSoundEntityDataType|eSoundEntityDataType]]|[[#GetDataType|GetDataType]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetElapsedTime|GetElapsedTime]]()|}}<br /> {{CodeDocSummaryItem|[[../iEntity3D|iEntity3D]]|[[#GetEntityParent|GetEntityParent]]()|}}<br /> {{CodeDocSummaryItem|[[../eEntityType|eEntityType]]|[[#GetEntityType|GetEntityType]]()|}}<br /> {{CodeDocSummaryItem|[[../tID|tID]]|[[#GetID|GetID]]()|}}<br /> {{CodeDocSummaryItem|[[../cMatrixf|cMatrixf]]|[[#GetLocalMatrix|GetLocalMatrix]]()|}}<br /> {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetLocalPosition|GetLocalPosition]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetMaxDistance|GetMaxDistance]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetMinDistance|GetMinDistance]]()|}}<br /> {{CodeDocSummaryItem|[[../tString|tString]]|[[#GetName|GetName]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetParam|GetParam]](int alIdx)|}}<br /> {{CodeDocSummaryItem|float|[[#GetParam|GetParam]](const [[../tString|tString]] &amp;in asName)|}}<br /> {{CodeDocSummaryItem|bool|[[#GetRemoveWhenOver|GetRemoveWhenOver]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#GetReverbActive|GetReverbActive]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetReverbAmount|GetReverbAmount]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#GetScriptableIsSaved|GetScriptableIsSaved]]()|}}<br /> {{CodeDocSummaryItem|[[../cSoundEntry|cSoundEntry]]|[[#GetSoundEntry|GetSoundEntry]](bool abCheckEntryValidity)|}}<br /> {{CodeDocSummaryItem|[[../tString|tString]]|[[#GetSoundFile|GetSoundFile]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#GetSoundFile3D|GetSoundFile3D]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#GetSoundFileBlockable|GetSoundFileBlockable]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetSoundFileBlockMul|GetSoundFileBlockMul]]()|}}<br /> {{CodeDocSummaryItem|[[../eSoundEntryType|eSoundEntryType]]|[[#GetSoundFileEntryType|GetSoundFileEntryType]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#GetSoundFileLoop|GetSoundFileLoop]]()|}}<br /> {{CodeDocSummaryItem|int|[[#GetSoundFilePriority|GetSoundFilePriority]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#GetSoundFileStream|GetSoundFileStream]]()|}}<br /> {{CodeDocSummaryItem|int|[[#GetTransformUpdateCount|GetTransformUpdateCount]]()|}}<br /> {{CodeDocSummaryItem|int|[[#GetUniqueID|GetUniqueID]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#GetUseCustomProperties|GetUseCustomProperties]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetVolume|GetVolume]]()|}}<br /> {{CodeDocSummaryItem|[[../cMatrixf|cMatrixf]]|[[#GetWorldMatrix|GetWorldMatrix]]()|}}<br /> {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetWorldPosition|GetWorldPosition]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#HasParent|HasParent]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#IsActive|IsActive]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#IsChild|IsChild]]([[../iEntity3D|iEntity3D@]] apEntity)|}}<br /> {{CodeDocSummaryItem|bool|[[#IsFadingOut|IsFadingOut]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#IsOneShot|IsOneShot]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#IsStopped|IsStopped]]()|}}<br /> {{CodeDocSummaryItem|void|[[#Play|Play]]()|}}<br /> {{CodeDocSummaryItem|void|[[#RemoveChild|RemoveChild]]([[../iEntity3D|iEntity3D@]] apEntity)|}}<br /> {{CodeDocSummaryItem|void|[[#SetActive|SetActive]](bool abActive)|}}<br /> {{CodeDocSummaryItem|void|[[#SetCustomMaxDistance|SetCustomMaxDistance]](float afX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetCustomMinDistance|SetCustomMinDistance]](float afX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetElapsedTime|SetElapsedTime]](float afX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetMatrix|SetMatrix]](const [[../cMatrixf|cMatrixf]] &amp;in a_mtxTransform)|}}<br /> {{CodeDocSummaryItem|void|[[#SetName|SetName]](const [[../tString|tString]] &amp;in asName)|}}<br /> {{CodeDocSummaryItem|void|[[#SetParam|SetParam]](int alIdx, float afValue)|}}<br /> {{CodeDocSummaryItem|void|[[#SetParam|SetParam]](const [[../tString|tString]] &amp;in asName, float afValue)|}}<br /> {{CodeDocSummaryItem|void|[[#SetParamHash|SetParamHash]](int alHash, float afValue)|}}<br /> {{CodeDocSummaryItem|void|[[#SetPosition|SetPosition]](const [[../cVector3f|cVector3f]] &amp;in avPos)|}}<br /> {{CodeDocSummaryItem|void|[[#SetReverbActive|SetReverbActive]](bool abX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetReverbAmount|SetReverbAmount]](float afX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetScriptableIsSaved|SetScriptableIsSaved]](bool abX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetSoundFile3D|SetSoundFile3D]](bool abX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetSoundFileBlockable|SetSoundFileBlockable]](bool abX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetSoundFileBlockMul|SetSoundFileBlockMul]](float afX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetSoundFileEntryType|SetSoundFileEntryType]]([[../eSoundEntryType|eSoundEntryType]] aType)|}}<br /> {{CodeDocSummaryItem|void|[[#SetSoundFileLoop|SetSoundFileLoop]](bool abX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetSoundFilePriority|SetSoundFilePriority]](int alX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetSoundFileStream|SetSoundFileStream]](bool abX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetSpeakerSpread|SetSpeakerSpread]](float afX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetupSoundFile|SetupSoundFile]](const [[../tString|tString]] &amp;in asFile, bool abLoop)|}}<br /> {{CodeDocSummaryItem|void|[[#SetUseCustomProperties|SetUseCustomProperties]](bool abX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetVolume|SetVolume]](float afX)|}}<br /> {{CodeDocSummaryItem|void|[[#SetWorldMatrix|SetWorldMatrix]](const [[../cMatrixf|cMatrixf]] &amp;in a_mtxWorldTransform)|}}<br /> {{CodeDocSummaryItem|void|[[#SetWorldPosition|SetWorldPosition]](const [[../cVector3f|cVector3f]] &amp;in avWorldPos)|}}<br /> {{CodeDocSummaryItem|void|[[#Stop|Stop]](bool abPlayEndSound)|}}<br /> {{CodeDocSummaryItem|void|[[#UpdateLogic|UpdateLogic]](float afTimeStep)|}}<br /> {{CodeDocSummaryBottom}}<br /> <br /> ==Details==<br /> {{CodeDocDetailTop|AddChild}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void AddChild(iEntity3D@ apEntity)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|apEntity|[[../iEntity3D|iEntity3D@]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|FadeIn}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void FadeIn(float afSpeed)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afSpeed|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|FadeIn}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void FadeIn(float afSpeed,<br /> float afTargetVol)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afSpeed|float|}}<br /> {{CodeDocDetailParam|afTargetVol|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|FadeOut}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void FadeOut(float afSpeed)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afSpeed|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|FadeSpeedMul}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void FadeSpeedMul(float afDest,<br /> float afSpeed)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afDest|float|}}<br /> {{CodeDocDetailParam|afSpeed|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|FadeVolumeMul}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void FadeVolumeMul(float afDest,<br /> float afSpeed)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afDest|float|}}<br /> {{CodeDocDetailParam|afSpeed|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetAverageSpectrum}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void GetAverageSpectrum(float &amp;out aDestArray,<br /> int alNumValues = 64)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|aDestArray|float|}}<br /> {{CodeDocDetailParam|alNumValues|int|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetBoundingVolume}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cBoundingVolume@+ GetBoundingVolume()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|cBoundingVolume@+|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetChildIterator}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cEntity3DIterator@ GetChildIterator()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|cEntity3DIterator@|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetCreationID}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;int GetCreationID()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|int|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetCustomMaxDistance}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetCustomMaxDistance()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetCustomMinDistance}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetCustomMinDistance()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetDataType}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;eSoundEntityDataType GetDataType()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|eSoundEntityDataType|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetElapsedTime}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetElapsedTime()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetEntityParent}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;iEntity3D@ GetEntityParent()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|iEntity3D@|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetEntityType}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;eEntityType GetEntityType()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|eEntityType|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetID}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;tID GetID()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|tID|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetLocalMatrix}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cMatrixf&amp; GetLocalMatrix()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|cMatrixf&amp;|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetLocalPosition}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cVector3f GetLocalPosition()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|cVector3f|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetMaxDistance}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetMaxDistance()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetMinDistance}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetMinDistance()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetName}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;const tString&amp; GetName()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|const tString&amp;|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetParam}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetParam(int alIdx)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alIdx|int|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetParam}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetParam(const tString &amp;in asName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetRemoveWhenOver}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetRemoveWhenOver()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetReverbActive}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetReverbActive()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetReverbAmount}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetReverbAmount()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetScriptableIsSaved}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetScriptableIsSaved()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundEntry}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cSoundEntry@ GetSoundEntry(bool abCheckEntryValidity)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abCheckEntryValidity|bool|}}<br /> {{CodeDocDetailReturn|cSoundEntry@|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundFile}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;const tString&amp; GetSoundFile()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|const tString&amp;|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundFile3D}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetSoundFile3D()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundFileBlockable}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetSoundFileBlockable()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundFileBlockMul}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetSoundFileBlockMul()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundFileEntryType}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;eSoundEntryType GetSoundFileEntryType()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|eSoundEntryType|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundFileLoop}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetSoundFileLoop()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundFilePriority}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;int GetSoundFilePriority()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|int|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetSoundFileStream}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetSoundFileStream()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetTransformUpdateCount}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;int GetTransformUpdateCount()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|int|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetUniqueID}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;int GetUniqueID()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|int|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetUseCustomProperties}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetUseCustomProperties()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetVolume}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetVolume()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetWorldMatrix}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cMatrixf&amp; GetWorldMatrix()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|cMatrixf&amp;|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetWorldPosition}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cVector3f GetWorldPosition()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|cVector3f|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|HasParent}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool HasParent()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|IsActive}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool IsActive()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|IsChild}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool IsChild(iEntity3D@ apEntity)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|apEntity|[[../iEntity3D|iEntity3D@]]|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|IsFadingOut}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool IsFadingOut()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|IsOneShot}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool IsOneShot()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|IsStopped}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool IsStopped()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Play}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Play()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|RemoveChild}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void RemoveChild(iEntity3D@ apEntity)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|apEntity|[[../iEntity3D|iEntity3D@]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetActive}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetActive(bool abActive)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abActive|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetCustomMaxDistance}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetCustomMaxDistance(float afX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afX|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetCustomMinDistance}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetCustomMinDistance(float afX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afX|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetElapsedTime}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetElapsedTime(float afX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afX|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetMatrix}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetMatrix(const cMatrixf &amp;in a_mtxTransform)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|a_mtxTransform|[[../cMatrixf|cMatrixf]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetName}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetName(const tString &amp;in asName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetParam}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetParam(int alIdx,<br /> float afValue)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alIdx|int|}}<br /> {{CodeDocDetailParam|afValue|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetParam}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetParam(const tString &amp;in asName,<br /> float afValue)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br /> {{CodeDocDetailParam|afValue|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetParamHash}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetParamHash(int alHash,<br /> float afValue)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alHash|int|}}<br /> {{CodeDocDetailParam|afValue|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetPosition}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetPosition(const cVector3f &amp;in avPos)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|avPos|[[../cVector3f|cVector3f]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetReverbActive}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetReverbActive(bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetReverbAmount}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetReverbAmount(float afX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afX|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetScriptableIsSaved}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetScriptableIsSaved(bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetSoundFile3D}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetSoundFile3D(bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetSoundFileBlockable}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetSoundFileBlockable(bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetSoundFileBlockMul}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetSoundFileBlockMul(float afX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afX|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetSoundFileEntryType}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetSoundFileEntryType(eSoundEntryType aType)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|aType|[[../eSoundEntryType|eSoundEntryType]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetSoundFileLoop}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetSoundFileLoop(bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetSoundFilePriority}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetSoundFilePriority(int alX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alX|int|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetSoundFileStream}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetSoundFileStream(bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetSpeakerSpread}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetSpeakerSpread(float afX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afX|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetupSoundFile}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetupSoundFile(const tString &amp;in asFile,<br /> bool abLoop)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asFile|[[../tString|tString]]|}}<br /> {{CodeDocDetailParam|abLoop|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetUseCustomProperties}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetUseCustomProperties(bool abX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abX|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetVolume}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetVolume(float afX)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afX|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetWorldMatrix}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetWorldMatrix(const cMatrixf &amp;in a_mtxWorldTransform)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|a_mtxWorldTransform|[[../cMatrixf|cMatrixf]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|SetWorldPosition}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void SetWorldPosition(const cVector3f &amp;in avWorldPos)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|avWorldPos|[[../cVector3f|cVector3f]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|Stop}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void Stop(bool abPlayEndSound)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|abPlayEndSound|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|UpdateLogic}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void UpdateLogic(float afTimeStep)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|afTimeStep|float|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{ReferencesSection}}<br /> <br /> {{HPL3SOMAScriptingCategories}}</div> Abion47