Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.EquipResponder Class Reference

Listens to Equip/Unequip events and More...

Inheritance diagram for PlatformerPro.EquipResponder:
PlatformerPro.PlatformerProMonoBehaviour

Public Attributes

EquipResponse[] responses
 How to repsond to matching items being equipped. More...
 

Protected Member Functions

virtual void PostInit ()
 Called from Start to initialise references. More...
 
virtual void HandleItemEquipped (object sender, ItemEventArgs e)
 Handles an item being equipped. More...
 
virtual void HandleItemUnequipped (object sender, ItemEventArgs e)
 Handles an item being unequipped. More...
 
virtual void DoAction (EquipResponse response, bool isUnequip)
 Does the action. More...
 

Protected Attributes

EquipmentManager equipmentManager
 The equipment manager. 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...
 
- 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

Listens to Equip/Unequip events and

Member Function Documentation

◆ DoAction()

virtual void PlatformerPro.EquipResponder.DoAction ( EquipResponse  response,
bool  isUnequip 
)
protectedvirtual

Does the action.

Parameters
responseResponse data.
isUnequipIf set to true this is an unequip.

◆ HandleItemEquipped()

virtual void PlatformerPro.EquipResponder.HandleItemEquipped ( object  sender,
ItemEventArgs  e 
)
protectedvirtual

Handles an item being equipped.

Parameters
senderSender.
eEvent args.

◆ HandleItemUnequipped()

virtual void PlatformerPro.EquipResponder.HandleItemUnequipped ( object  sender,
ItemEventArgs  e 
)
protectedvirtual

Handles an item being unequipped.

Parameters
senderSender.
eEvent args.

◆ PostInit()

virtual void PlatformerPro.EquipResponder.PostInit ( )
protectedvirtual

Called from Start to initialise references.

Member Data Documentation

◆ equipmentManager

EquipmentManager PlatformerPro.EquipResponder.equipmentManager
protected

The equipment manager.

◆ responses

EquipResponse [] PlatformerPro.EquipResponder.responses

How to repsond to matching items being equipped.


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