PlatformerPro.ItemPickupBox Class Reference

This UI element is shown when a character stands over an item and the pick up button is not equal to -1 (i.e. auto pick-up is off). More...

Inheritance diagram for PlatformerPro.ItemPickupBox:

Public Member Functions
void	Init (ItemManager itemManager)
virtual void	Show (Item item)
virtual void	Hide (Item item)
Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual void	Validate (PlatformerProMonoBehaviour myTarget)
	Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...

Public Attributes
GameObject	visibleContent
	Root element holding the visible content More...
Image	itemImage
	Image to show the item type. Can be null. More...
Text	itemName
	Text to show item name. Can be null. More...
Text	itemCount
	Text to show item count. Can be null. More...
bool	showInWorldSpace
	If true the box with be shown at transform of relevant item. You can use the visible content position relative to parent to offset. More...
Camera	uiCamera
	Camera to use for world space positioning. Will be searched for if null. More...

Protected Attributes
ItemManager	itemManager
List< Item >	activeItems
Canvas	canvas
Item	currentItem
	The item being shown. More...

Properties
override string	Header [get]
Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string	Header [get]
	Gets the header string used to describe the component. More...
virtual string	DocLink [get]
	Gets a link to documentation site. More...
virtual string	VideoLink [get]
	Gets a link to a youtube video. More...
virtual string	Deprecated [get]
	If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...

Detailed Description

This UI element is shown when a character stands over an item and the pick up button is not equal to -1 (i.e. auto pick-up is off).

Member Function Documentation

Hide()

virtual void PlatformerPro.ItemPickupBox.Hide ( Item  item )

virtual

Init()

void PlatformerPro.ItemPickupBox.Init

(

ItemManager

itemManager

)

Show()

virtual void PlatformerPro.ItemPickupBox.Show ( Item  item )

virtual

Member Data Documentation

activeItems

List<Item> PlatformerPro.ItemPickupBox.activeItems

protected

canvas

Canvas PlatformerPro.ItemPickupBox.canvas

protected

currentItem

Item PlatformerPro.ItemPickupBox.currentItem

protected

The item being shown.

itemCount

Text PlatformerPro.ItemPickupBox.itemCount

Text to show item count. Can be null.

itemImage

Image PlatformerPro.ItemPickupBox.itemImage

Image to show the item type. Can be null.

itemManager

ItemManager PlatformerPro.ItemPickupBox.itemManager

protected

itemName

Text PlatformerPro.ItemPickupBox.itemName

Text to show item name. Can be null.

showInWorldSpace

bool PlatformerPro.ItemPickupBox.showInWorldSpace

If true the box with be shown at transform of relevant item. You can use the visible content position relative to parent to offset.

uiCamera

Camera PlatformerPro.ItemPickupBox.uiCamera

Camera to use for world space positioning. Will be searched for if null.

visibleContent

GameObject PlatformerPro.ItemPickupBox.visibleContent

Root element holding the visible content

Property Documentation

Header

override string PlatformerPro.ItemPickupBox.Header

get

---

The documentation for this class was generated from the following file:

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Items/ItemPickupBox.cs