Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_AmbientSoundsComponent Interface Reference
Inheritance diagram for SCR_AmbientSoundsComponent:
AmbientSoundsComponent SoundComponent SimpleSoundComponent

Public Member Functions

EQueryType GetDominantTree ()
 
SCR_AudioHandleLoop SoundEventLooped (string soundEvent, vector transformation[4])
 Use to play sound events that has looped banks.
 
void TerminateLooped (SCR_AudioHandleLoop audioHandleLoop)
 Use to terminate looped sounds that were triggered using SoundEventLooped()
 
override void UpdateSoundJob (IEntity owner, float timeSlice)
 Call when component is in range.
 
override void OnPostInit (IEntity owner)
 
override void OnInit (IEntity owner)
 
void SCR_AmbientSoundsComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
 
void ~SCR_AmbientSoundsComponent ()
 
- Public Member Functions inherited from AmbientSoundsComponent
proto external void QueryAmbientSoundsBySphere (float radius, EQueryEntitiesFlags queryFlags=EQueryEntitiesFlags.ALL)
 
proto external void GetAmbientSoundsCountPerType (out notnull array< int > count)
 
proto external vector GetCameraOrigin ()
 
proto external bool GetRiver (const vector pos, out notnull array< float > count)
 
proto external IEntity GetRandomTree (int index, float minHeight)
 
proto external void GetClosestEntities (int soundTypeIdx, int nEntities, out notnull array< IEntity > output)
 
proto void TracePointToTerrain (const vector point, inout int iSoundGroup)
 
- Public Member Functions inherited from SoundComponent
proto external AudioHandle SoundEvent (string eventName)
 Play a sound from the owner entity's position.
 
proto external AudioHandle SoundEventTransform (string eventName, vector transf[])
 Play a sound from a set transformation.
 
proto external AudioHandle SoundEventBone (string eventName, string bone)
 Play a sound from the owner entity's position.
 
proto external AudioHandle SoundEventOffset (string eventName, vector offset)
 Play a sound with a given offset from the owner entity.
 
- Public Member Functions inherited from SimpleSoundComponent
proto external void EnableDynamicSimulation (bool value)
 Enables the dynamic simulation.
 
proto external void SetScriptedMethodsCall (bool state)
 Set flag for script callbacks.
 
proto external bool IsScriptedMethodsCallEnabled ()
 TRUE when flag for script callbacks is set.
 

Static Public Member Functions

static float GetPoint (float x, Curve curve)
 Uses linear interpolation to get value from curve.
 

Public Attributes

ref array< ref SCR_AmbientSoundsEffectm_aAmbientSoundsEffect
 

Static Public Attributes

const int WINDSPEED_MIN = 2
 
const int WINDSPEED_MAX = 12
 

Additional Inherited Members

- Protected Member Functions inherited from SimpleSoundComponent
void OnFrame (IEntity owner, float timeSlice)
 
void OnUpdateSoundJobBegin (IEntity owner)
 
void OnUpdateSoundJobEnd (IEntity owner)
 

Constructor & Destructor Documentation

◆ SCR_AmbientSoundsComponent()

void SCR_AmbientSoundsComponent.SCR_AmbientSoundsComponent ( IEntityComponentSource src,
IEntity ent,
IEntity parent )
Parameters
[in]src
[in]ent
[in]parent

◆ ~SCR_AmbientSoundsComponent()

void SCR_AmbientSoundsComponent.~SCR_AmbientSoundsComponent ( )

Member Function Documentation

◆ GetDominantTree()

EQueryType SCR_AmbientSoundsComponent.GetDominantTree ( )
Returns

◆ GetPoint()

static float SCR_AmbientSoundsComponent.GetPoint ( float x,
Curve curve )
static

Uses linear interpolation to get value from curve.

Parameters
[in]xRange <0, 1>
[in]curveCurve
Returns
value from curve

◆ OnInit()

override void SCR_AmbientSoundsComponent.OnInit ( IEntity owner)

◆ OnPostInit()

override void SCR_AmbientSoundsComponent.OnPostInit ( IEntity owner)

◆ SoundEventLooped()

SCR_AudioHandleLoop SCR_AmbientSoundsComponent.SoundEventLooped ( string soundEvent,
vector transformation[4] )

Use to play sound events that has looped banks.

Parameters
[in]soundEventSound event name
[in]transformationSound position
Returns

◆ TerminateLooped()

void SCR_AmbientSoundsComponent.TerminateLooped ( SCR_AudioHandleLoop audioHandleLoop)

Use to terminate looped sounds that were triggered using SoundEventLooped()

Parameters
[in]audioHandleLoop

◆ UpdateSoundJob()

override void SCR_AmbientSoundsComponent.UpdateSoundJob ( IEntity owner,
float timeSlice )

Call when component is in range.

Implements SimpleSoundComponent.

Member Data Documentation

◆ m_aAmbientSoundsEffect

ref array<ref SCR_AmbientSoundsEffect> SCR_AmbientSoundsComponent.m_aAmbientSoundsEffect

◆ WINDSPEED_MAX

const int SCR_AmbientSoundsComponent.WINDSPEED_MAX = 12
static

◆ WINDSPEED_MIN

const int SCR_AmbientSoundsComponent.WINDSPEED_MIN = 2
static

The documentation for this interface was generated from the following file: