Package me.deecaad.core.mechanics

Class PlayerEffectMechanic

java.lang.Object

me.deecaad.core.mechanics.defaultmechanics.Mechanic

me.deecaad.core.mechanics.PlayerEffectMechanic

All Implemented Interfaces:

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

Direct Known Subclasses:

CustomSoundMechanic, FireworkMechanic, SoundMechanic

public abstract class PlayerEffectMechanic
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
PlayerEffectMechanic()

Method Summary

Modifier and Type	Method	Description
abstract List<Condition>	getViewerConditions()
abstract @Nullable Targeter	getViewerTargeter()
abstract void	playFor(CastData castData, List<org.bukkit.entity.Player> viewers)	Similar to Mechanic.use0(CastData) but instead of using this Mechanic's viewer targeter and viewer conditions, the mechanic is used for the given viewer.

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

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

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, getKey, getKeyword, shouldSerialize

Methods inherited from interface org.bukkit.Keyed

key

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

canUsePathTo, getName, getParentKeywords, getWikiLink, letPassThrough, serialize, tryPathTo, useLater

Constructor Details

PlayerEffectMechanic

public PlayerEffectMechanic()

Method Details

playFor

public abstract void playFor(CastData castData,
 List<org.bukkit.entity.Player> viewers)

Similar to Mechanic.use0(CastData) but instead of using this Mechanic's viewer targeter and viewer conditions, the mechanic is used for the given viewer.

This is done to address a performance issue associated with having multiple per-player mechanics in the same list. See #311 for more info.

Parameters:

castData - The source of the mechanic... who is casting.

viewers - The target of the mechanic.

getViewerTargeter

@Nullable
public abstract @Nullable Targeter getViewerTargeter()

getViewerConditions

public abstract List<Condition> getViewerConditions()