Struct AssetVariationDb 

pub struct AssetVariationDb { /* private fields */ }

An asset variation database.

Implementations

impl AssetVariationDb

pub fn to_xml(&self) -> String

Returns the database in the XML form of the packs: UTF-8, CRLF line ends, tab indentation and single-quoted attributes.

pub fn from_xml(xml: &str) -> Result<Self>

Reads a database from the XML form of the packs. Whitespace between elements doesn’t matter.

Errors

Returns RLibError::DecodingAssetVariationDbXml if the XML is malformed, or doesn’t have the structure of the database.

pub fn from_environment_map(xml: &str) -> Result<Self>

Builds a database from its source in the Assembly Kit, raw_data/warscape_asset_variation_db/environment_map.xml.

Each environment_file lists the values it allows per category, comma-separated, and an empty or missing list allows every value. The database gets the single entry environment. The categories go in a fixed order, with their values sorted: the bit order the game’s tools use isn’t known, but it doesn’t change what matches.

Errors

Returns RLibError::DecodingAssetVariationDbXml if the XML is malformed, has no environment_file, or more values than bits.

impl AssetVariationDb

pub fn serialise_version(&self) -> &u16

Version of the format.

pub fn categories(&self) -> &Vec<VariationCategory>

Categories of the conditions of a battle, with their values.

pub fn entries(&self) -> &Vec<VariationEntry>

Lists of variations, by key.

impl AssetVariationDb

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

Version of the format.

pub fn categories_mut(&mut self) -> &mut Vec<VariationCategory>

Categories of the conditions of a battle, with their values.

pub fn entries_mut(&mut self) -> &mut Vec<VariationEntry>

Lists of variations, by key.

impl AssetVariationDb

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

Version of the format.

pub fn set_categories(&mut self, val: Vec<VariationCategory>) -> &mut Self

Categories of the conditions of a battle, with their values.

pub fn set_entries(&mut self, val: Vec<VariationEntry>) -> &mut Self

Lists of variations, by key.

impl AssetVariationDb

pub fn value_count(&self) -> usize

Amount of values of all the categories together.

pub fn category(&self, name: &str) -> Option<&VariationCategory>

Returns the category with the provided name, if any.

pub fn entry(&self, key: &str) -> Option<&VariationEntry>

Returns the entry with the provided key, if any.

pub fn bit(&self, category: &str, value: &str) -> u32

Bit of a value of a category, or 0 if the category or the value don’t exist.

pub fn value_bit(&self, value: &str) -> Option<u32>

Bit the game gives a value: that of the first value with this name in any category, or None if no category has it.

pub fn query_mask(&self, query: &VariationQuery) -> Option<u32>

Bits of a query, or None if one of its values is in no category, which makes the game match nothing.

pub fn matches(&self, key: &str, query: &VariationQuery) -> VariationMatches<'_>

Returns the variations of a key that match a query, as the game finds them.

Arguments

• key - Key of the entry, like environment.
• query - Value chosen for each category.

Returns

The matches. If nothing matches, they’re the ones of the same query with the map default_map.

pub fn allowed_values(&self, flags: u32) -> Vec<(&str, Vec<&str>)>

Returns, per category, the values allowed by some flags. Flags 0 allow every value.

pub fn flags_for(&self, allowed: &BTreeMap<String, Vec<String>>) -> u32

Returns the flags that allow exactly the provided values of each category. Categories left out allow all their values.

pub fn validate(&self) -> Vec<String>

Checks the database for what makes it wrong for the game.

Returns

A description of each problem: more values than bits, repeated names or values, no default_map, flags with bits of no value, and variations that can never match.

pub fn add_value(&mut self, category: &str, value: &str) -> Result<()>

Adds a value to a category, moving the bits of the flags of every variation so they keep allowing the same values.

A variation that allowed every value of the category, without being unconstrained, also allows the new one.

Errors

Returns RLibError::AssetVariationDbEditRefused if the category doesn’t exist, the value is empty or already exists in any category (the game finds values by name alone), or every bit of the flags is in use.

pub fn remove_value(&mut self, category: &str, value: &str) -> Result<()>

Removes a value from a category, moving the bits of the flags of every variation so they keep allowing the same values.

Errors

Returns RLibError::AssetVariationDbEditRefused if the category or the value don’t exist, if the value is the default_map map, or if a variation would allow nothing else, as its flags would become 0, which allows everything.

pub fn rename_value( &mut self, category: &str, from: &str, to: &str, ) -> Result<()>

Renames a value of a category. The flags don’t change.

Errors

Returns RLibError::AssetVariationDbEditRefused if the category or the value don’t exist, or the new name is empty or already exists in any category.

pub fn category_of(&self, value: &str) -> Option<&str>

Name of the first category that has a value, if any.

pub fn clone_value( &mut self, category: &str, from: &str, value: &str, ) -> Result<()>

Adds a value to a category that every variation allows exactly when it allows another value of the same category, like a new climate with the weather of an existing one.

Errors

Returns RLibError::AssetVariationDbEditRefused if from isn’t a value of the category, or for the reasons of AssetVariationDb::add_value.

pub fn add_category(&mut self, name: &str) -> Result<()>

Adds an empty category after the others. It takes no bit until it has values.

Errors

Returns RLibError::AssetVariationDbEditRefused if the name is empty or already used.

pub fn remove_category(&mut self, name: &str) -> Result<()>

Removes a category with its values, moving the bits of the flags of every variation so they keep allowing the same values of the other categories.

Errors

Returns RLibError::AssetVariationDbEditRefused if the category doesn’t exist, or if a variation only restricts this category, as its flags would become 0, which allows everything.

pub fn rename_category(&mut self, from: &str, to: &str) -> Result<()>

Renames a category. The flags don’t change.

Errors

Returns RLibError::AssetVariationDbEditRefused if the category doesn’t exist, or the new name is empty or already used.

Trait Implementations

impl Clone for AssetVariationDb

fn clone(&self) -> AssetVariationDb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetVariationDb

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

Formats the value using the given formatter.

impl Decodeable for AssetVariationDb

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

Decodes binary data into the implementing type.

impl Default for AssetVariationDb

fn default() -> AssetVariationDb

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AssetVariationDb

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodeable for AssetVariationDb

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

Encodes the implementing type into binary data.

impl PartialEq for AssetVariationDb

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AssetVariationDb

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 AssetVariationDb