Fix timer not being stopped when game is closed by "Quit" button

[github-actions[bot]]

https://github.com/fujaba/fulibFx/blob/f3464a9f500e60ce0579093ed8dfc1825ad569e7/card-game/src/main/java/io/github/sekassel/uno/service/BotService.java#L39

package io.github.sekassel.uno.service;

import dagger.Lazy;
import io.github.sekassel.uno.Constants;
import io.github.sekassel.uno.model.Card;
import io.github.sekassel.uno.model.Player;
import io.github.sekassel.uno.util.CardColor;
import io.github.sekassel.uno.util.Utils;
import javafx.application.Platform;

import javax.inject.Inject;
import javax.inject.Singleton;
import javax.swing.*;
import java.util.List;
import java.util.Random;

@Singleton
public class BotService {

    private final Random random;

    @Inject
    Lazy<GameService> gameService;

    @Inject
    public BotService() {
        this.random = new Random();
    }

    /**
     * Makes a bot play a round after a certain delay.
     *
     * @param bot The bot which should play
     */
    public void startTurn(Player bot) {
        Timer timer = new Timer(Constants.BOT_PLAY_DELAY, task -> Platform.runLater(() -> this.playRound(bot)));
        timer.setInitialDelay(Constants.BOT_PLAY_DELAY);
        timer.setRepeats(false);
        timer.restart(); //TODO: Fix timer not being stopped when game is closed by "Quit" button
    }

    /**
     * Selects a random cart out of the bot's cards which can be played
     *
     * @param bot The bot from which a card should be picked
     * @return A card which can be played or null
     */
    public Card selectCardToPlay(Player bot) {
        Card current = bot.getGame().getCurrentCard();
        List<Card> possibleCards = bot.getCards().stream().filter(card -> card.canBeOnTopOf(current)).toList();
        return possibleCards.isEmpty() ? null : possibleCards.get(random.nextInt(possibleCards.size()));
    }

    /**
     * Selects a card and plays it. If no card can be found, a card will be drawn.
     * If there is still no playable card, the next player will be selected.
     *
     * @param bot The bot which should play a card
     */
    private void playRound(Player bot) {
        Card selected = selectCardToPlay(bot);

        // If no card can be selected, draw a card
        if (selected == null) {
            Card drawn = this.gameService.get().handoutCards(bot, 1).get(0);
            if (!drawn.canBeOnTopOf(bot.getGame().getCurrentCard())) {
                this.gameService.get().selectNextPlayer(bot.getGame(), 1);
                Utils.playSound(Constants.SOUND_FAIL);
                return;
            }
            selected = drawn;
        }

        CardColor color = selected.getColor();

        // If the card is a wildcard, select a random color
        color = color == CardColor.WILD ? Utils.getRandomColor(this.random) : null;

        // Play the card
        gameService.get().playRound(selected, color);
    }

    /**
     * Removes a bot from the game.
     * @param player The bot to remove
     */
    public void removeBot(Player player) {
        player.removeYou();
    }

}

[Clashsoft]

Probably a good use and test for @onDestroy (which should be called when the App is closed)

[LeStegii]

As the timer is included in the service rather than the controller due to being an old project, this would require a larger rework of parts of the application. And since there will be a new example project soon, which will be created with the framework in mind, I'd say this is low priority for now.