Package me.deecaad.core.mechanics.defaultmechanics

Class BossBarMechanic

java.lang.Object

me.deecaad.core.mechanics.defaultmechanics.Mechanic

me.deecaad.core.mechanics.defaultmechanics.BossBarMechanic

All Implemented Interfaces:

InlineSerializer<Mechanic>, Serializer<Mechanic>, net.kyori.adventure.key.Keyed, org.bukkit.Keyed

public class BossBarMechanic
extends Mechanic

Nested Class Summary

Nested classes/interfaces inherited from interface me.deecaad.core.file.InlineSerializer

InlineSerializer.FormatException

Field Summary

Fields inherited from class me.deecaad.core.mechanics.defaultmechanics.Mechanic

conditions, targeter

Fields inherited from interface me.deecaad.core.file.InlineSerializer

NAME_FINDER, UNIQUE_IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
BossBarMechanic()
BossBarMechanic(String title, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay style, float progress, int time)

Method Summary

Modifier and Type	Method	Description
net.kyori.adventure.bossbar.BossBar.Color	getColor()
@NotNull org.bukkit.NamespacedKey	getKey()
float	getProgress()
net.kyori.adventure.bossbar.BossBar.Overlay	getStyle()
int	getTime()
String	getTitle()
@Nullable String	getWikiLink()	Returns a link to the page on the wiki that describes this serializer.
@NotNull Mechanic	serialize(@NotNull me.deecaad.core.file.SerializeData data)	Instantiates a new Object to be added into the finalized configuration.
void	use0(CastData cast)	This method should be overridden to define the behavior of the Mechanic.

Methods inherited from class me.deecaad.core.mechanics.defaultmechanics.Mechanic

applyParentArgs, getChance, getConditions, getDelayBeforePlay, getRepeatAmount, getRepeatInterval, getTargeter, handleTargetersAndConditions, use

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.deecaad.core.file.InlineSerializer

getInlineKeyword, getKeyword, shouldSerialize

Methods inherited from interface org.bukkit.Keyed

key

Methods inherited from interface me.deecaad.core.file.Serializer

canUsePathTo, getName, getParentKeywords, letPassThrough, tryPathTo, useLater

Constructor Details

BossBarMechanic

public BossBarMechanic()

BossBarMechanic

public BossBarMechanic(String title,
 net.kyori.adventure.bossbar.BossBar.Color color,
 net.kyori.adventure.bossbar.BossBar.Overlay style,
 float progress,
 int time)

Method Details

getTitle

public String getTitle()

getColor

public net.kyori.adventure.bossbar.BossBar.Color getColor()

getStyle

public net.kyori.adventure.bossbar.BossBar.Overlay getStyle()

getProgress

public float getProgress()

getTime

public int getTime()

use0

public void use0(CastData cast)

Description copied from class: Mechanic

This method should be overridden to define the behavior of the Mechanic. For example, a Potion mechanic may use the CastData.getTarget() method to apply a potion effect.

Specified by:

use0 in class Mechanic

Parameters:

cast - The non-null data including source/target information.

getKey

@NotNull
public @NotNull org.bukkit.NamespacedKey getKey()

getWikiLink

@Nullable
public @Nullable String getWikiLink()

Description copied from interface: Serializer

Returns a link to the page on the wiki that describes this serializer. This method is called from SerializeData, and is used to help the user find potential solutions to their problem.

Returns:

The nullable link to the wiki.

serialize

@NotNull
public @NotNull Mechanic serialize(@NotNull
 @NotNull me.deecaad.core.file.SerializeData data)
                            throws me.deecaad.core.file.SerializerException

Description copied from interface: Serializer

Instantiates a new Object to be added into the finalized configuration. The object should be built off of SerializeData.getConfig(). If there is any misconfiguration (or any other issue preventing the construction of an object), then this method should throw a SerializerException. This method may not return null.

Parameters:

data - The non-null data containing config

Returns:

The non-null serialized data.

Throws:

me.deecaad.core.file.SerializerException - If there is an error in config.