Skip to main content

BuildingLink

Struct BuildingLink 

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

Links a building instance to a prefab instance.

Building links establish relationships between buildings in the battlefield building list and their associated prefab instances. This allows buildings to reference prefab data for models, textures, and other assets.

§Fields

  • serialise_version: Format version (1-3)
  • building_index: Index of the building in the building list
  • prefab_index: Index of the prefab in the prefab list
  • prefab_building_key: String key identifying the prefab building
  • uid: Unique identifier for this building link
  • prefab_uid: Unique identifier of the associated prefab
  • building_reference: Reference data for the building

§Example

use rpfm_lib::files::bmd::common::building_link::BuildingLink;

let mut link = BuildingLink::default();
link.set_serialise_version(3);
link.set_building_index(5);
link.set_prefab_building_key("settlement_wall_01".to_string());

Implementations§

Source

pub fn serialise_version(&self) -> &u16

Format version number (1-3).

Source

pub fn building_index(&self) -> &i32

Index of the building in the building list.

Source

pub fn prefab_index(&self) -> &i32

Index of the prefab in the prefab list.

Source

pub fn prefab_building_key(&self) -> &String

String key identifying the prefab building.

Source

pub fn uid(&self) -> &u64

Unique identifier for this building link.

Source

pub fn prefab_uid(&self) -> &u64

Unique identifier of the associated prefab.

Source

pub fn building_reference(&self) -> &BuildingReference

Reference data for the building.

Source

pub fn serialise_version_mut(&mut self) -> &mut u16

Format version number (1-3).

Source

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

Index of the building in the building list.

Source

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

Index of the prefab in the prefab list.

Source

pub fn prefab_building_key_mut(&mut self) -> &mut String

String key identifying the prefab building.

Source

pub fn uid_mut(&mut self) -> &mut u64

Unique identifier for this building link.

Source

pub fn prefab_uid_mut(&mut self) -> &mut u64

Unique identifier of the associated prefab.

Source

pub fn building_reference_mut(&mut self) -> &mut BuildingReference

Reference data for the building.

Source

pub fn set_serialise_version(&mut self, val: u16) -> &mut Self

Format version number (1-3).

Source

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

Index of the building in the building list.

Source

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

Index of the prefab in the prefab list.

Source

pub fn set_prefab_building_key(&mut self, val: String) -> &mut Self

String key identifying the prefab building.

Source

pub fn set_uid(&mut self, val: u64) -> &mut Self

Unique identifier for this building link.

Source

pub fn set_prefab_uid(&mut self, val: u64) -> &mut Self

Unique identifier of the associated prefab.

Source

pub fn set_building_reference(&mut self, val: BuildingReference) -> &mut Self

Reference data for the building.

Trait Implementations§

Source§

fn clone(&self) -> BuildingLink

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§

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

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

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

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

fn default() -> BuildingLink

Returns the “default value” for a type. Read more
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§

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

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

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

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

Serialize this value into the given Serde serializer. Read more

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,