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

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

SetCameraRotation(float)

Sets a camera rotation for the minimap. This is called from system so UI screen can update its data. Rotation is in degrees, where 0 means that the camera is looking straight down on the map, and positive values rotate the camera clockwise.

Declaration
void SetCameraRotation(float cameraRotation)
Parameters
Type Name Description
float cameraRotation

SetTerrainEntity(Entity, EntityManager)

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

Declaration
void SetTerrainEntity(Entity terrainEntity, EntityManager entityManager)
Parameters
Type Name Description
Entity terrainEntity

Entity of terrain to be shown on minimap
EntityManager entityManager

SetViewMode(int)

Sets the view mode for the minimap display.

Declaration
void SetViewMode(int viewMode)
Parameters
Type Name Description
int viewMode

The view mode to apply to the minimap. The value determines how the minimap is rendered or what information it displays.

SetViewModesConfig(IViewModeCollectionConfig)

Configures the available view modes using the specified collection configuration.

Declaration
void SetViewModesConfig(IViewModeCollectionConfig viewModes)
Parameters
Type Name Description
IViewModeCollectionConfig viewModes

An object that defines the set of view modes to be made available.

Extension Methods