Package net.frozenspace.frostlib.achievement

Class Achievement.AchievementBuilder

java.lang.Object

net.frozenspace.frostlib.achievement.Achievement.AchievementBuilder

Enclosing class:

Achievement

public static class Achievement.AchievementBuilder
extends java.lang.Object

This class is used for build an Advancement

Method Summary

Modifier and Type	Method	Description
Achievement.AchievementBuilder	addRequirements(@NotNull java.lang.String... requirement)	Add a requirement to this achievement
Achievement.AchievementBuilder	addReward(RewardType type, java.lang.Object object)	Add a reward to this achievement
Achievement.AchievementBuilder	addTrigger(@NotNull Trigger trigger)	Add a trigger to this achievement
Achievement	create()	Create/Load this achievement and at it into the manager
Achievement.AchievementBuilder	isAnnounceSend(boolean flag)	Define if the message is show in the chat or not Work only with builder created with AchievementBuilder(String, String, AchievementManager)
Achievement.AchievementBuilder	isHidden(boolean flag)	Define if the achievement is hide or not Work only with builder created with AchievementBuilder(String, String, AchievementManager)
Achievement.AchievementBuilder	isToastVisible(boolean flag)	Define if the toast is show when achievement is completed Work only with builder created with AchievementBuilder(String, String, AchievementManager)
Achievement.AchievementBuilder	withBackground(@NotNull Background background)	Define the background of this achievement Work only with builder created with AchievementBuilder(String, String, AchievementManager)
Achievement.AchievementBuilder	withDescription(@NotNull java.lang.String description)	Define the description of this achievement Work only with builder created with AchievementBuilder(String, String, AchievementManager)
Achievement.AchievementBuilder	withFrame(@NotNull Frame frame)	Define the frame of this achievement Work only with builder created with AchievementBuilder(String, String, AchievementManager)
Achievement.AchievementBuilder	withIcon(@NotNull org.bukkit.Material material)	Define the icon of this achievement Work only with builder created with AchievementBuilder(String, String, AchievementManager)
Achievement.AchievementBuilder	withParent(@NotNull java.lang.String parent)	Define the parent of this achievement using his name
Achievement.AchievementBuilder	withParent(@NotNull Achievement achievement)	Define the parent of this achievement using Achievement instance

Methods inherited from class java.lang.Object

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

Method Detail

create

public Achievement create()

Create/Load this achievement and at it into the manager

Returns:

The achievement created

withIcon

public Achievement.AchievementBuilder withIcon(@NotNull
                                               @NotNull org.bukkit.Material material)

Define the icon of this achievement Work only with builder created with AchievementBuilder(String, String, AchievementManager)

Parameters:

material - Material of the icon

Returns:

Current builder instance

withDescription

public Achievement.AchievementBuilder withDescription(@NotNull
                                                      @NotNull java.lang.String description)

Define the description of this achievement Work only with builder created with AchievementBuilder(String, String, AchievementManager)

Parameters:

description - Description of this achievement

Returns:

Current builder instance

withBackground

public Achievement.AchievementBuilder withBackground(@NotNull
                                                     @NotNull Background background)

Define the background of this achievement Work only with builder created with AchievementBuilder(String, String, AchievementManager)

Parameters:

background - Background of this achievement

Returns:

Current builder instance

withFrame

public Achievement.AchievementBuilder withFrame(@NotNull
                                                @NotNull Frame frame)

Define the frame of this achievement Work only with builder created with AchievementBuilder(String, String, AchievementManager)

Parameters:

frame - Frame of this achievement

Returns:

Current builder instance

isHidden

public Achievement.AchievementBuilder isHidden(boolean flag)

Define if the achievement is hide or not Work only with builder created with AchievementBuilder(String, String, AchievementManager)

Parameters:

flag - Hide or not

Returns:

Current builder instance

isToastVisible

public Achievement.AchievementBuilder isToastVisible(boolean flag)

Define if the toast is show when achievement is completed Work only with builder created with AchievementBuilder(String, String, AchievementManager)

Parameters:

flag - Show toast or not

Returns:

Current builder instance

isAnnounceSend

public Achievement.AchievementBuilder isAnnounceSend(boolean flag)

Define if the message is show in the chat or not Work only with builder created with AchievementBuilder(String, String, AchievementManager)

Parameters:

flag - Message send or not

Returns:

Current builder instance

withParent

public Achievement.AchievementBuilder withParent(@NotNull
                                                 @NotNull java.lang.String parent)

Define the parent of this achievement using his name

Parameters:

parent - Name of the parent

Returns:

Current builder instance

withParent

public Achievement.AchievementBuilder withParent(@NotNull
                                                 @NotNull Achievement achievement)

Define the parent of this achievement using Achievement instance

Parameters:

achievement - Instance of the parent

Returns:

Current builder instance

addTrigger

public Achievement.AchievementBuilder addTrigger(@NotNull
                                                 @NotNull Trigger trigger)

Add a trigger to this achievement

Parameters:

trigger - Trigger to add

Returns:

Current builder instance

addRequirements

public Achievement.AchievementBuilder addRequirements(@NotNull
                                                      @NotNull java.lang.String... requirement)

Add a requirement to this achievement

Parameters:

requirement - Requirement to add

Returns:

Current builder instance

addReward

public Achievement.AchievementBuilder addReward(RewardType type,
                                                java.lang.Object object)

Add a reward to this achievement

Parameters:

type - Type of reward

object - The reward

Returns:

Current builder instance