net.minestom.server.advancements.Advancement Maven / Gradle / Ivy
Show all versions of minestom-snapshots Show documentation
package net.minestom.server.advancements;
import net.kyori.adventure.text.Component;
import net.minestom.server.item.ItemStack;
import net.minestom.server.item.Material;
import net.minestom.server.network.packet.server.play.AdvancementsPacket;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
/**
* Represents an advancement located in an {@link AdvancementTab}.
*
* All fields are dynamic, changing one will update the advancement in the specific {@link AdvancementTab}.
*/
public class Advancement {
protected AdvancementTab tab;
private boolean achieved;
private Component title;
private Component description;
private ItemStack icon;
private FrameType frameType;
private String background; // Only on root
private boolean toast;
private boolean hidden;
private float x, y;
private String identifier;
private Advancement parent;
// Packet
private AdvancementsPacket.Criteria criteria;
private boolean sendTelemetryData;
public Advancement(@NotNull Component title, @NotNull Component description,
@NotNull Material icon, @NotNull FrameType frameType,
float x, float y) {
this(title, description, ItemStack.of(icon), frameType, x, y, false);
}
public Advancement(@NotNull Component title, Component description,
@NotNull ItemStack icon, @NotNull FrameType frameType,
float x, float y) {
this(title, description, icon, frameType, x, y, false);
}
public Advancement(@NotNull Component title, Component description,
@NotNull ItemStack icon, @NotNull FrameType frameType,
float x, float y, boolean sendTelemetryData) {
this.title = title;
this.description = description;
this.icon = icon;
this.frameType = frameType;
this.x = x;
this.y = y;
this.sendTelemetryData = sendTelemetryData;
}
/**
* Gets if the advancement is achieved.
*
* @return true if the advancement is achieved
*/
public boolean isAchieved() {
return achieved;
}
/**
* Makes the advancement achieved.
*
* @param achieved true to make it achieved
* @return this advancement
*/
public Advancement setAchieved(boolean achieved) {
this.achieved = achieved;
update();
return this;
}
/**
* Gets the advancement tab linked to this advancement.
*
* @return the {@link AdvancementTab} linked to this advancement, null if not linked to anything yet
*/
public @Nullable AdvancementTab getTab() {
return tab;
}
protected void setTab(@NotNull AdvancementTab tab) {
this.tab = tab;
}
/**
* Gets the title of the advancement.
*
* @return the title
*/
public Component getTitle() {
return title;
}
/**
* Changes the advancement title.
*
* @param title the new title
*/
public void setTitle(@NotNull Component title) {
this.title = title;
update();
}
/**
* Gets the description of the advancement.
*
* @return the description title
*/
public @NotNull Component getDescription() {
return description;
}
/**
* Changes the description title.
*
* @param description the new description
*/
public void setDescription(@NotNull Component description) {
this.description = description;
update();
}
/**
* Gets the advancement icon.
*
* @return the advancement icon
*/
public @NotNull ItemStack getIcon() {
return icon;
}
/**
* Changes the advancement icon.
*
* @param icon the new advancement icon
*/
public void setIcon(@NotNull ItemStack icon) {
this.icon = icon;
update();
}
/**
* Gets if this advancement has a toast.
*
* @return true if the advancement has a toast
*/
public boolean hasToast() {
return toast;
}
/**
* Makes this argument a toast.
*
* @param toast true to make this advancement a toast
* @return this advancement
*/
public Advancement showToast(boolean toast) {
this.toast = toast;
return this;
}
public boolean isHidden() {
return hidden;
}
public Advancement setHidden(boolean hidden) {
this.hidden = hidden;
update();
return this;
}
/**
* Gets the advancement frame type.
*
* @return this advancement frame type
*/
@NotNull
public FrameType getFrameType() {
return frameType;
}
/**
* Changes the advancement frame type.
*
* @param frameType the new frame type
*/
public void setFrameType(FrameType frameType) {
this.frameType = frameType;
update();
}
/**
* Gets the X position of this advancement.
*
* @return this advancement X
*/
public float getX() {
return x;
}
/**
* Changes this advancement X coordinate.
*
* @param x the new X coordinate
*/
public void setX(float x) {
this.x = x;
update();
}
/**
* Gets the Y position of this advancement.
*
* @return this advancement Y
*/
public float getY() {
return y;
}
/**
* Changes this advancement Y coordinate.
*
* @param y the new Y coordinate
*/
public void setY(float y) {
this.y = y;
update();
}
/**
* Sets the background.
*
* Only available for {@link AdvancementRoot}.
*
* @param background the new background
*/
protected void setBackground(String background) {
this.background = background;
}
/**
* Gets the identifier of this advancement, used to register the advancement, use it as a parent and to retrieve it later
* in the {@link AdvancementTab}.
*
* @return the advancement identifier
*/
protected String getIdentifier() {
return identifier;
}
/**
* Changes the advancement identifier.
*
* WARNING: unsafe, only used by {@link AdvancementTab} to initialize the advancement.
*
* @param identifier the new advancement identifier
*/
protected void setIdentifier(String identifier) {
this.identifier = identifier;
}
/**
* Gets the advancement parent.
*
* @return the advancement parent, null for {@link AdvancementRoot}
*/
@Nullable
protected Advancement getParent() {
return parent;
}
protected void setParent(Advancement parent) {
this.parent = parent;
}
protected @NotNull AdvancementsPacket.ProgressMapping toProgressMapping() {
final var advancementProgress = new AdvancementsPacket.AdvancementProgress(List.of(criteria));
return new AdvancementsPacket.ProgressMapping(identifier, advancementProgress);
}
protected @NotNull AdvancementsPacket.DisplayData toDisplayData() {
return new AdvancementsPacket.DisplayData(title, description, icon,
frameType, getFlags(), background, x, y);
}
/**
* Converts this advancement to an {@link AdvancementsPacket.AdvancementMapping}.
*
* @return the mapping of this advancement
*/
protected @NotNull AdvancementsPacket.AdvancementMapping toMapping() {
final Advancement parent = getParent();
final String parentIdentifier = parent != null ? parent.getIdentifier() : null;
AdvancementsPacket.Advancement adv = new AdvancementsPacket.Advancement(parentIdentifier, toDisplayData(),
List.of(new AdvancementsPacket.Requirement(List.of(criteria.criterionIdentifier()))),
sendTelemetryData);
return new AdvancementsPacket.AdvancementMapping(getIdentifier(), adv);
}
/**
* Gets the packet used to add this advancement to the already existing tab.
*
* @return the packet to add this advancement
*/
protected AdvancementsPacket getUpdatePacket() {
return new AdvancementsPacket(false, List.of(toMapping()),
List.of(), List.of(toProgressMapping()));
}
/**
* Sends update to all tab viewers if one of the advancement value changes.
*/
protected void update() {
updateCriteria();
if (tab != null) {
tab.sendPacketsToViewers(tab.removePacket, tab.createPacket());
}
}
protected void updateCriteria() {
final Long achievedDate = achieved ? System.currentTimeMillis() : null;
final var progress = new AdvancementsPacket.CriterionProgress(achievedDate);
this.criteria = new AdvancementsPacket.Criteria(identifier, progress);
}
private int getFlags() {
byte result = 0;
if (background != null) result |= 0x1;
if (hasToast()) result |= 0x2;
if (isHidden()) result |= 0x4;
return result;
}
}