Class CurrencyHudView

Component that manages displaying a Currency's icon and quantity. When attached to a game object, it will display the Currency's icon and quantity.

Inheritance

Object

Object

Component

Behaviour

MonoBehaviour

CurrencyHudView

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(String, Single)

MonoBehaviour.InvokeRepeating(String, Single, Single)

MonoBehaviour.CancelInvoke(String)

MonoBehaviour.IsInvoking(String)

MonoBehaviour.StartCoroutine(String)

MonoBehaviour.StartCoroutine(String, Object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(String)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(Object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, Component)

Component.TryGetComponent<T>(T)

Component.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

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

Component.GetComponentsInChildren<T>()

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

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

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

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

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

Component.GetComponents<T>()

Component.CompareTag(String)

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.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

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, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

Namespace: UnityEngine.GameFoundation.Components

Syntax

[AddComponentMenu("Game Foundation/Currency HUD View", 4)]
[ExecuteInEditMode]
public class CurrencyHudView : MonoBehaviour

Properties

currency

A reference to the Currency definition.

Declaration

public Currency currency { get; }

Property Value

Type	Description
Currency

currencyKey

The identifier of the Currency to display.

Declaration

public string currencyKey { get; }

Property Value

Type	Description
String

iconImageField

The Image component to assign the Currency icon image to.

Declaration

public Image iconImageField { get; }

Property Value

Type	Description
Image

iconSpritePropertyKey

The Static Property key string that should be used for getting the sprite of the Currency for displaying in the hud view.

Declaration

public string iconSpritePropertyKey { get; }

Property Value

Type	Description
String

quantityTextField

The TextMeshProUGUI component to assign the Currency quantity to.

Declaration

public TextMeshProUGUI quantityTextField { get; }

Property Value

Type	Description
TMPro.TextMeshProUGUI

Methods

SetCurrency(Currency)

Sets the Currency that should be displayed by this view. Runtime only.

Declaration

public void SetCurrency(Currency currency)

Parameters

Type	Name	Description
Currency	currency	A reference to the Currency that should be displayed.

SetIconImageField(Image)

Sets the Image component to display Currency icon sprite on this view.

Declaration

public void SetIconImageField(Image image)

Parameters

Type	Name	Description
Image	image	The Image component to display Currency icon sprite.

SetIconSpritePropertyKey(String)

Sets sprite name for Currency icon that will be displayed on this view.

Declaration

public void SetIconSpritePropertyKey(string propertyKey)

Parameters

Type	Name	Description
String	propertyKey	The Static Property key to look up sprite by. Currency doesn't have this key in its Static Properties will not display an icon.

SetQuantityTextField(TextMeshProUGUI)

Sets the TextMeshProUGUI component to display the Currency quantity on this view.

Declaration

public void SetQuantityTextField(TextMeshProUGUI text)

Parameters

Type	Name	Description
TMPro.TextMeshProUGUI	text	The TextMeshProUGUI component to display the Currency quantity