com.velocitypowered.api.proxy.server

Class ServerPing.Builder

java.lang.Object

com.velocitypowered.api.proxy.server.ServerPing.Builder

Enclosing class:

ServerPing

public static final class ServerPing.Builder
extends Object

A builder for ServerPing objects.

Method Summary

Modifier and Type	Method and Description
ServerPing	build() Uses the information from this builder to create a new ServerPing instance.
ServerPing.Builder	clearMods()
ServerPing.Builder	clearSamplePlayers()
ServerPing.Builder	description(net.kyori.text.Component description) Deprecated.
ServerPing.Builder	description(net.kyori.adventure.text.Component description)
ServerPing.Builder	favicon(Favicon favicon)
Optional<net.kyori.text.Component>	getDescription() Deprecated.
Optional<net.kyori.adventure.text.Component>	getDescriptionComponent()
Optional<Favicon>	getFavicon()
int	getMaximumPlayers()
List<ModInfo.Mod>	getMods()
String	getModType()
int	getOnlinePlayers()
List<ServerPing.SamplePlayer>	getSamplePlayers()
ServerPing.Version	getVersion()
ServerPing.Builder	maximumPlayers(int maximumPlayers)
ServerPing.Builder	mods(ModInfo.Mod... mods)
ServerPing.Builder	mods(ModInfo mods) Uses the modified mods list in the response.
ServerPing.Builder	modType(String modType)
ServerPing.Builder	notModCompatible()
ServerPing.Builder	nullPlayers()
ServerPing.Builder	onlinePlayers(int onlinePlayers)
ServerPing.Builder	samplePlayers(ServerPing.SamplePlayer... players)
String	toString()
ServerPing.Builder	version(ServerPing.Version version)

Methods inherited from class java.lang.Object

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

Method Detail

version

public ServerPing.Builder version(ServerPing.Version version)

onlinePlayers

public ServerPing.Builder onlinePlayers(int onlinePlayers)

maximumPlayers

public ServerPing.Builder maximumPlayers(int maximumPlayers)

samplePlayers

public ServerPing.Builder samplePlayers(ServerPing.SamplePlayer... players)

modType

public ServerPing.Builder modType(String modType)

mods

public ServerPing.Builder mods(ModInfo.Mod... mods)

mods

public ServerPing.Builder mods(ModInfo mods)

Uses the modified mods list in the response.

Parameters:

mods - the mods list to use

Returns:

this build, for chaining

clearMods

public ServerPing.Builder clearMods()

clearSamplePlayers

public ServerPing.Builder clearSamplePlayers()

notModCompatible

public ServerPing.Builder notModCompatible()

nullPlayers

public ServerPing.Builder nullPlayers()

description

@Deprecated
public ServerPing.Builder description(net.kyori.text.Component description)

Deprecated.

description

public ServerPing.Builder description(net.kyori.adventure.text.Component description)

favicon

public ServerPing.Builder favicon(Favicon favicon)

build

public ServerPing build()

Uses the information from this builder to create a new ServerPing instance. The builder can be re-used after this event has been called.

Returns:

a new ServerPing instance

getVersion

public ServerPing.Version getVersion()

getOnlinePlayers

public int getOnlinePlayers()

getMaximumPlayers

public int getMaximumPlayers()

getSamplePlayers

public List<ServerPing.SamplePlayer> getSamplePlayers()

getDescription

@Deprecated
public Optional<net.kyori.text.Component> getDescription()

Deprecated.

getDescriptionComponent

public Optional<net.kyori.adventure.text.Component> getDescriptionComponent()

getFavicon

public Optional<Favicon> getFavicon()

getModType

public String getModType()

getMods

public List<ModInfo.Mod> getMods()

toString

public String toString()

Overrides:

toString in class Object