Skip to main content

ContainerRelative

rpfm_lib::files::group_formations

Struct ContainerRelative 

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

A container block positioned relative to another block.

Similar to ContainerAbsolute but positioned at an offset from a reference block, allowing formations to be built up from interconnected positioned blocks.

Implementations§

Source§

impl ContainerRelative

Source

pub fn block_priority(&self) -> &f32

Priority for filling this block (higher priority blocks are filled first).

Source

pub fn relative_block_id(&self) -> &u32

ID of the block this is positioned relative to.

Source

pub fn entity_arrangement(&self) -> &EntityArrangement

How units should be arranged (line, column, crescent, etc.).

Source

pub fn inter_entity_spacing(&self) -> &f32

Spacing between units in this block.

Source

pub fn crescent_y_offset(&self) -> &f32

Y-axis offset for crescent formations.

Source

pub fn position_x(&self) -> &f32

X offset relative to the reference block.

Source

pub fn position_y(&self) -> &f32

Y offset relative to the reference block.

Source

pub fn minimum_entity_threshold(&self) -> &i32

Minimum number of units required to use this block.

Source

pub fn maximum_entity_threshold(&self) -> &i32

Maximum number of units that can be placed in this block.

Source

pub fn entity_preferences(&self) -> &Vec<EntityPreference>

Ordered list of preferred unit types for this block.

Source§

impl ContainerRelative

Source

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

Priority for filling this block (higher priority blocks are filled first).

Source

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

ID of the block this is positioned relative to.

Source

pub fn entity_arrangement_mut(&mut self) -> &mut EntityArrangement

How units should be arranged (line, column, crescent, etc.).

Source

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

Spacing between units in this block.

Source

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

Y-axis offset for crescent formations.

Source

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

X offset relative to the reference block.

Source

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

Y offset relative to the reference block.

Source

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

Minimum number of units required to use this block.

Source

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

Maximum number of units that can be placed in this block.

Source

pub fn entity_preferences_mut(&mut self) -> &mut Vec<EntityPreference>

Ordered list of preferred unit types for this block.

Source§

impl ContainerRelative

Source

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

Priority for filling this block (higher priority blocks are filled first).

Source

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

ID of the block this is positioned relative to.

Source

pub fn set_entity_arrangement(&mut self, val: EntityArrangement) -> &mut Self

How units should be arranged (line, column, crescent, etc.).

Source

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

Spacing between units in this block.

Source

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

Y-axis offset for crescent formations.

Source

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

X offset relative to the reference block.

Source

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

Y offset relative to the reference block.

Source

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

Minimum number of units required to use this block.

Source

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

Maximum number of units that can be placed in this block.

Source

pub fn set_entity_preferences( &mut self, val: Vec<EntityPreference>, ) -> &mut Self

Ordered list of preferred unit types for this block.

Trait Implementations§

Source§

impl Clone for ContainerRelative

Source§

fn clone(&self) -> ContainerRelative

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 ContainerRelative

Source§

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

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

impl Default for ContainerRelative

Source§

fn default() -> ContainerRelative

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

impl<'de> Deserialize<'de> for ContainerRelative

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 ContainerRelative

Source§

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

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 ContainerRelative

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,