Class DynamicGeoPlastLayerConfigAsset
Provides configuration arguments for initializing a dynamic GeoPlast terrain layer, including dynamic settings and flow target references.
Inheritance
Implements
Inherited Members
Namespace: Fwt.HexTerrains.GeoPlasts.Data
Assembly: fwt.hexterrains.dll
Syntax
[CreateAssetMenu(menuName = "Fwt/HexTerrains/GeoPlasts/Dynamic GeoPlast Layer Config", fileName = "VisualGeoPlastLayerConfigAsset")]
public class DynamicGeoPlastLayerConfigAsset : VisualGeoPlastLayerConfigAsset, ITerrainLayerFactory, IInitDynamicGeoPlastLayerArgs, IVisualGeoPlastLayerConfig, IInitGeoPlastLayerConfig
Remarks
This class is used to supply initialization parameters for dynamic GeoPlast layers within the HexTerrains system. It extends visual layer arguments with additional properties specific to dynamic behavior, such as flow interactions between terrain layers. Typically, instances of this class are created as assets in the Unity editor for use in layer setup.
Fields
_downFlowTargetLayerReference
Declaration
[Tooltip("GeoPlast Layer Reference that serves as the target for downward flow interactions. This reference is typically used to determine which terrain layer receives flow from the current layer.")]
[SerializeField]
protected HexTerrainLayerReference _downFlowTargetLayerReference
Field Value
| Type | Description |
|---|---|
| HexTerrainLayerReference |
_dynamicSettings
Declaration
[Space]
[Header("Dynamic Settings")]
[SerializeField]
[Tooltip("Holds the dynamic configuration settings for the GeoPlast system.")]
protected DynamicGeoPlastSettings _dynamicSettings
Field Value
| Type | Description |
|---|---|
| DynamicGeoPlastSettings |
_upFlowTargetLayerReference
Declaration
[Tooltip("Represents the terrain layer reference that serves as the target for upward flow interactions. This reference is typically used to determine which terrain layer receives flow from the current layer. The flow behaviour must be implemented in derived GeoPlast layers.")]
[SerializeField]
protected HexTerrainLayerReference _upFlowTargetLayerReference
Field Value
| Type | Description |
|---|---|
| HexTerrainLayerReference |
Properties
DownFlowTargetLayerReference
Represents the terrain layer reference that serves as the target for downward flow interactions.
Declaration
public HexTerrainLayerReference DownFlowTargetLayerReference { get; set; }
Property Value
| Type | Description |
|---|---|
| HexTerrainLayerReference |
Remarks
This reference is typically used to determine which terrain layer receives flow from the current layer.
DynamicSettings
Holds the dynamic configuration settings for the GeoPlast system.
Declaration
public DynamicGeoPlastSettings DynamicSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| DynamicGeoPlastSettings |
UpFlowTargetLayerReference
Represents the terrain layer reference that serves as the target for upward flow interactions.
Declaration
public HexTerrainLayerReference UpFlowTargetLayerReference { get; set; }
Property Value
| Type | Description |
|---|---|
| HexTerrainLayerReference |
Remarks
This reference is typically used to determine which terrain layer receives flow from the current layer.
Methods
CreateTerrainLayer()
Creates a new instance of a terrain layer for hex-based maps.
Declaration
public override HexTerrainLayer CreateTerrainLayer()
Returns
| Type | Description |
|---|---|
| HexTerrainLayer | A HexTerrainLayer representing the newly created terrain layer. |