Package 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	Description
java.util.Optional<java.time.Instant>	add(int score)	Adds the target score value, the score cannot exceed the goal value (goal()).
ScoreAdvancementCriterion	criterion()	Gets the AdvancementCriterion.
default int	goal()	Gets the goal value.
java.util.Optional<java.time.Instant>	remove(int score)	Removes the target score value, the score cannot go under zero.
int	score()	Gets the score value.
java.util.Optional<java.time.Instant>	set(int score)	Adds the target score value, the score cannot exceed the goal value (goal()) or be under zero.

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

achieved, get, grant, revoke

Method Detail

criterion

ScoreAdvancementCriterion criterion()

Description copied from interface: CriterionProgress

Gets the AdvancementCriterion.

Specified by:

criterion in interface CriterionProgress

Returns:

The criterion

goal

default int goal()

Gets the goal value.

Returns:

The goal value

score

int score()

Gets the score value.

Returns:

The score value

set

java.util.Optional<java.time.Instant> set(int score)

Adds the target score value, the score cannot exceed the goal value (goal()) 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

java.util.Optional<java.time.Instant> add(int score)

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

Parameters:

score - The score to add

Returns:

The achieving time, if achieved

remove

java.util.Optional<java.time.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