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:

Public Types
enum	Methods { Methods.Permit, Methods.Forbid }

Public Attributes
Methods	Method = Methods.Permit
	whether this object should permit or forbid an ability when picked More...

bool	OnlyPickableByPlayerCharacters = true
	whether or not only characters of Player type should be able to pick this More...

string	AbilityTypeAsString

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 bool	CheckIfPickable ()
	Checks if the object is pickable More...

override void	Pick (GameObject picker)
	on pick, we permit or forbid our target ability More...

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 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

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

enum MoreMountains.TopDownEngine.PickableAbility.Methods

strong

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:

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

Public Types

Public Attributes

Protected Member Functions

Additional Inherited Members