From b169d89291dc1d5f9294776ffbcdc9481540e966 Mon Sep 17 00:00:00 2001
From: "Dylan K. Taylor" <odigiman@gmail.com>
Date: Sun, 4 Oct 2020 21:40:52 +0100
Subject: [PATCH] Added some documentation to FurnaceBurnEvent

---
 .../event/inventory/FurnaceBurnEvent.php         | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/pocketmine/event/inventory/FurnaceBurnEvent.php b/src/pocketmine/event/inventory/FurnaceBurnEvent.php
index f52ff4185..882046631 100644
--- a/src/pocketmine/event/inventory/FurnaceBurnEvent.php
+++ b/src/pocketmine/event/inventory/FurnaceBurnEvent.php
@@ -28,6 +28,9 @@ use pocketmine\event\Cancellable;
 use pocketmine\item\Item;
 use pocketmine\tile\Furnace;
 
+/**
+ * Called when a furnace is about to consume a new fuel item.
+ */
 class FurnaceBurnEvent extends BlockEvent implements Cancellable{
 	/** @var Furnace */
 	private $furnace;
@@ -53,18 +56,31 @@ class FurnaceBurnEvent extends BlockEvent implements Cancellable{
 		return $this->fuel;
 	}
 
+	/**
+	 * Returns the number of ticks that the furnace will be powered for.
+	 */
 	public function getBurnTime() : int{
 		return $this->burnTime;
 	}
 
+	/**
+	 * Sets the number of ticks that the given fuel will power the furnace for.
+	 */
 	public function setBurnTime(int $burnTime) : void{
 		$this->burnTime = $burnTime;
 	}
 
+	/**
+	 * Returns whether the fuel item will be consumed.
+	 */
 	public function isBurning() : bool{
 		return $this->burning;
 	}
 
+	/**
+	 * Sets whether the fuel will be consumed. If false, the furnace will smelt as if it consumed fuel, but no fuel
+	 * will be deducted.
+	 */
 	public function setBurning(bool $burning) : void{
 		$this->burning = $burning;
 	}