eu.wauz.wauzcore.players.effects

Class WauzPlayerEffect

java.lang.Object

eu.wauz.wauzcore.players.effects.WauzPlayerEffect

public class WauzPlayerEffect
extends java.lang.Object

A temporary status effect on a player.

Author:

Wauzmons

See Also:

WauzPlayerEffects

Field Summary

Fields

Modifier and Type	Field and Description
private int	duration The remaining duration of the effect in seconds.
private int	power The strength of the effect.
private WauzPlayerEffectSource	source The source of the effect.
private WauzPlayerEffectType	type The type of the effect.

Constructor Summary

Constructors

Constructor and Description
WauzPlayerEffect(WauzPlayerEffectType type, WauzPlayerEffectSource source, int duration, int power) Creates a new temporary status effect on a player.

Method Summary

Modifier and Type	Method and Description
int	getDuration()
int	getPower()
double	getPowerDecimal()
WauzPlayerEffectSource	getSource()
WauzPlayerEffectType	getType()
boolean	reduceDuration() Reduces the effect duration by 1 second.
java.lang.String	toString() Returns the name of the effect in a scoreboard friendly format.

Methods inherited from class java.lang.Object

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

Field Detail

type

private final WauzPlayerEffectType type

The type of the effect.

source

private final WauzPlayerEffectSource source

The source of the effect.

duration

private int duration

The remaining duration of the effect in seconds.

power

private int power

The strength of the effect.

Constructor Detail

WauzPlayerEffect

public WauzPlayerEffect(WauzPlayerEffectType type,
                        WauzPlayerEffectSource source,
                        int duration,
                        int power)

Creates a new temporary status effect on a player.

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.

Method Detail

reduceDuration

public boolean reduceDuration()

Reduces the effect duration by 1 second.

Returns:

If the effect expired.

getType

public WauzPlayerEffectType getType()

Returns:

The type of the effect.

getSource

public WauzPlayerEffectSource getSource()

Returns:

The source of the effect.

getDuration

public int getDuration()

Returns:

The remaining duration of the effect in seconds.

getPower

public int getPower()

Returns:

The strength of the effect.

getPowerDecimal

public double getPowerDecimal()

Returns:

The strength of the effect as decimal number.

toString

public java.lang.String toString()

Returns the name of the effect in a scoreboard friendly format.

Overrides:

toString in class java.lang.Object

Returns:

The name of the effect.