Difference between revisions of "HPL3/SOMA/Scripting/cSoundEntity"
Jump to navigation
Jump to search
(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. ==Fun...") |
|||
Line 168: | Line 168: | ||
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || UpdateLogic || <syntaxhighlight lang="c++" inline>float afTimeStep</syntaxhighlight> || | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || UpdateLogic || <syntaxhighlight lang="c++" inline>float afTimeStep</syntaxhighlight> || | ||
|} | |} | ||
+ | |||
+ | {{ReferencesSection}} | ||
{{HPL3SOMAScriptingCategories}} | {{HPL3SOMAScriptingCategories}} | ||
__FORCETOC__ | __FORCETOC__ |
Latest revision as of 15:20, 6 August 2020
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
Fields
cSoundEntity has no public fields.
Functions
Return Type | Function Name | Parameters | 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 | ,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 | ||
const tString& |
GetName | ||
float |
GetParam | int alIdx |
|
float |
GetParam | const tString &in asName |
|
bool |
GetRemoveWhenOver | ||
bool |
GetReverbActive | ||
float |
GetReverbAmount | ||
bool |
GetScriptableIsSaved | ||
cSoundEntry@ |
GetSoundEntry | bool abCheckEntryValidity |
|
const 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 |
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 |
References
- HPL3/SOMA/Scripting/cLuxAgent (← links)
- HPL3/SOMA/Scripting/cLuxArea (← links)
- HPL3/SOMA/Scripting/cLuxCritter (← links)
- HPL3/SOMA/Scripting/cLuxLiquidArea (← links)
- HPL3/SOMA/Scripting/cLuxProp (← links)
- HPL3/SOMA/Scripting/cLuxSoundscapeArea (← links)
- HPL3/SOMA/Scripting/cLuxVisibilityArea (← links)
- HPL3/SOMA/Scripting/cLuxVisibilityPortal (← links)
- HPL3/SOMA/Scripting/cSoundEntityIterator (← links)
- HPL3/SOMA/Scripting/cWorld (← links)
- HPL3/SOMA/Scripting/iLuxEntity (← links)
- HPL3/SOMA/Scripting/Scripting Api (← links)
- HPL3/SOMA/Scripting/Scripting Api/cLux (← links)
- HPL3/SOMA/Scripting/Scripting Api/cScene (← links)