Class MinimapScreenBase

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>

MinimapScreenBase

SamplesMinimapScreen

Implements

IViewDataReceiver<MinimapScreenDataSource>

IMinimapScreen

Inherited Members

UIScreen<MinimapScreenDataSource>.ViewData

UIScreen<MinimapScreenDataSource>.InitUI()

UIScreen<MinimapScreenDataSource>.SetViewData(MinimapScreenDataSource)

UIScreen<MinimapScreenDataSource>.SetUIDocumentViewData(MinimapScreenDataSource)

UIScreen.Name

UIScreen.Show()

UIScreen.Hide()

UIDocumentView.UIDocument

UIDocumentView.OnValidate()

UIDocumentView.OnEnable()

UIDocumentView.OnDisable()

UIDocumentView.TryGetRootElement(out VisualElement)

UIDocumentView.FindUIDocument()

UIDocumentView.DisposeUI()

UIDocumentView.AssignButtonClickEvent(VisualElement, string, Action)

UIDocumentView.InitIntegerField(VisualElement, string, EventCallback<ChangeEvent<int>>, int)

UIDocumentView.InitFloatField(VisualElement, string, EventCallback<ChangeEvent<float>>, float)

UIDocumentView.InitTextField(VisualElement, string, EventCallback<ChangeEvent<string>>, string)

UIDocumentView.InitSlider(VisualElement, string, EventCallback<ChangeEvent<int>>, int)

UIDocumentView.InitSlider(VisualElement, string, EventCallback<ChangeEvent<float>>, int)

UIDocumentView.InitVector2Field(VisualElement, string, EventCallback<ChangeEvent<Vector2>>, Vector2)

UIDocumentView.InitVector2IntField(VisualElement, string, EventCallback<ChangeEvent<Vector2Int>>, Vector2Int)

UIView.Transform

UIView.RectTransform

UIView.Awake()

UIView.OnDestroy()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

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.UI

Assembly: fwt.hexterrains.dll

Syntax

public abstract class MinimapScreenBase : UIScreen<MinimapScreenDataSource>, IViewDataReceiver<MinimapScreenDataSource>, IMinimapScreen

Fields

ViewMode

Current view mode of the minimap.

Declaration

public int ViewMode

Field Value

Type	Description
int

ViewModes

Array of settigs for each view mode. Index in this list = view mode.

Declaration

public List<MinimapScreenBase.ViewModeSettings> ViewModes

Field Value

Type	Description
List<MinimapScreenBase.ViewModeSettings>

_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

_world

Cached Entity World with terrains.

Declaration

protected World _world

Field Value

Type	Description
World

Properties

TerrainEntity

Terrain entity this minimap screen shows

Declaration

public virtual Entity TerrainEntity { get; protected set; }

Property Value

Type	Description
Entity

TexturesVersion

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

Declaration

public long TexturesVersion { get; set; }

Property Value

Type	Description
long

ViewModeVersion

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

Declaration

public long ViewModeVersion { get; set; }

Property Value

Type	Description
long

Methods

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

SetColorTextures(NativeArray<ColorMapTexture>, long)

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

Declaration

public virtual void SetColorTextures(NativeArray<ColorMapTexture> textures, long texturesVersion)

Parameters

Type	Name	Description
NativeArray<ColorMapTexture>	textures	new set of textures
long	texturesVersion	viewModeVersion of textures provided

SetTerrainEntity(Entity)

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

Declaration

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

public virtual void SetViewMode(int viewMode, long viewModeVersion)

Parameters

Type	Name	Description
int	viewMode
long	viewModeVersion

SetViewModeOnTerrain(int)

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

Declaration

public virtual void SetViewModeOnTerrain(int newViewMode)

Parameters

Type	Name	Description
int	newViewMode

Start()

Declaration

protected override void Start()

Overrides

UIDocumentView.Start()

Implements

IViewDataReceiver<TViewData>

IMinimapScreen

Extension Methods

Extensions_UnityObject.SmartDestroy<TObject>(TObject)

Extensions_UnityObject.SmartDestroy<TObject>(TObject)

Extensions_UnityObject.SmartDisableGameObject<TObject>(TObject)

Extensions_UnityObject.SmartDisableGameObject<TObject>(TObject)

Extensions_UnityObject.SmartEnableGameObject<TObject>(TObject)

Extensions_UnityObject.SmartEnableGameObject<TObject>(TObject)

HashExtensions.GetHashCode_RefType<TValue>(TValue, int)

HashExtensions.GetHashCode_RefType<TValue>(TValue, int)

Extensions_UnityObject.SmartDestroy(object)

Extensions_UnityObject.SmartDestroy(object)

Extensions_UnityObject.SmartGetComponent<TComponent>(object)

Extensions_UnityObject.SmartGetComponent<TComponent>(object)

Extensions_UnityObject.SmartGetGameGameObject(object)

Extensions_UnityObject.SmartGetGameGameObject(object)