Skip to main content

Tile

rpfm_lib::files::tile_database::tile

Struct Tile 

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

A single terrain tile definition.

Contains all properties for a terrain tile including dimensions, textures, rendering flags, and connection rules.

Implementations§

Source§

impl Tile

Source

pub fn serialise_version(&self) -> &u16

Serialisation format version.

Source

pub fn location(&self) -> &String

File path or location identifier.

Source

pub fn tile_set(&self) -> &String

Parent tile set name.

Source

pub fn mask(&self) -> &String

Mask texture path.

Source

pub fn width(&self) -> &u32

Tile width in units.

Source

pub fn height(&self) -> &u32

Tile height in units.

Source

pub fn red(&self) -> &f32

Red colour component (0.0-1.0).

Source

pub fn green(&self) -> &f32

Green colour component (0.0-1.0).

Source

pub fn blue(&self) -> &f32

Blue colour component (0.0-1.0).

Source

pub fn requires_infield_lodding(&self) -> &bool

Whether tile requires in-field LOD processing.

Source

pub fn random_rotatable(&self) -> &bool

Whether tile can be randomly rotated during placement.

Source

pub fn custom_alpha_blend_texture(&self) -> &String

Custom alpha blend texture path.

Source

pub fn scalable(&self) -> &bool

Whether tile can be scaled.

Source

pub fn encampable(&self) -> &bool

Whether units can encamp on this tile.

Source

pub fn custom_blend_tile(&self) -> &String

Custom blend tile reference.

Source

pub fn texture_red(&self) -> &String

Red channel texture path.

Source

pub fn texture_green(&self) -> &String

Green channel texture path.

Source

pub fn texture_blue(&self) -> &String

Blue channel texture path.

Source

pub fn texture_alpha(&self) -> &String

Alpha channel texture path.

Source

pub fn variations(&self) -> &Vec<TileVariation>

Visual variations of this tile.

Targets for tile linking.

Links to other tiles.

Source§

impl Tile

Source

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

Serialisation format version.

Source

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

File path or location identifier.

Source

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

Parent tile set name.

Source

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

Mask texture path.

Source

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

Tile width in units.

Source

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

Tile height in units.

Source

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

Red colour component (0.0-1.0).

Source

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

Green colour component (0.0-1.0).

Source

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

Blue colour component (0.0-1.0).

Source

pub fn requires_infield_lodding_mut(&mut self) -> &mut bool

Whether tile requires in-field LOD processing.

Source

pub fn random_rotatable_mut(&mut self) -> &mut bool

Whether tile can be randomly rotated during placement.

Source

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

Custom alpha blend texture path.

Source

pub fn scalable_mut(&mut self) -> &mut bool

Whether tile can be scaled.

Source

pub fn encampable_mut(&mut self) -> &mut bool

Whether units can encamp on this tile.

Source

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

Custom blend tile reference.

Source

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

Red channel texture path.

Source

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

Green channel texture path.

Source

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

Blue channel texture path.

Source

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

Alpha channel texture path.

Source

pub fn variations_mut(&mut self) -> &mut Vec<TileVariation>

Visual variations of this tile.

Targets for tile linking.

Links to other tiles.

Source§

impl Tile

Source

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

Serialisation format version.

Source

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

File path or location identifier.

Source

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

Parent tile set name.

Source

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

Mask texture path.

Source

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

Tile width in units.

Source

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

Tile height in units.

Source

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

Red colour component (0.0-1.0).

Source

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

Green colour component (0.0-1.0).

Source

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

Blue colour component (0.0-1.0).

Source

pub fn set_requires_infield_lodding(&mut self, val: bool) -> &mut Self

Whether tile requires in-field LOD processing.

Source

pub fn set_random_rotatable(&mut self, val: bool) -> &mut Self

Whether tile can be randomly rotated during placement.

Source

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

Custom alpha blend texture path.

Source

pub fn set_scalable(&mut self, val: bool) -> &mut Self

Whether tile can be scaled.

Source

pub fn set_encampable(&mut self, val: bool) -> &mut Self

Whether units can encamp on this tile.

Source

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

Custom blend tile reference.

Source

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

Red channel texture path.

Source

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

Green channel texture path.

Source

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

Blue channel texture path.

Source

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

Alpha channel texture path.

Source

pub fn set_variations(&mut self, val: Vec<TileVariation>) -> &mut Self

Visual variations of this tile.

Targets for tile linking.

Links to other tiles.

Trait Implementations§

Source§

impl Clone for Tile

Source§

fn clone(&self) -> Tile

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 Tile

Source§

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

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

impl Decodeable for Tile

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 Tile

Source§

fn default() -> Tile

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

impl<'de> Deserialize<'de> for Tile

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 Tile

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 Tile

Source§

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

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 Tile

Auto Trait Implementations§

§

impl Freeze for Tile

§

impl RefUnwindSafe for Tile

§

impl Send for Tile

§

impl Sync for Tile

§

impl Unpin for Tile

§

impl UnsafeUnpin for Tile

§

impl UnwindSafe for Tile

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.