Skip to main content

Module ssf

Module ssf 

Source
Expand description

SSF binary sound-set support. SSF binary reader and writer.

SSF (sound set file) resources map predefined sound-event slots to TLK string references (StrRef).

§Shape of the container

A 12-byte header, then 28 i32 slots located by sound_table_offset, then trailing reserved values. A slot’s position is its meaning – the list of 28 character actions is fixed and hardcoded – and an unset slot holds -1 rather than 0, since 0 is a valid StrRef.

Byte-level field maps live in docs/src/formats/audio/ssf.md, with the engine’s own load sequence and a note on the trailing entries, whose count matches a community tool rather than anything measured.

Structs§

Ssf
In-memory SSF container.

Enums§

SsfBinaryError
Errors produced while parsing or serializing SSF binary data.
SsfSoundSlot
Sound-slot identifiers for the SSF core table.

Functions§

read_ssf
Reads an SSF file from a reader.
read_ssf_from_bytes
Reads an SSF file directly from bytes.
write_ssf
Writes an SSF file to a writer.
write_ssf_to_vec
Serializes an SSF file into bytes.