Class Wander

java.lang.Object

ua.mcchickenstudio.opencreative.wanders.OfflineWander

ua.mcchickenstudio.opencreative.wanders.Wander

All Implemented Interfaces:

net.kyori.adventure.audience.Audience, net.kyori.adventure.pointer.Pointered

public final class Wander
extends OfflineWander
implements net.kyori.adventure.audience.Audience

Wander

This class represents wander, that could be online. Wander is a player, who plays on planets. He has nickname, description, gender, favorite worlds and last played world.

Nested Class Summary

Nested classes/interfaces inherited from class OfflineWander

OfflineWander.Gender

Modifier and Type	Class	Description
static enum	OfflineWander.Gender

Field Summary

Fields inherited from class OfflineWander

description, favoriteWorlds, friends, gender, hideHints, lastLocation, lastPlayedWorldId, links, name, uuid, visits

Modifier and Type	Field	Description
protected @Nullable String	description
protected @Nullable Set<Integer>	favoriteWorlds
protected @Nullable List<UUID>	friends
protected @Nullable OfflineWander.Gender	gender
protected boolean	hideHints
protected org.bukkit.Location	lastLocation
protected int	lastPlayedWorldId
protected Links	links
protected @Nullable String	name
protected final @NotNull UUID	uuid
protected int	visits

Constructor Summary

Constructors

Constructor	Description
Wander(@NotNull org.bukkit.entity.Player player)

Method Summary

Modifier and Type	Method	Description
@Nullable Planet	getCurrentPlanet()	Returns current planet, where wander is currently in.
@NotNull GriefStats	getGriefStats()	Returns statistics of destructive changes to world.
@NotNull org.bukkit.entity.Player	getPlayer()
boolean	isConnectingToPlanet()	Checks whether wander is trying to connect to some planet.
void	sendActionBar(@NotNull net.kyori.adventure.text.Component message)
void	sendMessage(@NotNull net.kyori.adventure.text.Component message)
void	setConnectingToPlanet(boolean connectingToPlanet)	Sets whether wander is currently connecting to planet.
void	showTitle(@NotNull net.kyori.adventure.title.Title title)

Methods inherited from class OfflineWander

addFavoriteWorld, addFriend, clearData, equals, getDescription, getFavoriteWorlds, getFriends, getGender, getLastLocation, getLastPlayedWorldId, getLink, getName, getOfflinePlayer, getUniqueId, getVisits, hashCode, isOnline, loadInfo, removeFavoriteWorld, removeFriend, removeLink, saveData, setDescription, setGender, setLastPlayedWorldId, setLink, setName, setVisits, shouldHideHints, toString

Modifier and Type	Method	Description
boolean	addFavoriteWorld(int worldId)	Adds specified planet's ID to favorite worlds.
boolean	addFriend(@NotNull UUID friendUUID)	Adds specified UUID to friends list.
boolean	clearData()	Clears all data and removes json file.
boolean	equals(Object obj)
@Nullable String	getDescription()	Returns profile's description, or null - if not set.
@NotNull Set<Integer>	getFavoriteWorlds()	Returns set of favorite worlds IDs, marked by player.
@NotNull List<UUID>	getFriends()	Returns set of friends UUIDs, picked by player.
@Nullable OfflineWander.Gender	getGender()	Returns profile's gender, or null - if not set.
@Nullable org.bukkit.Location	getLastLocation()	Returns last location of wander (where player was playing before leaving the server), or null - if not saved.
int	getLastPlayedWorldId()	Returns ID of last visited planet by player, or -1 - if not saved.
@Nullable String	getLink(@NotNull String id)	Returns link of social media by ID, or null - if not set.
@Nullable String	getName()	Returns custom name of wander, or null - if not set.
@NotNull org.bukkit.OfflinePlayer	getOfflinePlayer()	Returns offline player associated with wander.
@NotNull UUID	getUniqueId()	Returns unique ID of wander.
int	getVisits()	Returns amount of all visited worlds by player.
int	hashCode()
boolean	isOnline()	Checks whether wander is playing on server.
void	loadInfo()	Loads information about wander from disk.
boolean	removeFavoriteWorld(int worldId)	Removes specified planet's ID from favorite worlds.
boolean	removeFriend(@NotNull UUID friendUUID)	Removes specified UUID from friends list.
void	removeLink(@NotNull String id)	Removes social media link by ID.
void	saveData()	Saves wander's information to disk.
void	setDescription(@NotNull String description)	Sets profile's description.
boolean	setGender(@NotNull OfflineWander.Gender gender)	Sets profile's gender.
void	setLastPlayedWorldId(int lastPlayedWorldId)	Sets last visited world ID.
void	setLink(@NotNull String id, @NotNull String link)	Sets link of social media by ID.
void	setName(@NotNull String name)	Sets profile's custom name.
void	setVisits(int visits)	Sets amount of visits.
boolean	shouldHideHints()	Checks whether hints should be hidden from player.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kyori.adventure.audience.Audience

clearResourcePacks, clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, sendResourcePacks, sendTitlePart, showBossBar, stopSound, stopSound

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom, pointers

Constructor Details

Wander

public Wander(@NotNull
 @NotNull org.bukkit.entity.Player player)

Method Details

getGriefStats

@NotNull
public @NotNull GriefStats getGriefStats()

Returns statistics of destructive changes to world.

It will be cleared, when player leaves the world.

Returns:

grief statistics.

getPlayer

@NotNull
public @NotNull org.bukkit.entity.Player getPlayer()

getCurrentPlanet

@Nullable
public @Nullable Planet getCurrentPlanet()

Returns current planet, where wander is currently in.

Returns:

current planet, or null.

sendMessage

public void sendMessage(@NotNull
 @NotNull net.kyori.adventure.text.Component message)

Specified by:

sendMessage in interface net.kyori.adventure.audience.Audience

sendActionBar

public void sendActionBar(@NotNull
 @NotNull net.kyori.adventure.text.Component message)

Specified by:

sendActionBar in interface net.kyori.adventure.audience.Audience

showTitle

public void showTitle(@NotNull
 @NotNull net.kyori.adventure.title.Title title)

Specified by:

showTitle in interface net.kyori.adventure.audience.Audience

setConnectingToPlanet

public void setConnectingToPlanet(boolean connectingToPlanet)

Sets whether wander is currently connecting to planet.

Parameters:

connectingToPlanet - whether wander is connecting to planet or not.

isConnectingToPlanet

public boolean isConnectingToPlanet()

Checks whether wander is trying to connect to some planet.

Returns:

true - is connecting, false - not connecting.