truegrf 2.1.0

TrueGRF YAML to GRF compiler
Documentation 
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

pub mod action0;
mod action1;
mod action2;
mod action2_failed;
pub mod action2_rpn;
mod action3;
mod action8;
mod action14;
#[allow(non_snake_case)]
mod actionF;
mod varaction2;
pub mod variable;

pub use action0 as Action0;
pub use action1::Action1;
pub use action2::{Action2, Action2IndustryIO};
pub use action2_failed::Action2Failed;
pub use action2_rpn as Action2RPN;
pub use action3::Action3;
pub use action8::Action8;
pub use action14::Action14;
pub use actionF::{ActionF, ActionFId, ActionFPart, ActionFName};
pub use varaction2::{VarAction2, VarAction2Chain, VarAction2Switch, VarAction2Operator};
pub use variable as Variable;

use super::Output;

macro_rules! vec_list {
    ( $( $x:expr ),* ) => {
        {
            let mut list: Vec<u8> = Vec::new();
            $(
                list.extend($x);
            )*
            list
        }
    };
}
pub(crate) use vec_list;

#[allow(dead_code)]
pub enum Action {
    Action0 = 0,
    Action1,
    Action2,
    Action3,
    Action4,
    Action5,
    Action6,
    Action7,
    Action8,
    Action9,
    ActionA,
    ActionB,
    ActionC,
    ActionD,
    ActionE,
    ActionF,
    Action10,
    Action11,
    Action12,
    Action13,
    Action14,
}

#[allow(dead_code)]
#[derive(Clone, Copy)]
pub enum Feature {
    Trains = 0,
    RoadVehicles,
    Ships,
    Aircraft,
    Stations,
    Canals,
    Bridges,
    Houses,
    GlobalSettings,
    IndustryTiles,
    Industries,
    Cargoes,
    SoundEffects,
    Airports,
    Objects,
    Railtypes,
    AirportTiles,
    Roadtypes,
    Tramtypes,
}

pub trait ActionTrait {
    fn write(&self, output: &mut Output);
}

pub fn write_special(output: &mut Output, action: Action, data: &[u8]) {
    output.buffer.extend(vec_list!(
        (1 + data.len() as u32).to_le_bytes(),
        [0xff],
        &[action as u8],
        data
    ));
}

pub fn write(output: &mut Output, action: Action, feature: Feature, data: &[u8]) {
    output.buffer.extend(vec_list!(
        (2 + data.len() as u32).to_le_bytes(),
        [0xff],
        [action as u8, feature as u8],
        data
    ));
}

pub fn write_string(output: &mut Output, feature: Feature, string: &str) -> u16 {
    let mut parsed_string = string.to_string();
    parsed_string = parsed_string.replace("{SIGNED_WORD}", "\u{e07c}");
    parsed_string = parsed_string.replace("{VOLUME}", "\u{e087}");
    parsed_string = parsed_string.replace("{WEIGHT}", "\u{e09a}\x0d");
    /* Ensure OpenTTD reads the string as UTF-8. */
    parsed_string = String::from("\u{00de}") + &parsed_string;

    write(output, Action::Action4, feature, &vec_list!(
        [0xff, 0x01],
        &output.string_counter.to_le_bytes(),
        parsed_string.as_bytes(),
        [0x00]
    ));

    output.string_counter += 1;
    output.string_counter - 1
}