com.fren_gor.ultimateAdvancementAPI.advancement.multiParents.MultiParentsAdvancement

public class MultiParentsAdvancement extends AbstractMultiParentsAdvancement

An implementation of AbstractMultiParentsAdvancement.

Field Summary

Fields inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.BaseAdvancement
parent

Fields inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.Advancement
advancementTab, display, key, maxProgression
Constructor Summary

Constructors

Constructor

Description

MultiParentsAdvancement(@NotNull String key, @NotNull AdvancementDisplay display, @Range(from=1, to=Integer.MAX_VALUE) int maxProgression, @NotNull BaseAdvancement... parents)

Creates a new MultiParentsAdvancement.

MultiParentsAdvancement(@NotNull String key, @NotNull AdvancementDisplay display, @Range(from=1, to=Integer.MAX_VALUE) int maxProgression, @NotNull Set<BaseAdvancement> parents)

Creates a new MultiParentsAdvancement.

MultiParentsAdvancement(@NotNull String key, @NotNull AdvancementDisplay display, @NotNull BaseAdvancement... parents)

Creates a new MultiParentsAdvancement with a maximum progression of 1.

MultiParentsAdvancement(@NotNull String key, @NotNull AdvancementDisplay display, @NotNull Set<BaseAdvancement> parents)

Creates a new MultiParentsAdvancement with a maximum progression of 1.
Method Summary

Modifier and Type

Method

Description

@NotNull AdvancementWrapper

getNMSWrapper()

Returns the NMS wrapper of this advancement.

protected @NotNull AdvancementWrapper

getNMSWrapper(@NotNull BaseAdvancement advancement)

Returns the NMS wrapper of this advancement.

@NotNull BaseAdvancement

getParent()

Returns the parent advancement.

@NotNull @Unmodifiable Set<@NotNull BaseAdvancement>

getParents()

Gets an unmodifiable Set of the advancement parents.

boolean

isAnyGrandparentGranted(@NotNull TeamProgression pro)

Returns whether either any parent or any grandparent advancement is granted for the provided team.

boolean

isAnyParentGranted(@NotNull TeamProgression pro)

Returns whether any parent advancement is granted for the provided team.

boolean

isEveryGrandparentGranted(@NotNull TeamProgression pro)

Returns whether every parent and every grandparent advancements are granted for the provided team.

boolean

isEveryParentGranted(@NotNull TeamProgression pro)

Returns whether every parent advancement is granted for the provided team.

void

onDispose()

Called when the advancement is disposed.

void

onUpdate(@NotNull TeamProgression teamProgression, @NotNull Map<AdvancementWrapper,Integer> addedAdvancements)

Handles the serialisation of the advancement into the update packet.

void

validateRegister()

Validate the advancement after it has been registered by the advancement tab.

Methods inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.multiParents.AbstractMultiParentsAdvancement
isAnyGrandparentGranted, isAnyGrandparentGranted, isAnyParentGranted, isAnyParentGranted, isEveryGrandparentGranted, isEveryGrandparentGranted, isEveryParentGranted, isEveryParentGranted, validateAndGetFirst

Methods inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.Advancement
displayToastToPlayer, equals, getAdvancementTab, getAnnounceMessage, getDisplay, getKey, getMaxProgression, getProgression, getProgression, getProgression, giveReward, grant, grant, handlePlayer, hashCode, incrementProgression, incrementProgression, incrementProgression, incrementProgression, incrementProgression, incrementProgression, incrementProgression, incrementProgression, incrementProgression, isGranted, isGranted, isGranted, isValid, isVisible, isVisible, isVisible, onGrant, onRegister, registerEvent, registerEvent, revoke, setProgression, setProgression, setProgression, setProgression, setProgression, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- MultiParentsAdvancement
  
  public MultiParentsAdvancement(@NotNull @NotNull String key, @NotNull @NotNull AdvancementDisplay display, @NotNull @NotNull BaseAdvancement... parents)
  
  Creates a new MultiParentsAdvancement with a maximum progression of 1.
  
  Parameters:
  
  key - The unique key of the advancement. It must be unique among the other advancements of the tab.
  
  display - The display information of this advancement.
  
  parents - The advancement parents. There must be at least one.
- MultiParentsAdvancement
  
  public MultiParentsAdvancement(@NotNull @NotNull String key, @NotNull @NotNull AdvancementDisplay display, @Range(from=1, to=Integer.MAX_VALUE) int maxProgression, @NotNull @NotNull BaseAdvancement... parents)
  
  Creates a new MultiParentsAdvancement.
  
  Parameters:
  
  key - The unique key of the advancement. It must be unique among the other advancements of the tab.
  
  display - The display information of this advancement.
  
  maxProgression - The maximum advancement progression.
  
  parents - The advancement parents. There must be at least one.
- MultiParentsAdvancement
  
  public MultiParentsAdvancement(@NotNull @NotNull String key, @NotNull @NotNull AdvancementDisplay display, @NotNull @NotNull Set<BaseAdvancement> parents)
  
  Creates a new MultiParentsAdvancement with a maximum progression of 1.
  
  Parameters:
  
  key - The unique key of the advancement. It must be unique among the other advancements of the tab.
  
  display - The display information of this advancement.
  
  parents - The advancement parents. There must be at least one.
- MultiParentsAdvancement
  
  public MultiParentsAdvancement(@NotNull @NotNull String key, @NotNull @NotNull AdvancementDisplay display, @Range(from=1, to=Integer.MAX_VALUE) int maxProgression, @NotNull @NotNull Set<BaseAdvancement> parents)
  
  Creates a new MultiParentsAdvancement.
  
  Parameters:
  
  key - The unique key of the advancement. It must be unique among the other advancements of the tab.
  
  display - The display information of this advancement.
  
  maxProgression - The maximum advancement progression.
  
  parents - The advancement parents. There must be at least one.
Method Details
- onUpdate
  
  public void onUpdate(@NotNull @NotNull TeamProgression teamProgression, @NotNull @NotNull Map<AdvancementWrapper,Integer> addedAdvancements)
  
  Handles the serialisation of the advancement into the update packet.
  Advancement(s) to be sent have to be added to the provided Map, which contains the AdvancementWrappers paired with the progression of the provided team.
  
  Overrides:
  
  onUpdate in class Advancement
  
  Parameters:
  
  teamProgression - The TeamProgression of the team of the player(s).
  
  addedAdvancements - The Map in which the advancements to be sent are added as keys. The values are the current progressions of the team.
- getParents
  
  @NotNull public @NotNull @Unmodifiable Set<@NotNull BaseAdvancement> getParents()
  
  Gets an unmodifiable Set of the advancement parents.
  
  Specified by:
  
  getParents in class AbstractMultiParentsAdvancement
  
  Returns:
  
  An unmodifiable Set of the advancement parents.
- isEveryParentGranted
  
  public boolean isEveryParentGranted(@NotNull @NotNull TeamProgression pro)
  
  Returns whether every parent advancement is granted for the provided team.
  
  Specified by:
  
  isEveryParentGranted in class AbstractMultiParentsAdvancement
  
  Parameters:
  
  pro - The TeamProgression of the team.
  
  Returns:
  
  Whether every parent advancement is granted for the provided team.
- isAnyParentGranted
  
  public boolean isAnyParentGranted(@NotNull @NotNull TeamProgression pro)
  
  Returns whether any parent advancement is granted for the provided team.
  
  Specified by:
  
  isAnyParentGranted in class AbstractMultiParentsAdvancement
  
  Parameters:
  
  pro - The TeamProgression of the team.
  
  Returns:
  
  Whether any parent advancement is granted for the provided team.
- isEveryGrandparentGranted
  
  public boolean isEveryGrandparentGranted(@NotNull @NotNull TeamProgression pro)
  
  Returns whether every parent and every grandparent advancements are granted for the provided team.
  
  Specified by:
  
  isEveryGrandparentGranted in class AbstractMultiParentsAdvancement
  
  Parameters:
  
  pro - The TeamProgression of the team.
  
  Returns:
  
  Whether either any parent or any grandparent advancement is granted for the provided team.
- isAnyGrandparentGranted
  
  public boolean isAnyGrandparentGranted(@NotNull @NotNull TeamProgression pro)
  
  Returns whether either any parent or any grandparent advancement is granted for the provided team.
  
  Specified by:
  
  isAnyGrandparentGranted in class AbstractMultiParentsAdvancement
  
  Parameters:
  
  pro - The TeamProgression of the team.
  
  Returns:
  
  Whether either any parent or any grandparent advancement is granted for the provided team.
- validateRegister
  
  public void validateRegister() throws InvalidAdvancementException
  
  Validate the advancement after it has been registered by the advancement tab. If the validation fails, a InvalidAdvancementException should be thrown.
  For example, BaseAdvancement overrides this method to make sure it and its parent belongs to the same tab.
  Note that every method of AdvancementTab is available, since this method is called after every advancement has been registered and the tab has already been initialised.
  
  Overrides:
  
  validateRegister in class BaseAdvancement
  
  Throws:
  
  InvalidAdvancementException - If the validation fails.
- onDispose
  
  public void onDispose()
  
  Called when the advancement is disposed.
  
  Overrides:
  
  onDispose in class Advancement
- getParent
  
  @NotNull public @NotNull BaseAdvancement getParent()
  
  Returns the parent advancement.
  Calls to this method results in an undefined behaviour, since there is more than one parent.
  Use when you don't need an exact parent.
  
  Overrides:
  
  getParent in class BaseAdvancement
  
  Returns:
  
  A parent advancement.
- getNMSWrapper
  
  @NotNull public @NotNull AdvancementWrapper getNMSWrapper()
  
  Returns the NMS wrapper of this advancement.
  Calls to this method results in an undefined behaviour, since there is more than one parent and the NMS wrapper can contain only one.
  Use when you don't need the NMS wrapper of an exact parent.
  Use getNMSWrapper(BaseAdvancement) instead.
  Overrides:
  
  getNMSWrapper in class BaseAdvancement
  
  Returns:
  
  The NMS wrapper of this advancement.
  
  See Also:
  
  getNMSWrapper(BaseAdvancement)
- getNMSWrapper
  
  @NotNull protected @NotNull AdvancementWrapper getNMSWrapper(@NotNull @NotNull BaseAdvancement advancement)
  
  Returns the NMS wrapper of this advancement. The parent of the returned advancement wrapper is the (NMS wrapper of the) provided one.
  
  Parameters:
  
  advancement - The parent advancement used as the parent of the NMS wrapper.
  
  Returns:
  
  The NMS wrapper of this advancement.

Class MultiParentsAdvancement

Field Summary

Fields inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.BaseAdvancement

Fields inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.Advancement

Constructor Summary

Method Summary

Methods inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.multiParents.AbstractMultiParentsAdvancement

Methods inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.Advancement

Methods inherited from class java.lang.Object

Constructor Details

MultiParentsAdvancement

MultiParentsAdvancement

MultiParentsAdvancement

MultiParentsAdvancement

Method Details

onUpdate

getParents

isEveryParentGranted

isAnyParentGranted

isEveryGrandparentGranted

isAnyGrandparentGranted

validateRegister

onDispose

getParent

getNMSWrapper

getNMSWrapper