Orrery Terrain · OrreryTerrain module · class
UOrreryTerrainLibrary
Static Blueprint API over the world terrain: read the ground, preview and commit earthworks, undo them.
Declaration
UCLASS()
class UOrreryTerrainLibrary : public UBlueprintFunctionLibrary- Header
#include "OrreryTerrainLibrary.h"- Module
PublicDependencyModuleNames.Add("OrreryTerrain");in your module’s Build.cs.- Stability
- Stable: changes within a major version only add.
- Thread
- Game thread (Blueprint).
- Derives from
UBlueprintFunctionLibrary- Blueprint
- “Orrery Terrain Library”, a Blueprint type
Description
Reads run on one immutable snapshot and never block. Writes are game thread only and refused on a read-only terrain, a sculpt replica and inside a ground-changed broadcast. A world without a terrain answers NoData and refuses writes with a reason; nothing here asserts.
Game thread (Blueprint). Positions are world cm, angles degrees, volumes cubic metres.
Functions
- GetTerrainSubsystemBlueprintstatic
The world terrain subsystem, or null for a world that cannot have one.
- GetGroundHeightAccurateBlueprintstatic
The ground height under a position.
- SampleGroundBlueprintstatic
Ground height, normals, slope, paint and class at one position, the fields asked for.
- SampleGroundBatchBlueprintstatic
Many positions on one snapshot, results in input order.
- GetPaintWeightBlueprintstatic
The weight, 0 to 1, of a paint layer in a sample (0 when it is not among the sample layers).
- GetDominantPaintLayerBlueprintstatic
The heaviest paint layer of a sample, or -1 when the sample has no paint.
- GetGroundHeightRangeBlueprintstatic
Lowest and highest ground within a circle, from the resident tiles.
- GetGradeAlongBlueprintstatic
Rise over run of the ground along a horizontal direction (0.1 = 10 percent, positive uphill).
- FindPaintLayerBlueprintstatic
The index of the paint layer a layer set calls Name, or -1.
- EvaluatePlateBlueprintstatic
What a plate would do, with nothing changed.
- EvaluateCorridorBlueprintstatic
What a corridor would do, with nothing changed.
- CommitPlateBlueprintstatic
Commit a plate as one transaction.
- CommitCorridorBlueprintstatic
Commit a corridor as one transaction.
- CommitCorridorFromSplineBlueprintstatic
Commit a corridor along a spline: the spline centreline replaces Params.Points, sampled every Params.StationSpacing.
- EvaluateCorridorFromSplineBlueprintstatic
What a spline-based corridor would do, with nothing changed.
- UndoConstructionBlueprintstatic
Undo or redo a construction with the token its commit returned.
- RemoveFeaturesByOwnerBlueprintstatic
Remove every feature an owner stated, one undo step each.
- DoesTerrainSaveExistBlueprintstatic
Whether the file a save reference names is on disk.
- DeleteTerrainSaveBlueprintstatic
Delete the file a save reference names, when no terrain pages from it.
- GetFeatureInfoBlueprintstatic
What the stack knows about a feature; false for an unknown id.
Blueprint
- Commit CorridorOrrery › Terrain › Edit
- Commit Corridor from SplineOrrery › Terrain › Edit
- Commit PlateOrrery › Terrain › Edit
- Delete Terrain SaveOrrery › Terrain › Save
- Does Terrain Save ExistOrrery › Terrain › Save
- Evaluate CorridorOrrery › Terrain › Edit
- Evaluate Corridor from SplineOrrery › Terrain › Edit
- Evaluate PlateOrrery › Terrain › Edit
- Find Paint LayerOrrery › Terrain › Query
- Get Dominant Paint LayerOrrery › Terrain › Query
- Get Feature InfoOrrery › Terrain › Edit
- Get Grade AlongOrrery › Terrain › Query
- Get Ground Height AccurateOrrery › Terrain › Query
- Get Ground Height RangeOrrery › Terrain › Query
- Get Paint WeightOrrery › Terrain › Query
- Get Terrain SubsystemOrrery › Terrain › Query
- Remove Features by OwnerOrrery › Terrain › Edit
- Sample GroundOrrery › Terrain › Query
- Sample Ground BatchOrrery › Terrain › Query
- Undo ConstructionOrrery › Terrain › Edit