Struct Terrain

pub struct Terrain {

    pub enabled: bool,
    pub slp_id: Option<GraphicID>,
    pub sound_id: Option<SoundID>,
    pub minimap_color_high: u8,
    pub minimap_color_medium: u8,
    pub minimap_color_low: u8,
    pub minimap_color_cliff_lt: u8,
    pub minimap_color_cliff_rt: u8,
    pub passable_terrain_id: Option<u8>,
    pub impassable_terrain_id: Option<u8>,
    pub animation: TerrainAnimation,
    pub elevation_sprites: Vec<TerrainSpriteFrame>,
    pub terrain_id_to_draw: Option<TerrainID>,
    pub borders: Vec<i16>,
    pub terrain_objects: Vec<TerrainObject>,
    /* private fields */
}

Fields

enabled: bool

Is this terrain enabled?

slp_id: Option<GraphicID>

SLP graphic ID for this terrain.

sound_id: Option<SoundID>

The Sound ID for this terrain.

minimap_color_high: u8

The colour tiles with this terrain will have on the minimap when on a downhill slope.

minimap_color_medium: u8

The colour tiles with this terrain will have on the minimap when on a flat tile.

minimap_color_low: u8

The colour tiles with this terrain will have on the minimap when on an uphill slope.

minimap_color_cliff_lt: u8

The colour tiles with this terrain will have on the minimap when next to a cliff.

minimap_color_cliff_rt: u8

The colour tiles with this terrain will have on the minimap when next to a cliff.

passable_terrain_id: Option<u8>

impassable_terrain_id: Option<u8>

animation: TerrainAnimation

elevation_sprites: Vec<TerrainSpriteFrame>

terrain_id_to_draw: Option<TerrainID>

borders: Vec<i16>

terrain_objects: Vec<TerrainObject>

Implementations

impl Terrain

pub fn name(&self) -> &str

Get the internal name of this terrain.

pub fn read_from( input: impl Read, version: FileVersion, num_terrains: u16, ) -> Result<Self>

Read a Terrain object from an input stream.

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

Serialize this object to a binary output stream.

Trait Implementations

impl Clone for Terrain

fn clone(&self) -> Terrain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Terrain

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

Formats the value using the given formatter.

impl Default for Terrain

fn default() -> Terrain

Returns the “default value” for a type.