IDreamPrompt.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.DreamPrompt;
 
import org.bukkit.conversations.ConversationContext;
import org.bukkit.entity.Player;
 
import java.util.HashMap;
import java.util.function.Consumer;
 
public interface IDreamPrompt {
    String promptText(Player player);
 
    default HashMap<Object, Object> defaultData(Player player) { return new HashMap<>(); }
 
    default boolean clearPlayerChatOnStart(Player player)   { return true; }
    default boolean clearPlayerChatOnRestart(Player player) { return true; }
    default boolean clearPlayerChatOnEnd(Player player)     { return true; }
 
    Consumer<DreamPromptTriplet<Player, String, ConversationContext>> onResponseCallback();
 
    default Consumer<DreamPromptTriplet<Player, String, ConversationContext>> onConversationRestartCallback() {
        return triplet -> { /* no-op */ };
    }
 
    Consumer<DreamPromptTriplet<Player, String, ConversationContext>> onEndConversationCallback();
}