Struct Ssf 

pub struct Ssf {
    pub sound_table_offset: u32,
    pub sounds: [StrRef; 28],
    pub reserved_entries: Vec<StrRef>,
}

In-memory SSF container.

Fields

sound_table_offset: u32

Byte offset from file start to the core sound table.

Most files use 12.

sounds: [StrRef; 28]

Core sound table entries (-1 means unset).

reserved_entries: Vec<StrRef>

Trailing entries after the core table.

KotOR/PyKotor typically write 12 entries set to -1.

Implementations

impl Ssf

pub fn new() -> Self

Creates an empty SSF with canonical defaults.

pub fn get(&self, slot: SsfSoundSlot) -> StrRef

Returns the StrRef for one sound slot.

pub fn set(&mut self, slot: SsfSoundSlot, strref: StrRef)

Sets the StrRef for one sound slot.

pub fn get_raw(&self, slot: SsfSoundSlot) -> i32

Returns the raw StrRef value for one sound slot.

pub fn set_raw(&mut self, slot: SsfSoundSlot, strref_raw: i32)

Sets a raw StrRef value for one sound slot.

pub fn reset(&mut self)

Resets all core slots to -1.

Trait Implementations

impl Clone for Ssf

fn clone(&self) -> Ssf

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Ssf

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DecodeBinary for Ssf

type Error = SsfBinaryError

Error type used by the format.

fn decode_binary(bytes: &[u8]) -> Result<Self, Self::Error>

Decodes a value from raw bytes.

impl Default for Ssf

fn default() -> Self

Returns the “default value” for a type.

impl EncodeBinary for Ssf

type Error = SsfBinaryError

Error type used by the format.

fn encode_binary(&self) -> Result<Vec<u8>, Self::Error>

Encodes a value into an owned byte buffer.

impl PartialEq for Ssf

fn eq(&self, other: &Ssf) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Ssf

impl StructuralPartialEq for Ssf