com.bermudalocket.smartmobs

Class Zone

java.lang.Object

com.bermudalocket.smartmobs.Zone

public final class Zone
extends java.lang.Object

Represents an arbitrary zone. A zone is an explicitly 2-dimensional but implicitly 3-dimensional manifold with a defined center and radius.

Field Summary

Fields

Modifier and Type	Field and Description
private OrderedPair<java.lang.Double>	_center The center coordinates of this zone as an ordered pair (x, y).
private java.util.function.BiFunction<java.lang.Double,java.lang.Double,java.lang.Boolean>	_circleFunction A function that tests if a coordinate pair is within the boundaries of this zone.
private org.bukkit.ChatColor	_color The zone's color.
private java.util.Map<org.bukkit.entity.EntityType,java.util.HashSet<org.bukkit.inventory.ItemStack>>	_customDrops Stores this zone's custom drops.
private java.lang.String	_name The zone's name.
private int	_radius The zone's radius, in whole blocks.
private java.util.Map<org.bukkit.attribute.Attribute,java.lang.Double>	_scalarMap Stores this zone's attribute scalars.
private Shape	_shape The shape of this zone.
private java.util.function.BiFunction<java.lang.Double,java.lang.Double,java.lang.Boolean>	_squareFunction A function that tests if a coordinate pair is within the boundaries of this zone.
private org.bukkit.World	_world The world in which this zone is located.
private double	_xpScalar This zone's xp scalar.

Constructor Summary

Constructors

Constructor and Description
Zone(org.bukkit.configuration.ConfigurationSection configurationSection) Constructor.
Zone(java.lang.String name, org.bukkit.World world, org.bukkit.ChatColor color, int radius, double x, double z, Shape shape) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) void	addCustomDrop(org.bukkit.entity.EntityType entityType, org.bukkit.inventory.ItemStack itemStack) Adds a custom drop to this zone for an entity type.
(package private) void	configure(org.bukkit.entity.LivingEntity livingEntity) Configures a LivingEntity's AttributeInstance based on this zone's attributes.
(package private) boolean	contains(org.bukkit.Location location) Determines if this zone contains the given location.
(package private) java.util.Map<org.bukkit.entity.EntityType,java.util.HashSet<org.bukkit.inventory.ItemStack>>	getAllDrops() Returns all custom drops defined in this zone.
(package private) org.bukkit.ChatColor	getColor() Returns this zone's color.
(package private) java.util.HashSet<org.bukkit.inventory.ItemStack>	getCustomDrops(org.bukkit.entity.EntityType entityType) Get a custom drop for an entity type.
(package private) java.lang.String	getDescription() Returns a short description of this zone.
private java.util.HashSet<org.bukkit.inventory.ItemStack>	getDrops(org.bukkit.entity.EntityType entityType) Returns a set of all custom drops for a particular EntityType.
(package private) java.lang.String	getFormattedName() Returns this zone's name with its color applied.
java.lang.String	getName() Returns this zone's name.
(package private) int	getRadius() Returns this zone's radius.
(package private) java.util.Map<org.bukkit.attribute.Attribute,java.lang.Double>	getScalars() Returns a map of all of the scalars defined in this zone.
private void	load(org.bukkit.configuration.ConfigurationSection zoneSection) Configures this zone based on data loaded from a ConfigurationSection.
(package private) boolean	removeCustomDrop(org.bukkit.entity.EntityType entityType, org.bukkit.inventory.ItemStack itemStack) Removes an entity type's custom drop in this zone.
(package private) void	save(org.bukkit.configuration.ConfigurationSection zoneSection) Writes this zone's data to a ConfigurationSection.
(package private) int	scaleXp(int xp) Scales the given xp according to this zone's xp scalar.
(package private) void	setCenter(double x, double z) Set the center of this zone to new coordinates.
(package private) void	setScalar(org.bukkit.attribute.Attribute attribute, double value) Sets the given Attribute to the given value.
(package private) void	setXpScalar(double scalar) Sets this zone's XP scalar.

Methods inherited from class java.lang.Object

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

Field Detail

_name

private java.lang.String _name

The zone's name.

_color

private org.bukkit.ChatColor _color

The zone's color.

_center

private OrderedPair<java.lang.Double> _center

The center coordinates of this zone as an ordered pair (x, y).

_radius

private int _radius

The zone's radius, in whole blocks.

_world

private org.bukkit.World _world

The world in which this zone is located.

_shape

private Shape _shape

The shape of this zone.

_xpScalar

private double _xpScalar

This zone's xp scalar.

_scalarMap

private final java.util.Map<org.bukkit.attribute.Attribute,java.lang.Double> _scalarMap

Stores this zone's attribute scalars.

_customDrops

private final java.util.Map<org.bukkit.entity.EntityType,java.util.HashSet<org.bukkit.inventory.ItemStack>> _customDrops

Stores this zone's custom drops.

_circleFunction

private final java.util.function.BiFunction<java.lang.Double,java.lang.Double,java.lang.Boolean> _circleFunction

A function that tests if a coordinate pair is within the boundaries of this zone.

_squareFunction

private final java.util.function.BiFunction<java.lang.Double,java.lang.Double,java.lang.Boolean> _squareFunction

A function that tests if a coordinate pair is within the boundaries of this zone.

Constructor Detail

Zone

public Zone(java.lang.String name,
            org.bukkit.World world,
            org.bukkit.ChatColor color,
            int radius,
            double x,
            double z,
            Shape shape)

Constructor. Represents an arbitrary zone. A zone is an explicitly 2-dimensional but implicitly 3-dimensional manifold with a defined center and radius.

Parameters:

name - the zone's name.

world - the world in which this zone is located.

color - the zone's color.

radius - the zone's radius, in whole blocks.

x - the x-coordinate of the zone center.

z - the z-coordinate of the zone center.

shape - the Shape of the zone.

Zone

Zone(org.bukkit.configuration.ConfigurationSection configurationSection)

Constructor. Represents an arbitrary zone. A zone is an explicitly 2-dimensional but implicitly 3-dimensional manifold with a defined center and radius.

Parameters:

configurationSection - the configuration to load.

Method Detail

getName

public java.lang.String getName()

Returns this zone's name.

Returns:

this zone's name.

getColor

org.bukkit.ChatColor getColor()

Returns this zone's color.

Returns:

this zone's color.

getFormattedName

java.lang.String getFormattedName()

Returns this zone's name with its color applied. Resets its color to white.

Returns:

this zone's name with its color applied.

getDescription

java.lang.String getDescription()

Returns a short description of this zone.

Returns:

a short description of this zone.

getRadius

int getRadius()

Returns this zone's radius.

Returns:

this zone's radius.

setCenter

void setCenter(double x,
               double z)

Set the center of this zone to new coordinates.

Parameters:

x - the x coordinate of the new center.

z - the z coordinate of the new center.

contains

boolean contains(org.bukkit.Location location)

Determines if this zone contains the given location.

Parameters:

location - the location.

Returns:

if this zone contains the location.

configure

void configure(org.bukkit.entity.LivingEntity livingEntity)

Configures a LivingEntity's AttributeInstance based on this zone's attributes.

Parameters:

livingEntity - the LivingEntity to configure.

setScalar

void setScalar(org.bukkit.attribute.Attribute attribute,
               double value)

Sets the given Attribute to the given value. This only applies to mobs in this zone.

Parameters:

attribute - the attribute to set.

value - the value.

setXpScalar

void setXpScalar(double scalar)

Sets this zone's XP scalar.

Parameters:

scalar - the xp scalar to set.

scaleXp

int scaleXp(int xp)

Scales the given xp according to this zone's xp scalar.

Parameters:

xp - the xp to be scaled.

Returns:

the xp scaled according to this zone's xp scalar.

getScalars

java.util.Map<org.bukkit.attribute.Attribute,java.lang.Double> getScalars()

Returns a map of all of the scalars defined in this zone.

Returns:

a map of all of the scalars defined in this zone.

addCustomDrop

void addCustomDrop(org.bukkit.entity.EntityType entityType,
                   org.bukkit.inventory.ItemStack itemStack)

Adds a custom drop to this zone for an entity type.

Parameters:

entityType - the entity type to drop the item(s).

itemStack - the item(s).

getCustomDrops

java.util.HashSet<org.bukkit.inventory.ItemStack> getCustomDrops(org.bukkit.entity.EntityType entityType)

Get a custom drop for an entity type.

Parameters:

entityType - the entity type.

Returns:

the custom drop, if one exists.

removeCustomDrop

boolean removeCustomDrop(org.bukkit.entity.EntityType entityType,
                         org.bukkit.inventory.ItemStack itemStack)

Removes an entity type's custom drop in this zone.

Parameters:

entityType - the entity type whose drop should be removed.

itemStack - the custom drop to be removed.

Returns:

true if the entity type had a custom drop and it was removed.

getDrops

private java.util.HashSet<org.bukkit.inventory.ItemStack> getDrops(org.bukkit.entity.EntityType entityType)

Returns a set of all custom drops for a particular EntityType. May be empty but not null.

Parameters:

entityType - the entity type.

Returns:

a set of all custom drops for the given entity type.

getAllDrops

java.util.Map<org.bukkit.entity.EntityType,java.util.HashSet<org.bukkit.inventory.ItemStack>> getAllDrops()

Returns all custom drops defined in this zone.

Returns:

all custom drops defined in this zone.

save

void save(org.bukkit.configuration.ConfigurationSection zoneSection)

Writes this zone's data to a ConfigurationSection.

Parameters:

zoneSection - the ConfigurationSection.

load

private void load(org.bukkit.configuration.ConfigurationSection zoneSection)

Configures this zone based on data loaded from a ConfigurationSection.

Parameters:

zoneSection - the ConfigurationSection.