PlanetX Docsv1.0.1
Language: ENLast audited: 2026-08-23
Configuration ReferenceSource verified

Planet Asset and Visual Settings

Download this pageMarkdown

Distances and sizes are in Unreal Units (centimeters) unless noted otherwise.

#Planet contract established at creation

SettingMeaning
Planet IDThe unique FName that identifies the planet across the project and at runtime. It is immutable after creation.
RadiusThe planet radius. The creation UI may accept kilometers, but the Asset stores centimeters and requires at least 1 cm. Radius participates in the bake and visual-build contract and is not intended for direct changes after creation.
Coordinate ConventionDefines the North Pole and longitude axes, longitude direction, Source X/Y/Z mapping, and UnrealUnitToCm. The defaults are Up/Forward/Right, counterclockwise longitude, X=East, Y=North, Z=Up, and 1 uu=1 cm. It is immutable after creation.

#Authoring Geometry Settings

SettingDefault / rangePurpose
DetailLevelMediumChooses the Low, Medium, High, or Custom preview-planet mesh tier.
PreviewSegmentCount64, 8–512Segment count for the procedural preview sphere. More segments improve the silhouette but increase preview cost.
PreviewVertexBudget10,000, 128–1,000,000Maximum vertex budget for preview generation.
ProxyTextureResolution2048, 256–8192Target texture resolution used by proxy and visual authoring. Consider both memory and build time.
bUseCustomPreviewMeshfalseUses CustomPreviewMesh instead of the generated preview mesh.
CustomPreviewMeshNoneStatic Mesh used while custom preview is enabled.
LowPreviewMeshNoneExplicit Static Mesh for the Low preview tier.
MediumPreviewMeshNoneExplicit Static Mesh for the Medium preview tier.
HighPreviewMeshNoneExplicit Static Mesh for the High preview tier.

#Surface Completion Settings

These settings generate the portion of the planet not covered by Sections.

SettingDefault / rangePurpose
CompletionMeshDetailLevel6, 0–7Detail level of the completion sphere. Higher values increase vertex count and build cost.
CompletionNoiseSeed1337Selects a reproducible terrain-noise layout.
CompletionNoiseStrengthPercent10%, 0–25Strength of surface-height variation relative to planet radius.
CompletionNoiseScale3.0, 0.001–25Controls the spatial frequency/scale of the noise.
TerrainRegionProfiles4 entriesStrength/sharpness pairs for noise regions. Use 1–8 entries. Defaults are (0.20,1.25), (0.45,2.00), (0.70,3.25), and (1.00,4.50).
TerrainRegionProfiles[].Strength0.5, 0–1Height influence of that region.
TerrainRegionProfiles[].Sharpness2.0, 0.5–8Concentration of the region boundary.
CompletionMaterialNoneMaterial applied to completion geometry. Inspect the Visual Build result to ensure that it joins Section materials as intended.
BlendSharpness1.0, 0.01–8Sharpness of the material blend between completion and adjacent surfaces.

#Proxy Padding Settings

SettingDefault / rangePurpose
GeometryPaddingWidthCm100,000, at least 0Width of the geometric bridge from a Section Proxy to completion.
MaterialTransitionWidthRatio0.1, 0–0.5Fraction of total padding width used for material transition.
PaddingMaterialBakeResolution2048, 256–2048Output resolution for Padding Material Bake.
MaterialBakeBindingsEmptyGenerated Section-to-padding-material records written by Visual Build. Do not edit entries manually.
PaddingSegmentCount8, 1–128Number of geometry segments across the padding width.
RingDistributionStrength2.0, 1–4Controls how strongly padding rings are concentrated toward the boundary.
HeightTransitionStrength1.0, 0–4Strength of height correction between proxy and completion.

#Padding Performance Budget

Warning values produce warnings; Hard values stop an excessive build. Do not set a Hard value below its corresponding Warning value.

SettingsDefaultsMeasurement
WarningBoundaryEdgeCount / HardBoundaryEdgeCount10,000 / 100,000Extracted boundary edges
WarningGeneratedVertexCount / HardGeneratedVertexCount200,000 / 5,000,000Generated vertices
WarningIndexCount / HardIndexCount1,000,000 / 15,000,000Generated indices
WarningCompactBindingCount / HardCompactBindingCount64 / 256Compact material bindings
WarningTotalMidCount / HardTotalMidCount64 / 256Total intermediate rings/results

#Transition Distance Settings

SettingDefaultPurpose
TransitionStartDistance50,000Reference distance at which Ground/Proxy transition begins.
ApproachStartDistance75,000Reference distance at which approach begins; it is normally outside the transition distance.
LandingSelectionDistance30,000Distance used to choose a candidate landing Section.
CameraBlendDistance15,000Distance used for camera blending during transition presentation.

All values must be non-negative. Actual runtime Section load and visibility alpha thresholds are owned by the Level Pair's TransitionPolicy.

#Preview and Build Settings

SettingDefaultPurpose
bPreviewProxyRegiontrueShows the proxy region in Preview.
bPreviewVisualBlendPaddingtrueShows visual-blend padding.
bPreviewGeometricPaddingtrueShows geometric padding.
bPreviewCompletionRegiontrueShows the completion region.
bPreviewTransitionDistancetrueShows transition-distance visualization.
bRealtimeMaterialPreviewtrueRefreshes material preview while settings change.
PreviewDebugModeFinalSurfaceSelects FinalSurface, ProxyRegion, VisualPaddingRegion, GeometricPaddingRegion, CompletionRegion, BlendMask, LandingMask, or TransitionDistance.
FakeProxyRegion.ProxyUVMin / ProxyUVMax(0.35,0.35) / (0.65,0.65)Test proxy UV rectangle used when no real Section is available.
FakeProxyRegion.FakeProxyColor(0.1,0.6,0.2,1)Color of the test proxy.
FakeProxyRegion.FakeProxyHeightOffset500Height offset of the test proxy.
FakeProxyRegion.FakeCompletionHeightOffset0Height offset of the test completion surface.
AuthoringOutputFolderEmptyOutput folder for generated Visual Build assets. When empty, the editor resolves a path from the target Asset.
bAllowGeneratedAssetOverwritefalseAllows replacement of assets at the generated path. Enable it only after confirming the output target.

#Section Settings

The Planet Asset Editor and Proxy Bake manage the Section list.

SettingDefaultPurpose
SectionIdNoneStable Section identifier within the planet.
DisplayNameEmptyEditor-facing name. Runtime identity uses SectionId.
Placement.CenterGeo(0°,0°,0 cm)Latitude, longitude, and altitude of the Section center.
Placement.YawDeg0°Section rotation relative to its Surface Frame.
Placement.Scale1.0, greater than 0Uniform Section scale.
Placement.LocalExtentCm(100,000,100,000)Section-local X/Y half extent.
Placement.bLockToSurfacetrueLocks the center to the planet-surface contract.
SurfaceCorrectionSettings.ModeDisabledChooses Disabled, bake-vertex-derived Automatic, or direct-offset Manual.
SurfaceClearanceCm1.0, at least 0Additional outward clearance after Automatic moves the lowest baked vertex to the surface.
ManualOffsetCm0, at least 0Outward offset applied by Manual mode.
LevelPairIdNoneLevel Pair referenced by the Section.
bEnabledtrueA disabled Section is excluded from runtime presentation and travel targets.

The Same World north-pole anchor contract locks latitude, longitude, yaw, and scale. Only Altitude remains available for Ground contact-height correction. Bounds, RegionSet, SourceRef, ProxyBakeData, rectangles, and hashes are Scan/Bake output and should not be edited manually.

#Level Pair and Transition Policy

SettingDefaultPurpose
LevelPairId, PlanetId, SectionIdNoneStable IDs joining the Pair. Let the editor and bake workflow keep them consistent.
EntryModeSameWorldChooses same-World presentation or travel to a separate World through LevelHandoff.
HandoffBackendOpenLevelRecords the OpenLevel, SeamlessTravel, or PreparedMapChange contract. PlanetX does not open the Level for you.
PlanetSyncModeNonePlanet Actor synchronization policy during travel. Change it only when the project explicitly requires synchronization.
OrbitWorld / GroundWorldNoneSame World requires the same package; Level Handoff requires two distinct, saved Worlds.
bCanEnterGroundtrueWhether gameplay may enter Ground.
bVisualOnlyfalseTreats the Pair as presentation-only rather than a gameplay entry target.
TransitionPolicy.PreloadAlpha0.0, 0–1Transition alpha at which Runtime Preview preload is requested.
TransitionPolicy.VisibleAlpha0.25, 0–1Alpha at which Preview becomes visible.
TransitionPolicy.HideAlpha0.15, 0–1Alpha at which Preview is hidden on return. Keep it below VisibleAlpha for hysteresis.
TransitionPolicy.UnloadDelaySeconds5 s, at least 0Delay before unloading a hidden Preview.
TransitionPolicy.bKeepPreviewLoadedfalseKeeps Runtime Preview resident while hidden.
TransitionPolicy.GroundProxyVisibilityHiddenChooses Hidden, HorizonOnly, or FullProxy for Planet/Section Proxy visibility while Ground is active.

#Surface Preset

SettingDefaultPurpose
PresetIdNonePreset identifier.
DisplayNameEmptyEditor-facing name.
PresetTypeCustomPreset classification.
CompletionSettingsStructure defaultsThe completion settings documented above.
PaddingSettingsStructure defaultsThe padding settings documented above.
BaseSurfaceMaterialNoneBase surface material supplied by the preset.
OptionalBiomeMaskNoneOptional biome-mask texture.
OptionalHeightMaskNoneOptional height-mask texture.

After assigning ActiveSurfacePreset to a Planet Asset, inspect the effective build input in Preview and run Apply & Build.

#Planet Asset setting-group names

In Details and the API, AuthoringGeometrySettings, SurfaceCompletionSettings, ProxyPaddingSettings, TransitionDistanceSettings, and ShapeEditorSettings own the corresponding groups above. ProxyPaddingSettings.PerformanceBudget owns the Padding Warning/Hard limits.