Hex Terrains Framework
Search Results for

    Show / Hide Table of Contents

    Namespace Fwt.HexTerrains.Data

    Classes

    ChunksGridLayer

    Container for data related to Terrain Chunks Grid. Chunk visibility, Chunk Metrics per chunk, not per cell.

    EnvironmentAPIAuthoring

    Provides authoring support for configuring environment API settings in a Unity scene.

    EnvironmentAPIAuthoringBaker

    EnvironmentAPIComponent

    Represents a component that provides access to an environment API instance.

    EnvironmentAPIConfigAssetBase

    Provides a base class for configuring and creating environment API instances within a Unity project.

    HexTerrainLayer

    Base class for HexTerrain layer. Your custom layers can be derived from this class to keep the proposed terrain layers standard. But system does not require you to derive from this class, you can create your own layers that do not inherit from it.

    HexTerrainLayerConfigAsset<TTerrainLayer>

    Provides a base asset for configuring and creating terrain layers for hex-based maps.

    HexTerrainLayerGroup

    Base class for HexTerrain layer that holds a list of Terrain layers inside. Inherit from this class to create a list of terrain layers following the standard HexTerrain layers structure.

    HexTerrainLayerGroup<TTerrainLayer>

    Base class for HexTerrain layer that holds a list of Terrain layers inside. Each nested layer must be derived from TTerrainLayer type.

    HexTerrainUtils

    Structs

    AttachMainCameraRequest

    Request component that attaches the Camera.main to the terrain entity on initialization

    AutoColorMapSettings

    CellItemTransformSettings

    CellItemTransformSettingsEditor

    ChunkBounds

    ChunkPositions

    ChunkVisibility

    This is a layer of info about wether chunk is visible and if so, where among all possible positions this chunk is visible (Center, North, East, etc.) If Terrain has Left-Right sides connected, nether Top-Down sides, there is only one possible position: Center

    CreateChunksGridLayerRequest

    CreateEnvironmentAPIRequest

    Represents a request to create an environment API using the specified configuration asset.

    EnvironmentAPIEntity

    Component that marks an entity as an environment API entity. Needed for systems that try to get singleton entity with environment API. Placed alongside the EnvironmentAPIComponent on the same entity.

    HexCellIndex

    HexCellMetrics

    Metrics of a cell in the hex terrain. Contains information about the cell's biome, position, coordinate, byte height (from heightmap), height in meters, chunk index, chunk coord, etc.

    HexChunkGridIndex

    Shared component that is placed on the CellEntity so it helps to quickly find all CellEntities placed on given chunk.

    HexChunkMetrics

    HexTerrain

    Contains the TerrainSettings. Indicates that the entity is a HexTerrain

    HexTerrainLayerReference

    HexTerrainMetrics

    Metrics of the HexTerrain. Contains information about the size of the terrain, chunk size, number of cells, etc.

    HexTerrainRaycastData

    Data structure used to store the result of a raycast on the hex terrain.

    HexTerrainSettings

    Struct for storing hex terrain settings like TerrainSize, ChunkSize, HexRotation, HexLayout, etc. Has methods for converting between pixel and cell coordinates, getting cell index by coordinates, etc.

    HexTerrainVisibility

    Component to indicate whether the hex terrain is visible or not. Change Value to false to exclude the hex terrain from rendering.

    InitCellValueDataLayerArgs<TValue>

    InitColorMapCellValueDataLayerArgs<TValue>

    Provides configuration parameters for initializing a color map cell value data layer, including value ranges, fill options, randomization, source texture settings, and color mapping details.

    LoadTerrainFromSaveFile

    NotInitializedTerrain

    While this component is present on terrain entity, it's not fully initialized. It is removed from entity at the end of HexTerrainsInitGroup

    Interfaces

    IInitCellValueDataLayerArgs<TValue>

    Defines the arguments used to initialize cell values in a data layer, including value ranges, fill options, and optional source texture settings.

    IInitColorMapCellValueDataLayerArgs<TValue>

    Defines the arguments required to initialize a cell value data layer with color mapping capabilities, including automatic color mapping mode, color palette, and texture index settings.

    ISerializableTerrainLayer

    ITerrainLayerFactory

    Defines a factory for creating terrain layer instances used in hex-based map systems.

    Enums

    AutoColorMapMode

    Enumeration of all available modes for automatic color mapping in IColorMapHexTerrainLayer.

    HexDirections3d

    In this article
    Back to top Generated by DocFX