TopDown Engine v4.5
Loading...
Searching...
No Matches
MoreMountains.TopDownEngine.Stimpack Class Reference

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

Inheritance diagram for MoreMountains.TopDownEngine.Stimpack:
MoreMountains.TopDownEngine.PickableItem MoreMountains.TopDownEngine.TopDownMonoBehaviour MoreMountains.Tools.MMMonoBehaviour

Public Attributes

float HealthToGive = 10f
 The amount of points to add when collected.
bool OnlyForPlayerCharacter = true
 if this is true, only player characters can pick this up
Public Attributes inherited from MoreMountains.TopDownEngine.PickableItem
MMFeedbacks PickedMMFeedbacks
 A feedback to play when the object gets picked.
bool DisableColliderOnPick = false
 if this is true, the picker's collider will be disabled on pick
bool DisableObjectOnPick = true
 if this is set to true, the object will be disabled when picked
float DisableDelay = 0f
 the duration (in seconds) after which to disable the object, instant if 0
bool DisableModelOnPick = false
 if this is set to true, the object will be disabled when picked
bool DisableTargetObjectOnPick = false
 if this is set to true, the target object will be disabled when picked
GameObject TargetObjectToDisable
 the object to disable on pick if DisableTargetObjectOnPick is true
float TargetObjectDisableDelay = 1f
 the time in seconds before disabling the target if DisableTargetObjectOnPick is true
GameObject Model
 the visual representation of this picker
bool RequireCharacterComponent = true
 if this is true, this pickable item will only be pickable by objects with a Character component
bool RequirePlayerType = true
 if this is true, this pickable item will only be pickable by objects with a Character component of type player

Protected Member Functions

override void Pick (GameObject picker)
 Triggered when something collides with the stimpack.
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.
virtual void Effects ()
 Triggers the various pick effects.

Additional Inherited Members

Public Member Functions inherited from MoreMountains.TopDownEngine.PickableItem
virtual void OnTriggerEnter (Collider collider)
 Triggered when something collides with the coin.
virtual void OnTriggerEnter2D (Collider2D collider)
 Triggered when something collides with the coin.
virtual void PickItem (GameObject picker)
 Check if the item is pickable and if yes, proceeds with triggering the effects and disabling the object.
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

◆ Pick()

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

Triggered when something collides with the stimpack.

Parameters
colliderOther.

Reimplemented from MoreMountains.TopDownEngine.PickableItem.

Member Data Documentation

◆ HealthToGive

float MoreMountains.TopDownEngine.Stimpack.HealthToGive = 10f

The amount of points to add when collected.

◆ OnlyForPlayerCharacter

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:
  • H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/Scripts/Items/Stimpack.cs