SfxGeComponentDef

Inheritance 1 ancestor · 40 siblings

IGeComponentDef

Class Documentation

An ambient sound placed on the map, with an optional area. It sits in the Sfx field of an SfxEntityTemplate.

When the entity activates, the SfxGeComponent creates a sound emitter and posts SoundName on it, once. Deactivation and reset stop the sound and release the emitter. While the sound plays, the component moves the emitter each tick:

Without shapeData, the emitter stays at the entity position.
With shapeData, the emitter is at the point of the outline nearest to the listener, measured on the ground plane and recomputed every 0.05 seconds. If FillVolume is set and the listener is inside the outline, the emitter is on the listener instead, so the sound fills the area.

Properties

0x610b3282

Bool = false

Removed in 16.4 16.3

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

0x6a6c6fe

Bool = false

16.2

Documentation Edit documentation

If set, the component sets the Wwise RTPC Distance2D_To_Camera on the emitter every tick.

FillVolume

Bool = true

16.2

Documentation Edit documentation

If set, the emitter follows the listener while the listener is inside the outline.

SoundName

String = ""

16.2

Documentation Edit documentation

Name of the Wwise event that the emitter posts when the entity activates.

shapeData

Pointer<EntityShapeData> = null

16.2

Documentation Edit documentation

The outline of the sound area, as an EntityShapeData. Its points are offsets from the entity position. If it is not set, the sound is a single point at the entity position.

Referenced by 1 class · 1 property

SfxEntityTemplate Sfx Embed<SfxGeComponentDef>