Timberborn-SimpleFloodgateTriggers

This plugin for Timberborn allows you to automate your Floodgates a little. Currently we offer automatic setting of floodgate height when a Drought starts or ends, based on a basic schedule or based on a Stream Gauge depth. Pretty neat.

The current version v2.0.2 only works with experimental v0.2.6.

Usage

The will add a simple UI fragment on the Floodgate UI. Example images below.

Floodgate UI

Water pumps UI

Bear in mind that it is possible to create some very janky setups with enabling multiple triggers on the same floodgates. Automation is nice, but it isn't magic. Be careful, or you'll end up drying/flooding everything!

Floodgate

Drought

The fist settings on the Basic tab are related to Droughts. The available settings are:

• Enable setting of height when drought ends
• The height to set when drought ends
• Enable setting of height when drought starts
• The height to set when drought starts

Schedule

The basic tab also contains the settings for automating floodgates based on a schedule.

• Enable Schedule based setting of height
• Optionally disable schedule during droughts
• The times and heights for the schedule
  • Normally the height is set at the selected timestamp. If you change the timestamp, then the height might get instantly changed. This should be fixed once the schedule has been running in peace for a while.

Linking a Stream Gauge

On the Advanced you can link a Floodgate with a Stream Gauge. This allows you to control the Floodgate based on the water depth recorded by the Stream Gauge. The available settins are:

• Low threshold: Set the floodgate height when water depth is below this value
• Low threshold height: The height to set when the water depth is below the chosen low threshold
• High threshold: Set the floodgate height when water depth is above this value
• High threshold height: The height to set when the water depth is above the chosen high threshold

IMPORTANT! Be aware that if a Stream Gauge is linked, then the Floodgate's height will be set always when below low or above high threshold, instead of triggering once when the thresholds are crossed.

Water pumps and dumps

Normal and mechanical water pumps and wter dumps have similar setting compared to floodgates. The main difference is that instead of height, you can choose when to pause/resume the pumps.

Curretly you can only link a single Stream Gauge with a Floodgate or water pump. However, there is no limit with how many Floodgates can be connected to a certain StreamGauge.

Known Limitations

1. The trigger settings are NOT synchronized to neighboring Floodgates. This might be fixed in the future
   • Though if you have a line of Floodgate that are synchronized, you only need to enable the trigger for one of them, as the built in synchronization will take care of the neighboring height when one is set.
2. This plugin might cause some lag spikes when a drought ends or starts. They shouldn't be too heavy though

Installing

Recommended way to install this mod is through Thunderstore. You can install this plugin manually by cloning the repo, building it and adding the dll to your bepinex plugins folder. This plugin is dependent on the magnificent TimberAPI.

Changelog

v4.0.2 - 6.10.2023

• Fixed Depth and Contamination labels to localization
• Fixed "Pause when Badtide starts" button

v4.0.1 - 6.10.2023

• Fixed temperate labels on waterpump basic tab
• Added German translations for new lines (thx to juf0816)

v4.0.0 - 30.9.2023

• Updated Timber API to v0.6.2
• Necessary changes after breaking changed to game version 0.5
• Added various options to control buildings on badtide or contamination level on a stream gauge

v3.4.4 - 29.4.2023

• Fixed waterpumps being paused by triggers when they were unfinished
• Fixed incorrect text in waterpump schedule tab

v3.4.3 - 29.4.2023

• Fixed waterpumps again

v3.4.2 - 29.4.2023

• Fixed advanced settings not working on floodgates

v3.4.1 - 22.4.2023

• Fixed crash when trying to link water pumps with stream gauges

v3.4.0 - 22.4.2023

• Updated to work with game version 0.4.1.1

v3.3.2 - 21.4.2023

• Fixed a slider going under a textlabel on Chinese

v3.3.1 - 21.4.2023

• Added Chinese translations (thx ALiangLiang!)

v3.3.0 - 11.2.2023

• Fixed slider backgrounds
• Fixed streamgauge threshholds if stream gauge is more than 3 height

v3.2.0 - 16.12.2022

• Updated TimberAPI to 0.5.3
• Necessary changes that came with game version 0.3.4.3

v3.1.2 - 6.12.2022

• Minor fixes

v3.1.1 - 11.10.2022

• Quick fix that was caused by incompatibility with PerformanceFix mod

v3.1.0 - 7.10.2022

• Added water level to advanced tabs when a Stream Gauge is linked
• Fixed Water Dump sprite not showing on stream gauge fragment
• Fixed a crash when Timer toggles were toggle on an unfinished buildings

v3.0.1 - 25.9.2022

• Added German localization (thanks juf0816!)

v3.0.0 - 23.9.2022

• Added automation to Irrigation Tower
• Updated to work with TimberAPI v0.5

v2.1.0 - 7.9.2022

• Added buttons for water pumps to pause when drought ends and unpause when drought starts
• Added buttons to disable stream gauge link during drought or temperate
• Fixed some localizations issues and added some loc lines
• Minor change to package output folder structure

v2.0.2 - 6.9.2022

• Minor UI fixed on water pump fragments

v2.0.1 - 6.9.2022

• Added japanese localization (thank you sukunabikona!)
• Fixed a line in the english localization

v2.0.0 - 5.9.2022

• Upped TimberAPI dependency to 0.4.4
• Fixed crash when game was saved and a link between floodgate and stream gauge existed
• Fixed stream gauge high height slider not working properly with floodgates taller than 3
• Added option to enable schedule only during droughts
• Added automation for water pumps and dumps!

v1.0.3 - 11.6.2022

• Modified so mod works on stable and golem experimental

v1.0.2 - 3.6.2022

• Fixed crash when setting values on unfinished floodgate and no finished floodgates were on the map

v1.0.1 - 30.3.2022

• Fixed issue where existing links were not removed when a Floodgate was deleted
• Fixed some typos in game and in readme

v1.0.0 - 29.3.2022

• Added option to link Floodgates with Stream Gauges
  • This allows to set Floodgate's height when StreamGagues depth is below or above chosen thresholds
• UI Overhaul
  • Added 2 tabs: Basic and Advanced
  • Basic tab contains Drought and Schedule settings
  • Advanced tab contains StreamGague links

v0.2.0 - 22.3.2022

• Added Schedule based setting of Floodgate height
  • Schedule takes two times and two heights.
  • When the first time is hit, sets the floodgate height to the first chosen height. Do the same at second time. Repeat the next day.
  • Schedule can optionally be disabled during Droughts.

v0.1.2 - 20.3.2022

• Fixed Drought related Floodgate UI Fragment to look like fragments from the base game.

v0.1.1 - 19.3.2022

• Minor tweaks to Readme

v0.1.0 - 19.3.2022

• First implementation that supports setting of height when Droughts end or start.