BetterHud/api/standard-api/kr.toxicity.hud.api.placeholder/HudPlaceholder

HudPlaceholder

interface HudPlaceholder<T>

Represents placeholder

Parameters

<T>

type (Number, String, Boolean)

Types

open class Builder<T>

Placeholder builder

PlaceholderFunction

@FunctionalInterface

interface PlaceholderFunction<T> : BiFunction<List<String>, UpdateEvent, (HudPlayer) -> T>

An aliases of (args, event) -> (player) -> T

Functions

open fun <T> builder(): HudPlaceholder.Builder<T>

Creates placeholder builder.

getRequiredArgsLength

abstract fun getRequiredArgsLength(): Int

Gets a length of required args.

@NotNull

abstract fun invoke(@NotNull @Unmodifiable args: @NotNull @Unmodifiable List<String>, @NotNull reason: @NotNull UpdateEvent): @NotNull (HudPlayer) -> T

Creates new function from given args.

open fun <T> of(@NotNull biFunction: @NotNull HudPlaceholder.PlaceholderFunction<T>): @NotNull HudPlaceholder<T>

Creates new placeholder by function.