Iteration Overlay: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{technical|type=section}} | {{technical|type=section}} | ||
The Iteration | The '''Iteration Overlay''' is a [[Grid Overlay]] used to collect values from each iteration of its source. For example, running 10 iterations of a [[Water Overlay]] in the [[Simulation Core]] allows you to collect the results using an Iteration Overlay. The 10 iterations are now 10 timeframes. | ||
==Attributes== | ==Attributes== | ||
| Line 7: | Line 7: | ||
{{overlay attributes|suppresscategory=true|allowselflinks=true| | {{overlay attributes|suppresscategory=true|allowselflinks=true| | ||
{{:Modulus (Iteration Overlay)}} | {{:Modulus (Iteration Overlay)}} | ||
{{:Timeframe | {{:Timeframe times (Iteration Overlay)}} | ||
}} | }} | ||
{{article end | {{article end | ||
|howtos= | |howtos= | ||
* [[How to create a custom breach formula]] | * [[How to setup a flooding overlay with iterations]] | ||
* [[How to create a custom breach growth formula]] | |||
|api=* [[Api session event editor overlay add]] | |||
* [[Api session event editor overlay set attribute]] | |||
* [[Api session event editor overlay set prequel]] | |||
}} | }} | ||
{{Overlay nav}} | {{Overlay nav}} | ||
Latest revision as of 14:27, 14 July 2026
This section describes a technical aspect, and is mainly for advanced users.
The Iteration Overlay is a Grid Overlay used to collect values from each iteration of its source. For example, running 10 iterations of a Water Overlay in the Simulation Core allows you to collect the results using an Iteration Overlay. The 10 iterations are now 10 timeframes.
Attributes
The calculation can be configured via the following attributes:
| Icon | Attribute | Unit | Range | Description | Default value |
|---|---|---|---|---|---|
| File:Modulus.png | MODULUS | number | 1 to 1000 | Store value as timeframe every X iterations. | 1 |
| File:Timeframe times.png | TIMEFRAME_TIMES | number | 0 to 1.7976931348623157E308 | Store date per timeframe. | 0 |
How-to's
API Endpoints