eu.wauz.wauzcore.skills.passive

Class AbstractPassiveSkill

java.lang.Object

eu.wauz.wauzcore.skills.passive.AbstractPassiveSkill

Direct Known Subclasses:

AbstractPassiveJobSkill, PassiveBreath, PassiveNutrition, PassiveWeight

public abstract class AbstractPassiveSkill
extends java.lang.Object

An abstract passive skill, that can be leveled.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private long	exp The current experience in this skill.
private int	level The current level of this skill.

Constructor Summary

Constructors

Constructor and Description
AbstractPassiveSkill() Creates an empty instance of this passive skill.
AbstractPassiveSkill(long exp) Creates a new instance of this passive skill.

Method Summary

Modifier and Type	Method and Description
long	getExp()
abstract AbstractPassiveSkill	getInstance(long exp) Creates a new instance of this passive skill.
int	getLevel()
protected abstract java.util.List<java.lang.Long>	getMilestones() Gets all experience milestones, marking where new levels are reached.
java.lang.Long	getNextMilestone()
abstract java.lang.String	getPassiveName() Gets the name of the passive skill.
void	grantExperience(org.bukkit.entity.Player player, long earned) Adds experience to the passive and levels it up, if a new milestone was reached.
protected boolean	hasReachedMilestone()
protected abstract void	onLevelUp(org.bukkit.entity.Player player) Method that gets called when a new milestone has been reached.

Methods inherited from class java.lang.Object

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

Field Detail

level

private int level

The current level of this skill.

exp

private long exp

The current experience in this skill.

Constructor Detail

AbstractPassiveSkill

public AbstractPassiveSkill()

Creates an empty instance of this passive skill.

AbstractPassiveSkill

public AbstractPassiveSkill(long exp)

Creates a new instance of this passive skill.

Parameters:

exp - The current experience in this skill.

Method Detail

getInstance

public abstract AbstractPassiveSkill getInstance(long exp)

Creates a new instance of this passive skill.

Parameters:

exp - The current experience in this skill.

Returns:

The created instance.

getPassiveName

public abstract java.lang.String getPassiveName()

Gets the name of the passive skill.

Returns:

The name of the skill.

getLevel

public int getLevel()

Returns:

The current level of this skill.

getExp

public long getExp()

Returns:

The current experience in this skill.

grantExperience

public void grantExperience(org.bukkit.entity.Player player,
                            long earned)

Adds experience to the passive and levels it up, if a new milestone was reached.

Parameters:

player - The player that should see level up messages.

earned - The amount of experience that has been earned.

getNextMilestone

public java.lang.Long getNextMilestone()

Returns:

The following milestone.

hasReachedMilestone

protected boolean hasReachedMilestone()

Returns:

If the following milestone has been reached.

getMilestones

protected abstract java.util.List<java.lang.Long> getMilestones()

Gets all experience milestones, marking where new levels are reached.

Returns:

A list of experience milestones.

onLevelUp

protected abstract void onLevelUp(org.bukkit.entity.Player player)

Method that gets called when a new milestone has been reached.

Parameters:

player - The player who reached the milestone.