surf-api-core-api/dev.slne.surf.surfapi.core.api.messages.builder/SurfComponentBuilder

SurfComponentBuilder

@ApiStatus.NonExtendable
interface SurfComponentBuilder : TextComponent.Builder

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract override fun append(vararg components: ComponentLike): SurfComponentBuilder
abstract override fun append(vararg components: Component): SurfComponentBuilder
abstract override fun append(components: Iterable<ComponentLike?>): SurfComponentBuilder
abstract override fun append(component: Component): SurfComponentBuilder
abstract override fun append(builder: ComponentBuilder<*, *>): SurfComponentBuilder
abstract override fun append(component: ComponentLike): SurfComponentBuilder
Link copied to clipboard
open fun <E> appendCollection(collection: Iterable<E>, formatter: (E) -> Component): SurfComponentBuilder
Link copied to clipboard
open fun <E> appendCollectionNewLine(collection: Iterable<E>, linePrefix: Component = PREFIX, formatter: (E) -> Component): SurfComponentBuilder
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun appendDisconnectMessage(disconnectReason: String, suggestHelp: SurfComponentBuilder.() -> Unit, footerRenderer: SurfComponentBuilder.() -> Unit = { }): SurfComponentBuilder
Link copied to clipboard
Link copied to clipboard
open fun appendKickDisconnectMessage(messageRenderer: SurfComponentBuilder.() -> Unit, footerRenderer: SurfComponentBuilder.() -> Unit = { }): SurfComponentBuilder
Link copied to clipboard
open fun <K, V> appendMap(map: Map<K, V>, keyFormatter: (K) -> Component, valueFormatter: (V) -> Component, linePrefix: Component = PREFIX, keyValueSeparator: Component = MAP_KEY_VALUE_SEPARATOR): SurfComponentBuilder
Link copied to clipboard
abstract override fun appendNewline(): SurfComponentBuilder
Link copied to clipboard
fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.appendNewline(amount: Int)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract override fun appendSpace(): SurfComponentBuilder
Link copied to clipboard
fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.appendText(text: String, color: TextColor? = null): @NotNull B
fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.appendText(text: String, color: TextColor? = null, block: TextComponent.Builder.() -> Unit): @NotNull B
Link copied to clipboard
open fun appendTime(time: Duration, showSeconds: Boolean = true, shortForms: Boolean = false, separator: Component = TIME_SEPARATOR, timeColor: TextColor = VARIABLE_VALUE): SurfComponentBuilder
Link copied to clipboard
abstract override fun applicableApply(applicable: ComponentBuilderApplicable): SurfComponentBuilder
Link copied to clipboard
abstract override fun apply(consumer: Consumer<in ComponentBuilder<*, *>>): SurfComponentBuilder
Link copied to clipboard
abstract override fun applyDeep(action: Consumer<in ComponentBuilder<*, *>>): SurfComponentBuilder
Link copied to clipboard
@NotNull
open override fun asComponent(): @NotNull Component
Link copied to clipboard
@NotNull
abstract override fun build(): @NotNull TextComponent
Link copied to clipboard
@NotNull
abstract fun children(): @NotNull MutableList<Component>
Link copied to clipboard
abstract override fun clickEvent(event: ClickEvent?): SurfComponentBuilder
Link copied to clipboard
fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.clickOpensUrl(url: String): @NotNull B
Link copied to clipboard
abstract override fun color(color: TextColor?): SurfComponentBuilder
Link copied to clipboard
abstract override fun colorIfAbsent(color: TextColor?): SurfComponentBuilder
Link copied to clipboard
open override fun componentBuilderApply(@NotNull component: @NotNull ComponentBuilder<*, *>)
Link copied to clipboard
abstract override fun content(content: String): SurfComponentBuilder
@NotNull
abstract fun content(): @NotNull String
Link copied to clipboard
abstract override fun decorate(vararg decorations: TextDecoration): SurfComponentBuilder
abstract override fun decorate(decoration: TextDecoration): SurfComponentBuilder
Link copied to clipboard
abstract override fun decoration(decoration: TextDecoration, flag: Boolean): SurfComponentBuilder
abstract override fun decoration(decoration: TextDecoration, state: TextDecoration.State): SurfComponentBuilder
Link copied to clipboard
abstract override fun decorationIfAbsent(decoration: TextDecoration, state: TextDecoration.State): SurfComponentBuilder
Link copied to clipboard
abstract override fun decorations(decorations: Map<TextDecoration?, TextDecoration.State?>): SurfComponentBuilder
abstract override fun decorations(decorations: Set<TextDecoration?>, flag: Boolean): SurfComponentBuilder
Link copied to clipboard
abstract override fun font(font: Key?): SurfComponentBuilder
Link copied to clipboard
abstract override fun hoverEvent(source: HoverEventSource<*>?): SurfComponentBuilder
Link copied to clipboard
abstract override fun insertion(insertion: String?): SurfComponentBuilder
Link copied to clipboard
abstract override fun mapChildren(function: Function<BuildableComponent<*, *>?, out BuildableComponent<*, *>?>): SurfComponentBuilder
Link copied to clipboard
abstract override fun mapChildrenDeep(function: Function<BuildableComponent<*, *>?, out BuildableComponent<*, *>?>): SurfComponentBuilder
Link copied to clipboard
abstract override fun mergeStyle(that: Component): SurfComponentBuilder
abstract override fun mergeStyle(that: Component, vararg merges: Style.Merge): SurfComponentBuilder
abstract override fun mergeStyle(that: Component, merges: Set<Style.Merge?>): SurfComponentBuilder
Link copied to clipboard
abstract override fun resetStyle(): SurfComponentBuilder
Link copied to clipboard
abstract override fun shadowColor(argb: ARGBLike?): SurfComponentBuilder
Link copied to clipboard
abstract override fun shadowColorIfAbsent(argb: ARGBLike?): SurfComponentBuilder
Link copied to clipboard
abstract override fun style(consumer: Consumer<Style.Builder?>): SurfComponentBuilder
abstract override fun style(style: Style): SurfComponentBuilder