The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:SoundNodeAmbient (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 11:47, 6 November 2009 by (Talk)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> SoundNode >> SoundNodeAmbient
Package: 
Engine
Direct subclass:
SoundNodeAmbientNonLoop
This class in other games:
UT3

Defines the parameters for an in world looping ambient sound e.g. a wind sound

Properties[edit]

Property group 'Attenuation'[edit]

bAttenuate[edit]

Type: bool

Enable attenuation via volume

Default value: True

bSpatialize[edit]

Type: bool

Enable the source to be positioned in 3D

Default value: True

dBAttenuationAtMax[edit]

Type: float

The volume at maximum distance in deciBels

Default value: -60.0

DistanceModel[edit]

Type: SoundNodeAttenuation.SoundDistanceModel

What kind of attenuation model to use

RadiusMax[edit]

Type: float

The range at which the sound has attenuated completely

Default value: 5000.0

RadiusMin[edit]

Type: float

The range at which the sound starts attenuating

Default value: 2000.0

Property group 'LowPassFilter'[edit]

bAttenuateWithLPF[edit]

Type: bool

Enable attenuation via low pass filter

LPFRadiusMax[edit]

Type: float

The range at which to apply the maximum amount of low pass filter

Default value: 7000.0

LPFRadiusMin[edit]

Type: float

The range at which to start applying a low passfilter

Default value: 3500.0

Property group 'Modulation'[edit]

PitchMax[edit]

Type: float

The upper bound of pitch (1.0 is no change)

Default value: 1.0

PitchMin[edit]

Type: float

The lower bound of pitch (1.0 is no change)

Default value: 1.0

VolumeMax[edit]

Type: float

The upper bound of volume (1.0 is no change)

Default value: 0.7

VolumeMin[edit]

Type: float

The lower bound of volume (1.0 is no change)

Default value: 0.7

Property group 'Sounds'[edit]

SoundSlots[edit]

Type: array<AmbientSoundSlot>

Sounds to play

Internal variables[edit]

bAttenuateWithLowPassFilter[edit]

Type: bool

Modifiers: deprecated


LPFMaxRadius[edit]

Type: DistributionFloat.RawDistributionFloat

Modifiers: deprecated


Default value:

Member Value
Distribution DistributionLPFMaxRadius
LookupTable
  1. 2500.0
  2. 2500.0
  3. 2500.0
  4. 2500.0
LookupTableChunkSize 1
LookupTableNumElements 1
Op 1

LPFMinRadius[edit]

Type: DistributionFloat.RawDistributionFloat

Modifiers: deprecated


Default value:

Member Value
Distribution DistributionLPFMinRadius
LookupTable
  1. 1500.0
  2. 1500.0
  3. 1500.0
  4. 1500.0
LookupTableChunkSize 1
LookupTableNumElements 1
Op 1

MaxRadius[edit]

Type: DistributionFloat.RawDistributionFloat

Modifiers: deprecated


Default value:

Member Value
Distribution DistributionMaxRadius
LookupTable
  1. 5000.0
  2. 5000.0
  3. 5000.0
  4. 5000.0
LookupTableChunkSize 1
LookupTableNumElements 1
Op 1

MinRadius[edit]

Type: DistributionFloat.RawDistributionFloat

Modifiers: deprecated


Default value:

Member Value
Distribution DistributionMinRadius
LookupTable
  1. 400.0
  2. 400.0
  3. 400.0
  4. 400.0
LookupTableChunkSize 1
LookupTableNumElements 1
Op 1

PitchModulation[edit]

Type: DistributionFloat.RawDistributionFloat

Modifiers: deprecated


Default value:

Member Value
Distribution DistributionPitch
LookupTable
  1. 1.0
  2. 1.0
  3. 1.0
  4. 1.0
LookupTableChunkSize 1
LookupTableNumElements 1
Op 1

VolumeModulation[edit]

Type: DistributionFloat.RawDistributionFloat

Modifiers: deprecated


Default value:

Member Value
Distribution DistributionVolume
LookupTable
  1. 0.7
  2. 0.7
  3. 0.7
  4. 0.7
LookupTableChunkSize 1
LookupTableNumElements 1
Op 1

Wave[edit]

Type: SoundNodeWave

Modifiers: deprecated


Structs[edit]

AmbientSoundSlot[edit]

Modifiers: native

SoundNodeWave Wave 
float PitchScale 
float VolumeScale 
float Weight 

Default values:

Property Value
PitchScale 1.0
VolumeScale 1.0
Weight 1.0