Interface Status

public interface Status

A status to be narrated in the player status readout or to trigger warnings.

Since:

1.12.0

See Also:

• AddonRegistry.register(String, Status)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Status.Visibility	Weather this status should appear in the player status readout or the conditional status readout.
static enum	Status.WarningLevel	Represents a warning level from warning().

Method Summary

Modifier and Type	Method	Description
@NotNull String	message()	The message to be narrated to the player.
default @NotNull Status.Visibility	visibility()	Weather this status should appear in the player status readout or the conditional status readout.
default @NotNull Status.WarningLevel	warning()	Returns the current warning severity for this status.

Method Details

message

@Contract(pure=true)
@NotNull
@NotNull String message()

The message to be narrated to the player.

This should in most cases contain the name of the status (E.g. "Health") along with some value.

Returns:

The message to be narrated.

Since:

1.12.0

visibility

@Contract(pure=true)
@NotNull
default @NotNull Status.Visibility visibility()

Weather this status should appear in the player status readout or the conditional status readout.

Returns:

See Status.Visibility.

Since:

1.12.0

See Also:

• Status.Visibility

Implementation Requirements:

Returns Status.Visibility.NORMAL by default.

warning

@Contract(pure=true)
@NotNull
default @NotNull Status.WarningLevel warning()

Returns the current warning severity for this status.

A warning is triggered whenever the returned Status.WarningLevel increases from the previous tick. When a warning is triggered, a sound is played depending on the Status.WarningLevel and the message() is narrated.

Returns:

The current warning severity.

Since:

1.12.0

See Also:

• Status.WarningLevel

Implementation Requirements:

The default implementation always returns Status.WarningLevel.NONE, effectively disabling warnings for this status.