Skip to main content

SoundEvents

rpfm_lib::files::sound_events

Struct SoundEvents 

Source 
pub struct SoundEvents { /* private fields */ }
Expand description

Sound events configuration for a game.

Contains the complete audio event system configuration including categories, event definitions, ambience mappings, and movie audio settings.

Note: Many fields in this format are not fully understood and are marked as uk_*.

Implementations§

Source§

impl SoundEvents

Source

pub fn master_volume(&self) -> &f32

Master volume level for all sounds.

Source

pub fn categories(&self) -> &Vec<Category>

Sound categories (e.g., music, SFX, voice).

Source

pub fn uk_1(&self) -> &Vec<Uk1>

Unknown data section 1.

Source

pub fn uk_4(&self) -> &Vec<Uk4>

Unknown data section 4.

Source

pub fn uk_5(&self) -> &Vec<Uk5>

Unknown data section 5.

Source

pub fn uk_6(&self) -> &u32

Unknown value 6.

Source

pub fn uk_7(&self) -> &u32

Unknown value 7.

Source

pub fn uk_8(&self) -> &Vec<Uk8>

Unknown data section 8.

Source

pub fn event_data(&self) -> &Vec<EventData>

Event data parameters referenced by event records.

Source

pub fn event_records(&self) -> &Vec<EventRecord>

Sound event definitions.

Source

pub fn ambience_map(&self) -> &Vec<AmbienceMap>

Ambience sound mappings.

Source

pub fn uk_3(&self) -> &Vec<Uk3>

Unknown data section 3.

Source

pub fn movies(&self) -> &Vec<Movie>

Movie audio configurations.

Source

pub fn uk_9(&self) -> &Vec<Uk9>

Unknown data section 9.

Source§

impl SoundEvents

Source

pub fn master_volume_mut(&mut self) -> &mut f32

Master volume level for all sounds.

Source

pub fn categories_mut(&mut self) -> &mut Vec<Category>

Sound categories (e.g., music, SFX, voice).

Source

pub fn uk_1_mut(&mut self) -> &mut Vec<Uk1>

Unknown data section 1.

Source

pub fn uk_4_mut(&mut self) -> &mut Vec<Uk4>

Unknown data section 4.

Source

pub fn uk_5_mut(&mut self) -> &mut Vec<Uk5>

Unknown data section 5.

Source

pub fn uk_6_mut(&mut self) -> &mut u32

Unknown value 6.

Source

pub fn uk_7_mut(&mut self) -> &mut u32

Unknown value 7.

Source

pub fn uk_8_mut(&mut self) -> &mut Vec<Uk8>

Unknown data section 8.

Source

pub fn event_data_mut(&mut self) -> &mut Vec<EventData>

Event data parameters referenced by event records.

Source

pub fn event_records_mut(&mut self) -> &mut Vec<EventRecord>

Sound event definitions.

Source

pub fn ambience_map_mut(&mut self) -> &mut Vec<AmbienceMap>

Ambience sound mappings.

Source

pub fn uk_3_mut(&mut self) -> &mut Vec<Uk3>

Unknown data section 3.

Source

pub fn movies_mut(&mut self) -> &mut Vec<Movie>

Movie audio configurations.

Source

pub fn uk_9_mut(&mut self) -> &mut Vec<Uk9>

Unknown data section 9.

Source§

impl SoundEvents

Source

pub fn set_master_volume(&mut self, val: f32) -> &mut Self

Master volume level for all sounds.

Source

pub fn set_categories(&mut self, val: Vec<Category>) -> &mut Self

Sound categories (e.g., music, SFX, voice).

Source

pub fn set_uk_1(&mut self, val: Vec<Uk1>) -> &mut Self

Unknown data section 1.

Source

pub fn set_uk_4(&mut self, val: Vec<Uk4>) -> &mut Self

Unknown data section 4.

Source

pub fn set_uk_5(&mut self, val: Vec<Uk5>) -> &mut Self

Unknown data section 5.

Source

pub fn set_uk_6(&mut self, val: u32) -> &mut Self

Unknown value 6.

Source

pub fn set_uk_7(&mut self, val: u32) -> &mut Self

Unknown value 7.

Source

pub fn set_uk_8(&mut self, val: Vec<Uk8>) -> &mut Self

Unknown data section 8.

Source

pub fn set_event_data(&mut self, val: Vec<EventData>) -> &mut Self

Event data parameters referenced by event records.

Source

pub fn set_event_records(&mut self, val: Vec<EventRecord>) -> &mut Self

Sound event definitions.

Source

pub fn set_ambience_map(&mut self, val: Vec<AmbienceMap>) -> &mut Self

Ambience sound mappings.

Source

pub fn set_uk_3(&mut self, val: Vec<Uk3>) -> &mut Self

Unknown data section 3.

Source

pub fn set_movies(&mut self, val: Vec<Movie>) -> &mut Self

Movie audio configurations.

Source

pub fn set_uk_9(&mut self, val: Vec<Uk9>) -> &mut Self

Unknown data section 9.

Trait Implementations§

Source§

impl Clone for SoundEvents

Source§

fn clone(&self) -> SoundEvents

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SoundEvents

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Decodeable for SoundEvents

Source§

fn decode<R: ReadBytes>( data: &mut R, extra_data: &Option<DecodeableExtraData<'_>>, ) -> Result<Self>

Decodes binary data into the implementing type. Read more
Source§

impl Default for SoundEvents

Source§

fn default() -> SoundEvents

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SoundEvents

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Encodeable for SoundEvents

Source§

fn encode<W: WriteBytes>( &mut self, buffer: &mut W, extra_data: &Option<EncodeableExtraData<'_>>, ) -> Result<()>

Encodes the implementing type into binary data. Read more
Source§

impl PartialEq for SoundEvents

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for SoundEvents

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SoundEvents

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,