Hex Terrains Framework
Search Results for

    Show / Hide Table of Contents

    Class GeoPlastLayerConfigAsset

    Provides configuration settings and references required to initialize a static non-visual GeoPlast terrain layer within a hex-based terrain system.

    Inheritance
    object
    Object
    ScriptableObject
    HexTerrainLayerConfigAsset<GeoPlastLayer>
    GeoPlastLayerConfigAsset
    VisualGeoPlastLayerConfigAsset
    Implements
    ITerrainLayerFactory
    IInitGeoPlastLayerConfig
    Inherited Members
    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/GeoPlast Layer Config", fileName = "GeoPlastLayerConfigAsset")]
    public class GeoPlastLayerConfigAsset : HexTerrainLayerConfigAsset<GeoPlastLayer>, ITerrainLayerFactory, IInitGeoPlastLayerConfig
    Remarks

    This asset encapsulates parameters for GeoPlast layer initialization, including plast settings, references to adjacent terrain layers, and cell value data for plast amount, density, and volume. It is intended for use in Unity as a ScriptableObject and can be created via the asset menu. Modifying these properties affects how the GeoPlast layer is generated and interacts with other terrain layers.

    Fields

    _amountArgs

    Declaration
    [SerializeField]
    [Tooltip("Initialization arguments for the plast amount data layer.")]
    [FormerlySerializedAs("_plastAmountArgs")]
    protected InitColorMapCellValueDataLayerArgs<float> _amountArgs
    Field Value
    Type Description
    InitColorMapCellValueDataLayerArgs<float>

    _bedrockLayerReference

    Declaration
    [SerializeField]
    [Tooltip("Reference to the bedrock terrain layer. Bedrock height defines the base height for a geo plast. If bedrock height changes, the ceiling of this layer changes accordingly")]
    protected HexTerrainLayerReference _bedrockLayerReference
    Field Value
    Type Description
    HexTerrainLayerReference

    _densityArgs

    Declaration
    [SerializeField]
    [Tooltip("Initialization arguments for the density data layer.")]
    protected InitColorMapCellValueDataLayerArgs<float> _densityArgs
    Field Value
    Type Description
    InitColorMapCellValueDataLayerArgs<float>

    _geoPlastSettings

    Declaration
    [Header("Static GeoPlast Settings")]
    [Space]
    [SerializeField]
    [Tooltip("Configuration settings for GeoPlast operations.")]
    [FormerlySerializedAs("_geoPlastSettings")]
    protected GeoPlastSettings _geoPlastSettings
    Field Value
    Type Description
    GeoPlastSettings

    _volumeArgs

    Declaration
    [SerializeField]
    [Tooltip("Initialization arguments for the volume data layer.")]
    protected InitColorMapCellValueDataLayerArgs<float> _volumeArgs
    Field Value
    Type Description
    InitColorMapCellValueDataLayerArgs<float>

    Properties

    AmountArgs

    Gets or sets the initialization arguments for the plast amount data layer.

    Declaration
    public InitColorMapCellValueDataLayerArgs<float> AmountArgs { get; set; }
    Property Value
    Type Description
    InitColorMapCellValueDataLayerArgs<float>

    BedrockPlastReference

    Represents the reference to the bedrock terrain layer used by this object.

    Declaration
    public HexTerrainLayerReference BedrockPlastReference { get; set; }
    Property Value
    Type Description
    HexTerrainLayerReference
    Remarks

    This field is typically assigned in the Unity Editor and determines which terrain layer is considered bedrock for terrain operations. Changing this reference may affect terrain generation or interaction logic that depends on the bedrock layer.

    DensityArgs

    Gets or sets the initialization arguments for the density data layer.

    Declaration
    public InitColorMapCellValueDataLayerArgs<float> DensityArgs { get; set; }
    Property Value
    Type Description
    InitColorMapCellValueDataLayerArgs<float>

    GeoPlastSettings

    Provides the configuration settings used for GeoPlast operations.

    Declaration
    public GeoPlastSettings GeoPlastSettings { get; set; }
    Property Value
    Type Description
    GeoPlastSettings

    VolumeArgs

    Gets or sets the initialization arguments for the volume data layer.

    Declaration
    public InitColorMapCellValueDataLayerArgs<float> VolumeArgs { get; set; }
    Property Value
    Type Description
    InitColorMapCellValueDataLayerArgs<float>

    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
    HexTerrainLayerConfigAsset<GeoPlastLayer>.CreateTerrainLayer()

    Implements

    ITerrainLayerFactory
    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