tiger-lib 1.18.0

Library used by the tools ck3-tiger, vic3-tiger, and imperator-tiger. This library holds the bulk of the code for them. It can be built either for ck3-tiger with the feature ck3, or for vic3-tiger with the feature vic3, or for imperator-tiger with the feature imperator, but not both at the same time.
Documentation
use crate::block::{BV, Block};
use crate::context::ScopeContext;
use crate::db::{Db, DbKind};
use crate::everything::Everything;
use crate::game::GameFlags;
use crate::item::{Item, ItemLoader};
use crate::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::validator::Validator;

#[derive(Clone, Debug)]
pub struct Story {}

inventory::submit! {
    ItemLoader::Normal(GameFlags::Ck3, Item::Story, Story::add)
}

impl Story {
    pub fn add(db: &mut Db, key: Token, block: Block) {
        db.add(Item::Story, key, block, Box::new(Self {}));
    }
}

impl DbKind for Story {
    fn validate(&self, _key: &Token, block: &Block, data: &Everything) {
        let mut vd = Validator::new(block, data);

        let sc_builder = |key: &Token| {
            let mut sc = ScopeContext::new(Scopes::StoryCycle, key);
            sc.define_name("story", Scopes::StoryCycle, key);
            sc
        };

        vd.field_effect_builder("on_setup", Tooltipped::No, sc_builder);
        vd.field_effect_builder("on_end", Tooltipped::No, sc_builder);
        vd.field_effect_builder("on_owner_death", Tooltipped::No, sc_builder);

        vd.field_bool("visible");
        // TODO: if visible and no icon, look for icon in STORY_CYCLE_TYPE_ICON_PATH define
        vd.multi_field_validated_block("icon", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_trigger_builder("trigger", Tooltipped::No, sc_builder);
            vd.field_item("reference", Item::File);
        });

        // TODO: if visible and no background, look for STORY_CYCLE_TYPE_FALLBACK_BACKGROUND define
        vd.multi_field_validated_block("background", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_trigger_builder("trigger", Tooltipped::No, sc_builder);
            vd.field_item("reference", Item::File);
        });

        vd.field_validated_block("visualization", |block, data| {
            let mut vd = Validator::new(block, data);
            for field in
                &["character", "character_list", "title", "title_list", "artifact", "artifact_list"]
            {
                vd.multi_field_validated_block(field, |block, data| {
                    let mut vd = Validator::new(block, data);
                    // TODO: register these variable types?
                    vd.field_value("variable_name");
                    vd.field_item("label", Item::Localization);
                });
            }
            // TODO: "has STORY as an available scope"
            vd.field_item("custom_string_key", Item::Localization);
            for field in &["basic_counter", "tug_of_war_counter"] {
                vd.multi_field_validated_block(field, |block, data| {
                    let mut vd = Validator::new(block, data);
                    // TODO: register these variable types?
                    vd.field_value("variable_name");
                    vd.field_numeric("min");
                    vd.field_numeric("max");
                    vd.field_item("label", Item::Localization);
                    vd.field_item("tooltip", Item::Localization);
                    vd.field_item("min_label", Item::Localization);
                    vd.field_item("max_label", Item::Localization);
                });
            }
            vd.field_list_items("decisions", Item::Decision);
            vd.field_list_items("modifiers", Item::Modifier);
            vd.field_list_items("traits", Item::Trait);
        });

        vd.multi_field_validated_key_block("effect_group", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::StoryCycle, key);
            sc.define_name("story", Scopes::StoryCycle, key);
            let mut vd = Validator::new(block, data);

            // TODO: handle case of multiple of these fields being specified
            for field in &["days", "weeks", "months", "years"] {
                vd.field_validated(field, |bv, data| match bv {
                    BV::Value(token) => {
                        token.expect_integer();
                    }
                    BV::Block(block) => {
                        let mut vd = Validator::new(block, data);
                        vd.req_tokens_integers_exactly(2);
                    }
                });
            }
            vd.field_numeric_range("chance", 0.0..=100.0);

            vd.field_trigger("trigger", Tooltipped::No, &mut sc);

            validate_complex_effect(&mut vd, &mut sc);
        });
    }
}

fn validate_complex_effect(vd: &mut Validator, sc: &mut ScopeContext) {
    vd.multi_field_validated_block("first_valid", |block, data| {
        let mut vd = Validator::new(block, data);
        validate_complex_effect(&mut vd, sc);
    });
    vd.multi_field_validated_block("random_valid", |block, data| {
        let mut vd = Validator::new(block, data);
        validate_complex_effect(&mut vd, sc);
    });
    vd.multi_field_validated_block("triggered_effect", |block, data| {
        let mut vd = Validator::new(block, data);
        vd.field_trigger("trigger", Tooltipped::No, sc);
        vd.field_effect("effect", Tooltipped::No, sc);
    });
    vd.field_effect("fallback", Tooltipped::No, sc);
}