Hex Terrains Framework
Search Results for

    Show / Hide Table of Contents

    Class DynamicGeoPlastLayerConfigAsset

    Provides configuration arguments for initializing a dynamic GeoPlast terrain layer, including dynamic settings and flow target references.

    Inheritance
    object
    Object
    ScriptableObject
    HexTerrainLayerConfigAsset<GeoPlastLayer>
    GeoPlastLayerConfigAsset
    VisualGeoPlastLayerConfigAsset
    DynamicGeoPlastLayerConfigAsset
    MaterialGeoPlastLayerConfigAsset
    Implements
    ITerrainLayerFactory
    IInitDynamicGeoPlastLayerArgs
    IVisualGeoPlastLayerConfig
    IInitGeoPlastLayerConfig
    Inherited Members
    VisualGeoPlastLayerConfigAsset._visualGeoPlastSettings
    VisualGeoPlastLayerConfigAsset.VisualGeoPlastSettings
    VisualGeoPlastLayerConfigAsset._chunkMeshLayerReference
    VisualGeoPlastLayerConfigAsset.ChunkMeshLayerReference
    GeoPlastLayerConfigAsset._geoPlastSettings
    GeoPlastLayerConfigAsset.GeoPlastSettings
    GeoPlastLayerConfigAsset._bedrockLayerReference
    GeoPlastLayerConfigAsset.BedrockPlastReference
    GeoPlastLayerConfigAsset._amountArgs
    GeoPlastLayerConfigAsset.AmountArgs
    GeoPlastLayerConfigAsset._densityArgs
    GeoPlastLayerConfigAsset.DensityArgs
    GeoPlastLayerConfigAsset._volumeArgs
    GeoPlastLayerConfigAsset.VolumeArgs
    HexTerrainLayerConfigAsset<GeoPlastLayer>.CreateTerrainLayer<TTargetLayer>()
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    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.

    Overrides
    VisualGeoPlastLayerConfigAsset.CreateTerrainLayer()

    Implements

    ITerrainLayerFactory
    IInitDynamicGeoPlastLayerArgs
    IVisualGeoPlastLayerConfig
    IInitGeoPlastLayerConfig

    Extension Methods

    Extensions_UnityObject.SmartDestroy<TObject>(TObject)
    Extensions_UnityObject.SmartDisableGameObject<TObject>(TObject)
    Extensions_UnityObject.SmartEnableGameObject<TObject>(TObject)
    HashExtensions.GetHashCode_RefType<TValue>(TValue, int)
    Extensions_UnityObject.SmartDestroy(object)
    Extensions_UnityObject.SmartGetComponent<TComponent>(object)
    Extensions_UnityObject.SmartGetGameGameObject(object)
    In this article
    Back to top Generated by DocFX