Struct DatFile

pub struct DatFile {
    pub terrain_tables: Vec<TerrainRestriction>,
    pub tile_sizes: Vec<TileSize>,
    pub terrains: Vec<Terrain>,
    pub terrain_borders: Vec<TerrainBorder>,
    pub color_tables: Vec<ColorTable>,
    pub sounds: Vec<Sound>,
    pub sprites: Vec<Option<Sprite>>,
    pub effects: Vec<TechEffect>,
    pub task_lists: Vec<Option<TaskList>>,
    pub civilizations: Vec<Civilization>,
    pub techs: Vec<Tech>,
    pub tech_tree: TechTree,
    /* private fields */
}

A data file.

Fields

terrain_tables: Vec<TerrainRestriction>

Terrain restriction tables.

tile_sizes: Vec<TileSize>

Tile size data.

terrains: Vec<Terrain>

Terrains.

terrain_borders: Vec<TerrainBorder>

Terrain border data, specifying how different terrains blend.

color_tables: Vec<ColorTable>

Data about player colours.

sounds: Vec<Sound>

The available sounds.

sprites: Vec<Option<Sprite>>

The available sprites.

effects: Vec<TechEffect>

Tech effect data.

task_lists: Vec<Option<TaskList>>

Task lists for unit types.

civilizations: Vec<Civilization>

The available civilizations.

techs: Vec<Tech>

Techs or researches.

tech_tree: TechTree

Tech tree data.

Implementations

impl DatFile

pub fn read_from(input: impl Read) -> Result<Self>

Read a data file from a compressed byte stream.

pub fn write_to<W: Write>(&self, output: &mut W) -> Result<()>

Serialize this data file to an output stream. Compression is applied by this function.

pub fn get_tech(&self, id: impl Into<TechID>) -> Option<&Tech>

Get a tech by its ID.

pub fn get_terrain(&self, id: impl Into<TerrainID>) -> Option<&Terrain>

Get a terrain type by its ID.

pub fn get_gaia(&self) -> Option<&Civilization>

Get the GAIA civilization.

pub fn get_civilization( &self, id: impl Into<CivilizationID>, ) -> Option<&Civilization>

Get a civilization by its ID.

pub fn get_sound(&self, id: impl Into<SoundID>) -> Option<&Sound>

Get a sound by its ID.

pub fn get_sprite(&self, id: impl Into<SpriteID>) -> Option<&Sprite>

Get a sprite by its ID.

Trait Implementations

impl Clone for DatFile

fn clone(&self) -> DatFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatFile

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

Formats the value using the given formatter.