Class TerrainClearer

Namespace

S1MAPI.Building.Structural

Assembly

S1MAPI_Mono.dll

Clears terrain trees and scene objects from a specified world-space area. Typically used to prepare a building site after positioning.

public static class TerrainClearer

Inheritance

object

TerrainClearer

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

ClearAroundBuilding(GameObject, Vector3, ClearingOptions?)

Clear the area around a building using its transform and room size. Correctly handles rotated buildings by computing world-space bounds from the building's actual corners.

public static bool ClearAroundBuilding(GameObject buildingRoot, Vector3 roomSize, ClearingOptions? options = null)

Parameters

buildingRoot GameObject

The building root GameObject (must be positioned).

roomSize Vector3

The building's room dimensions.

options ClearingOptions

Clearing configuration. Uses defaults if null.

Returns

bool

True if terrain was available and clearing executed immediately; false if terrain wasn't available (a background retry has been queued automatically).