Corgi Engine  v8.8
MoreMountains.CorgiEngine.InventoryPickableItem Class Reference
Inheritance diagram for MoreMountains.CorgiEngine.InventoryPickableItem:
MoreMountains.InventoryEngine.ItemPicker MoreMountains.CorgiEngine.Respawnable

Public Member Functions

virtual void OnPlayerRespawn (CheckPoint checkpoint, Character player)
 Triggered when the player respawns, resets the block if needed More...
 
- Public Member Functions inherited from MoreMountains.InventoryEngine.ItemPicker
virtual void ResetQuantity ()
 Resets the remaining quantity to the initial quantity More...
 
virtual void OnTriggerEnter (Collider collider)
 Triggered when something collides with the picker More...
 
virtual void OnTriggerEnter2D (Collider2D collider)
 Triggered when something collides with the picker More...
 
virtual void Pick ()
 Picks this item and adds it to its target inventory More...
 
virtual void Pick (string targetInventoryName, string playerID="Player1")
 Picks this item and adds it to the target inventory specified as a parameter More...
 
virtual bool Pickable ()
 Returns true if this item can be picked, false otherwise More...
 
virtual void FindTargetInventory (string targetInventoryName, string playerID="Player1")
 Finds the target inventory based on its name More...
 

Public Attributes

MMFeedbacks PickFeedbacks
 the MMFeedback to play when the object gets picked More...
 
bool ResetQuantityOnPlayerRespawn = true
 whether or not this should reset RemainingQuantity when the player respawns More...
 
- Public Attributes inherited from MoreMountains.InventoryEngine.ItemPicker
InventoryItem Item
 the item that should be picked More...
 
int Quantity = 1
 the initial quantity of that item that should be added to the inventory when picked More...
 
int RemainingQuantity = 1
 the current quantity of that item that should be added to the inventory when picked More...
 
bool PickableIfInventoryIsFull = false
 if you set this to true, a character will be able to pick this item even if its inventory is full More...
 
bool DisableObjectWhenDepleted = false
 if you set this to true, the object will be disabled when picked More...
 
bool RequirePlayerTag = true
 if this is true, this object will only be allowed to be picked by colliders with a Player tag More...
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from MoreMountains.InventoryEngine.ItemPicker
int _pickedQuantity = 0
 
Inventory _targetInventory
 

Member Function Documentation

◆ Effects()

virtual void MoreMountains.CorgiEngine.InventoryPickableItem.Effects ( )
protectedvirtual

Triggers the various pick effects

◆ OnPlayerRespawn()

virtual void MoreMountains.CorgiEngine.InventoryPickableItem.OnPlayerRespawn ( CheckPoint  checkpoint,
Character  player 
)
virtual

Triggered when the player respawns, resets the block if needed

Parameters
checkpointCheckpoint.
playerPlayer.

Implements MoreMountains.CorgiEngine.Respawnable.

◆ PickSuccess()

override void MoreMountains.CorgiEngine.InventoryPickableItem.PickSuccess ( )
protectedvirtual

Describes what happens when the object is successfully picked

Reimplemented from MoreMountains.InventoryEngine.ItemPicker.

Member Data Documentation

◆ PickFeedbacks

MMFeedbacks MoreMountains.CorgiEngine.InventoryPickableItem.PickFeedbacks

the MMFeedback to play when the object gets picked

◆ ResetQuantityOnPlayerRespawn

bool MoreMountains.CorgiEngine.InventoryPickableItem.ResetQuantityOnPlayerRespawn = true

whether or not this should reset RemainingQuantity when the player respawns


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