er2.isWater 4

Available from Easy Red 2 2.1.1

Whether a position is water rather than dry land. The margin lets you decide how much shoreline counts as water: a squad that would land in ankle-deep surf usually still needs a boat, so the default leans that way.


Return value

Return TypeDescription
voidTrue if the position is water (or shallower than the margin).

Parameters

ParameterTypeDescription
1voidThe world position to test.
2NumberOptional, default 1.2. How many metres above the water line still count as water. Pass 0 to test the water line exactly.

Examples

No examples available.


Back to Scripting API