Terrain Layer Spawner Component

The Terrain Layer Spawner component spawns a terrain layer within given bounds, and enables the ordering of multiple layers.
The priority is controlled by first assigning a layer, either Foregound(Highest priority) or Background, and then by using the Priority setting, with a higher number being a higher priority.
You can configure the dimensions of the layer by modifying the Box component on the same entity. The Box component is required for the Layer Spawner to operate.

Provider

Terrain Gem

Properties

PropertyDescriptionValuesDefault
Layer PriorityThe priority of the spawner. Foreground has a higher priority than Background.Foreground or BackgroundForeground
Sub PrioritySets the priority of this spawner within the layer. Higher numbers will override lower.0 - 100000
Use Ground PlaneEnable this setting to provide a default ground plane where no terrain is defined.BooleanTrue

TerrainSpawnerRequestBus

Use the following request functions with the TerrainSpawnerRequestBus EBus interface to communicate with other components of your game.

GetPriority

Retrieves the terrain layer priority.

Parameters
Layer [out] - Index of the Layer Priority setting (Foreground is 0). Type: Unsigned Int
Priority [out] - Value of the Sub Priority setting. Type: Unsigned Int

Return None

GetUseGroundPlane

Retrieves the value of the Use Ground Plane setting.

Parameters None

Return Value of the setting . Type: Boolean


Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.