Added PercentageProvider

This commit is contained in:
Rsl1122 2019-03-06 16:36:40 +02:00
parent 1fb62cc1cc
commit 605f28f12c

View File

@ -0,0 +1,81 @@
/*
* This file is part of Player Analytics (Plan).
*
* Plan is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License v3 as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Plan 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Plan. If not, see <https://www.gnu.org/licenses/>.
*/
package com.djrapitops.plan.extension.annotation;
import com.djrapitops.plan.extension.icon.Color;
import com.djrapitops.plan.extension.icon.Family;
/**
* Method annotation to provide a double (Percentage) about a Player.
* <p>
* Usage: {@code @PercentageProvider double method(UUID playerUUID)}
* <p>
* The returned value should be between (or one of) 0.0 (0%) and 1.0 (100%).
* Other values will be ignored.
*
* @author Rsl1122
*/
public @interface PercentageProvider {
/**
* Text displayed before the value, limited to 50 characters.
* <p>
* Should inform the user what the value represents, for example
* "Health", "Power"
*
* @return String of max 50 characters, remainder will be clipped.
*/
String text();
/**
* Text displayed when hovering over the value, limited to 150 characters.
* <p>
* Should be used to clarify what the value is if not self evident, for example
* text: "Power", description: "Faction power, affects ability of faction to perform actions. Regenerates"
*
* @return String of max 150 characters, remainder will be clipped.
*/
String description() default "";
/**
* Name of Font Awesome icon.
* <p>
* See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}.
*
* @return Name of the icon, if name is not valid no icon is shown.
*/
String iconName() default "question";
/**
* Family of Font Awesome icon.
* <p>
* See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}.
*
* @return Family that matches an icon, if there is no icon for this family no icon is shown.
*/
Family iconFamily() default Family.SOLID;
/**
* Color preference of the plugin.
* <p>
* This color will be set as the default color to use for plugin's elements.
*
* @return Preferred color. If none are specified defaults are used.
*/
Color iconColor() default Color.NONE;
}