001/*
002 * PlotSquared, a land and world management plugin for Minecraft.
003 * Copyright (C) IntellectualSites <https://intellectualsites.com>
004 * Copyright (C) IntellectualSites team and contributors
005 *
006 * This program is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU General Public License for more details.
015 *
016 * You should have received a copy of the GNU General Public License
017 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
018 */
019package com.plotsquared.core.util.task;
020
021/**
022 * A runnable that can be yielded.
023 * If {@link #yield()} is invoked, {@link #run()} will be called
024 * on the next tick again. Implementations need to save their state
025 * correctly.
026 */
027public interface YieldRunnable extends Runnable {
028
029    /**
030     * Runs the {@link #run()} method again on the next tick.
031     */
032    default void yield() {
033        TaskManager.runTaskLater(this, TaskTime.ticks(1L));
034    }
035
036}