Table of Contents

Hole Output Node

  • Category: IO
  • Edition: All editions
  • Output type: Terrain holes
  • Typical place in a graph: at the end of a mask chain that marks where the terrain surface should be cut away

Hole Output cuts holes in the terrain. Connect a mask, and wherever it reaches the Threshold the terrain surface is removed, so you can see and walk through it. Use it for cave mouths, mine shafts, sinkholes, or openings where a separate mesh, such as a cave or a bridge pier, takes over from the terrain.

Generated terrain with a five sided hole cut through a hillside

When to use it

  • Cave and tunnel entrances, where a cave mesh meets the terrain.
  • Sinkholes, shafts and openings for buildings set into the ground.
  • Not for: lowering or digging the ground (send a lower height to Height Output); hiding parts of the terrain for gameplay at runtime.

Inputs

Slot Type Required What to connect
Input Mask Yes Where to cut: values at or above Threshold become holes. A hand drawn Polygon Mask, a Paint Mask or a mask from the terrain's shape. With nothing connected, there are no holes.

Outputs

Slot Type What it holds
Output Mask 1 where a hole is cut, 0 where the surface stays. You rarely need it; the holes reach the terrain without connecting anything here.

Properties

Property Default Range What it does
Threshold 0.5 0 to 1 The mask value at which the surface is cut. Lower values cut more: with a soft mask, the hole grows out into the soft edge. Higher values cut only where the mask is strongest.

A hole is either there or not; the terrain has no partial holes, so a soft mask always gives a hard edged hole.

Common properties

Property What it does
Id The node's unique name in this graph, shown for reference. You cannot edit it. Scripts and the AI workflow CLI use it to find the node.
Resolution How detailed this node's result is, in texels across the biome. Relative To Main Input (default) matches the mask connected to Input, times the multiplier below it. Relative To Graph follows the biome's Canvas Resolution instead. Absolute sets an exact size. The terrain then cuts holes at its own hole resolution, which follows its height map. Absolute is limited to 32 to 512 in Vista Personal and 32 to 4096 in Vista Indie and Pro.
Split Execution Lets this node run over several frames so the editor stays responsive during long generations. It only works when Allow Split Execution is on in the graph settings. This node finishes in one step, so splitting only adds a short pause around it; leave it off.

Output nodes cannot be bypassed.

Examples

All examples cut the same shape, a Polygon Mask, out of a Noise terrain on a 1024 × 1024 m biome. Scene view of the generated terrain.

Setting Scene view
Default: hard edged shape, Threshold 0.5 A clean five sided hole through the hillside
Shape with a fade band (Falloff 0.1), Threshold 0.1 A larger hole, reaching out into the fade band
Same shape, Threshold 0.9 A smaller hole, only the core of the shape

With a hard edged mask, Threshold makes no difference. With a soft edge, it sets how far into the fade the hole reaches: 0.1 cuts almost the whole band, 0.9 only the full core.

Recipes

  • Cave entrance: Polygon Mask drawn over the cave mouth → Hole Output, and the cave mesh placed in the opening.
  • Sinkholes: Scatter → Splatter 2 (disc stamps, Max) → Hole Output with a high Threshold for small round holes; dig the ground around them with the same stamps on the height.
Note

Holes remove the surface and its collision, so objects and players fall through them. Place a mesh under or inside every hole.

Note

In the Universal Render Pipeline, terrain holes only appear in a build when Terrain Holes is enabled in the URP asset. This is a Unity setting, not a Vista one.

Note

Only one Hole Output counts per graph. When several biomes overlap, the biome's Hole Map blend decides whether a later biome can fill holes cut by an earlier one (Replace) or keeps them (Max).

Performance

Very cheap: one quick GPU step.

For AI agents

  • Type name: HoleOutputNode. Slot ids: Input = 0 (Mask), Output = 100 (Mask).
  • Property for vista_graphitor_node_set: threshold (0 to 1). Output = input ≥ threshold ? 1 : 0.
  • Not bypassable. One per graph (first found). Skipped when the biome's Data Mask excludes HoleMap.
  • Check holes in the Scene view after generation (vista_graphitor_save, vista_generation_status, then vista_sceneview_look and capture scene_view); the 2D view shows the binary hole mask.