Struct genie::Scenario

pub struct Scenario { /* fields omitted */ }

A Scenario file.

Methods

impl Scenario

pub fn from<R>(input: &mut R) -> Result<Scenario, Error> where
    R: Read, 

Read a scenario file.

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

Write the scenario file to an output stream.

Equivalent to scen.write_to_version(scen.version()).

pub fn write_to_version<W>(
    &self,
    output: &mut W,
    version: &VersionBundle
) -> Result<(), Error> where
    W: Write, 

Write the scenario file to an output stream, targeting specific game versions.

pub fn format_version(&self) -> [u8; 4]

Get the format version of this SCX file.

pub fn header_version(&self) -> u32

Get the header version for this SCX file.

pub fn data_version(&self) -> f32

Get the data version for this SCX file.

pub fn header(&self) -> &SCXHeader

Get the header.

pub fn description(&self) -> Option<&str>

Get the scenario description.

pub fn filename(&self) -> &str

Get the scenario filename.

pub fn version(&self) -> &VersionBundle

Get data about the game versions this scenario file was made for.

pub fn requires_dlc(&self, dlc: DLCPackage) -> bool

Check if this scenario requires the given DLC (for HD Edition scenarios only).

pub fn objects(&self) -> impl Iterator<Item = &ScenarioObject>

Iterate over all the objects placed in the scenario.

pub fn objects_mut(&mut self) -> impl Iterator<Item = &mut ScenarioObject>

Iterate mutably over all the objects placed in the scenario.

pub fn map(&self) -> &Map

Get the map/terrain data for this scenario.

pub fn map_mut(&mut self) -> &mut Map

Get the (mutable) map/terrain data for this scenario.

pub fn triggers(&self) -> Option<&TriggerSystem>

Get trigger data for this scenario if it exists.

pub fn triggers_mut(&mut self) -> Option<&mut TriggerSystem>

Get (mutable) trigger data for this scenario if it exists.