PlatformerPro.UIEquipmentSlotView Class Reference

Shows the item equipped to a given slot for a given player. More...

Inheritance diagram for PlatformerPro.UIEquipmentSlotView:

Public Attributes
string	slot
	Slot to show. More...
int	playerId = -1
	The player identifier. More...
Image	itemImage
	The image component used to show equipped item. More...
GameObject	nothingEquippedGo
	If non-null this GO will be disabled when an item is equipped and enabled when no item is equipped. More...

Protected Member Functions
virtual void	Init ()
	Init this instance. More...
virtual void	GetCharacter ()
	Gets a character ref from a loader. More...
virtual void	HandleCharacterLoaded (object sender, CharacterEventArgs e)
	Handles character loaded by assigning equipment manager. More...
virtual void	DoDestroy ()
	Object destroyed, clear event listeners. More...
virtual void	HanldeItemEquipped (object sender, ItemEventArgs e)
	Hanldes an item being equipped. More...
virtual void	HanldeItemUnequipped (object sender, ItemEventArgs e)
	Hanldes an item being unequipped. More...

Properties
override string	Header [get]
	Gets the header. More...
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...

Additional Inherited Members
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...

Detailed Description

Shows the item equipped to a given slot for a given player.

Member Function Documentation

DoDestroy()

virtual void PlatformerPro.UIEquipmentSlotView.DoDestroy ( )

protectedvirtual

Object destroyed, clear event listeners.

GetCharacter()

virtual void PlatformerPro.UIEquipmentSlotView.GetCharacter ( )

protectedvirtual

Gets a character ref from a loader.

HandleCharacterLoaded()

virtual void PlatformerPro.UIEquipmentSlotView.HandleCharacterLoaded ( object  sender, CharacterEventArgs  e  )

protectedvirtual

Handles character loaded by assigning equipment manager.

Parameters

sender	Sender.
e	E.

HanldeItemEquipped()

virtual void PlatformerPro.UIEquipmentSlotView.HanldeItemEquipped ( object  sender, ItemEventArgs  e  )

protectedvirtual

Hanldes an item being equipped.

Parameters

sender	Sender.
e	E.

HanldeItemUnequipped()

virtual void PlatformerPro.UIEquipmentSlotView.HanldeItemUnequipped ( object  sender, ItemEventArgs  e  )

protectedvirtual

Hanldes an item being unequipped.

Parameters

sender	Sender.
e	E.

Init()

virtual void PlatformerPro.UIEquipmentSlotView.Init ( )

protectedvirtual

Init this instance.

Member Data Documentation

itemImage

Image PlatformerPro.UIEquipmentSlotView.itemImage

The image component used to show equipped item.

nothingEquippedGo

GameObject PlatformerPro.UIEquipmentSlotView.nothingEquippedGo

If non-null this GO will be disabled when an item is equipped and enabled when no item is equipped.

playerId

int PlatformerPro.UIEquipmentSlotView.playerId = -1

The player identifier.

slot

string PlatformerPro.UIEquipmentSlotView.slot

Slot to show.

Property Documentation

Header

override string PlatformerPro.UIEquipmentSlotView.Header

get

Gets the header.

The header.

---

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

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/UI/InGameUI/UIEquipmentSlotView.cs