HealthPotion Class Reference

Detailed Description

Functionality for the health potion object that spawns after breaking a pot. This script simply invokes an event and destroys the object when the player enters the trigger zone.

Documentation updated 3/5/2024

Author

Stephen Nuttall

Events
static Action	potionPickedUp
	Triggers when the player enters the trigger zone.

Private Member Functions
void	OnTriggerEnter2D (Collider2D col)
	Invoke potionPickedUp and destroy the object when the player enters the trigger zone.

Member Function Documentation

OnTriggerEnter2D()

void HealthPotion.OnTriggerEnter2D ( Collider2D col )

private

Invoke potionPickedUp and destroy the object when the player enters the trigger zone.

Event Documentation

potionPickedUp

Action HealthPotion.potionPickedUp

static

Triggers when the player enters the trigger zone.

---

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

• Assets/Scripts/Entities/HealthPotion.cs