~~NOTOC~~
<=[[4rpl:start| Index]] \\
<=[[4rpl:start#creeper| Creeper]]
* [[4rpl:commands:GetFlow|Get]]
* [[4rpl:commands:SetFlow|Set]]
====== GetFlow ======
GetFlow(<-cellX <-cellZ) ->flowZ ->flowX
===== Description =====
Gets the wave flow vector for a given map location.
Perfectly still creeper that isn't flowing will have a {0,0} flow vector. Once creeper starts to flow, the flow vector will
store the amount of creper that moved in or out of the cell on the last game update frame. So creeper flowing only towards the right of the map,
would return a positive flowX and a zero flowZ.
Note that flow values in integer creeper values. A value of 1000000 (1 million) represents an amount of "1" creeper on the map.
Flow values can be useful for finding/setting waves.
===== Examples =====
GetFlow(42 23)->flowZ ->flowX
<=[[4rpl:start| Index]]