Index
All Classes and Interfaces|All Packages|Serialized Form
A
- addPlaceholderProvider(PlaceholderProvider) - Method in class ch.andre601.advancedserverlist.api.AdvancedServerListAPI
-
Adds the provided
PlaceholderProvider
to the list, if it passes the following checks: - AdvancedServerListAPI - Class in ch.andre601.advancedserverlist.api
-
Core class of the API for AdvancedServerList.
B
- build() - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Creates a new ProfileEntry instance with the values set in this Builder.
- builder() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Creates a Builder instance with the values from this ProfileEntry set.
- Builder() - Constructor for class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Empty Builder Constructor used to create a new instance of this class.
- BukkitPlayer - Interface in ch.andre601.advancedserverlist.api.bukkit.objects
-
GenericPlayer instance for the Paper server implementation of AdvancedServerList.
- BukkitServer - Interface in ch.andre601.advancedserverlist.api.bukkit.objects
-
Paper specific instance of a
GenericServer
. - BungeePlayer - Interface in ch.andre601.advancedserverlist.api.bungeecord.objects
-
GenericPlayer instance for the BungeeCord proxy implementation of AdvancedServerList.
- BungeeProxy - Interface in ch.andre601.advancedserverlist.api.bungeecord.objects
-
GenericServer instance for the BungeeCord proxy implementation of AdvancedServerList.
C
- ch.andre601.advancedserverlist.api - package ch.andre601.advancedserverlist.api
-
Main API module used to interact with AdvancedServerList.
- ch.andre601.advancedserverlist.api.bukkit - package ch.andre601.advancedserverlist.api.bukkit
-
Bukkit-specific API containing interfaces and classes specific for the Paper version of AdvancedServerList.
- ch.andre601.advancedserverlist.api.bukkit.events - package ch.andre601.advancedserverlist.api.bukkit.events
-
Custom, Bukkit-specific events executed by the Bukkit version of AdvancedServerList.
- ch.andre601.advancedserverlist.api.bukkit.objects - package ch.andre601.advancedserverlist.api.bukkit.objects
-
Bukkit-specific objects.
- ch.andre601.advancedserverlist.api.bungeecord - package ch.andre601.advancedserverlist.api.bungeecord
-
BungeeCord-specific API containing interfaces and classes specific for the BungeeCord/Waterfall version of AdvancedServerList.
- ch.andre601.advancedserverlist.api.bungeecord.events - package ch.andre601.advancedserverlist.api.bungeecord.events
-
Custom, BungeeCord-specific events executed by the BungeeCord version of AdvancedServerList.
- ch.andre601.advancedserverlist.api.bungeecord.objects - package ch.andre601.advancedserverlist.api.bungeecord.objects
-
BungeeCord-specific objects.
- ch.andre601.advancedserverlist.api.events - package ch.andre601.advancedserverlist.api.events
-
Generic Event Interfaces used by AdvancedServerList.
- ch.andre601.advancedserverlist.api.exceptions - package ch.andre601.advancedserverlist.api.exceptions
-
Custom Exceptions from the API of AdvancedServerList.
- ch.andre601.advancedserverlist.api.objects - package ch.andre601.advancedserverlist.api.objects
-
Generic Objects used by the platform-specific APIs of AdvancedServerList (With exception of
NullBool
. - ch.andre601.advancedserverlist.api.profiles - package ch.andre601.advancedserverlist.api.profiles
-
Contains Profile-related classes and alike used by the API.
- ch.andre601.advancedserverlist.api.velocity - package ch.andre601.advancedserverlist.api.velocity
-
Velocity-specific API containing interfaces and classes specific for the Velocity version of AdvancedServerList.
- ch.andre601.advancedserverlist.api.velocity.events - package ch.andre601.advancedserverlist.api.velocity.events
-
Custom, Velocity-specific events executed by the Velocity version of AdvancedServerList.
- ch.andre601.advancedserverlist.api.velocity.objects - package ch.andre601.advancedserverlist.api.velocity.objects
-
Velocity-specific objects.
- copy() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Creates a copy of this ProfileEntry Instance.
E
- empty() - Static method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Creates an "empty" PlayerEntry with the following values:
- equals(Object) - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Indicates whether some other object is "equal to" this one.
- extraPlayersCount() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Gets the currently set number of extra players of this ProfileEntry.
- extraPlayersCount(String) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets the value to resolve into a number by AdvancedServerList.
- extraPlayersEnabled() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Whether the extra players feature should be used or not.
- extraPlayersEnabled(NullBool) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets whether the extra players feature should be enabled.
F
- FALSE - Enum constant in enum class ch.andre601.advancedserverlist.api.objects.NullBool
-
Representation of the Boolean value
false
. - favicon() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Gets the currently set favicon of this ProfileEntry.
- favicon(String) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets the value to use for the favicon.
G
- GenericPlayer - Interface in ch.andre601.advancedserverlist.api.objects
-
Interface used by the API to share common information across all platforms.
- GenericServer - Interface in ch.andre601.advancedserverlist.api.objects
-
Interface used to share common information across all platforms.
- GenericServerListEvent - Interface in ch.andre601.advancedserverlist.api.events
-
Interface used for the platform-specific PreServerListSetEvent instances.
- get() - Static method in class ch.andre601.advancedserverlist.api.AdvancedServerListAPI
-
Retrieves the instance used of this API.
- getEntry() - Method in class ch.andre601.advancedserverlist.api.bukkit.events.PostServerListSetEvent
-
The
ProfileEntry
that was used during the PingEvent handling. - getEntry() - Method in class ch.andre601.advancedserverlist.api.bukkit.events.PreServerListSetEvent
-
Gets the
ProfileEntry
currently set. - getEntry() - Method in class ch.andre601.advancedserverlist.api.bungeecord.events.PostServerListSetEvent
-
The
ProfileEntry
that was used during the PingEvent handling. - getEntry() - Method in class ch.andre601.advancedserverlist.api.bungeecord.events.PreServerListSetEvent
-
Gets the
ProfileEntry
currently set. - getEntry() - Method in interface ch.andre601.advancedserverlist.api.events.GenericServerListEvent
-
Gets the
ProfileEntry
currently set for this Event. - getEntry() - Method in class ch.andre601.advancedserverlist.api.velocity.events.PostServerListSetEvent
-
The
ProfileEntry
that was used during the PingEvent handling. - getEntry() - Method in class ch.andre601.advancedserverlist.api.velocity.events.PreServerListSetEvent
-
Gets the
ProfileEntry
currently set. - getHandlerList() - Static method in class ch.andre601.advancedserverlist.api.bukkit.events.PostServerListSetEvent
-
Static
HandlerList
getter. - getHandlerList() - Static method in class ch.andre601.advancedserverlist.api.bukkit.events.PreServerListSetEvent
-
Static
HandlerList
getter. - getHandlers() - Method in class ch.andre601.advancedserverlist.api.bukkit.events.PostServerListSetEvent
- getHandlers() - Method in class ch.andre601.advancedserverlist.api.bukkit.events.PreServerListSetEvent
- getHost() - Method in interface ch.andre601.advancedserverlist.api.objects.GenericServer
-
Returns the IP/Domain that got pinged by the Player.
- getIdentifier() - Method in class ch.andre601.advancedserverlist.api.PlaceholderProvider
-
Returns the identifier used by this instance.
- getName() - Method in interface ch.andre601.advancedserverlist.api.objects.GenericPlayer
-
Returns the name of the player.
- getOrDefault(boolean) - Method in enum class ch.andre601.advancedserverlist.api.objects.NullBool
-
Returns the NullBool's Boolean value or the provided
def
value, should the Instance be equal to NullBool.NOT_SET. - getPlayer() - Method in interface ch.andre601.advancedserverlist.api.bukkit.objects.BukkitPlayer
-
Gives the OfflinePlayer embedded in this BukkitPlayer instance.
- getPlayersMax() - Method in interface ch.andre601.advancedserverlist.api.objects.GenericServer
-
Returns the number of players allowed to join the Proxy/Server.
- getPlayersOnline() - Method in interface ch.andre601.advancedserverlist.api.objects.GenericServer
-
Returns the number of players currently online on the Proxy/Server.
- getProtocol() - Method in interface ch.andre601.advancedserverlist.api.objects.GenericPlayer
-
Returns the protocol ID the Player is using.
- getServers() - Method in interface ch.andre601.advancedserverlist.api.bungeecord.objects.BungeeProxy
-
Returns a Map<String, ServerInfo> where the key is the name of the Server and the value the ServerInfo from the BungeeCord Proxy.
- getServers() - Method in interface ch.andre601.advancedserverlist.api.velocity.objects.VelocityProxy
-
Returns a Map<String, RegisteredServer> where the key is the name of the Server and the value the RegisteredServer from the Velocity Proxy.
- getUUID() - Method in interface ch.andre601.advancedserverlist.api.objects.GenericPlayer
-
Returns the Unique ID associated with this Player.
- getVersion() - Method in interface ch.andre601.advancedserverlist.api.velocity.objects.VelocityPlayer
-
Returns the protocol version in a readable MC version format (i.e. 1.19.3).
- getWorlds() - Method in interface ch.andre601.advancedserverlist.api.bukkit.objects.BukkitServer
-
Returns a Map<String, World> where the key is the name of the World and the value the World of the Server.
H
- hashCode() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Returns a hash code value for this object.
- hasPlayedBefore() - Method in interface ch.andre601.advancedserverlist.api.bukkit.objects.BukkitPlayer
-
Returns whether this player has played on the Server before.
- hidePlayersEnabled() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Whether the player count should be hidden or not.
- hidePlayersEnabled(NullBool) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets whether the player count should be hidden or not.
I
- InvalidPlaceholderProviderException - Exception Class in ch.andre601.advancedserverlist.api.exceptions
-
RuntimeException thrown whenever an invalid
PlaceholderProvider
has been given. - InvalidPlaceholderProviderException(String) - Constructor for exception class ch.andre601.advancedserverlist.api.exceptions.InvalidPlaceholderProviderException
-
Basic Constructor to create an instance of this Exception.
- isBanned() - Method in interface ch.andre601.advancedserverlist.api.bukkit.objects.BukkitPlayer
-
Returns whether this player is banned on the server.
- isCancelled() - Method in class ch.andre601.advancedserverlist.api.bukkit.events.PreServerListSetEvent
-
Returns whether this event has been cancelled or not.
- isCancelled() - Method in class ch.andre601.advancedserverlist.api.bungeecord.events.PreServerListSetEvent
-
Returns whether this event has been cancelled or not.
- isCancelled() - Method in interface ch.andre601.advancedserverlist.api.events.GenericServerListEvent
-
Returns whether this Event has been cancelled or not.
- isCancelled() - Method in class ch.andre601.advancedserverlist.api.velocity.events.PreServerListSetEvent
-
Returns whether this event has been cancelled or not.
- isInvalid() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Whether this ProfileEntry is invalid or not.
- isNotSet() - Method in enum class ch.andre601.advancedserverlist.api.objects.NullBool
-
Returns whether the NullBool Instance is NullBool.NOT_SET.
- isWhitelisted() - Method in interface ch.andre601.advancedserverlist.api.bukkit.objects.BukkitPlayer
-
Returns whether this player is whitelisted on the server.
M
- maxPlayersCount() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Gets the currently set number of max players of this ProfileEntry.
- maxPlayersCount(String) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets the value to resolve into a number by AdvancedServerList.
- maxPlayersEnabled() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Whether the max players feature should be used or not.
- maxPlayersEnabled(NullBool) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets whether the max players feature should be enabled.
- motd() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Gets the currently set MOTD of this ProfileEntry.
- motd(List<String>) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets a new MOTD to use.
N
- NOT_SET - Enum constant in enum class ch.andre601.advancedserverlist.api.objects.NullBool
-
Representation of a
null
Boolean value. - NullBool - Enum Class in ch.andre601.advancedserverlist.api.objects
-
Enum used to return a
Boolean
Value with a fallback, should the boolean benull
.
O
- onlinePlayersCount() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Gets the currently set number of online players of this ProfileEntry.
- onlinePlayersCount(String) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets the value to resolve into a number by AdvancedServerList.
- onlinePlayersEnabled() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Whether the online players feature should be used or not.
- onlinePlayersEnabled(NullBool) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets whether the online players feature should be enabled.
P
- parsePlaceholder(String, GenericPlayer, GenericServer) - Method in class ch.andre601.advancedserverlist.api.PlaceholderProvider
-
This method is called by AdvancedServerList whenever a Placeholder pattern of
${identifier value}
is being found. - PlaceholderProvider - Class in ch.andre601.advancedserverlist.api
-
Abstract class used to create Placeholders in the format
${identifier values}
withidentifier
being the name you provide through the Constructor. - PlaceholderProvider(String) - Constructor for class ch.andre601.advancedserverlist.api.PlaceholderProvider
-
Constructor used to set the identifier for the class extending the PlaceholderProvider class.
- playerCountText() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Gets the currently set player count text of this ProfileEntry.
- playerCountText(String) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets the text to override the player count with.
- players() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Gets the currently set list of players of this ProfileEntry.
- players(List<String>) - Method in class ch.andre601.advancedserverlist.api.profiles.ProfileEntry.Builder
-
Sets the players (lines) to use for the hover.
- PostServerListSetEvent - Class in ch.andre601.advancedserverlist.api.bukkit.events
-
Called after the plugin has updated the Server List.
- PostServerListSetEvent - Class in ch.andre601.advancedserverlist.api.bungeecord.events
-
Called after AdvancedServerList modified the server list.
- PostServerListSetEvent - Class in ch.andre601.advancedserverlist.api.velocity.events
-
Called after AdvancedServerList modified the server list.
- PostServerListSetEvent(ProfileEntry) - Constructor for class ch.andre601.advancedserverlist.api.bukkit.events.PostServerListSetEvent
-
Constructor for creating a new PostServerListSetEvent instance.
- PostServerListSetEvent(ProfileEntry) - Constructor for class ch.andre601.advancedserverlist.api.bungeecord.events.PostServerListSetEvent
-
Constructor for creating a new PostServerListSetEvent instance.
- PostServerListSetEvent(ProfileEntry) - Constructor for class ch.andre601.advancedserverlist.api.velocity.events.PostServerListSetEvent
-
Constructor for creating a new PostServerListSetEvent instance.
- PreServerListSetEvent - Class in ch.andre601.advancedserverlist.api.bukkit.events
-
Called before AdvancedServerList modifies the server list.
- PreServerListSetEvent - Class in ch.andre601.advancedserverlist.api.bungeecord.events
-
Called before AdvancedServerList modifies the server list.
- PreServerListSetEvent - Class in ch.andre601.advancedserverlist.api.velocity.events
-
Called before AdvancedServerList modifies the server list.
- PreServerListSetEvent(ProfileEntry) - Constructor for class ch.andre601.advancedserverlist.api.bukkit.events.PreServerListSetEvent
-
Constructor for creating a new PreServerListSetEvent instance.
- PreServerListSetEvent(ProfileEntry) - Constructor for class ch.andre601.advancedserverlist.api.bungeecord.events.PreServerListSetEvent
-
Constructor for creating a new PreServerListSetEvent instance.
- PreServerListSetEvent(ProfileEntry) - Constructor for class ch.andre601.advancedserverlist.api.velocity.events.PreServerListSetEvent
-
Constructor for creating a new PreServerListSetEvent instance.
- ProfileEntry - Record Class in ch.andre601.advancedserverlist.api.profiles
-
This record represents the content found in a Server List Profile YAML file.
- ProfileEntry(List<String>, List<String>, String, String, NullBool, NullBool, NullBool, NullBool, String, String, String) - Constructor for record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Creates a new Instance of a ProfileEntry with the provided values.
- ProfileEntry.Builder - Class in ch.andre601.advancedserverlist.api.profiles
-
Builder class to create a new ProfileEntry instance.
R
- resolve(Boolean) - Static method in enum class ch.andre601.advancedserverlist.api.objects.NullBool
-
Returns a NullBool Instance based on the provided
Boolean
instance: - retrievePlaceholderProvider(String) - Method in class ch.andre601.advancedserverlist.api.AdvancedServerListAPI
-
Retrieves the
PlaceholderProvider
associated with the given identifier, ornull
should no such entry exist.
S
- setCancelled(boolean) - Method in class ch.andre601.advancedserverlist.api.bukkit.events.PreServerListSetEvent
-
Sets the event's cancel state.
- setCancelled(boolean) - Method in class ch.andre601.advancedserverlist.api.bungeecord.events.PreServerListSetEvent
-
Sets the event's cancel state.
- setCancelled(boolean) - Method in interface ch.andre601.advancedserverlist.api.events.GenericServerListEvent
-
Sets the Event's cancelled state.
- setCancelled(boolean) - Method in class ch.andre601.advancedserverlist.api.velocity.events.PreServerListSetEvent
-
Sets the event's cancel state.
- setEntry(ProfileEntry) - Method in class ch.andre601.advancedserverlist.api.bukkit.events.PreServerListSetEvent
-
Sets the new
ProfileEntry
to use. - setEntry(ProfileEntry) - Method in class ch.andre601.advancedserverlist.api.bungeecord.events.PreServerListSetEvent
-
Sets the new
ProfileEntry
to use. - setEntry(ProfileEntry) - Method in interface ch.andre601.advancedserverlist.api.events.GenericServerListEvent
-
Sets the
ProfileEntry
to use for this Event. - setEntry(ProfileEntry) - Method in class ch.andre601.advancedserverlist.api.velocity.events.PreServerListSetEvent
-
Sets the new
ProfileEntry
to use.
T
- toString() - Method in record class ch.andre601.advancedserverlist.api.profiles.ProfileEntry
-
Returns a string representation of this record class.
- TRUE - Enum constant in enum class ch.andre601.advancedserverlist.api.objects.NullBool
-
Representation of the Boolean value
true
.
V
- valueOf(String) - Static method in enum class ch.andre601.advancedserverlist.api.objects.NullBool
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class ch.andre601.advancedserverlist.api.objects.NullBool
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VelocityPlayer - Interface in ch.andre601.advancedserverlist.api.velocity.objects
-
GenericPlayer instance for the Velocity proxy implementation of AdvancedServerList.
- VelocityProxy - Interface in ch.andre601.advancedserverlist.api.velocity.objects
-
GenericServer instance for the Velocity proxy implementation of AdvancedServerList.
All Classes and Interfaces|All Packages|Serialized Form