mirror/Plan
2
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-12-21 05:50:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

'showInPlayerTable' parameter for Providers

Browse Source 
for BooleanProvider, DoubleProvider, PercentageProvider, NumberProvider,
StringProvider annotations.
When the parameter is set to 'true' the value from the Provider is shown
on a table alongside players.

Capability DATA_EXTENSION_SHOW_IN_PLAYER_TABLE added
This commit is contained in:
Rsl1122 2019-05-12 11:13:39 +03:00
parent 6d788ba61a
commit 45da64e88f
6 changed files with 41 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Plan/api/src/main/java/com/djrapitops/plan/capability/Capability.java
View File

@ -42,9 +42,15 @@ enum Capability {
*/
DATA_EXTENSION_TABLES,
/**
* DataExtension API
* DataExtension API addition, allows throwing {@link com.djrapitops.plan.extension.NotReadyException} inside a Provider method when your API is not ready for a method call.
*/
DATA_EXTENSION_NOT_READY_EXCEPTION;
DATA_EXTENSION_NOT_READY_EXCEPTION,
/**
* DataExtension API addition, parameter {@code showInPlayerTable} for BooleanProvider, DoubleProvider, PercentageProvider, NumberProvider, StringProvider annotations.
* <p>
* When the parameter is set to {@code true} the value from this Provider is shown on a table alongside players.
*/
DATA_EXTENSION_SHOW_IN_PLAYER_TABLE;
static Optional<Capability> getByName(String name) {
if (name == null) {

9
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java
View File

@ -112,4 +112,13 @@ public @interface BooleanProvider {
* @return Preferred color. If none are specified defaults are used.
*/
Color iconColor() default Color.NONE;
/**
* When the parameter is set to {@code true} the value from this Provider is shown on a table alongside players.
* <p>
* If {@link BooleanProvider#hidden()} is {@code true} then this value will not be shown in the table regardless of the value of this parameter.
*
* @return false by default.
*/
boolean showInPlayerTable() default false;
}

6
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/DoubleProvider.java
View File

@ -91,4 +91,10 @@ public @interface DoubleProvider {
*/
Color iconColor() default Color.NONE;
/**
* When the parameter is set to {@code true} the value from this Provider is shown on a table alongside players.
*
* @return false by default.
*/
boolean showInPlayerTable() default false;
}

6
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/NumberProvider.java
View File

@ -103,4 +103,10 @@ public @interface NumberProvider {
*/
Color iconColor() default Color.NONE;
/**
* When the parameter is set to {@code true} the value from this Provider is shown on a table alongside players.
*
* @return false by default.
*/
boolean showInPlayerTable() default false;
}

6
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/PercentageProvider.java
View File

@ -94,4 +94,10 @@ public @interface PercentageProvider {
*/
Color iconColor() default Color.NONE;
/**
* When the parameter is set to {@code true} the value from this Provider is shown on a table alongside players.
*
* @return false by default.
*/
boolean showInPlayerTable() default false;
}

6
Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/StringProvider.java
View File

@ -103,4 +103,10 @@ public @interface StringProvider {
*/
Color iconColor() default Color.NONE;
/**
* When the parameter is set to {@code true} the value from this Provider is shown on a table alongside players.
*
* @return false by default.
*/
boolean showInPlayerTable() default false;
}