https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FiSoundChannel
HPL3/Amnesia: Rebirth/Scripting/iSoundChannel - Revision history
2026-05-15T06:57:28Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/iSoundChannel&diff=6111&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== iSoundChannel has no public fields. ==Fun..."
2020-11-15T22:51:05Z
<p>Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== iSoundChannel has no public fields. ==Fun..."</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 />
iSoundChannel has no public fields.<br />
<br />
==Functions==<br />
{{CodeDocSummaryTop|Return Type|Function And Description}}<br />
{{CodeDocSummaryItem|[[../iSoundData|iSoundData]]|[[#GetData|GetData]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetElapsedTime|GetElapsedTime]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetMaxDistance|GetMaxDistance]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetMinDistance|GetMinDistance]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetPan|GetPan]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#GetPaused|GetPaused]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetPosition|GetPosition]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#GetPostionIsHeadRelative|GetPostionIsHeadRelative]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetPriority|GetPriority]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#GetReverbActive|GetReverbActive]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetReverbAmount|GetReverbAmount]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetSpeakerSpread|GetSpeakerSpread]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetSpeed|GetSpeed]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetTotalTime|GetTotalTime]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetVelocity|GetVelocity]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetVolume|GetVolume]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#Is3D|Is3D]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#IsPlaying|IsPlaying]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#IsPriorityReleased|IsPriorityReleased]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#IsVirtual|IsVirtual]]()|}}<br />
{{CodeDocSummaryItem|void|[[#Play|Play]]()|}}<br />
{{CodeDocSummaryItem|void|[[#SetElapsedTime|SetElapsedTime]](float afTime)|}}<br />
{{CodeDocSummaryItem|void|[[#SetMaxDistance|SetMaxDistance]](float fMax)|}}<br />
{{CodeDocSummaryItem|void|[[#SetMinDistance|SetMinDistance]](float fMin)|}}<br />
{{CodeDocSummaryItem|void|[[#SetPan|SetPan]](float afPan)|}}<br />
{{CodeDocSummaryItem|void|[[#SetPaused|SetPaused]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetPosition|SetPosition]](const [[../cVector3f|cVector3f]] &in avPos)|}}<br />
{{CodeDocSummaryItem|void|[[#SetPostionIsHeadRelative|SetPostionIsHeadRelative]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetPriority|SetPriority]](int alX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetReverbActive|SetReverbActive]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetReverbAmount|SetReverbAmount]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetSpeakerSpread|SetSpeakerSpread]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetSpeed|SetSpeed]](float afSpeed)|}}<br />
{{CodeDocSummaryItem|void|[[#SetVelocity|SetVelocity]](const [[../cVector3f|cVector3f]] &in avVel)|}}<br />
{{CodeDocSummaryItem|void|[[#SetVolume|SetVolume]](float afVolume)|}}<br />
{{CodeDocSummaryItem|void|[[#Stop|Stop]]()|}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Details==<br />
{{CodeDocDetailTop|GetData}}<br />
<syntaxhighlight lang="c++">iSoundData@ GetData()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|iSoundData@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetElapsedTime}}<br />
<syntaxhighlight lang="c++">float GetElapsedTime()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetMaxDistance}}<br />
<syntaxhighlight lang="c++">float GetMaxDistance()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetMinDistance}}<br />
<syntaxhighlight lang="c++">float GetMinDistance()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetPan}}<br />
<syntaxhighlight lang="c++">float GetPan()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetPaused}}<br />
<syntaxhighlight lang="c++">bool GetPaused()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetPosition}}<br />
<syntaxhighlight lang="c++">const cVector3f& GetPosition()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const cVector3f&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetPostionIsHeadRelative}}<br />
<syntaxhighlight lang="c++">bool GetPostionIsHeadRelative()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetPriority}}<br />
<syntaxhighlight lang="c++">int GetPriority()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetReverbActive}}<br />
<syntaxhighlight lang="c++">bool GetReverbActive()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetReverbAmount}}<br />
<syntaxhighlight lang="c++">float GetReverbAmount()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetSpeakerSpread}}<br />
<syntaxhighlight lang="c++">float GetSpeakerSpread()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetSpeed}}<br />
<syntaxhighlight lang="c++">float GetSpeed()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetTotalTime}}<br />
<syntaxhighlight lang="c++">float GetTotalTime()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetVelocity}}<br />
<syntaxhighlight lang="c++">const cVector3f& GetVelocity()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const cVector3f&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetVolume}}<br />
<syntaxhighlight lang="c++">float GetVolume()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Is3D}}<br />
<syntaxhighlight lang="c++">bool Is3D()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|IsPlaying}}<br />
<syntaxhighlight lang="c++">bool IsPlaying()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|IsPriorityReleased}}<br />
<syntaxhighlight lang="c++">bool IsPriorityReleased()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|IsVirtual}}<br />
<syntaxhighlight lang="c++">bool IsVirtual()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Play}}<br />
<syntaxhighlight lang="c++">void Play()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetElapsedTime}}<br />
<syntaxhighlight lang="c++">void SetElapsedTime(float afTime)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afTime|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetMaxDistance}}<br />
<syntaxhighlight lang="c++">void SetMaxDistance(float fMax)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|fMax|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetMinDistance}}<br />
<syntaxhighlight lang="c++">void SetMinDistance(float fMin)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|fMin|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetPan}}<br />
<syntaxhighlight lang="c++">void SetPan(float afPan)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afPan|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetPaused}}<br />
<syntaxhighlight lang="c++">void SetPaused(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetPosition}}<br />
<syntaxhighlight lang="c++">void SetPosition(const cVector3f &in avPos)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avPos|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetPostionIsHeadRelative}}<br />
<syntaxhighlight lang="c++">void SetPostionIsHeadRelative(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetPriority}}<br />
<syntaxhighlight lang="c++">void SetPriority(int alX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alX|int|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetReverbActive}}<br />
<syntaxhighlight lang="c++">void SetReverbActive(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetReverbAmount}}<br />
<syntaxhighlight lang="c++">void SetReverbAmount(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetSpeakerSpread}}<br />
<syntaxhighlight lang="c++">void SetSpeakerSpread(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetSpeed}}<br />
<syntaxhighlight lang="c++">void SetSpeed(float afSpeed)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afSpeed|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetVelocity}}<br />
<syntaxhighlight lang="c++">void SetVelocity(const cVector3f &in avVel)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avVel|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetVolume}}<br />
<syntaxhighlight lang="c++">void SetVolume(float afVolume)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afVolume|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Stop}}<br />
<syntaxhighlight lang="c++">void Stop()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{ReferencesSection}}<br />
<br />
{{HPL3RebirthScriptingCategories}}</div>
Abion47