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::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::report::{ErrorKey, warn};
use crate::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::validate::validate_duration;
use crate::validator::Validator;

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Vic3, Item::PoliticalLobby, PoliticalLobby::add)
}

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

impl DbKind for PoliticalLobby {
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        fn sc_no_lobby(key: &Token) -> ScopeContext {
            let mut sc = ScopeContext::new(Scopes::InterestGroup, key);
            // sc.define_name("country", Scopes::Country, key); // Docs lie about this scope existing (1.9.6)
            sc.define_name("target_country", Scopes::Country, key);
            sc
        }

        fn sc_with_lobby(key: &Token) -> ScopeContext {
            let mut sc = ScopeContext::new(Scopes::Country, key);
            sc.define_name("target_country", Scopes::Country, key);
            sc.define_name("political_lobby", Scopes::PoliticalLobby, key);
            sc
        }

        // requirement_to_maintain is documented as having interest group scope,
        // but it's actually country.
        fn sc_rtm(key: &Token) -> ScopeContext {
            let mut sc = ScopeContext::new(Scopes::Country, key);
            sc.define_name("target_country", Scopes::Country, key);
            sc.define_name("political_lobby", Scopes::PoliticalLobby, key);
            sc
        }

        fn sc_jw(key: &Token) -> ScopeContext {
            let mut sc = ScopeContext::new(Scopes::InterestGroup, key);
            sc.define_name("country", Scopes::Country, key);
            sc.define_name("target_country", Scopes::Country, key);
            sc.define_name("political_lobby", Scopes::PoliticalLobby, key);
            sc
        }

        let mut vd = Validator::new(block, data);

        data.verify_exists(Item::Localization, key);
        let loca = format!("{key}_name");
        data.verify_exists_implied(Item::Localization, &loca, key);
        let loca = format!("{key}_icon");
        data.verify_exists_implied(Item::Localization, &loca, key);

        vd.field_choice("category", &["foreign_pro_country", "foreign_anti_country", "foreign"]);
        vd.field_item("texture", Item::File);

        vd.field_trigger_builder("can_create", Tooltipped::No, sc_no_lobby);
        vd.field_effect_builder("on_created", Tooltipped::No, sc_with_lobby);

        vd.multi_field_validated_block("requirement_to_maintain", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_trigger_builder("trigger", Tooltipped::No, sc_rtm);
            vd.field_effect_builder("on_failed", Tooltipped::No, sc_rtm);
            vd.field_item("swap_type_on_failed", Item::PoliticalLobby);
        });

        let appeasement_factors_validation = |value: &Token, data: &Everything| {
            data.verify_exists(Item::PoliticalLobbyAppeasement, value);
            if data.item_has_property(
                Item::PoliticalLobbyAppeasement,
                value.as_str(),
                "is_always_usable",
            ) {
                let msg = "cannot contain appeasement factors marked as `is_always_usable`";
                warn(ErrorKey::Validation).msg(msg).loc(value).push();
            }
        };

        vd.field_validated_list("appeasement_factors_pro", appeasement_factors_validation);
        vd.field_validated_list("appeasement_factors_anti", appeasement_factors_validation);

        vd.field_trigger_builder("available_for_interest_group", Tooltipped::No, sc_no_lobby);

        vd.field_script_value_no_breakdown_builder("join_weight", sc_jw);
    }
}

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Vic3, Item::PoliticalLobbyAppeasement, PoliticalLobbyAppeasement::add)
}

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

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

        data.verify_exists(Item::Localization, key);
        let loca = format!("{key}_desc");
        data.verify_exists_implied(Item::Localization, &loca, key);

        // TODO: verify if script values are allowed in these durations at all
        let mut sc = ScopeContext::new(Scopes::PoliticalLobby, key);

        vd.field_validated_block_sc("duration_to_show", &mut sc, validate_duration);
        vd.field_bool("is_always_usable");
    }

    fn has_property(
        &self,
        _key: &Token,
        block: &Block,
        property: &str,
        _data: &Everything,
    ) -> bool {
        block.get_field_bool(property).unwrap_or_default()
    }
}