forked from DFHack/scripts
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcaravan.lua
More file actions
166 lines (143 loc) · 4.96 KB
/
caravan.lua
File metadata and controls
166 lines (143 loc) · 4.96 KB
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
158
159
160
161
162
163
164
165
166
-- Adjusts properties of caravans
--[====[
caravan
=======
Adjusts properties of caravans on the map. See also `force` to create caravans.
This script has multiple subcommands. Commands listed with the argument
``[IDS]`` can take multiple caravan IDs (see ``caravan list``). If no IDs are
specified, then the commands apply to all caravans on the map.
**Subcommands:**
- ``list``: lists IDs and information about all caravans on the map.
- ``extend [DAYS] [IDS]``: extends the time that caravans stay at the depot by
the specified number of days (defaults to 7 if not specified). Also causes
caravans to return to the depot if applicable.
- ``happy [IDS]``: makes caravans willing to trade again (after seizing goods,
annoying merchants, etc.). Also causes caravans to return to the depot if
applicable.
- ``leave [IDS]``: makes caravans pack up and leave immediately.
- ``unload``: fixes endless unloading at the depot. Run this if merchant pack
animals were startled and now refuse to come to the trade depot.
]====]
--@ module = true
INTERESTING_FLAGS = {
casualty = 'Casualty',
hardship = 'Encountered hardship',
seized = 'Goods seized',
offended = 'Offended'
}
local caravans = df.global.ui.caravans
local function caravans_from_ids(ids)
if not ids or #ids == 0 then
return caravans
end
local c = {} --as:df.caravan_state[]
for _,id in ipairs(ids) do
local id = tonumber(id)
if id then
c[id] = caravans[id]
end
end
return c
end
function bring_back(car)
if car.trade_state ~= df.caravan_state.T_trade_state.AtDepot then
car.trade_state = df.caravan_state.T_trade_state.Approaching
end
end
local commands = {}
function commands.list()
for id, car in pairs(caravans) do
print(dfhack.df2console(('%d: %s caravan from %s'):format(
id,
df.creature_raw.find(df.historical_entity.find(car.entity).race).name[2], -- adjective
dfhack.TranslateName(df.historical_entity.find(car.entity).name)
)))
print(' ' .. (df.caravan_state.T_trade_state[car.trade_state] or 'Unknown state: ' .. car.trade_state))
print((' %d day(s) remaining'):format(math.floor(car.time_remaining / 120)))
for flag, msg in pairs(INTERESTING_FLAGS) do
if car.flags[flag] then
print(' ' .. msg)
end
end
end
end
function commands.extend(days, ...)
days = tonumber(days or 7) or qerror('invalid number of days: ' .. days) --luacheck: retype
for id, car in pairs(caravans_from_ids{...}) do
car.time_remaining = car.time_remaining + (days * 120)
bring_back(car)
end
end
function commands.happy(...)
for id, car in pairs(caravans_from_ids{...}) do
-- all flags default to false
car.flags.whole = 0
bring_back(car)
end
end
function commands.leave(...)
for id, car in pairs(caravans_from_ids{...}) do
car.trade_state = df.caravan_state.T_trade_state.Leaving
end
end
local function isDisconnectedPackAnimal(unit)
if unit.following then
local dragger = unit.following
return (
unit.relationship_ids[ df.unit_relationship_type.Dragger ] == -1 and
dragger.relationship_ids[ df.unit_relationship_type.Draggee ] == -1
)
end
end
local function getPrintableUnitName(unit)
local visible_name = dfhack.units.getVisibleName(unit)
local profession_name = dfhack.units.getProfessionName(unit)
if visible_name.has_name then
return ('%s (%s)'):format(dfhack.TranslateName(visible_name), profession_name)
end
return profession_name -- for unnamed animals
end
local function rejoin_pack_animals()
print('Reconnecting disconnected pack animals...')
local found = false
for _, unit in pairs(df.global.world.units.active) do
if unit.flags1.merchant and isDisconnectedPackAnimal(unit) then
local dragger = unit.following
print((' %s <-> %s'):format(
dfhack.df2console(getPrintableUnitName(unit)),
dfhack.df2console(getPrintableUnitName(dragger))
))
unit.relationship_ids[ df.unit_relationship_type.Dragger ] = dragger.id
dragger.relationship_ids[ df.unit_relationship_type.Draggee ] = unit.id
found = true
end
end
if (found) then
print('All pack animals reconnected.')
else
print('No disconnected pack animals found.')
end
end
function commands.unload(...)
rejoin_pack_animals()
end
function commands.help()
print(dfhack.script_help())
end
function main(...)
local args = {...}
local command = table.remove(args, 1)
if commands[command] then
commands[command](table.unpack(args))
else
commands.help()
if command then
qerror("No such subcommand: " .. command)
else
qerror("Missing subcommand")
end
end
end
if not dfhack_flags.module then
main(...)
end