SAPI_Msg.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * 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.jcwhatever.nucleus.internal.managed.scripting.api;

import com.jcwhatever.nucleus.internal.managed.messenger.InternalMessengerFactory;
import com.jcwhatever.nucleus.managed.messaging.IMessenger;
import com.jcwhatever.nucleus.managed.messaging.IMessenger.LineWrapping;
import com.jcwhatever.nucleus.mixins.IDisposable;
import com.jcwhatever.nucleus.utils.PreCon;
import com.jcwhatever.nucleus.utils.player.PlayerUtils;
import org.bukkit.entity.Player;

import javax.annotation.Nullable;
import java.util.UUID;

/**
 * Provide scripts with api access to a NucleusFramework messenger.
 */
public class SAPI_Msg implements IDisposable {

    private final IMessenger _msg;

    private String _chatPrefix = "";
    private boolean _isDisposed;

    public SAPI_Msg(IMessenger messenger) {
        _msg = messenger;
        _msg.setDefaultLineWrap(LineWrapping.DISABLED);
    }

    @Override
    public boolean isDisposed() {
        return _isDisposed;
    }

    @Override
    public void dispose() {
        _isDisposed = true;
    }

    /**
     * Set the chat prefix to use.
     *
     * @param prefix  The prefix.
     */
    public void setChatPrefix(@Nullable Object prefix) {
        _chatPrefix = InternalMessengerFactory.getChatPrefix(prefix);
    }

    /**
     * Broadcast a message to all players on the server.
     *
     * @param message  The message to broadcast.
     */
    public void broadcast(String message) {
        PreCon.notNull(message);

        _msg.broadcast(_chatPrefix + message);
    }

    /**
     * Broadcast a message to all players on the server.
     *
     * @param message  The message to broadcast.
     * @param args     Message formatting arguments.
     */
    public void broadcast(String message, Object[] args) {
        PreCon.notNull(message);
        PreCon.notNull(args);

        _msg.broadcast(_chatPrefix + message, args);
    }

    /**
     * Tell a player a message.
     *
     * @param player   The player to tell.
     * @param message  The message to send.
     */
    public void tell(Object player, String message) {
        PreCon.notNull(player);
        PreCon.notNull(message);

        Player p = PlayerUtils.getPlayer(player);
        PreCon.notNull(p);

        _msg.tell(p, _chatPrefix + message);
    }

    /**
     * Tell a player a message.
     *
     * @param player   The player to tell.
     * @param message  The message to send.
     * @param args     Message formatting arguments.
     */
    public void tell(Object player, String message, Object[] args) {
        PreCon.notNull(player);
        PreCon.notNull(message);
        PreCon.notNull(args);

        Player p = PlayerUtils.getPlayer(player);
        PreCon.notNull(p);

        _msg.tell(p, _chatPrefix + message, args);
    }

    /**
     * Tell a player a message and prevent spamming of the same message.
     *
     * @param player   The player to tell.
     * @param timeout  The spam timeout, the amount of time to wait before the message can be seen again.
     * @param message  The message to send.
     */
    public void tellNoSpam(Object player, int timeout, String message) {
        PreCon.notNull(player);
        PreCon.greaterThanZero(timeout);
        PreCon.notNull(message);

        Player p = PlayerUtils.getPlayer(player);
        PreCon.notNull(p);

        _msg.tellNoSpam(p, timeout, _chatPrefix + message);
    }

    /**
     * Tell a player a message and prevent spamming of the same message.
     *
     * @param player   The player to tell.
     * @param timeout  The spam timeout, the amount of time to wait before the message can be seen again.
     * @param message  The message to send.
     * @param args     Message formatting arguments.
     */
    public void tellNoSpam(Object player, int timeout, String message, Object[] args) {
        PreCon.notNull(player);
        PreCon.greaterThanZero(timeout);
        PreCon.notNull(message);
        PreCon.notNull(args);

        Player p = PlayerUtils.getPlayer(player);
        PreCon.notNull(p);

        _msg.tellNoSpam(p, timeout, _chatPrefix + message, args);
    }

    /**
     * Tell a player a message and prevent spamming of the same message
     * without a plugin tag in the message.
     *
     * @param player   The player to tell.
     * @param timeout  The spam timeout, the amount of time to wait before the message can be seen again.
     * @param message  The message to send.
     */
    public void tellNoSpamAnon(Object player, int timeout, String message) {
        PreCon.notNull(player);
        PreCon.greaterThanZero(timeout);
        PreCon.notNull(message);

        Player p = PlayerUtils.getPlayer(player);
        PreCon.notNull(p);

        _msg.tellNoSpam(p, timeout, message);
    }

    /**
     * Tell a player an important message.
     *
     * <p>If the player is not online, the message is saved until the player logs on.</p>
     *
     * @param player   The player or player Id.
     * @param context  The message context.
     * @param message  The message.
     */
    public void tellImportant(Object player, String context, String message) {

        UUID playerId = PlayerUtils.getPlayerId(player);
        PreCon.notNull(playerId);

        _msg.tellImportant(playerId, context, message);
    }

    /**
     * Send scripting debug message to console.
     *
     * @param message  The message to send.
     */
    public void debug(String message) {
        PreCon.notNull(message);

        _msg.warning(_chatPrefix + " [SCRIPT DEBUG] " + message);
    }

    /**
     * Send scripting debug message to console.
     *
     * @param message  The message to send.
     * @param args     Message formatting arguments.
     */
    public void debug(String message, Object[] args) {
        PreCon.notNull(message);
        PreCon.notNull(args);

        _msg.warning(_chatPrefix + " [SCRIPT DEBUG] " + message, args);
    }
}