tiger_lib/vic3/data/
journalentries.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
use crate::block::Block;
use crate::context::ScopeContext;
use crate::data::on_actions::validate_on_action;
use crate::db::{Db, DbKind};
use crate::desc::validate_desc;
use crate::effect::validate_effect;
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::trigger::validate_trigger;
use crate::validator::Validator;

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

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

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

impl DbKind for JournalEntry {
    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}_reason");
        data.verify_exists_implied(Item::Localization, &loca, key);
        // TODO: make this depend on whether the journalentry uses the "goal" mechanic
        let loca = format!("{key}_goal");
        data.mark_used(Item::Localization, &loca);

        let mut sc = ScopeContext::new(Scopes::Country, key);
        sc.define_name("journal_entry", Scopes::JournalEntry, key);
        sc.define_name("target", Scopes::all(), key);

        vd.field_item("group", Item::JournalEntryGroup);

        vd.field_item("icon", Item::File);

        vd.field_validated_block("is_shown_when_inactive", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });

        vd.multi_field_item("scripted_button", Item::ScriptedButton);

        vd.field_validated_block("possible", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::Yes);
        });

        vd.field_validated_block("immediate", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::No);
        });

        vd.field_validated_block("complete", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::Yes);
        });
        vd.field_validated_block("on_complete", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::Yes);
        });

        vd.field_validated_block("fail", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::Yes);
        });
        vd.field_validated_block("on_fail", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::Yes);
        });

        vd.field_validated_block("invalid", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_block("on_invalid", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::Yes);
        });

        if !vd.field_validated_sc("status_desc", &mut sc, validate_desc) {
            let loca = format!("{key}_status");
            data.mark_used(Item::Localization, &loca);
        }

        vd.field_integer("timeout");
        vd.field_validated_block("on_timeout", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::Yes);
        });

        vd.field_list_items("modifiers_while_active", Item::Modifier);

        for field in &["on_weekly_pulse", "on_monthly_pulse", "on_yearly_pulse"] {
            vd.field_validated_block_sc(field, &mut sc, validate_on_action);
        }

        vd.field_script_value("current_value", &mut sc);
        vd.field_script_value("goal_add_value", &mut sc);
        vd.field_script_value("weight", &mut sc);

        vd.field_bool("transferable");
        vd.field_bool("can_revolution_inherit");

        vd.field_validated_block("is_progressing", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_bool("progressbar");
        vd.multi_field_item("scripted_progress_bar", Item::ScriptedProgressBar);

        vd.field_bool("can_deactivate");

        if block.field_value_is("progressbar", "yes") {
            if !vd.field_validated_sc("progress_desc", &mut sc, validate_desc) {
                let loca = format!("{key}_progress");
                data.mark_used(Item::Localization, &loca);
            }
        } else {
            vd.ban_field("progress_desc", || "progressbar = yes");
        }

        vd.field_item("how_tutorial", Item::TutorialLesson);
        vd.field_item("why_tutorial", Item::TutorialLesson);

        vd.field_bool("should_be_pinned_by_default");

        // undocumented

        vd.field_integer("active_update_frequency");
        vd.field_bool("should_update_on_player_command");
        vd.field_bool("display_progressbar_as_months");
    }
}

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

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

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

impl DbKind for JournalEntryGroup {
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        // Since journal entry groups have no defined fields, this Validator
        // is just here to warn about unknown fields when it is dropped.
        Validator::new(block, data);

        data.verify_exists(Item::Localization, key);
    }
}