Package net.islandearth.rpgregions.effects

Class RegionEffect

java.lang.Object

net.islandearth.rpgregions.effects.RegionEffect

All Implemented Interfaces:

IGuiEditable

public abstract class RegionEffect
extends Object
implements IGuiEditable

Constructor Summary

Constructors

Constructor	Description
RegionEffect(IRPGRegionsAPI api)
RegionEffect(IRPGRegionsAPI api, boolean wearingRequired, List<org.bukkit.inventory.ItemStack> ignoreItems)

Method Summary

Modifier and Type	Method	Description
abstract void	effect(org.bukkit.entity.Player player)	Effects the specified player
List<org.bukkit.inventory.ItemStack>	getIgnoreItems()	The items that a player should have to not be effected
String	getPermission()	Gets the permission for this effect to apply.
@Nullable String	getRequiredVersion()	Gets the required Minecraft version for this effect to function.
boolean	isIgnorePerm()	Whether the permission should be ignored or not.
boolean	isWearingRequired()	Whether the items are required to be worn in armour slots
boolean	shouldIgnore(org.bukkit.inventory.ItemStack item)	Whether the ItemStack is within #getIgnoreItems()
void	uneffect(org.bukkit.entity.Player player)	Called when a player exits all regions and effects should be entirely removed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.islandearth.rpgregions.gui.IGuiEditable

getName

Constructor Details

RegionEffect

public RegionEffect(IRPGRegionsAPI api)

RegionEffect

public RegionEffect(IRPGRegionsAPI api,
 boolean wearingRequired,
 List<org.bukkit.inventory.ItemStack> ignoreItems)

Method Details

effect

public abstract void effect(org.bukkit.entity.Player player)

Effects the specified player

Parameters:

player -

uneffect

public void uneffect(org.bukkit.entity.Player player)

Called when a player exits all regions and effects should be entirely removed.

Parameters:

player -

getRequiredVersion

@Nullable
public @Nullable String getRequiredVersion()

Gets the required Minecraft version for this effect to function.

Returns:

minecraft version

isWearingRequired

public boolean isWearingRequired()

Whether the items are required to be worn in armour slots

Returns:

whether items should be worn in armour slots

getIgnoreItems

public List<org.bukkit.inventory.ItemStack> getIgnoreItems()

The items that a player should have to not be effected

Returns:

ignored items

shouldIgnore

public boolean shouldIgnore(org.bukkit.inventory.ItemStack item)

Whether the ItemStack is within #getIgnoreItems()

Parameters:

item - the ItemStack

Returns:

true if item is ignored

getPermission

public String getPermission()

Gets the permission for this effect to apply.

Returns:

permission the player requires

isIgnorePerm

public boolean isIgnorePerm()

Whether the permission should be ignored or not.

Returns:

true if permission is ignored