This function is designed for API usage.

This commit is contained in:
TfT_02 2014-10-11 12:03:08 +02:00
parent 1a2d586086
commit 3b249aa4e6
3 changed files with 65 additions and 0 deletions

View File

@ -13,6 +13,8 @@ public final class AbilityAPI {
/**
* Checks if the ability "Berserk" is active.
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to check
*
@ -24,6 +26,8 @@ public final class AbilityAPI {
/**
* Checks if the ability "Giga Drill Breaker" is active.
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to check
*
@ -35,6 +39,8 @@ public final class AbilityAPI {
/**
* Checks if the ability "Green Terra" is active.
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to check
*
@ -46,6 +52,8 @@ public final class AbilityAPI {
/**
* Checks if the ability "Serrated Strikes" is active.
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to check
*
@ -57,6 +65,8 @@ public final class AbilityAPI {
/**
* Checks if the ability "Skull Splitter" is active.
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to check
*
@ -68,6 +78,8 @@ public final class AbilityAPI {
/**
* Checks if the ability "Super Breaker" is active.
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to check
*
@ -79,6 +91,8 @@ public final class AbilityAPI {
/**
* Checks if the ability "Tree Feller" is active.
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to check
*
@ -90,6 +104,8 @@ public final class AbilityAPI {
/**
* Checks if any ability is active.
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to check
*
@ -109,6 +125,8 @@ public final class AbilityAPI {
/**
* Reset the ability cooldowns for a player
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to reset the cooldowns for
*/
@ -118,6 +136,8 @@ public final class AbilityAPI {
/**
* Set the cooldown for the "Berserk" ability
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to set the cooldown for
* @param cooldown The cooldown length to set
@ -128,6 +148,8 @@ public final class AbilityAPI {
/**
* Set the cooldown for the "Giga Drill Breaker" ability
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to set the cooldown for
* @param cooldown The cooldown length to set
@ -138,6 +160,8 @@ public final class AbilityAPI {
/**
* Set the cooldown for the "Green Terra" ability
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to set the cooldown for
* @param cooldown The cooldown length to set
@ -148,6 +172,8 @@ public final class AbilityAPI {
/**
* Set the cooldown for the "Serrated Strikes" ability
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to set the cooldown for
* @param cooldown The cooldown length to set
@ -158,6 +184,8 @@ public final class AbilityAPI {
/**
* Set the cooldown for the "Skull Splitter" ability
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to set the cooldown for
* @param cooldown The cooldown length to set
@ -168,6 +196,8 @@ public final class AbilityAPI {
/**
* Set the cooldown for the "Super Breaker" ability
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to set the cooldown for
* @param cooldown The cooldown length to set
@ -178,6 +208,8 @@ public final class AbilityAPI {
/**
* Set the cooldown for the "Tree Feller" ability
* </br>
* This function is designed for API usage.
*
* @param player The {@link Player} to set the cooldown for
* @param cooldown The cooldown length to set
@ -186,6 +218,15 @@ public final class AbilityAPI {
UserManager.getPlayer(player).setAbilityDATS(AbilityType.TREE_FELLER, cooldown);
}
/**
* Check if a LivingEntity is bleeding
* </br>
* This function is designed for API usage.
*
* @param entity The {@link LivingEntity} to check
* @return true if entity is bleeding, false otherwise
*/
public static boolean isBleeding(LivingEntity entity) {
return BleedTimerTask.isBleeding(entity);
}

View File

@ -71,6 +71,8 @@ public final class ChatAPI {
/**
* Check if a player is currently talking in party chat.
* </br>
* This function is designed for API usage.
*
* @param player The player to check
* @return true if the player is using party chat, false otherwise
@ -81,6 +83,8 @@ public final class ChatAPI {
/**
* Check if a player is currently talking in party chat.
* </br>
* This function is designed for API usage.
*
* @param playerName The name of the player to check
* @return true if the player is using party chat, false otherwise
@ -91,6 +95,8 @@ public final class ChatAPI {
/**
* Check if a player is currently talking in admin chat.
* </br>
* This function is designed for API usage.
*
* @param player The player to check
* @return true if the player is using admin chat, false otherwise
@ -101,6 +107,8 @@ public final class ChatAPI {
/**
* Check if a player is currently talking in admin chat.
* </br>
* This function is designed for API usage.
*
* @param playerName The name of the player to check
* @return true if the player is using admin chat, false otherwise
@ -111,6 +119,8 @@ public final class ChatAPI {
/**
* Toggle the party chat mode of a player.
* </br>
* This function is designed for API usage.
*
* @param player The player to toggle party chat on.
*/
@ -120,6 +130,8 @@ public final class ChatAPI {
/**
* Toggle the party chat mode of a player.
* </br>
* This function is designed for API usage.
*
* @param playerName The name of the player to toggle party chat on.
*/
@ -129,6 +141,8 @@ public final class ChatAPI {
/**
* Toggle the admin chat mode of a player.
* </br>
* This function is designed for API usage.
*
* @param player The player to toggle admin chat on.
*/
@ -138,6 +152,8 @@ public final class ChatAPI {
/**
* Toggle the admin chat mode of a player.
* </br>
* This function is designed for API usage.
*
* @param playerName The name of the player to toggle party chat on.
*/

View File

@ -192,6 +192,14 @@ public final class PartyAPI {
return PartyManager.getOnlineMembers(player);
}
/**
* Check is a certain party has an ally
* </br>
* This function is designed for API usage.
*
* @param partyName The name of the party to check
* @return true if the party has an ally, false otherwise
*/
public static boolean hasAlly(String partyName) {
return getAllyName(partyName) != null;
}