Class NullProvider

java.lang.Object

org.skriptlang.skript.bukkit.potion.providers.PotionEffectProvider<Object>

org.skriptlang.skript.bukkit.potion.providers.NullProvider

public class NullProvider
extends PotionEffectProvider<Object>

Nested Class Summary

Nested classes/interfaces inherited from class PotionEffectProvider

PotionEffectProvider.RetrievalState

Field Summary

Fields inherited from class PotionEffectProvider

source

Constructor Summary

Constructors

Constructor	Description
NullProvider()

Method Summary

Modifier and Type	Method	Description
void	add(org.bukkit.potion.PotionEffect potionEffect)	Adds a potion effect to this provider.
void	clear(org.bukkit.potion.PotionEffectType[] potionEffectTypes, PotionEffectProvider.RetrievalState state)	Clears all potion effects of potionEffectTypes from this provider.
void	clearAll(PotionEffectProvider.RetrievalState state)	Clears all potion effects from this provider.
Collection<SkriptPotionEffect>	get(org.bukkit.potion.PotionEffectType[] potionEffectTypes, PotionEffectProvider.RetrievalState state)	Obtains specific types of potion effects from this provider.
Collection<SkriptPotionEffect>	getAll(PotionEffectProvider.RetrievalState state)	Obtains all potion effects from this provider.
void	mirrorEffectChanges(SkriptPotionEffect potionEffect, Runnable runnable)	Used for mirroring modifications of a potion effect actively applied to this provider.
void	remove(SkriptPotionEffect potionEffect, PotionEffectProvider.RetrievalState state)	Removes a potion effect from this provider.
void	removeAll(org.bukkit.potion.PotionEffectType potionEffectType, PotionEffectProvider.RetrievalState state)	Removes all potion effects of a specific type from this provider.

Methods inherited from class PotionEffectProvider

modify, of

Methods inherited from class Object

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

Constructor Details

NullProvider

public NullProvider()

Method Details

get

public Collection<SkriptPotionEffect> get(org.bukkit.potion.PotionEffectType[] potionEffectTypes,
 PotionEffectProvider.RetrievalState state)

Description copied from class: PotionEffectProvider

Obtains specific types of potion effects from this provider.

Specified by:

get in class PotionEffectProvider<Object>

Parameters:

potionEffectTypes - The type of potion effects to obtain.

state - The type of retrieval to perform.

Returns:

All potion effects of potionEffectTypes present on this provider.

getAll

public Collection<SkriptPotionEffect> getAll(PotionEffectProvider.RetrievalState state)

Description copied from class: PotionEffectProvider

Obtains all potion effects from this provider.

Specified by:

getAll in class PotionEffectProvider<Object>

Parameters:

state - The type of retrieval to perform.

Returns:

All potion effects present on this provider.

add

public void add(org.bukkit.potion.PotionEffect potionEffect)

Description copied from class: PotionEffectProvider

Adds a potion effect to this provider.

Specified by:

add in class PotionEffectProvider<Object>

Parameters:

potionEffect - The potion effect to add.

remove

public void remove(SkriptPotionEffect potionEffect,
 PotionEffectProvider.RetrievalState state)

Description copied from class: PotionEffectProvider

Removes a potion effect from this provider. A potion effect only needs to match the qualities of potionEffect to be removed. Thus, an effect will be removed even if it has other, distinguishing qualities.

Specified by:

remove in class PotionEffectProvider<Object>

Parameters:

potionEffect - The potion effect to remove.

state - State determining whether certain types of potion effects should be ignored.

removeAll

public void removeAll(org.bukkit.potion.PotionEffectType potionEffectType,
 PotionEffectProvider.RetrievalState state)

Description copied from class: PotionEffectProvider

Removes all potion effects of a specific type from this provider.

Specified by:

removeAll in class PotionEffectProvider<Object>

Parameters:

potionEffectType - The type of potion effect to remove.

state - State determining whether certain types of potion effects should be preserved.

clear

public void clear(org.bukkit.potion.PotionEffectType[] potionEffectTypes,
 PotionEffectProvider.RetrievalState state)

Description copied from class: PotionEffectProvider

Clears all potion effects of potionEffectTypes from this provider.

Specified by:

clear in class PotionEffectProvider<Object>

Parameters:

potionEffectTypes - The types of potion effects to clear.

state - State determining whether certain types of potion effects should be ignored.

clearAll

public void clearAll(PotionEffectProvider.RetrievalState state)

Description copied from class: PotionEffectProvider

Clears all potion effects from this provider.

Specified by:

clearAll in class PotionEffectProvider<Object>

Parameters:

state - State determining whether certain types of potion effects should be preserved.

mirrorEffectChanges

public void mirrorEffectChanges(SkriptPotionEffect potionEffect,
 Runnable runnable)

Description copied from class: PotionEffectProvider

Used for mirroring modifications of a potion effect actively applied to this provider.

Specified by:

mirrorEffectChanges in class PotionEffectProvider<Object>

Parameters:

potionEffect - The potion effect being modified.

runnable - A runnable that applies the modification(s) to potionEffect when invoked.