Hex Terrains Framework
Search Results for

    Show / Hide Table of Contents

    Class CellObjectLayerConfigAsset

    Inheritance
    object
    Object
    ScriptableObject
    HexTerrainLayerConfigAsset<CellObjectLayer>
    CellItemLayerConfigAsset<CellObjectLayer>
    CellObjectLayerConfigAsset
    Implements
    ITerrainLayerFactory
    ICellObjectLayerConfig
    ICellItemLayerConfig
    Inherited Members
    CellItemLayerConfigAsset<CellObjectLayer>._cellItemTranformSettings
    CellItemLayerConfigAsset<CellObjectLayer>.CellItemTransformSettings
    CellItemLayerConfigAsset<CellObjectLayer>._surfaceLayerReference
    CellItemLayerConfigAsset<CellObjectLayer>.SurfaceLayerReference
    CellItemLayerConfigAsset<CellObjectLayer>._overlapSurfaceLayerReference
    CellItemLayerConfigAsset<CellObjectLayer>.OverlapSurfaceLayerReference
    CellItemLayerConfigAsset<CellObjectLayer>._cellItemIndexArgs
    CellItemLayerConfigAsset<CellObjectLayer>.CellItemIndexArgs
    CellItemLayerConfigAsset<CellObjectLayer>._cellItemStateArgs
    CellItemLayerConfigAsset<CellObjectLayer>.CellItemStateArgs
    CellItemLayerConfigAsset<CellObjectLayer>._cellItemLocalPositionArgs
    CellItemLayerConfigAsset<CellObjectLayer>.CellItemLocalPositionArgs
    CellItemLayerConfigAsset<CellObjectLayer>._cellItemLocalRotationArgs
    CellItemLayerConfigAsset<CellObjectLayer>.CellItemLocalRotationArgs
    CellItemLayerConfigAsset<CellObjectLayer>._cellItemLocalScaleArgs
    CellItemLayerConfigAsset<CellObjectLayer>.CellItemLocalScaleArgs
    HexTerrainLayerConfigAsset<CellObjectLayer>.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.CellObjects.Data
    Assembly: fwt.hexterrains.dll
    Syntax
    [CreateAssetMenu(fileName = "CreateCellObjectsLayerArgs", menuName = "Fwt/HexTerrains/Cell Items/Cell Object Layer Config")]
    public class CellObjectLayerConfigAsset : CellItemLayerConfigAsset<CellObjectLayer>, ITerrainLayerFactory, ICellObjectLayerConfig, ICellItemLayerConfig

    Fields

    _LODSettings

    Declaration
    [Tooltip("List of LOD settings for cell objects in this layer. Set MinDistance and MaxDistance for each LOD so they don't overlap and don't have gaps. This settings apply to all cell objects in the layer. Baked from LOD Distances list")]
    [SerializeField]
    protected List<CellObjectLayerLODSettings> _LODSettings
    Field Value
    Type Description
    List<CellObjectLayerLODSettings>

    _bakedStatesLODSettings

    Declaration
    [Tooltip("Baked LOD settings for cell objects. All LOD settings are baked from the LODDistances list during baking process.")]
    [SerializeField]
    protected List<CellObjectLODSettings> _bakedStatesLODSettings
    Field Value
    Type Description
    List<CellObjectLODSettings>

    _bakedVisualItemSettings

    Declaration
    [Tooltip("Baked visual item settings for cell objects. All visual item settings are baked from the ObjectConfigs list during baking process.")]
    [SerializeField]
    protected List<CellObjectVisualItemSettings> _bakedVisualItemSettings
    Field Value
    Type Description
    List<CellObjectVisualItemSettings>

    _bulkRendererAsset

    Declaration
    [Tooltip("RenderEntitiesConfig that holds meshes, materials, and everything needed for rendering using Graphics.DrawMeshInstanced.")]
    [SerializeField]
    protected BulkRendererAsset _bulkRendererAsset
    Field Value
    Type Description
    BulkRendererAsset

    _cellItemPrefabs

    Declaration
    [Tooltip("List of cell object config authorings. While baking data from this list is taken to be extract one cell object from one ObjectConfigAuthoring.")]
    [SerializeField]
    protected List<CellObjectConfigAuthoring> _cellItemPrefabs
    Field Value
    Type Description
    List<CellObjectConfigAuthoring>

    _maxSubmeshesPerCell

    Declaration
    [Tooltip("Maximum number of submeshes per cell. Meaning the CellObject can contain maximum this amount of submeshes.")]
    [SerializeField]
    protected int _maxSubmeshesPerCell
    Field Value
    Type Description
    int

    _statesCountPerItem

    Declaration
    [Tooltip("Number of states per cell cell item. Used to calculate the amount of memory to allocate for cell item states.")]
    [SerializeField]
    [FormerlySerializedAs("_statesCountPerObject")]
    protected int _statesCountPerItem
    Field Value
    Type Description
    int

    Properties

    BakedStatesLODSettings

    Baked LOD settings for cell objects. All LOD settings are baked from the LODDistances list during baking process.

    Declaration
    public List<CellObjectLODSettings> BakedStatesLODSettings { get; set; }
    Property Value
    Type Description
    List<CellObjectLODSettings>

    BakedVisualItemSettings

    Baked visual item settings for cell objects. All visual item settings are baked from the ObjectConfigs list during baking process.

    Declaration
    public List<CellObjectVisualItemSettings> BakedVisualItemSettings { get; set; }
    Property Value
    Type Description
    List<CellObjectVisualItemSettings>

    BulkRenderer

    RenderEntitiesConfig that holds meshes, materials, and everything needed for rendering using Graphics.DrawMeshInstanced.

    Declaration
    public IBulkRenderer BulkRenderer { get; set; }
    Property Value
    Type Description
    IBulkRenderer

    CellItemPrefabs

    List of cell object config authorings. While baking data from this list is taken to be extract one cell object from one ObjectConfigAuthoring.

    Declaration
    public List<CellObjectConfigAuthoring> CellItemPrefabs { get; set; }
    Property Value
    Type Description
    List<CellObjectConfigAuthoring>

    LODSettings

    List of LOD settings for cell objects in this layer. Set MinDistance and MaxDistance for each LOD so they don't overlap and don't have gaps. This settings apply to all cell objects in the layer.

    Declaration
    public List<CellObjectLayerLODSettings> LODSettings { get; set; }
    Property Value
    Type Description
    List<CellObjectLayerLODSettings>

    LODsCount

    Number of LODs defined for this layer.

    Declaration
    public int LODsCount { get; }
    Property Value
    Type Description
    int

    MaxSubmeshesPerCell

    Maximum number of submeshes per cell. Meaning the CellObject can contain maximum this amount of submeshes.

    Declaration
    public int MaxSubmeshesPerCell { get; set; }
    Property Value
    Type Description
    int

    StatesCountPerItem

    Number of states per cell item. Used to calculate the amount of memory to allocate for cell item states.

    Declaration
    public int StatesCountPerItem { get; set; }
    Property Value
    Type Description
    int

    Methods

    Bake()

    Bakes the cell object configs from the ObjectConfigs list into BakedConfigs list.

    Declaration
    [ContextMenu("Bake")]
    public virtual void Bake()

    BakeCellObject(CellObjectConfigAuthoring, int)

    Declaration
    protected virtual void BakeCellObject(CellObjectConfigAuthoring objAuthoring, int cellItemIndex)
    Parameters
    Type Name Description
    CellObjectConfigAuthoring objAuthoring
    int cellItemIndex

    ClearBakedData()

    Declaration
    [ContextMenu("Clear Baked Data")]
    protected virtual void ClearBakedData()

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

    GetObjectStatesLODSettings()

    Returns the list of LOD settings for cell object states in this layer.

    Declaration
    public virtual IList<CellObjectLODSettings> GetObjectStatesLODSettings()
    Returns
    Type Description
    IList<CellObjectLODSettings>

    GetObjectsLODSettings()

    Returns the list of LOD settings for cell objects in this layer.

    Declaration
    public virtual IList<CellObjectLayerLODSettings> GetObjectsLODSettings()
    Returns
    Type Description
    IList<CellObjectLayerLODSettings>

    GetVisualItemSettings()

    Returns the list of baked visual item settings.

    Declaration
    public virtual IList<CellObjectVisualItemSettings> GetVisualItemSettings()
    Returns
    Type Description
    IList<CellObjectVisualItemSettings>

    Implements

    ITerrainLayerFactory
    ICellObjectLayerConfig
    ICellItemLayerConfig

    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