org.spongepowered.api.advancement.criteria

Interface ScoreCriterionProgress

All Superinterfaces:

CriterionProgress, Progressable

public interface ScoreCriterionProgress
extends CriterionProgress

Represents the progress of a ScoreAdvancementCriterion.

Method Summary

Modifier and Type	Method and Description
Optional<Instant>	add(int score) Adds the target score value, the score cannot exceed the goal value (getGoal()).
ScoreAdvancementCriterion	getCriterion() Gets the AdvancementCriterion.
default int	getGoal() Gets the goal value.
int	getScore() Gets the score value.
Optional<Instant>	remove(int score) Removes the target score value, the score cannot go under zero.
Optional<Instant>	set(int score) Adds the target score value, the score cannot exceed the goal value (getGoal()) or be under zero.

Methods inherited from interface org.spongepowered.api.advancement.Progressable

achieved, get, grant, revoke

Method Detail

getCriterion

ScoreAdvancementCriterion getCriterion()

Description copied from interface: CriterionProgress

Gets the AdvancementCriterion.

Specified by:

getCriterion in interface CriterionProgress

Returns:

The criterion

getGoal

default int getGoal()

Gets the goal value.

Returns:

The goal value

getScore

int getScore()

Gets the score value.

Returns:

The score value

set

Optional<Instant> set(int score)

Adds the target score value, the score cannot exceed the goal value (getGoal()) or be under zero. The achieved time will be returned if the goal is met.

Parameters:

score - The score to set

Returns:

The achieving time, if achieved

add

Optional<Instant> add(int score)

Adds the target score value, the score cannot exceed the goal value (getGoal()). The achieved time will be returned if the goal is met.

Parameters:

score - The score to add

Returns:

The achieving time, if achieved

remove

Optional<Instant> remove(int score)

Removes the target score value, the score cannot go under zero. The achieved time will be returned if the goal is met before.

Parameters:

score - The score to remove

Returns:

The old achieving time, if achieved before