Skip to main content

Module audio

Module audio 

Source
Expand description

Audio resources: Audio::SoundEffect (Runtime), and the game’s MusicList, AnimAudioEvent, AmbientEmitterDescription and AmbientEnvironmentDescription. See docs/AUDIO.md.

Structs§

AmbientEmitterDescription
AmbientEmitterDescription: the effects an ambient emitter feeds, and whether activation starts them.
AmbientEnvironmentDescription
AmbientEnvironmentDescription.
AmbientTerrain
One terrain class of an AmbientEnvironmentDescription (0x28 bytes).
AnimAudioEvent
AnimAudioEvent: an animation event that plays a 3D effect at the entity (sound type 4) with probability probability.
EffectSound
A sound of the effect’s timeline: starts start seconds after the effect.
MusicTrack
One MusicList track (0x18 bytes): played when the month and the town’s mood are in range.
SoundEffect
A sound effect: a timeline of sounds, each with variants, a pitch range and a volume, and the radius within which it can be heard.
SoundVariant
One playable variant of a sound (0x18 bytes: buffer, pitch range, volume).

Functions§

ambient_emitter_description
Read a AmbientEmitterDescription from the bytes of its resource.
ambient_environment_description
Read a AmbientEnvironmentDescription from the bytes of its resource.
anim_audio_event
Read a AnimAudioEvent from the bytes of its resource.
music_list
MusicList (Game/MusicTracks.rsc).
sound_effect
Read a SoundEffect from the bytes of its resource.