Package net.kyori.adventure.platform.viaversion

Class ViaFacet.Title<V>

java.lang.Object

net.kyori.adventure.platform.facet.FacetBase<V>

net.kyori.adventure.platform.viaversion.ViaFacet<V>

net.kyori.adventure.platform.viaversion.ViaFacet.ProtocolBased<V>

net.kyori.adventure.platform.viaversion.ViaFacet.Title<V>

All Implemented Interfaces:

Facet<V>, Facet.Message<V,java.lang.String>, Facet.Title<V,java.lang.String,java.util.function.Consumer<V>>, Facet.TitlePacket<V,java.lang.String,java.util.function.Consumer<V>>

Enclosing class:

ViaFacet<V>

public static class ViaFacet.Title<V>
extends ViaFacet.ProtocolBased<V>
implements Facet.TitlePacket<V,java.lang.String,java.util.function.Consumer<V>>

Nested Class Summary

Nested classes/interfaces inherited from class net.kyori.adventure.platform.viaversion.ViaFacet

ViaFacet.ActionBar<V>, ViaFacet.ActionBarTitle<V>, ViaFacet.BossBar<V>, ViaFacet.Chat<V>, ViaFacet.ProtocolBased<V>, ViaFacet.Title<V>

Nested classes/interfaces inherited from interface net.kyori.adventure.platform.facet.Facet

Facet.ActionBar<V,M>, Facet.Book<V,M,B>, Facet.BossBar<V>, Facet.BossBarEntity<V,P>, Facet.BossBarPacket<V>, Facet.Chat<V,M>, Facet.ChatPacket<V,M>, Facet.FakeEntity<V,P>, Facet.Message<V,M>, Facet.Position<V,P>, Facet.Sound<V,P>, Facet.Title<V,M,T>, Facet.TitlePacket<V,M,T>

Field Summary

Fields inherited from class net.kyori.adventure.platform.facet.FacetBase

viewerClass

Fields inherited from interface net.kyori.adventure.platform.facet.Facet.Message

PROTOCOL_HEX_COLOR, PROTOCOL_JSON

Fields inherited from interface net.kyori.adventure.platform.facet.Facet.Title

PROTOCOL_ACTION_BAR

Fields inherited from interface net.kyori.adventure.platform.facet.Facet.TitlePacket

ACTION_ACTIONBAR, ACTION_CLEAR, ACTION_RESET, ACTION_SUBTITLE, ACTION_TIMES, ACTION_TITLE

Constructor Summary

Constructors

Modifier	Constructor	Description
	Title(@NonNull java.lang.Class<? extends V> viewerClass, @NonNull java.util.function.Function<V,us.myles.ViaVersion.api.data.UserConnection> connectionFunction)
protected	Title(@NonNull java.lang.String fromProtocol, @NonNull java.lang.String toProtocol, int minProtocol, @NonNull java.lang.Class<? extends V> viewerClass, @NonNull java.util.function.Function<V,us.myles.ViaVersion.api.data.UserConnection> connectionFunction)

Method Summary

Modifier and Type	Method	Description
void	clearTitle(@NonNull V viewer)	Clears a title.
@NonNull java.util.function.Consumer<V>	createTitle(@Nullable java.lang.String title, @Nullable java.lang.String subTitle, int inTicks, int stayTicks, int outTicks)	Creates a title.
void	resetTitle(@NonNull V viewer)	Resets a title.
void	showTitle(@NonNull V viewer, @NonNull java.util.function.Consumer<V> title)	Shows a title.

Methods inherited from class net.kyori.adventure.platform.viaversion.ViaFacet.ProtocolBased

createPacket, isSupported, sendPacket

Methods inherited from class net.kyori.adventure.platform.viaversion.ViaFacet

createMessage, findConnection, findProtocol, isApplicable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.kyori.adventure.platform.facet.Facet

isApplicable, isSupported

Methods inherited from interface net.kyori.adventure.platform.facet.Facet.Message

createMessage

Methods inherited from interface net.kyori.adventure.platform.facet.Facet.Title

toTicks

Constructor Detail

Title

protected Title(@NonNull java.lang.String fromProtocol,
                @NonNull java.lang.String toProtocol,
                int minProtocol,
                @NonNull java.lang.Class<? extends V> viewerClass,
                @NonNull java.util.function.Function<V,us.myles.ViaVersion.api.data.UserConnection> connectionFunction)

Title

public Title(@NonNull java.lang.Class<? extends V> viewerClass,
             @NonNull java.util.function.Function<V,us.myles.ViaVersion.api.data.UserConnection> connectionFunction)

Method Detail

createTitle

public @NonNull java.util.function.Consumer<V> createTitle(@Nullable java.lang.String title,
                                                           @Nullable java.lang.String subTitle,
                                                           int inTicks,
                                                           int stayTicks,
                                                           int outTicks)

Description copied from interface: Facet.Title

Creates a title.

Specified by:

createTitle in interface Facet.Title<V,java.lang.String,java.util.function.Consumer<V>>

Parameters:

title - a title or null if empty

subTitle - a subtitle or null if empty

inTicks - number of fade in ticks

stayTicks - number of stay ticks

outTicks - number of fade out ticks

Returns:

a title or null

showTitle

public void showTitle(@NonNull V viewer,
                      @NonNull java.util.function.Consumer<V> title)

Description copied from interface: Facet.Title

Shows a title.

Specified by:

showTitle in interface Facet.Title<V,java.lang.String,java.util.function.Consumer<V>>

Parameters:

viewer - a viewer

title - a title

clearTitle

public void clearTitle(@NonNull V viewer)

Description copied from interface: Facet.Title

Clears a title.

Specified by:

clearTitle in interface Facet.Title<V,java.lang.String,java.util.function.Consumer<V>>

Parameters:

viewer - a viewer

resetTitle

public void resetTitle(@NonNull V viewer)

Description copied from interface: Facet.Title

Resets a title.

Specified by:

resetTitle in interface Facet.Title<V,java.lang.String,java.util.function.Consumer<V>>

Parameters:

viewer - a viewer