Interface IMinimapScreen

Interface for the minimap UI screen. When creating a new minimap screen, implement this interface to allow HexTerrains to interact with it.

Namespace: Fwt.HexTerrains.UI
Assembly: fwt.hexterrains.dll
Syntax
public interface IMinimapScreen

Properties

TexturesVersion

Cached version of the color textures. If it is different from the version of Color Textures data, the screen will be updated with a new data.

Declaration
long TexturesVersion { get; }
Property Value
Type Description
long

ViewModeVersion

Cached version of the view mode. If it is different from the version of View Mode data, the screen will be updated with a new data.

Declaration
long ViewModeVersion { get; }
Property Value
Type Description
long

Methods

SetCameraNormalizedPosition(float2)

Sets the camera normalized position for the minimap. This is called from system so UI screen can update its data. Normalized position is a position in range x 0..1 and y 0..1 where 1 is the full width/height of the terrain in meters.

Declaration
void SetCameraNormalizedPosition(float2 normalizedCameraPosition)
Parameters
Type Name Description
float2 normalizedCameraPosition

Position of the camera relative to the map in range 0..1 where 1 is a full width/height of the terrain in meters

SetColorTextures(NativeArray<ColorMapTexture>, long)

Set the color textures for the minimap. Called from system so UI screen can update its data.

Declaration
void SetColorTextures(NativeArray<ColorMapTexture> textures, long texturesVersion)
Parameters
Type Name Description
NativeArray<ColorMapTexture> textures

new set of textures
long texturesVersion

version of textures provided

SetTerrainEntity(Entity)

Sets an entity of terrain that will be displayed on the minimap.

Declaration
void SetTerrainEntity(Entity terrainEntity)
Parameters
Type Name Description
Entity terrainEntity

Entity of terrain to be shown on minimap

SetViewMode(int, long)

Set the view mode for the minimap. Called from system so UI screen can update its data.

Declaration
void SetViewMode(int viewMode, long version)
Parameters
Type Name Description
int viewMode
long version

Extension Methods