Category: Landscape
Since engine version: 1.0 OC
DigFree
Description
Makes a circular hole in semi-solid materials. The return value is the amount of pixels that were dug free. If no_dig2objects is true, the dug out material does neither create objects according to the Dig2Objects in the *.ocm nor will the amount be stored in the internal buffer.
Syntax
int DigFree(int x, int y, int radius, bool no_dig2objects, bool no_instability_check);
Parameters
- x:
- X coordinate
- y:
- Y coordinate
- radius:
- Radius
- no_dig2objects:
- [opt] Prevent objects from being dug out
- no_instability_check:
- [opt] Does not perform instability checks around dug pixels, i.e. prevents surrounding single pixels and liquids from becoming loose.
Example
DigFree(700, 1500, 5);
Makes a small hole in the middle of the landscape.
See also: DigFreeRect