Package kr.toxicity.hud.api.placeholder

Interface HudPlaceholder<T>

Type Parameters:

T - type (Number, String, Boolean)

public interface HudPlaceholder<T>

Represents placeholder

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HudPlaceholder.Builder<T>	Placeholder builder
static interface	HudPlaceholder.PlaceholderFunction<T>	An aliases of (args, event) -> (player) -> T

Method Summary

Modifier and Type	Method	Description
static <T> HudPlaceholder.Builder<T>	builder()	Creates placeholder builder.
int	getRequiredArgsLength()	Gets a length of required args.
@NotNull Function<HudPlayer,T>	invoke(@NotNull @Unmodifiable List<String> args, @NotNull UpdateEvent reason)	Creates new function from given args.
static <T> @NotNull HudPlaceholder<T>	of(@NotNull HudPlaceholder.PlaceholderFunction<T> biFunction)	Creates new placeholder by function.

Method Details

invoke

@NotNull
@NotNull Function<HudPlayer,T> invoke(@NotNull
 @NotNull @Unmodifiable List<String> args,
 @NotNull
 @NotNull UpdateEvent reason)

Creates new function from given args.

Parameters:

args - args

reason - event

Returns:

function

Throws:

RuntimeException - if given args or reason is invalid.

getRequiredArgsLength

int getRequiredArgsLength()

Gets a length of required args.

Returns:

args length.

of

@NotNull
static <T> @NotNull HudPlaceholder<T> of(@NotNull
 @NotNull HudPlaceholder.PlaceholderFunction<T> biFunction)

Creates new placeholder by function.

Type Parameters:

T - return value's type.

Parameters:

biFunction - builder

Returns:

an instance of placeholder.

builder

static <T> HudPlaceholder.Builder<T> builder()

Creates placeholder builder.

Type Parameters:

T - type (Number, String, Boolean)

Returns:

builder