Package net.kyori.adventure.platform.viaversion

Class ViaFacet<V>

java.lang.Object

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

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

All Implemented Interfaces:

Facet<V>, Facet.Message<V,java.lang.String>

Direct Known Subclasses:

ViaFacet.BossBar.Builder, ViaFacet.BossBar.Builder1_9_To_1_15, ViaFacet.ProtocolBased

public class ViaFacet<V>
extends FacetBase<V>
implements Facet.Message<V,java.lang.String>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViaFacet.ActionBar<V>
static class	ViaFacet.ActionBarTitle<V>
static class	ViaFacet.BossBar<V>
static class	ViaFacet.Chat<V>
static class	ViaFacet.ProtocolBased<V>
static class	ViaFacet.Title<V>

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

Facet.Book<V,M,B>, Facet.BossBarEntity<V,P>, Facet.BossBarPacket<V>, Facet.ChatPacket<V,M>, Facet.FakeEntity<V,P>, Facet.Message<V,M>, Facet.Position<V,P>, Facet.Sound<V,P>, 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NonNull java.lang.String	createMessage(@NonNull V viewer, @NonNull net.kyori.adventure.text.Component message)	Creates a message.
@Nullable us.myles.ViaVersion.api.data.UserConnection	findConnection(@NonNull V viewer)
int	findProtocol(@NonNull V viewer)
boolean	isApplicable(@NonNull V viewer)	Gets whether this handler is applicable to a particular viewer.
boolean	isSupported()	Gets whether this handler is supported by the current runtime.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViaFacet

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

Method Detail

isSupported

public boolean isSupported()

Description copied from interface: Facet

Gets whether this handler is supported by the current runtime.

If not, this can be discarded since it will fail for all viewers.

Specified by:

isSupported in interface Facet<V>

Overrides:

isSupported in class FacetBase<V>

Returns:

if this handler is supported

isApplicable

public boolean isApplicable(@NonNull V viewer)

Description copied from interface: Facet

Gets whether this handler is applicable to a particular viewer.

This should only be invoked if Facet.isSupported() is true.

Specified by:

isApplicable in interface Facet<V>

Overrides:

isApplicable in class FacetBase<V>

Parameters:

viewer - a viewer

Returns:

if this handler is applicable to a viewer

findConnection

public @Nullable us.myles.ViaVersion.api.data.UserConnection findConnection(@NonNull V viewer)

findProtocol

public int findProtocol(@NonNull V viewer)

createMessage

public @NonNull java.lang.String createMessage(@NonNull V viewer,
                                               @NonNull net.kyori.adventure.text.Component message)

Description copied from interface: Facet.Message

Creates a message.

Messages should not be translated to a viewer's locale, this is done elsewhere.

Specified by:

createMessage in interface Facet.Message<V,java.lang.String>

Parameters:

viewer - a viewer

message - a message

Returns:

a message or null