eu.wauz.wauzcore.system.util

Class Cooldown

java.lang.Object

eu.wauz.wauzcore.system.util.Cooldown

public class Cooldown
extends java.lang.Object

An util class for getting and setting cooldowns.

Author:

Wauzmons

Constructor Summary

Constructors

Constructor and Description
Cooldown()

Method Summary

Modifier and Type	Method and Description
static boolean	characterDailyReward(org.bukkit.entity.Player player) Returns the daily reward cooldown from the config.
private static boolean	getAndUpdateCooldownFromCache(org.bukkit.entity.Player player, java.lang.String actionId, java.lang.Long cooldown) Returns a session specific cooldown from the player data.
private static boolean	getAndUpdateCooldownFromCache(org.bukkit.entity.Player player, java.lang.String actionId, java.lang.Long cooldown, boolean forceUpdate) Returns a session specific cooldown from the player data.
private static boolean	getAndUpdateCooldownFromConfig(org.bukkit.entity.Player player, java.lang.String actionId, java.lang.Long cooldown) Returns a character specific cooldown from the config.
static boolean	playerEntityInteraction(org.bukkit.entity.Player player) Returns the entity interaction cooldown from the player data.
static boolean	playerFoodConsume(org.bukkit.entity.Player player) Returns the food consumtion cooldown from the player data.
static boolean	playerProjectileShoot(org.bukkit.entity.Player player) Returns the projectile shooting cooldown from the player data.
static boolean	playerQuickSlotUse(org.bukkit.entity.Player player) Returns the quick slot usage cooldown from the player data.
static boolean	playerSkillUse(org.bukkit.entity.Player player) Returns the skill usage cooldown from the player data.
static boolean	playerWeaponSkillUse(org.bukkit.entity.Player player, java.lang.String skillName) Returns the weapon skill usage cooldown from the player data.
static boolean	playerWeaponUse(org.bukkit.entity.Player player) Returns the weapon usage cooldown from the player data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cooldown

public Cooldown()

Method Detail

playerEntityInteraction

public static boolean playerEntityInteraction(org.bukkit.entity.Player player)

Returns the entity interaction cooldown from the player data. Cooldown lasts 1 second. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

Returns:

If the cooldown is ready.

playerWeaponUse

public static boolean playerWeaponUse(org.bukkit.entity.Player player)

Returns the weapon usage cooldown from the player data. Cooldown lasts depending on weapon. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

Returns:

If the cooldown is ready.

playerWeaponSkillUse

public static boolean playerWeaponSkillUse(org.bukkit.entity.Player player,
                                           java.lang.String skillName)

Returns the weapon skill usage cooldown from the player data. Cooldown lasts 2.8 seconds for each weapon skill. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

skillName - The name of the skill.

Returns:

If the cooldown is ready.

playerSkillUse

public static boolean playerSkillUse(org.bukkit.entity.Player player)

Returns the skill usage cooldown from the player data. Cooldown lasts 1 second. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

Returns:

If the cooldown is ready.

playerQuickSlotUse

public static boolean playerQuickSlotUse(org.bukkit.entity.Player player)

Returns the quick slot usage cooldown from the player data. Cooldown lasts 0.1 seconds. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

Returns:

If the cooldown is ready.

playerFoodConsume

public static boolean playerFoodConsume(org.bukkit.entity.Player player)

Returns the food consumtion cooldown from the player data. Cooldown lasts 1 second. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

Returns:

If the cooldown is ready.

playerProjectileShoot

public static boolean playerProjectileShoot(org.bukkit.entity.Player player)

Returns the projectile shooting cooldown from the player data. Cooldown lasts 2 seconds. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

Returns:

If the cooldown is ready.

characterDailyReward

public static boolean characterDailyReward(org.bukkit.entity.Player player)

Returns the daily reward cooldown from the config. Cooldown lasts 79,200 seconds (22 hours). Resets it, if it is ready.

Parameters:

player - The player who has selected the character.

Returns:

If the cooldown is ready.

getAndUpdateCooldownFromCache

private static boolean getAndUpdateCooldownFromCache(org.bukkit.entity.Player player,
                                                     java.lang.String actionId,
                                                     java.lang.Long cooldown)

Returns a session specific cooldown from the player data. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

actionId - The id of the action the cooldown is set for.

cooldown - The timestamp, till when the cooldown lasts.

Returns:

If the cooldown is ready.

getAndUpdateCooldownFromCache

private static boolean getAndUpdateCooldownFromCache(org.bukkit.entity.Player player,
                                                     java.lang.String actionId,
                                                     java.lang.Long cooldown,
                                                     boolean forceUpdate)

Returns a session specific cooldown from the player data. Resets it, if it is ready.

Parameters:

player - The player who owns the player data.

actionId - The id of the action the cooldown is set for.

cooldown - The timestamp, till when the cooldown lasts.

forceUpdate - Also resets the cooldown if it is not ready.

Returns:

If the cooldown is ready.

getAndUpdateCooldownFromConfig

private static boolean getAndUpdateCooldownFromConfig(org.bukkit.entity.Player player,
                                                      java.lang.String actionId,
                                                      java.lang.Long cooldown)

Returns a character specific cooldown from the config. Resets it, if it is ready.

Parameters:

player - The player who has selected the character.

actionId - The id of the action the cooldown is set for.

cooldown - The timestamp, till when the cooldown lasts.

Returns:

If the cooldown is ready.