Skip to main content

Climate

rpfm_lib::files::tile_database::climate

Struct Climate 

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

A climate definition with textures and colour modifiers.

Climates affect the visual appearance of terrain tiles by providing texture sets and colour adjustments for different environmental conditions.

Implementations§

Source§

impl Climate

Source

pub fn serialise_version(&self) -> &u16

Serialisation format version.

Source

pub fn name(&self) -> &String

Climate identifier name.

Source

pub fn texture_set(&self) -> &String

Associated texture set name.

Source

pub fn red(&self) -> &f32

Red colour modifier (0.0-1.0).

Source

pub fn green(&self) -> &f32

Green colour modifier (0.0-1.0).

Source

pub fn blue(&self) -> &f32

Blue colour modifier (0.0-1.0).

Source

pub fn textures(&self) -> &Vec<Texture>

Textures used by this climate.

Source

pub fn grass_alpha_add(&self) -> &f32

Additive grass alpha adjustment.

Source

pub fn grass_alpha_mul(&self) -> &f32

Multiplicative grass alpha adjustment.

Source

pub fn destruction_climate(&self) -> &String

Climate to use for destruction effects.

Source§

impl Climate

Source

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

Serialisation format version.

Source

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

Climate identifier name.

Source

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

Associated texture set name.

Source

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

Red colour modifier (0.0-1.0).

Source

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

Green colour modifier (0.0-1.0).

Source

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

Blue colour modifier (0.0-1.0).

Source

pub fn textures_mut(&mut self) -> &mut Vec<Texture>

Textures used by this climate.

Source

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

Additive grass alpha adjustment.

Source

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

Multiplicative grass alpha adjustment.

Source

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

Climate to use for destruction effects.

Source§

impl Climate

Source

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

Serialisation format version.

Source

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

Climate identifier name.

Source

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

Associated texture set name.

Source

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

Red colour modifier (0.0-1.0).

Source

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

Green colour modifier (0.0-1.0).

Source

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

Blue colour modifier (0.0-1.0).

Source

pub fn set_textures(&mut self, val: Vec<Texture>) -> &mut Self

Textures used by this climate.

Source

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

Additive grass alpha adjustment.

Source

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

Multiplicative grass alpha adjustment.

Source

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

Climate to use for destruction effects.

Trait Implementations§

Source§

impl Clone for Climate

Source§

fn clone(&self) -> Climate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Climate

Source§

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

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

impl Decodeable for Climate

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 Climate

Source§

fn default() -> Climate

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

impl<'de> Deserialize<'de> for Climate

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 Climate

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 Climate

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Climate

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 Climate

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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
Source§

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

§

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.