Volumes

Volumes

InstanceForge volumes provide level-scoped include/exclude areas for scan and restore workflows.

Use volumes when a level is too large for a broad scan or when you need to control optimization by area.

Volume classes

InstanceForge provides these runtime volume classes:

  • AInstanceForgeBoxVolume
  • AInstanceForgeSphereVolume

Both derive from AInstanceForgeVolumeBase.

They live in the runtime module so they can be placed and saved in maps.

Volume properties

PropertyPurpose
bEnabledControls whether the volume participates when enabled-volume filtering is used.
ModeInclude adds candidates. Exclude removes candidates inside the volume.
RequiredTagOverrideOptional required tag override for candidates matched by this include volume.
InstanceTypeOverrideStores target intent for volume workflows.
bIncludeStaticMeshActorsAllows or disallows AStaticMeshActor candidates for this volume.
bIncludeBlueprintComponentsAllows or disallows UStaticMeshComponent candidates inside Blueprint actors for this volume.

Scan with volumes

  1. Place InstanceForge volumes in the level.
  2. Configure include/exclude modes.
  3. Open Tools > InstanceForge.
  4. Open Scan.
  5. Choose InstanceForge Volumes as the scan scope.
  6. Click Scan Sources.

Restore with volumes

The Instances tab includes volume restore actions.

Use them to restore generated components or instances affected by selected volumes.

ActionPurpose
Restore Volume ComponentsRestores generated components touched by selected volumes.
Restore Volume InstancesRestores generated instances inside selected volumes.

Containment behavior

The scanner uses component origin point containment for volume inclusion.

Bounds-overlap and full-bounds workflows should be treated as future behavior unless exposed in your current build.

Safety

Volume scanning is still a controlled selection workflow.

Review the Build Plan before building and use Hide originals after build for the first pass.