Skip to main content

EventRecord

rpfm_lib::files::sound_events

Struct EventRecord 

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

A sound event record.

Defines a triggerable sound event that references sound files and event data parameters.

Implementations§

Source§

impl EventRecord

Source

pub fn category(&self) -> &u32

Index of the category this event belongs to.

Source

pub fn name(&self) -> &Option<String>

Optional name of the event.

Source

pub fn uk_1(&self) -> &u32

Unknown value 1.

Source

pub fn uk_2(&self) -> &i32

Unknown value 2.

Source

pub fn uk_3(&self) -> &i32

Unknown value 3.

Source

pub fn event_data_index(&self) -> &u32

Index into the event_data array for this event’s parameters.

Source

pub fn uk_4(&self) -> &u8

Unknown value 4.

Source

pub fn sounds(&self) -> &Vec<String>

List of sound file paths associated with this event.

Source§

impl EventRecord

Source

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

Index of the category this event belongs to.

Source

pub fn name_mut(&mut self) -> &mut Option<String>

Optional name of the event.

Source

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

Unknown value 1.

Source

pub fn uk_2_mut(&mut self) -> &mut i32

Unknown value 2.

Source

pub fn uk_3_mut(&mut self) -> &mut i32

Unknown value 3.

Source

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

Index into the event_data array for this event’s parameters.

Source

pub fn uk_4_mut(&mut self) -> &mut u8

Unknown value 4.

Source

pub fn sounds_mut(&mut self) -> &mut Vec<String>

List of sound file paths associated with this event.

Source§

impl EventRecord

Source

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

Index of the category this event belongs to.

Source

pub fn set_name(&mut self, val: Option<String>) -> &mut Self

Optional name of the event.

Source

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

Unknown value 1.

Source

pub fn set_uk_2(&mut self, val: i32) -> &mut Self

Unknown value 2.

Source

pub fn set_uk_3(&mut self, val: i32) -> &mut Self

Unknown value 3.

Source

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

Index into the event_data array for this event’s parameters.

Source

pub fn set_uk_4(&mut self, val: u8) -> &mut Self

Unknown value 4.

Source

pub fn set_sounds(&mut self, val: Vec<String>) -> &mut Self

List of sound file paths associated with this event.

Trait Implementations§

Source§

impl Clone for EventRecord

Source§

fn clone(&self) -> EventRecord

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 EventRecord

Source§

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

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

impl Default for EventRecord

Source§

fn default() -> EventRecord

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

impl<'de> Deserialize<'de> for EventRecord

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 PartialEq for EventRecord

Source§

fn eq(&self, other: &EventRecord) -> 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 EventRecord

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 EventRecord

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,