Package eu.endercentral.crazy_advancements.manager

Class AdvancementManager

java.lang.Object

eu.endercentral.crazy_advancements.manager.AdvancementManager

public final class AdvancementManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
AdvancementManager(org.bukkit.entity.Player... players)

Method Summary

Modifier and Type	Method	Description
void	addAdvancement(Advancement... advancementsAdded)	Adds advancements or updates one advancement
void	addPlayer(org.bukkit.entity.Player player)	Adds a player to the manager
void	displayMessage(org.bukkit.entity.Player player, Advancement advancement)	Displays a message to all players in the manager Note that this doesn't grant the advancement
static AdvancementManager	getAccessibleManager(java.lang.String name)	Gets an accessible Advancement Manager by it's Name
static java.util.Collection<AdvancementManager>	getAccessibleManagers()
Advancement	getAdvancement(NameKey name)
java.util.ArrayList<Advancement>	getAdvancements()
java.util.ArrayList<Advancement>	getAdvancements(java.lang.String namespace)
int	getCriteriaProgress(java.util.UUID uuid, Advancement advancement)
int	getCriteriaProgress(org.bukkit.entity.Player player, Advancement advancement)
java.lang.String	getCriterionKey()	Get the key that is used for the Namespaced Key for criteria
java.lang.String	getCriterionNamespace()	Get the namespace that is used for the Namespaced Key for criteria
java.lang.String	getCriterionPrefix()	Get the prefix that is used for criteria
boolean	getHiddenBoolean()	Gets the boolean that is passed via the advancement packet when an advancement is hidden
java.lang.String	getName()	Returns the Unique Name if AdvancementManager is accessible
static AdvancementManager	getNewAdvancementManager(org.bukkit.entity.Player... players)	Deprecated. Use the AdvancementManager constructor instead of this method
java.util.ArrayList<org.bukkit.entity.Player>	getPlayers()
java.lang.String	getProgressJSON(java.util.UUID uuid)
java.lang.String	getProgressJSON(java.util.UUID uuid, java.lang.String namespace)
java.lang.String	getProgressJSON(org.bukkit.entity.Player player)
java.lang.String	getProgressJSON(org.bukkit.entity.Player player, java.lang.String namespace)
void	grantAdvancement(java.util.UUID uuid, Advancement advancement)	Grants an advancement, also works with offline players
void	grantAdvancement(org.bukkit.entity.Player player, Advancement advancement)	Grants an advancement
void	grantCriteria(java.util.UUID uuid, Advancement advancement, java.lang.String... criteria)	Grans criteria for an advancement, also works with offline players
void	grantCriteria(org.bukkit.entity.Player player, Advancement advancement, java.lang.String... criteria)	Grants criteria for an advancement
boolean	isAnnounceAdvancementMessages()
void	loadCustomProgress(java.util.UUID uuid, java.lang.String json)	Deprecated.
void	loadCustomProgress(java.util.UUID uuid, java.lang.String json, Advancement... advancementsLoaded)	Deprecated.
void	loadCustomProgress(java.util.UUID uuid, java.lang.String json, java.lang.String namespace)	Deprecated.
void	loadCustomProgress(org.bukkit.entity.Player player, java.lang.String json)	Loads the progress with a custom JSON String
void	loadCustomProgress(org.bukkit.entity.Player player, java.lang.String json, Advancement... advancementsLoaded)	Loads the progress with a custom JSON String
void	loadCustomProgress(org.bukkit.entity.Player player, java.lang.String json, java.lang.String namespace)	Loads the progress with a custom JSON String
void	loadProgress(java.util.UUID uuid, Advancement... advancementsLoaded)	Deprecated.
void	loadProgress(java.util.UUID uuid, java.lang.String namespace)	Deprecated.
void	loadProgress(org.bukkit.entity.Player player, Advancement... advancementsLoaded)	Loads the progress
void	loadProgress(org.bukkit.entity.Player player, java.lang.String namespace)	Loads the progress
void	makeAccessible(java.lang.String name)	Makes the AdvancementManager accessible
void	removeAdvancement(Advancement... advancementsRemoved)	Removes an advancement from the manager
void	removePlayer(org.bukkit.entity.Player player)	Removes a player from the manager
void	resetAccessible()	Resets Accessibility-Status and Name
void	revokeAdvancement(java.util.UUID uuid, Advancement advancement)	Revokes an advancement, also works with offline players
void	revokeAdvancement(org.bukkit.entity.Player player, Advancement advancement)	Revokes an advancement
void	revokeCriteria(java.util.UUID uuid, Advancement advancement, java.lang.String... criteria)	Revokes criteria for an advancement, also works with offline players
void	revokeCriteria(org.bukkit.entity.Player player, Advancement advancement, java.lang.String... criteria)	Revokes criteria for an advancement
void	saveProgress(java.util.UUID uuid, java.lang.String namespace)	Saves the progress
void	saveProgress(org.bukkit.entity.Player player, java.lang.String namespace)	Saves the progress
void	setAnnounceAdvancementMessages(boolean announceAdvancementMessages)	Changes if advancement messages will be shown by default in this manager
void	setCriteriaProgress(java.util.UUID uuid, Advancement advancement, int progress)	Sets the criteria progress for an advancement, also works for offline players Might not work as expected when using features for experts Is the only method triggering CriteriaProgressChangeEvent
void	setCriteriaProgress(org.bukkit.entity.Player player, Advancement advancement, int progress)	Sets the criteria progress for an advancement Might not work as expected when using features for experts Is the only method triggering CriteriaProgressChangeEvent
void	setCriterionKey(java.lang.String criterionKey)	Sets the key that is used for the Namespaced Key for criteria Only works for advancements that have not generated their criteria yet (use this method before adding advancements to it)
void	setCriterionNamespace(java.lang.String criterionNamespace)	Set the namespace that is used for the Namespaced Key for criteria Only works for advancements that have not generated their criteria yet (use this method before adding advancements to it)
void	setCriterionPrefix(java.lang.String criterionPrefix)	Set the prefix that is used for criteria For legacy reasons, the default prefix is "criterion." as the advancement progress is stored by their criterion name, which consists of prefix + number To reduce packet size and thus increase the max criteria number that can be used, the prefix can be set to an empty String Only works for advancements that have not generated their criteria yet (use this method before adding advancements to it)
void	setHiddenBoolean(boolean hiddenBoolean)	Sets the boolean that is passed via the advancement packet when an advancement is hidden Default: false When set to true, hidden advancements that have not been granted yet, will have a line drawn to them even though they aren't displayed yet, when they should be visible (according to their AdvancementVisibility) Can be used to create an empty advancement tab where there are no advancements visible and no lines visible, when the tab only has a hidden advancement as a root
void	unloadProgress(java.util.UUID uuid)	Unloads the progress for all advancements in the manager Does not work for Online Players!
void	unloadProgress(java.util.UUID uuid, Advancement... advancements)	Unloads the progress for the given advancements Does not work for Online Players!
void	unloadProgress(java.util.UUID uuid, java.lang.String namespace)	Unloads the progress for all advancements in the manager with a specified namespace Does not work for Online Players!
void	update(org.bukkit.entity.Player player)	Updates/Refreshes the player
void	update(org.bukkit.entity.Player player, NameKey tab)	Updates/Refreshes the player
void	updateAllPossiblyAffectedVisibilities(org.bukkit.entity.Player player, Advancement from)	Updates all possibly affected visibilities for all parents and childs
void	updateProgress(org.bukkit.entity.Player player, Advancement... advancementsUpdated)	Updates advancement progress for a player
void	updateVisibility(org.bukkit.entity.Player player, Advancement advancement)	Updates the visibility

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvancementManager

public AdvancementManager(org.bukkit.entity.Player... players)

Parameters:

players - All players that should be in the new manager from the start, can be changed at any time

Method Detail

getAccessibleManager

public static AdvancementManager getAccessibleManager(java.lang.String name)

Gets an accessible Advancement Manager by it's Name

Parameters:

name -

Returns:

getAccessibleManagers

public static java.util.Collection<AdvancementManager> getAccessibleManagers()

setHiddenBoolean

public void setHiddenBoolean(boolean hiddenBoolean)

Sets the boolean that is passed via the advancement packet when an advancement is hidden
Default: false
When set to true, hidden advancements that have not been granted yet, will have a line drawn to them even though they aren't displayed yet, when they should be visible (according to their AdvancementVisibility)
Can be used to create an empty advancement tab where there are no advancements visible and no lines visible, when the tab only has a hidden advancement as a root

Parameters:

hiddenBoolean - The new hiddenBoolean

getHiddenBoolean

public boolean getHiddenBoolean()

Gets the boolean that is passed via the advancement packet when an advancement is hidden

Returns:

setCriterionPrefix

public void setCriterionPrefix(java.lang.String criterionPrefix)

Set the prefix that is used for criteria
For legacy reasons, the default prefix is "criterion." as the advancement progress is stored by their criterion name, which consists of prefix + number
To reduce packet size and thus increase the max criteria number that can be used, the prefix can be set to an empty String
Only works for advancements that have not generated their criteria yet (use this method before adding advancements to it)

Parameters:

criterionPrefix - The new prefix that is used for criteria

getCriterionPrefix

public java.lang.String getCriterionPrefix()

Get the prefix that is used for criteria

Returns:

The prefix that is used for criteria

setCriterionNamespace

public void setCriterionNamespace(java.lang.String criterionNamespace)

Set the namespace that is used for the Namespaced Key for criteria
Only works for advancements that have not generated their criteria yet (use this method before adding advancements to it)

Parameters:

criterionNamespace - The new namespace that is used for the Namespaced Key for criteria

getCriterionNamespace

public java.lang.String getCriterionNamespace()

Get the namespace that is used for the Namespaced Key for criteria

Returns:

The namespace that is used for the Namespaced Key for criteria

setCriterionKey

public void setCriterionKey(java.lang.String criterionKey)

Sets the key that is used for the Namespaced Key for criteria
Only works for advancements that have not generated their criteria yet (use this method before adding advancements to it)

Parameters:

criterionKey - The new key that is used for the Namespaced Key for criteria

getCriterionKey

public java.lang.String getCriterionKey()

Get the key that is used for the Namespaced Key for criteria

Returns:

The key that is used for the Namespaced Key for criteria

getNewAdvancementManager

@Deprecated(since="1.13.10")
public static AdvancementManager getNewAdvancementManager(org.bukkit.entity.Player... players)

Deprecated. Use the AdvancementManager constructor instead of this method

Creates a new instance of an advancement manager

Parameters:

players - All players that should be in the new manager from the start, can be changed at any time

Returns:

the generated advancement manager

getPlayers

public java.util.ArrayList<org.bukkit.entity.Player> getPlayers()

Returns:

All players that have been added to the manager

addPlayer

public void addPlayer(org.bukkit.entity.Player player)

Adds a player to the manager

Parameters:

player - Player to add

removePlayer

public void removePlayer(org.bukkit.entity.Player player)

Removes a player from the manager

Parameters:

player - Player to remove

addAdvancement

public void addAdvancement(Advancement... advancementsAdded)

Adds advancements or updates one advancement

Parameters:

advancementsAdded - An array of all advancements that should be added
If you want to update the display of an advancement, the array must have a length of 1

removeAdvancement

public void removeAdvancement(Advancement... advancementsRemoved)

Removes an advancement from the manager

Parameters:

advancementsRemoved - An array of advancements that should be removed

update

public void update(org.bukkit.entity.Player player)

Updates/Refreshes the player

Parameters:

player - Player to update

update

public void update(org.bukkit.entity.Player player,
                   NameKey tab)

Updates/Refreshes the player

Parameters:

player - Player to update

tab - Tab to update

updateProgress

public void updateProgress(org.bukkit.entity.Player player,
                           Advancement... advancementsUpdated)

Updates advancement progress for a player

Parameters:

player - Player to update

advancementsUpdated - An array of advancement to update progress

updateAllPossiblyAffectedVisibilities

public void updateAllPossiblyAffectedVisibilities(org.bukkit.entity.Player player,
                                                  Advancement from)

Updates all possibly affected visibilities for all parents and childs

Parameters:

player - Player to update

from - Advancement to check from

updateVisibility

public void updateVisibility(org.bukkit.entity.Player player,
                             Advancement advancement)

Updates the visibility

Parameters:

player - Player to update

advancement - Advancement to update

getAdvancements

public java.util.ArrayList<Advancement> getAdvancements()

Returns:

A list of all advancements in the manager

getAdvancements

public java.util.ArrayList<Advancement> getAdvancements(java.lang.String namespace)

Parameters:

namespace - Namespace to check

Returns:

A list of all advancements in the manager with a specified namespace

getAdvancement

public Advancement getAdvancement(NameKey name)

Parameters:

name - Name to check

Returns:

An advancement matching the given name or null if it doesn't exist in the AdvancementManager

displayMessage

public void displayMessage(org.bukkit.entity.Player player,
                           Advancement advancement)

Displays a message to all players in the manager
Note that this doesn't grant the advancement

Parameters:

player - Player which has received an advancement

advancement - Advancement Player has received

isAnnounceAdvancementMessages

public boolean isAnnounceAdvancementMessages()

Returns:

true if advancement messages will be shown by default in this manager
false if advancement messages will never be shown in this manager

setAnnounceAdvancementMessages

public void setAnnounceAdvancementMessages(boolean announceAdvancementMessages)

Changes if advancement messages will be shown by default in this manager

Parameters:

announceAdvancementMessages -

makeAccessible

public void makeAccessible(java.lang.String name)

Makes the AdvancementManager accessible

Parameters:

name - Unique Name, case insensitive

resetAccessible

public void resetAccessible()

Resets Accessibility-Status and Name

getName

public java.lang.String getName()

Returns the Unique Name if AdvancementManager is accessible

Returns:

Name or null if not accessible

grantAdvancement

public void grantAdvancement(org.bukkit.entity.Player player,
                             Advancement advancement)

Grants an advancement

Parameters:

player - Reciever

advancement - Advancement to grant

grantAdvancement

public void grantAdvancement(java.util.UUID uuid,
                             Advancement advancement)

Grants an advancement, also works with offline players

Parameters:

uuid - Receiver UUID

advancement - Advancement to grant

revokeAdvancement

public void revokeAdvancement(org.bukkit.entity.Player player,
                              Advancement advancement)

Revokes an advancement

Parameters:

player - Receiver

advancement - Advancement to revoke

revokeAdvancement

public void revokeAdvancement(java.util.UUID uuid,
                              Advancement advancement)

Revokes an advancement, also works with offline players

Parameters:

uuid - Receiver UUID

advancement - Advancement to revoke

grantCriteria

public void grantCriteria(org.bukkit.entity.Player player,
                          Advancement advancement,
                          java.lang.String... criteria)

Grants criteria for an advancement

Parameters:

player - Receiver

advancement -

criteria - Array of criteria to grant

grantCriteria

public void grantCriteria(java.util.UUID uuid,
                          Advancement advancement,
                          java.lang.String... criteria)

Grans criteria for an advancement, also works with offline players

Parameters:

uuid -

advancement -

criteria -

revokeCriteria

public void revokeCriteria(org.bukkit.entity.Player player,
                           Advancement advancement,
                           java.lang.String... criteria)

Revokes criteria for an advancement

Parameters:

player - Receiver

advancement -

criteria - Array of criteria to revoke

revokeCriteria

public void revokeCriteria(java.util.UUID uuid,
                           Advancement advancement,
                           java.lang.String... criteria)

Revokes criteria for an advancement, also works with offline players

Parameters:

uuid - Receiver UUID

advancement -

criteria - Array of criteria to revoke

setCriteriaProgress

public void setCriteriaProgress(org.bukkit.entity.Player player,
                                Advancement advancement,
                                int progress)

Sets the criteria progress for an advancement
Might not work as expected when using features for experts
Is the only method triggering CriteriaProgressChangeEvent

Parameters:

player - Receiver

advancement -

progress -

setCriteriaProgress

public void setCriteriaProgress(java.util.UUID uuid,
                                Advancement advancement,
                                int progress)

Sets the criteria progress for an advancement, also works for offline players
Might not work as expected when using features for experts
Is the only method triggering CriteriaProgressChangeEvent

Parameters:

uuid - Receiver UUID

advancement -

progress -

getCriteriaProgress

public int getCriteriaProgress(org.bukkit.entity.Player player,
                               Advancement advancement)

Parameters:

player -

advancement -

Returns:

The criteria progress

getCriteriaProgress

public int getCriteriaProgress(java.util.UUID uuid,
                               Advancement advancement)

Parameters:

uuid -

advancement -

Returns:

The criteria progress

getProgressJSON

public java.lang.String getProgressJSON(org.bukkit.entity.Player player)

Parameters:

player - Player to check

Returns:

A JSON String representation of the progress for a player

getProgressJSON

public java.lang.String getProgressJSON(org.bukkit.entity.Player player,
                                        java.lang.String namespace)

Parameters:

player - Player to check

namespace - Namespace to check

Returns:

A JSON String representation of the progress for a player in a specified namespace

saveProgress

public void saveProgress(org.bukkit.entity.Player player,
                         java.lang.String namespace)

Saves the progress

Parameters:

player - Player to check

namespace - Namespace to check

loadProgress

public void loadProgress(org.bukkit.entity.Player player,
                         java.lang.String namespace)

Loads the progress

Parameters:

player - Player to check

namespace - Namespace to check

loadProgress

public void loadProgress(org.bukkit.entity.Player player,
                         Advancement... advancementsLoaded)

Loads the progress

Parameters:

player - Player to check

advancementsLoaded - Array of advancements to check, all advancements which arent in the same namespace as the first one will be ignored

loadCustomProgress

public void loadCustomProgress(org.bukkit.entity.Player player,
                               java.lang.String json,
                               Advancement... advancementsLoaded)

Loads the progress with a custom JSON String

Parameters:

player - Player to check

json - JSON String to load from

advancementsLoaded - Array of advancements to check

loadCustomProgress

public void loadCustomProgress(org.bukkit.entity.Player player,
                               java.lang.String json)

Loads the progress with a custom JSON String

Parameters:

player - Player to check

json - JSON String to load from

loadCustomProgress

public void loadCustomProgress(org.bukkit.entity.Player player,
                               java.lang.String json,
                               java.lang.String namespace)

Loads the progress with a custom JSON String

Parameters:

player - Player to check

json - JSON String to load from

namespace - Namespace to check

getProgressJSON

public java.lang.String getProgressJSON(java.util.UUID uuid)

Parameters:

uuid - Player UUID to check

Returns:

A JSON String representation of the progress for a player

getProgressJSON

public java.lang.String getProgressJSON(java.util.UUID uuid,
                                        java.lang.String namespace)

Parameters:

uuid - Player UUID to check

namespace - Namespace to check

Returns:

A JSON String representation of the progress for a player in a specified namespace

saveProgress

public void saveProgress(java.util.UUID uuid,
                         java.lang.String namespace)

Saves the progress

Parameters:

uuid - Player UUID to check

namespace - Namespace to check

loadProgress

@Deprecated
public void loadProgress(java.util.UUID uuid,
                         java.lang.String namespace)

Deprecated.

Loads the progress
Recommended to only load progress for online players!

Parameters:

uuid - Player UUID to check

namespace - Namespace to check

loadProgress

@Deprecated
public void loadProgress(java.util.UUID uuid,
                         Advancement... advancementsLoaded)

Deprecated.

Loads the progress
Recommended to only load progress for online players!

Parameters:

uuid - Player UUID to check

advancementsLoaded - Array of advancements to check, all advancements which arent in the same namespace as the first one will be ignored

loadCustomProgress

@Deprecated
public void loadCustomProgress(java.util.UUID uuid,
                               java.lang.String json,
                               Advancement... advancementsLoaded)

Deprecated.

Loads the progress with a custom JSON String
Recommended to only load progress for online players!

Parameters:

uuid - Player UUID to check

json - JSON String to load from

advancementsLoaded - Array of advancements to check

loadCustomProgress

@Deprecated
public void loadCustomProgress(java.util.UUID uuid,
                               java.lang.String json)

Deprecated.

Loads the progress with a custom JSON String
Recommended to only load progress for online players!

Parameters:

uuid - Player UUID to check

json - JSON String to load from

loadCustomProgress

@Deprecated
public void loadCustomProgress(java.util.UUID uuid,
                               java.lang.String json,
                               java.lang.String namespace)

Deprecated.

Loads the progress with a custom JSON String
Recommended to only load progress for online players!

Parameters:

uuid - Player UUID to check

json - JSON String to load from

namespace - Namespace to check

unloadProgress

public void unloadProgress(java.util.UUID uuid)

Unloads the progress for all advancements in the manager
Does not work for Online Players!

Parameters:

uuid - Affected Player UUID

unloadProgress

public void unloadProgress(java.util.UUID uuid,
                           java.lang.String namespace)

Unloads the progress for all advancements in the manager with a specified namespace
Does not work for Online Players!

Parameters:

uuid - Affected Player UUID

namespace - Specific Namespace

unloadProgress

public void unloadProgress(java.util.UUID uuid,
                           Advancement... advancements)

Unloads the progress for the given advancements
Does not work for Online Players!

Parameters:

uuid - Affected Player UUID

advancements - Specific Advancements