Struct TileDatabase 

pub struct TileDatabase { /* private fields */ }

In-memory representation of a decoded tile database file.

Contains all terrain tile definitions and related configuration data used by the game’s terrain system.

Fields

• serialise_version - Format version (currently only 1 is supported).
• render_params - Global rendering parameters for terrain tiles.
• conversion_params - Parameters for tile format conversion.
• climates - Climate-specific tile configurations.
• tile_sets - Groups of related tiles.
• tiles - Individual tile definitions.

Implementations

impl TileDatabase

pub fn from_assembly_kit( settings: &str, tiles: &[&str], order: Option<&[String]>, add_user_tile_set: bool, ) -> Result<Self>

Builds a tile database from its sources in the Assembly Kit.

Tile sets that tiles use but _settings.xml doesn’t define are added after the defined ones, with empty values, and so is the user set if requested: the battle database always has it, the campaign one doesn’t.

Arguments

• settings - The contents of _settings.xml.
• tiles - The contents of each tile’s XML.
• order - Locations of the tiles, in the order they go in the database. If None, larger tiles go first, then by location.
• add_user_tile_set - If the user tile set is added.

Returns

The tile database.

Errors

Returns RLibError::DecodingTileDatabaseXml if any source is malformed, or a tile is missing from order.

impl TileDatabase

pub fn serialise_version(&self) -> &u16

Serialisation format version.

pub fn render_params(&self) -> &RenderParams

Global rendering parameters.

pub fn conversion_params(&self) -> &ConversionParams

Tile conversion parameters.

pub fn climates(&self) -> &Vec<Climate>

Climate definitions with tile variations.

pub fn tile_sets(&self) -> &Vec<TileSet>

Tile set groupings.

pub fn tiles(&self) -> &Vec<Tile>

Individual tile definitions.

impl TileDatabase

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

Serialisation format version.

pub fn render_params_mut(&mut self) -> &mut RenderParams

Global rendering parameters.

pub fn conversion_params_mut(&mut self) -> &mut ConversionParams

Tile conversion parameters.

pub fn climates_mut(&mut self) -> &mut Vec<Climate>

Climate definitions with tile variations.

pub fn tile_sets_mut(&mut self) -> &mut Vec<TileSet>

Tile set groupings.

pub fn tiles_mut(&mut self) -> &mut Vec<Tile>

Individual tile definitions.

impl TileDatabase

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

Serialisation format version.

pub fn set_render_params(&mut self, val: RenderParams) -> &mut Self

Global rendering parameters.

pub fn set_conversion_params(&mut self, val: ConversionParams) -> &mut Self

Tile conversion parameters.

pub fn set_climates(&mut self, val: Vec<Climate>) -> &mut Self

Climate definitions with tile variations.

pub fn set_tile_sets(&mut self, val: Vec<TileSet>) -> &mut Self

Tile set groupings.

pub fn set_tiles(&mut self, val: Vec<Tile>) -> &mut Self

Individual tile definitions.

Trait Implementations

impl Clone for TileDatabase

fn clone(&self) -> TileDatabase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TileDatabase

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

Formats the value using the given formatter.

impl Decodeable for TileDatabase

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

Decodes binary data into the implementing type.

impl Default for TileDatabase

fn default() -> TileDatabase

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TileDatabase

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodeable for TileDatabase

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

Encodes the implementing type into binary data.

impl PartialEq for TileDatabase

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TileDatabase

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TileDatabase