Contents

struct

SushiEngine::Simulation::AudioEmitterParameters

The authorable parameters of an "Audio Emitter" entity.

Declared in
engine/world/simulation/include/SushiEngine/simulation/audio_parameters.hpp

An emitter entity plays a sound, positioned by the entity's transform. These mirror the fields the audio engine's VoiceDescriptor carries, in editor-facing form (plain scalars + a distance-model code), so the editor's audio system can spawn and steer a live voice from them. Stored as an archetype column on the entity.

Properties

sound_asset

The .wav this emitter plays, by permanent id; the authored half.

sound

Holds the resolved sound handle the host factory turns into a voice source.

gain

Linear base gain before attenuation.

priority

Voice-manager real-slot priority (higher wins).

bus

Target mixer bus id.

min_distance

Full gain within this radius (metres).

max_distance

Silent and cullable beyond this radius (metres).

distance_model

0 Linear, 1 Inverse, 2 Exponent.

rolloff

Rolloff factor for inverse/exponent models.

doppler_scale

Doppler exaggeration (0 off, 1 physical, >1 more).

reverb_send

Reverb aux-send level in [0, 1].

spatial

Whether distance/Doppler apply (else a 2D sound).

playing

Whether the emitter is currently sounding.

looping

Whether the source loops (music/ambience vs one-shot).

trigger

Restarts the sound from its beginning each time it is bumped.