/*
 * This file is a part of the SteamWar software.
 *
 * Copyright (C) 2021  SteamWar.de-Serverteam
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package de.steamwar.bausystem.linkage.specific;

import de.steamwar.bausystem.region.Region;
import org.bukkit.entity.Player;

public interface ScoreboardItem {

    /**
     * Returns one Scoreboard line. If {@code null} result will be ignored.
     * If return value contains {@code '?'} it will be replaced to the color
     * code of the current {@link Region}.
     *
     * @param player the player to create the scoreboard line for
     * @param region the region the player is in
     * @return the String to send, can be {@code null}
     */
    String getString(Player player, Region region);
}
