eu.wauz.wauzcore.players.effects

Class WauzPlayerEffects

java.lang.Object

eu.wauz.wauzcore.players.effects.WauzPlayerEffects

public class WauzPlayerEffects
extends java.lang.Object

All the active status effects on a player.

Author:

Wauzmons

See Also:

WauzPlayerEffect

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<WauzPlayerEffect>	effects The list of currently active status effects.

Constructor Summary

Constructors

Constructor and Description
WauzPlayerEffects()

Method Summary

Modifier and Type	Method and Description
boolean	addEffect(WauzPlayerEffectType type, WauzPlayerEffectSource source, int duration) Adds a new temporary status effect to the player.
boolean	addEffect(WauzPlayerEffectType type, WauzPlayerEffectSource source, int duration, int power) Adds a new temporary status effect to the player.
void	clearEffects() Removes all currently active status effects.
private java.util.List<WauzPlayerEffect>	getEffectList()
int	getEffectPowerSum(WauzPlayerEffectType type) Gets the combined strength of the all matching effects.
double	getEffectPowerSumDecimal(WauzPlayerEffectType type) Gets the combined strength of the all matching effects as decimal number.
boolean	hasEffect(WauzPlayerEffectType type) Checks if the player has an effect of the given type on them.
static void	progressPlayerEffects(org.bukkit.entity.Player player) Reduces the duration of all the player's effects by 1 second and removes expired ones.
void	removeEffect(WauzPlayerEffect effect) Removes a single active status effect.
java.lang.String	toString() Returns the names of all effects in a scoreboard friendly format.

Methods inherited from class java.lang.Object

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

Field Detail

effects

private final java.util.List<WauzPlayerEffect> effects

The list of currently active status effects.

Constructor Detail

WauzPlayerEffects

public WauzPlayerEffects()

Method Detail

addEffect

public boolean addEffect(WauzPlayerEffectType type,
                         WauzPlayerEffectSource source,
                         int duration)

Adds a new temporary status effect to the player. Gets ignored when there is already a better effect of the same type and source active.

Parameters:

type - The type of the effect.

source - The source of the effect.

duration - The remaining duration of the effect in seconds.

Returns:

If the effect could be added.

addEffect

public boolean addEffect(WauzPlayerEffectType type,
                         WauzPlayerEffectSource source,
                         int duration,
                         int power)

Adds a new temporary status effect to the player. Gets ignored when there is already a better effect of the same type and source active.

Parameters:

type - The type of the effect.

source - The source of the effect.

duration - The remaining duration of the effect in seconds.

power - The strength of the effect.

Returns:

If the effect could be added.

hasEffect

public boolean hasEffect(WauzPlayerEffectType type)

Checks if the player has an effect of the given type on them.

Parameters:

type - The type of the effect.

Returns:

If the player has the effect.

getEffectPowerSum

public int getEffectPowerSum(WauzPlayerEffectType type)

Gets the combined strength of the all matching effects.

Parameters:

type - The type of the effect.

Returns:

The sum of the effect strengths.

getEffectPowerSumDecimal

public double getEffectPowerSumDecimal(WauzPlayerEffectType type)

Gets the combined strength of the all matching effects as decimal number.

Parameters:

type - The type of the effect.

Returns:

The sum of the effect strengths.

getEffectList

private java.util.List<WauzPlayerEffect> getEffectList()

Returns:

A cloned list of currently active status effects.

removeEffect

public void removeEffect(WauzPlayerEffect effect)

Removes a single active status effect.

Parameters:

effect - The effect to remove.

clearEffects

public void clearEffects()

Removes all currently active status effects.

toString

public java.lang.String toString()

Returns the names of all effects in a scoreboard friendly format.

Overrides:

toString in class java.lang.Object

Returns:

The names of all effects.

progressPlayerEffects

public static void progressPlayerEffects(org.bukkit.entity.Player player)

Reduces the duration of all the player's effects by 1 second and removes expired ones.

Parameters:

player - The player to progress the effects for.