Class InventoryItemHudView

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

Inheritance

Object

Object

Component

Behaviour

MonoBehaviour

InventoryItemHudView

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/Inventory Item HUD View", 5)]
[ExecuteInEditMode]
public class InventoryItemHudView : MonoBehaviour

Properties

iconImageField

The Image component to assign the InventoryItem 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 Inventory Item for displaying in the hud view.

Declaration

public string iconSpritePropertyKey { get; }

Property Value

Type	Description
String

itemDefinition

A reference to the InventoryItemDefinition definition.

Declaration

public InventoryItemDefinition itemDefinition { get; }

Property Value

Type	Description
InventoryItemDefinition

itemDefinitionKey

The identifier of the InventoryItem to display.

Declaration

public string itemDefinitionKey { get; }

Property Value

Type	Description
String

quantityTextField

The TextMeshProUGUI component to assign the InventoryItem quantity to.

Declaration

public TextMeshProUGUI quantityTextField { get; }

Property Value

Type	Description
TMPro.TextMeshProUGUI

Methods

SetIconImageField(Image)

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

Declaration

public void SetIconImageField(Image image)

Parameters

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

SetIconSpritePropertyKey(String)

Sets the property key to use when getting the sprite of the Inventory Item icon.

Declaration

public void SetIconSpritePropertyKey(string propertyKey)

Parameters

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

SetItemDefinition(InventoryItemDefinition)

Sets Inventory Item should be displayed by this view.

Declaration

public void SetItemDefinition(InventoryItemDefinition itemDefinition)

Parameters

Type	Name	Description
InventoryItemDefinition	itemDefinition	The Inventory Item definition that should be displayed.

SetQuantityTextField(TextMeshProUGUI)

Sets the TextMeshProUGUI component to display the Inventory item quantity on this view.

Declaration

public void SetQuantityTextField(TextMeshProUGUI text)

Parameters

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