Hex Terrains Framework
Search Results for

    Show / Hide Table of Contents

    Struct GeoPlastFlowSettings

    Settings that defile flow of the geo plast (Amount, Heat, etc) in all possible directions (horizontal, up, down). These settings are used in the flow simulation to determine how the plast will move between cells and layers

    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Fwt.HexTerrains.GeoPlasts.Data
    Assembly: fwt.hexterrains.dll
    Syntax
    [Serializable]
    public struct GeoPlastFlowSettings

    Fields

    DownFlowSettings

    Settings for vertical flow, which represents the movement of plast between different layers of the terrain. This flow can occur in both upward and downward directions. This is a settings for Downward flow (like condensation or water freezing).

    Declaration
    [Tooltip("Settings for vertical flow, which represents the movement of plast between different layers of the terrain. This flow can occur in both upward and downward directions. This is a settings for Downward flow (like condensation or water freezing).")]
    [SerializeField]
    public DirectionFlowSettings DownFlowSettings
    Field Value
    Type Description
    DirectionFlowSettings

    HorizontalFlowSettings

    Settings for horizontal flow, which represents the movement of plast between adjacent cells within the same layer. This flow is influenced by factors such as plast height differences and terrain slope, and is crucial for simulating processes like erosion or liquid flow.

    Declaration
    [Tooltip("Settings for horizontal flow, which represents the movement of plast between adjacent cells within the same layer. This flow is influenced by factors such as plast height differences and terrain slope, and is crucial for simulating processes like erosion or liquid flow.")]
    [SerializeField]
    public DirectionFlowSettings HorizontalFlowSettings
    Field Value
    Type Description
    DirectionFlowSettings

    UpFlowSettings

    Settings for vertical flow, which represents the movement of plast between different layers of the terrain. This flow can occur in both upward and downward directions. This is a settings for Upward flow (like evaporation or melting).

    Declaration
    [Tooltip("Settings for vertical flow, which represents the movement of plast between different layers of the terrain. This flow can occur in both upward and downward directions. This is a settings for Upward flow (like evaporation).")]
    [SerializeField]
    public DirectionFlowSettings UpFlowSettings
    Field Value
    Type Description
    DirectionFlowSettings

    Properties

    Default

    Declaration
    public static GeoPlastFlowSettings Default { get; }
    Property Value
    Type Description
    GeoPlastFlowSettings

    IsAnyFlowEnabled

    True if any of the flow types (horizontal, upward, or downward) is enabled. This property provides a quick way to check if any flow simulation is active based on the individual flow settings.

    Declaration
    public bool IsAnyFlowEnabled { get; }
    Property Value
    Type Description
    bool

    Methods

    GetFlowSettings(FlowDirections)

    Declaration
    public DirectionFlowSettings GetFlowSettings(FlowDirections direction)
    Parameters
    Type Name Description
    FlowDirections direction
    Returns
    Type Description
    DirectionFlowSettings

    Extension Methods

    HashExtensions.GetHashCode_ValueType<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