Add an API to remove a player's item cooldown

[ItsMax123]

Currently, plugins cannot remove a player's server-side item cooldown. The only publicly available API is Player->resetItemCooldown(Item $item, ?int $ticks = null), which intentionally only supports cooldown values greater than 0.

Changes

API changes

• The following API methods have been added:
  • public Player->removeItemCooldown(Item $item) : void - removes the player's cooldown time for the given item

Tests

This testing plugin removes the cooldown on ender pearls and goat horns after 10 and 40 ticks respectively.
Video: https://github.com/user-attachments/assets/0f716c52-1369-486b-8062-902f97504a24

<?php

declare(strict_types=1);

namespace Max\Test;

use pocketmine\event\Listener;
use pocketmine\event\player\PlayerItemUseEvent;
use pocketmine\item\EnderPearl;
use pocketmine\item\GoatHorn;
use pocketmine\plugin\PluginBase;
use pocketmine\scheduler\ClosureTask;

class Test extends PluginBase implements Listener {
    public function onEnable(): void {
        $this->getServer()->getPluginManager()->registerEvents($this, $this);
    }

    public function onItemUse(PlayerItemUseEvent $event): void {
        $item = $event->getItem();
        if ($item instanceof EnderPearl) {
            $delay = 10;
        } elseif ($item instanceof GoatHorn) {
            $delay = 40;
        } else {
            return;
        }
        $player = $event->getPlayer();
        $this->getScheduler()->scheduleDelayedTask(new ClosureTask(function() use ($player, $item) {
            $player->removeItemCooldown($item);
        }), $delay);
    }
}

[ItsMax123]

Also, thoughts on adding a PlayerItemCooldownStartEvent? That way plugins can override an item's cooldown without having to do hacky workarounds.
I can add it to this PR or create a new one if you'd like.

[dktapps]

Code looks OK but I don't know if this will actually work. Needs playtesting

[ItsMax123]

Ok, I added tests to the original post.

[kaxyum]

Also, thoughts on adding a PlayerItemCooldownStartEvent? That way plugins can override an item's cooldown without having to do hacky workarounds. I can add it to this PR or create a new one if you'd like.

Any news about that ? I think it is a good idea