An item picker that instantiates an effect and plays a sound on pick. More...

Inheritance diagram for MoreMountains.TopDownEngine.InventoryPickableItem:

Public Attributes
GameObject	Effect
	The effect to instantiate when the coin is hit.
AudioClip	PickSfx
	The sound effect to play when the object gets picked.
Public Attributes inherited from MoreMountains.InventoryEngine.ItemPicker
InventoryItem	Item
	the item that should be picked
int	Quantity = 1
	the initial quantity of that item that should be added to the inventory when picked
int	RemainingQuantity = 1
	the current quantity of that item that should be added to the inventory when picked
bool	PickableIfInventoryIsFull = false
	if you set this to true, a character will be able to pick this item even if its inventory is full
bool	DisableObjectWhenDepleted = false
	if you set this to true, the object will be disabled when picked
bool	RequirePlayerTag = true
	if this is true, this object will only be allowed to be picked by colliders with a Player tag

Protected Member Functions
override void	PickSuccess ()
	Describes what happens when the object is successfully picked.
virtual void	Effects ()
	Triggers the various pick effects.
Protected Member Functions inherited from MoreMountains.InventoryEngine.ItemPicker
virtual void	Start ()
	On Start we initialize our item picker.
virtual void	Initialization ()
	On Init we look for our target inventory.
virtual void	PickFail ()
	Describes what happens when the object fails to get picked (inventory full, usually)
virtual void	DisableObjectIfNeeded ()
	Disables the object if needed.
virtual void	DetermineMaxQuantity ()
	Determines the max quantity of item that can be picked from this.

Additional Inherited Members
Public Member Functions inherited from MoreMountains.InventoryEngine.ItemPicker
virtual void	ResetQuantity ()
	Resets the remaining quantity to the initial quantity.
virtual void	OnTriggerEnter (Collider collider)
	Triggered when something collides with the picker.
virtual void	OnTriggerEnter2D (Collider2D collider)
	Triggered when something collides with the picker.
virtual void	Pick ()
	Picks this item and adds it to its target inventory.
virtual void	Pick (string targetInventoryName, string playerID="Player1")
	Picks this item and adds it to the target inventory specified as a parameter.
virtual bool	Pickable ()
	Returns true if this item can be picked, false otherwise.
virtual void	FindTargetInventory (string targetInventoryName, string playerID="Player1")
	Finds the target inventory based on its name.
Protected Attributes inherited from MoreMountains.InventoryEngine.ItemPicker
int	_pickedQuantity = 0
Inventory	_targetInventory

Detailed Description

An item picker that instantiates an effect and plays a sound on pick.

Member Function Documentation

virtual void MoreMountains.TopDownEngine.InventoryPickableItem.Effects ( )

protectedvirtual

Triggers the various pick effects.

override void MoreMountains.TopDownEngine.InventoryPickableItem.PickSuccess ( )

protectedvirtual

Describes what happens when the object is successfully picked.

GameObject MoreMountains.TopDownEngine.InventoryPickableItem.Effect

The effect to instantiate when the coin is hit.

AudioClip MoreMountains.TopDownEngine.InventoryPickableItem.PickSfx

The sound effect to play when the object gets picked.

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

H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/Scripts/Items/InventoryPickableItem.cs