A Stimpack / health bonus, that gives health back when picked More...

Inheritance diagram for MoreMountains.TopDownEngine.Stimpack:

Public Attributes
float	HealthToGive = 10f
	The amount of points to add when collected. More...

bool	OnlyForPlayerCharacter = true
	if this is true, only player characters can pick this up More...

Public Attributes inherited from MoreMountains.TopDownEngine.PickableItem
MMFeedbacks	PickedMMFeedbacks
	A feedback to play when the object gets picked. More...

bool	DisableColliderOnPick = false
	if this is true, the picker's collider will be disabled on pick More...

bool	DisableObjectOnPick = true
	if this is set to true, the object will be disabled when picked More...

float	DisableDelay = 0f
	the duration (in seconds) after which to disable the object, instant if 0 More...

bool	DisableModelOnPick = false
	if this is set to true, the object will be disabled when picked More...

bool	DisableTargetObjectOnPick = false
	if this is set to true, the target object will be disabled when picked More...

GameObject	TargetObjectToDisable
	the object to disable on pick if DisableTargetObjectOnPick is true More...

float	TargetObjectDisableDelay = 1f
	the time in seconds before disabling the target if DisableTargetObjectOnPick is true More...

GameObject	Model
	the visual representation of this picker More...

bool	RequireCharacterComponent = true
	if this is true, this pickable item will only be pickable by objects with a Character component More...

bool	RequirePlayerType = true
	if this is true, this pickable item will only be pickable by objects with a Character component of type player More...

Protected Member Functions
override void	Pick (GameObject picker)
	Triggered when something collides with the stimpack More...

Protected Member Functions inherited from MoreMountains.TopDownEngine.PickableItem
virtual void	Start ()

virtual IEnumerator	DisableTargetObjectCoroutine ()

virtual IEnumerator	DisablePickerCoroutine ()

virtual bool	CheckIfPickable ()
	Checks if the object is pickable. More...

virtual void	Effects ()
	Triggers the various pick effects More...

Additional Inherited Members
Public Member Functions inherited from MoreMountains.TopDownEngine.PickableItem
virtual void	OnTriggerEnter (Collider collider)
	Triggered when something collides with the coin More...

virtual void	OnTriggerEnter2D (Collider2D collider)
	Triggered when something collides with the coin More...

virtual void	PickItem (GameObject picker)
	Check if the item is pickable and if yes, proceeds with triggering the effects and disabling the object More...

Protected Attributes inherited from MoreMountains.TopDownEngine.PickableItem
Collider	_collider

Collider2D	_collider2D

GameObject	_collidingObject

Character	_character = null

bool	_pickable = false

ItemPicker	_itemPicker = null

WaitForSeconds	_disableDelay

Detailed Description

A Stimpack / health bonus, that gives health back when picked

Member Function Documentation

override void MoreMountains.TopDownEngine.Stimpack.Pick ( GameObject picker )

protectedvirtual

Triggered when something collides with the stimpack

Parameters

collider Other.

float MoreMountains.TopDownEngine.Stimpack.HealthToGive = 10f

The amount of points to add when collected.

bool MoreMountains.TopDownEngine.Stimpack.OnlyForPlayerCharacter = true

if this is true, only player characters can pick this up

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

F:/Github/Store/TopDownEngine/Assets/TopDownEngine/Common/Scripts/Items/Stimpack.cs