API ReferenceGE Extensionseditor
Terraform Tool
Utility extension providing terraforming functions and preference-backed parameters - used by other editor tools for terrain manipulation.
Utility extension providing terraforming functions and preference-backed parameters - used by other editor tools for terrain manipulation.
Public API
| Function | Signature | Description |
|---|---|---|
M.getDOI | () | Returns the domain of influence preference value |
M.getMargin | () | Returns the margin preference value |
M.getFalloff | () | Returns the falloff preference value |
M.getRoughness | () | Returns the roughness preference value |
M.getScale | () | Returns the scale preference value |
M.setDOI | (value) | Sets the domain of influence preference |
M.setMargin | (value) | Sets the margin preference |
M.setFalloff | (value) | Sets the falloff preference |
M.setRoughness | (value) | Sets the roughness preference |
M.setScale | (value) | Sets the scale preference |
M.getPolygon | () | Returns the current user-drawn polygon |
M.isPolygonExist | () | Returns whether a valid polygon exists |
M.clearPolygon | () | Clears the current polygon |
M.handleTerraformingPolygon | () | Handles user polygon drawing and triggers terraforming on completion |
M.terraformPolygon | (polygon) | Terraforms terrain to sources within the given polygon |
M.terraformSelection | () | Terraforms terrain to currently selected editor objects |
M.onEditorRegisterPreferences | (prefs) | Registers terraformTool preferences (DOI, margin, falloff, roughness, scale) |
Preferences
| Key | Type | Default | Range |
|---|---|---|---|
terraformTool.general.domainOfInfluence | int | 100 | 1–500 |
terraformTool.general.margin | float | 5.0 | 0–20 |
terraformTool.general.falloff | float | 1.5 | 1–5 |
terraformTool.general.roughness | float | 0.4 | 0–1 |
terraformTool.general.scale | float | 0.5 | 0–1 |
Dependencies
| Module | Purpose |
|---|---|
editor/terraform/terraform | Core terraforming algorithm |
editor/terraform/fetchSources | Source extraction from polygons/selection |
editor/toolUtilities/polygon | User polygon drawing |
Notes
- No GUI window - this is a utility extension consumed by other tools
- Sources are extracted from DecalRoad, MeshRoad, or other supported object types
See Also
- Editor AI Tests - Related reference
- Editor AI Visualization - Related reference
- Editor – Assembly Spline Tool - Related reference
- World Editor Guide - Guide
Tech Server Manager
Editor window for managing the BeamNGpy TCP server - start/stop server, configure listen IP and port.
Terrain And Road Importer
Editor tool for importing terrain heightmaps and road networks from external data - supports IDW interpolation, peak-based terrain conforming, and DecalRoad generation.