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

Add this class to an object with a trigger box collider 2D, and it'll become a pickable object, able to permit or forbid an ability on a Character. More...

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

Public Types

enum  Methods { Permit , Forbid }

Public Attributes

Methods Method = Methods.Permit
 whether this object should permit or forbid an ability when picked
bool OnlyPickableByPlayerCharacters = true
 whether or not only characters of Player type should be able to pick this
string AbilityTypeAsString
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 bool CheckIfPickable ()
 Checks if the object is pickable.
override void Pick (GameObject picker)
 on pick, we permit or forbid our target ability
Protected Member Functions inherited from MoreMountains.TopDownEngine.PickableItem
virtual void Start ()
virtual IEnumerator DisableTargetObjectCoroutine ()
virtual IEnumerator DisablePickerCoroutine ()
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

Add this class to an object with a trigger box collider 2D, and it'll become a pickable object, able to permit or forbid an ability on a Character.

Member Enumeration Documentation

◆ Methods

Enumerator
Permit 
Forbid 

Member Function Documentation

◆ CheckIfPickable()

override bool MoreMountains.TopDownEngine.PickableAbility.CheckIfPickable ( )
protectedvirtual

Checks if the object is pickable.

Returns
true

false

Reimplemented from MoreMountains.TopDownEngine.PickableItem.

◆ Pick()

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

on pick, we permit or forbid our target ability

Reimplemented from MoreMountains.TopDownEngine.PickableItem.

Member Data Documentation

◆ AbilityTypeAsString

string MoreMountains.TopDownEngine.PickableAbility.AbilityTypeAsString

◆ Method

Methods MoreMountains.TopDownEngine.PickableAbility.Method = Methods.Permit

whether this object should permit or forbid an ability when picked

◆ OnlyPickableByPlayerCharacters

bool MoreMountains.TopDownEngine.PickableAbility.OnlyPickableByPlayerCharacters = true

whether or not only characters of Player type should be able to pick this


The documentation for this class was generated from the following file:
  • H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/Scripts/Items/PickableAbility.cs