API

Classes
class	AbstractSoundScene
class	SoundObject
class	AbstractWaveEvents

Functions
	SetSoundControllerOverride (string controllerName, float value, SoundControllerAction action)
proto native void	MuteAllSoundControllers ()
proto native void	ResetAllSoundControllers ()
class AbstractSoundScene	SoundObjectBuilder (SoundParams soundParams)
SoundObject	BuildSoundObject ()
proto native void	Initialize (SoundParams soundParams)
proto native void	AddEnvSoundVariables (vector position)
proto native void	AddVariable (string name, float value)
proto void	AddVariables (notnull array< string > names, array< float > values=null)
void	UpdateEnvSoundControllers (vector position)
	Deprecated - same functionality, just poor naming.
void	SetVariable (string name, float value)
	Deprecated - same functionality, just poor naming.
class SoundObject	SoundParams (string name)
void	SoundObject (SoundParams soundParams)
proto void	UpdateVariables (notnull array< float > values)
proto native void	SetParent (IEntity parent, int pivot=-1)
proto native IEntity	GetParent ()
	Get parent of the Effect.
proto native int	GetHierarchyPivot ()
proto native void	SetPosition (vector position)
	Note: Sets the position locally if parented, retrieves globally with the sound offset.
proto native vector	GetPosition ()
	Get the world position of the Effect.
proto native void	SetSpeed (vector speed)
	Note: Sets the speed locally if parented, retrieves globally with the parent speed.
proto native vector	GetSpeed ()
proto native void	SetOcclusionObstruction (float occlusion, float obstruction)
proto native void	SetKind (WaveKind kind)
proto native bool	Load (string name)
proto native bool	IsValid ()
	Checks if the ScriptCaller is valid.
proto string	GetName ()
	Test name getter. Strictly for UI porposes!
class AbstractWaveEvents	InitEvents ()
void	AbstractWave ()
proto void	SetUserData (Managed inst)
proto Managed	GetUserData ()
proto void	Play ()
void	PlayWithOffset (float offset)
proto void	Stop ()
	Stops all elements this effect consists of.
proto void	Restart ()
proto void	SetStartOffset (float offset)
proto float	GetLength ()
	WARNING: Blocking! Waits for header to load.
proto float	GetCurrPosition ()
	Current position in percentage of total length.
proto void	Loop (bool setLoop)
proto float	GetVolume ()
proto void	SetVolume (float value)
proto void	SetVolumeRelative (float value)
proto void	SetFrequency (float value)
proto float	GetFrequency ()
proto void	SetPosition (vector position, vector velocity="0 0 0")
proto void	SetFadeInFactor (float volume)
proto void	SetFadeOutFactor (float volume)
proto void	SetDoppler (bool setDoppler)
proto void	Skip (float timeSec)
proto bool	IsHeaderLoaded ()
AbstractWaveEvents	GetEvents ()
void	OnPlay ()
void	OnStop ()
void	OnLoad ()
void	OnHeaderLoad ()
void	OnEnd ()

Variables
	WAVEEFFECT
	WAVEEFFECTEX
	WAVESPEECH
	WAVEMUSIC
	WAVESPEECHEX
	WAVEENVIRONMENT
	WAVEENVIRONMENTEX
	WAVEWEAPONS
	WAVEWEAPONSEX
	WAVEATTALWAYS
	WAVEUI
	None
	Limit
ref ScriptInvoker	Event_OnSoundWaveStarted = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveStopped = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveLoaded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveHeaderLoaded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveEnded = new ScriptInvoker()

Detailed Description

Function Documentation

AbstractWave()

void AbstractWave

(

)

Definition at line 167 of file sound.c.

AddEnvSoundVariables()

proto native void AddEnvSoundVariables

(

vector

position

)

AddVariable()

proto native void AddVariable	(	string	name,
		float	value )

AddVariables()

proto void AddVariables	(	notnull array< string >	names,
		array< float >	values = null )

BuildSoundObject()

SoundObject BuildSoundObject

(

)

Definition at line 86 of file sound.c.

GetCurrPosition()

proto float GetCurrPosition

(

)

Current position in percentage of total length.

GetEvents()

AbstractWaveEvents GetEvents

(

)

Definition at line 201 of file sound.c.

GetFrequency()

proto float GetFrequency

(

)

GetHierarchyPivot()

proto native int SoundParams::GetHierarchyPivot

(

)

GetLength()

proto float GetLength

(

)

WARNING: Blocking! Waits for header to load.

GetName()

proto string GetName

(

)

Test name getter. Strictly for UI porposes!

Gets the name which is set for the ParticleManager, default is "ParticleSourceManager".

Suite class name getter. Strictly for UI porposes!

Definition at line 50 of file syncedvalue.c.

GetParent()

proto native IEntity SoundParams::GetParent

(

)

Get parent of the Effect.

Note

Same as GetAttachmentParent, but more generic name

Warning

Only gets the cached variable, for immediate effect use GetCurrent variant

Returns

Object The parent of the Effect

Definition at line 422 of file effect.c.

GetPosition()

proto native vector SoundParams::GetPosition

(

)

Get the world position of the Effect.

Warning

Only gets the cached variable, for immediate effect use GetCurrent variant

Returns

vector The world position of the Effect

Definition at line 47 of file undergroundarealoader.c.

GetSpeed()

proto native vector SoundParams::GetSpeed

(

)

GetUserData()

proto Managed GetUserData

(

)

GetVolume()

proto float GetVolume

(

)

InitEvents()

class AbstractWaveEvents InitEvents

(

)

Definition at line 143 of file sound.c.

Initialize()

proto native void Initialize

(

SoundParams

soundParams

)

IsHeaderLoaded()

proto bool IsHeaderLoaded

(

)

IsValid()

proto native bool IsValid

(

)

Checks if the ScriptCaller is valid.

Checks if the ScriptCaller is valid.

Definition at line 251 of file catchingcontextbase.c.

Load()

proto native bool Load

(

string

name

)

Loop()

proto void Loop

(

bool

setLoop

)

MuteAllSoundControllers()

proto native void MuteAllSoundControllers

(

)

Overrides all the environment controllers to be muted

OnEnd()

void OnEnd

(

)

Definition at line 226 of file sound.c.

OnHeaderLoad()

void OnHeaderLoad

(

)

Definition at line 221 of file sound.c.

OnLoad()

void OnLoad

(

)

Definition at line 216 of file sound.c.

OnPlay()

void OnPlay

(

)

Definition at line 206 of file sound.c.

OnStop()

void OnStop

(

)

Definition at line 211 of file sound.c.

Play()

override EAnimPlayState Play

(

)

Definition at line 144 of file smptanimmeta.c.

PlayWithOffset()

void PlayWithOffset

(

float

offset

)

Definition at line 175 of file sound.c.

ResetAllSoundControllers()

proto native void ResetAllSoundControllers

(

)

Removes all the previously set overrides of sound controllers

Restart()

proto void Restart

(

)

SetDoppler()

proto void SetDoppler

(

bool

setDoppler

)

SetFadeInFactor()

proto void SetFadeInFactor

(

float

volume

)

SetFadeOutFactor()

proto void SetFadeOutFactor

(

float

volume

)

SetFrequency()

proto void SetFrequency

(

float

value

)

SetKind()

proto native void SoundParams::SetKind

(

WaveKind

kind

)

SetOcclusionObstruction()

proto native void SoundParams::SetOcclusionObstruction	(	float	occlusion,
		float	obstruction )

SetParent()

proto native void SoundParams::SetParent	(	IEntity	parent,
		int	pivot = -1 )

Note: 'SoundObject' is not an Entity, and therefore can not be accessed by using 'IEntity.GetChildren', though internally 'SoundObject.SetParent' is similiar to 'IEntity.AddChild' by creating an 'EntityHierarchyComponent'

SetPosition() [1/2]

proto native void SoundParams::SetPosition

(

vector

pos

)

Note: Sets the position locally if parented, retrieves globally with the sound offset.

Note: Sets the position locally if parented, retrieves globally with the sound offset.

Warning

Only sets the cached variable, for immediate effect use SetCurrent variant

Parameters

pos	vector The world position for the Effect

Definition at line 463 of file effect.c.

SetPosition() [2/2]

proto void SetPosition	(	vector	position,
		vector	velocity = "0 0 0" )

SetSoundControllerOverride()

SetSoundControllerOverride	(	string	controllerName,
		float	value,
		SoundControllerAction	action )

Overrides or limits soundmap value for a sound cotroller

Parameters

controllerName	the sound controller name. One of: rain,night,meadow,trees,hills,houses,windy,deadBody,sea,forest,altitudeGround,altitudeSea,altitudeSurface,daytime,shooting,coast,waterDepth,overcast,fog,snowfall,caveSmall,caveBig
action	what action will be used on the normal landscape sound controller value
value	the new value of sound controller

SetSpeed()

proto native void SoundParams::SetSpeed

(

vector

speed

)

Note: Sets the speed locally if parented, retrieves globally with the parent speed.

SetStartOffset()

proto void SetStartOffset

(

float

offset

)

SetUserData()

proto void SetUserData

(

Managed

inst

)

SetVariable()

void SetVariable	(	string	name,
		float	value )

Deprecated - same functionality, just poor naming.

Definition at line 104 of file sound.c.

SetVolume()

proto void SetVolume

(

float

value

)

SetVolumeRelative()

proto void SetVolumeRelative

(

float

value

)

Skip()

proto void Skip

(

float

timeSec

)

SoundObject()

void SoundParams::SoundObject

(

SoundParams

soundParams

)

SoundObjectBuilder()

class AbstractSoundScene SoundObjectBuilder

(

SoundParams

soundParams

)

SoundParams()

class SoundObject SoundParams

(

string

name

)

Stop()

proto void Stop

(

)

Stops all elements this effect consists of.

Note

Alternatively use SEffectManager.Stop( effect_id )

Stops all elements this effect consists of.

Definition at line 183 of file effect.c.

UpdateEnvSoundControllers()

void UpdateEnvSoundControllers

(

vector

position

)

Deprecated - same functionality, just poor naming.

Definition at line 98 of file sound.c.

UpdateVariables()

proto void SoundParams::UpdateVariables

(

notnull array< float >

values

)

Variable Documentation

Event_OnSoundWaveEnded

ref ScriptInvoker Event_OnSoundWaveEnded = new ScriptInvoker()

Definition at line 162 of file sound.c.

Event_OnSoundWaveHeaderLoaded

ref ScriptInvoker Event_OnSoundWaveHeaderLoaded = new ScriptInvoker()

Definition at line 161 of file sound.c.

Event_OnSoundWaveLoaded

ref ScriptInvoker Event_OnSoundWaveLoaded = new ScriptInvoker()

Definition at line 160 of file sound.c.

Event_OnSoundWaveStarted

ref ScriptInvoker Event_OnSoundWaveStarted = new ScriptInvoker()

Definition at line 158 of file sound.c.

Event_OnSoundWaveStopped

ref ScriptInvoker Event_OnSoundWaveStopped = new ScriptInvoker()

Definition at line 159 of file sound.c.

Limit

Limit

None

None

WAVEATTALWAYS

WAVEATTALWAYS

Definition at line 12 of file sound.c.

WAVEEFFECT

WAVEEFFECT

Definition at line 3 of file sound.c.

WAVEEFFECTEX

WAVEEFFECTEX

Definition at line 4 of file sound.c.

WAVEENVIRONMENT

WAVEENVIRONMENT

Definition at line 8 of file sound.c.

WAVEENVIRONMENTEX

WAVEENVIRONMENTEX

Definition at line 9 of file sound.c.

WAVEMUSIC

WAVEMUSIC

Definition at line 6 of file sound.c.

WAVESPEECH

WAVESPEECH

Definition at line 5 of file sound.c.

WAVESPEECHEX

WAVESPEECHEX

Definition at line 7 of file sound.c.

WAVEUI

WAVEUI

Definition at line 13 of file sound.c.

WAVEWEAPONS

WAVEWEAPONS

Definition at line 10 of file sound.c.

WAVEWEAPONSEX

WAVEWEAPONSEX

Definition at line 11 of file sound.c.