Class MinimapScreen

Base class for the minimap UI screen. Inherit from this class to create a new minimap screen (optional). In reality you have to implement IMinimapScreen interface to allow HexTerrains to interact with your screen.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
UIView
UIDocumentView
UIScreen
UIScreen<MinimapScreenDataSource>
MinimapScreen
Implements
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.destroyCancellationToken
MonoBehaviour.useGUILayout
MonoBehaviour.didStart
MonoBehaviour.didAwake
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.GetComponentIndex()
Component.CompareTag(TagHandle)
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
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<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.ToString()
Object.name
Object.hideFlags
Namespace: Fwt.HexTerrains.UI
Assembly: fwt.hexterrains.dll
Syntax
public class MinimapScreen : UIScreen<MinimapScreenDataSource>, IUIScreen, IViewDataReceiver<MinimapScreenDataSource>, IMinimapScreen

Fields

ToggleVisibilityKey

When pressed, toggles the visibility of the minimap screen.

Declaration
[Tooltip("When pressed, toggles the visibility of the minimap screen.")]
public KeyCode ToggleVisibilityKey
Field Value
Type Description
KeyCode

ViewMode

Current view mode of the minimap.

Declaration
[Tooltip("Current view mode of the minimap.")]
public int ViewMode
Field Value
Type Description
int

ViewModeConfigs

A list of configuration assets that define available view modes.

Declaration
[Tooltip("A list of configuration assets that define available view modes.")]
protected IViewModeCollectionConfig ViewModeConfigs
Field Value
Type Description
IViewModeCollectionConfig

_entityManager

Cached EntityManager of the World with terrains.

Declaration
protected EntityManager? _entityManager
Field Value
Type Description
EntityManager?

_terrainEntity

Terrain entity this minimap screen shows

Declaration
protected Entity _terrainEntity
Field Value
Type Description
Entity

Properties

TerrainEntity

Terrain entity this minimap screen shows

Declaration
public virtual Entity TerrainEntity { get; protected set; }
Property Value
Type Description
Entity

Methods

GetViewModeConfig(int)

Retrieves the configuration associated with the specified view mode.

Declaration
protected virtual IViewModeConfig GetViewModeConfig(int viewMode)
Parameters
Type Name Description
int viewMode

The zero-based index of the view mode for which to retrieve the configuration. Must be greater than or equal to 0 and less than the number of available view mode configurations.
Returns
Type Description
IViewModeConfig

The configuration for the specified view mode if it exists; otherwise, null.

OnMinimapClick(float2)

Called from UI when user clicks on the minimap. (Makes a camera to center at clicked position).

Declaration
public virtual void OnMinimapClick(float2 normalizedPos)
Parameters
Type Name Description
float2 normalizedPos

Click position in range x 0..1 and y 0..1 where 1 is the full width/height of the terrain

OnViewModeChanged()

Called when the view mode is changed.

Declaration
protected virtual void OnViewModeChanged()

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
public virtual 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
public virtual 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
public virtual 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
public virtual 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.

SetViewModeOnTerrain(int)

Set the view mode on terrain entity. Happens when user requests to change the view mode through the UI.

Declaration
public virtual void SetViewModeOnTerrain(int newViewMode)
Parameters
Type Name Description
int newViewMode

SetViewModesConfig(IViewModeCollectionConfig)

Configures the available view modes using the specified collection configuration.

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

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

Update()

Declaration
protected virtual void Update()

Implements

Extension Methods