factorio-api 0.3.2

Generated Factorio runtime API type stubs for factorio-rs mods
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
130
131
132
133

/// Typed Factorio mod-settings tables (`settings.startup`, ...).
///
/// Prefer [`SettingsDictionary::get_bool`] / [`get_int`] / [`get_double`] /
/// [`get_string`] over indexing into opaque values.

/// One mod setting entry (`settings.startup["name"]`).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ModSettingValue {
    pub value: crate::LuaAny,
}

pub static UNIT_MOD_SETTING: ModSettingValue = ModSettingValue {
    value: crate::LuaAny,
};

/// A settings stage dictionary (`startup` / `global` / `player_default`).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct SettingsDictionary;

impl SettingsDictionary {
    /// Read a bool setting: `settings.startup["name"].value`.
    #[must_use]
    pub const fn get_bool(self, _name: &'static str) -> bool {
        false
    }

    /// Read an integer setting.
    #[must_use]
    pub const fn get_int(self, _name: &'static str) -> i64 {
        0
    }

    /// Read a double setting.
    #[must_use]
    pub const fn get_double(self, _name: &'static str) -> f64 {
        0.0
    }

    /// Read a string setting.
    #[must_use]
    pub const fn get_string(self, _name: &'static str) -> &'static str {
        ""
    }

    /// Fall back to the generic typed read used by older mods.
    #[must_use]
    pub const fn get<T: crate::SettingValue>(self, _name: &'static str) -> T {
        T::STUB
    }

    /// Index into a setting entry (`.value` still opaque for uncommon types).
    #[must_use]
    pub fn setting(self, _name: &'static str) -> ModSettingValue {
        UNIT_MOD_SETTING
    }
}

impl std::ops::Index<&str> for SettingsDictionary {
    type Output = ModSettingValue;

    fn index(&self, _key: &str) -> &ModSettingValue {
        &UNIT_MOD_SETTING
    }
}

pub struct SettingTable {
    pub startup: SettingsDictionary,
    pub global: SettingsDictionary,
    pub player_default: SettingsDictionary,
}

pub const settings: SettingTable = SettingTable {
    startup: SettingsDictionary,
    global: SettingsDictionary,
    player_default: SettingsDictionary,
};

pub struct LuaDataInterface;

impl LuaDataInterface {
    /// Register one or more prototype definitions. Translates to `data:extend({...})`.
    #[allow(unused_variables)]
    pub fn extend<T, I: IntoIterator<Item = T>>(&self, items: I) {}
}

/// The global `data` object used to register prototypes and settings.
pub static data: LuaDataInterface = LuaDataInterface;

pub struct BoolSetting {
    /// Internal mod-namespaced name (e.g. `"my-mod-enabled"`).
    pub name: &'static str,
    /// When the setting takes effect: `"startup"`, `"runtime-global"`, or `"runtime-per-user"`.
    pub setting_type: &'static str,
    /// The default value for this setting.
    pub default_value: bool,
}

pub struct IntSetting {
    /// Internal mod-namespaced name (e.g. `"my-mod-count"`).
    pub name: &'static str,
    /// When the setting takes effect: `"startup"`, `"runtime-global"`, or `"runtime-per-user"`.
    pub setting_type: &'static str,
    /// The default value for this setting.
    pub default_value: i64,
    /// Optional minimum allowed value.
    pub minimum_value: Option<i64>,
    /// Optional maximum allowed value.
    pub maximum_value: Option<i64>,
}

pub struct DoubleSetting {
    /// Internal mod-namespaced name.
    pub name: &'static str,
    /// When the setting takes effect: `"startup"`, `"runtime-global"`, or `"runtime-per-user"`.
    pub setting_type: &'static str,
    /// The default value for this setting.
    pub default_value: f64,
    /// Optional minimum allowed value.
    pub minimum_value: Option<f64>,
    /// Optional maximum allowed value.
    pub maximum_value: Option<f64>,
}

pub struct StringSetting {
    /// Internal mod-namespaced name.
    pub name: &'static str,
    /// When the setting takes effect: `"startup"`, `"runtime-global"`, or `"runtime-per-user"`.
    pub setting_type: &'static str,
    /// The default value for this setting.
    pub default_value: &'static str,
    /// If `true`, the value is not shown in-game (useful for internal state).
    pub hidden: bool,
}