IDreamLoop.java

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 Dreamfire Studio
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.dreamfirestudios.dreamcore.DreamLoop;
 
import com.dreamfirestudios.dreamcore.DreamCore;
import org.bukkit.Bukkit;
 
import java.util.UUID;
 
public interface IDreamLoop {
 
    UUID ReturnID();
 
    default long StartDelay() { return 0L; }
 
    default long LoopInterval() { return 20L; }
 
    void Start();
 
    void Loop();
 
    void End();
 
    default void CancelLoop() {
        final int id = GetId();
        if (id >= 0) {
            Bukkit.getScheduler().cancelTask(id);
        }
        try {
            End();
        } finally {
            try {
                DreamCore.IDreamLoops.remove(ReturnID());
            } catch (Throwable ignored) {
                // Best-effort cleanup; do not propagate
            }
        }
    }
 
    void PassID(int id);
 
    int GetId();
}