com.bermudalocket.smartmobs.attack

Class AbstractSpecialAttack

java.lang.Object

com.bermudalocket.smartmobs.attack.AbstractSpecialAttack

All Implemented Interfaces:

org.bukkit.event.Listener

Direct Known Subclasses:

Bloat, Chemistry, EnderDance, Flamethrower, Greneggs, Resurrection

public abstract class AbstractSpecialAttack
extends java.lang.Object
implements org.bukkit.event.Listener

Represents an abstract special attack. The idea is that an attack class is only instantiated once (when the plugin loads), but can be fired many times. This prevents needless garbage collecting and reinstatiation. During construction, an attack is given a specific Event class to listen to. The creator can then override the this#checkConditions method to fine-tune when this attack should occur.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_enabled The state of this attack.
private java.util.Set<AbstractModule>	_modules The modules set for this attack.
private java.lang.String	_name The name of this attack.

Constructor Summary

Constructors

Constructor and Description
AbstractSpecialAttack(java.lang.String name, java.lang.Class<? extends org.bukkit.event.Event> eventClass, AbstractModule... modules) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) abstract boolean	checkConditions(org.bukkit.event.Event event) An abstract method to be implemented when a new AbstractSpecialAttack is created.
(package private) static boolean	checkDefaultConditions(org.bukkit.event.entity.EntityDamageByEntityEvent event, org.bukkit.entity.LivingEntity e, java.util.Set<org.bukkit.entity.EntityType> supportedMobs)
private boolean	checkEligibility(org.bukkit.event.Event event) Checks an event's eligibility to cause this attack to occcur.
(package private) abstract void	doAttack(org.bukkit.event.Event event) A method to implement all of the logic behind the attack, i.e.
private void	dynamicallyRegisterEvent(java.lang.Class<? extends org.bukkit.event.Event> eventClass) Dynamically registers this class as a listener for the Event class defined during construction.
AbstractModule	getModule(ModuleType moduleType) Returns this attack's module corresponding to the given ModuleType.
java.util.Set<AbstractModule>	getModules() Returns all modules defined for this attack.
java.lang.String	getName() Returns this attack's name.
void	load(org.bukkit.configuration.ConfigurationSection configurationSection) Deserializes this attack's modules.
void	save(org.bukkit.configuration.ConfigurationSection configurationSection) Serializes this attack's modules.
void	setEnabled(boolean state) Sets the state of this attack.

Methods inherited from class java.lang.Object

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

Field Detail

_name

private final java.lang.String _name

The name of this attack.

_enabled

private boolean _enabled

The state of this attack.

_modules

private final java.util.Set<AbstractModule> _modules

The modules set for this attack.

Constructor Detail

AbstractSpecialAttack

AbstractSpecialAttack(java.lang.String name,
                      java.lang.Class<? extends org.bukkit.event.Event> eventClass,
                      AbstractModule... modules)

Constructor.

Parameters:

name - the name of this attack.

eventClass - the Event class this attack should listen to.

modules - the AbstractModules this attack uses.

Method Detail

setEnabled

public void setEnabled(boolean state)

Sets the state of this attack.

Parameters:

state - the state.

dynamicallyRegisterEvent

private void dynamicallyRegisterEvent(java.lang.Class<? extends org.bukkit.event.Event> eventClass)

Dynamically registers this class as a listener for the Event class defined during construction.

Parameters:

eventClass - the Event class.

checkEligibility

private boolean checkEligibility(org.bukkit.event.Event event)

Checks an event's eligibility to cause this attack to occcur.

Parameters:

event - the event.

Returns:

true if the event can cause this attack to occur.

getModule

public AbstractModule getModule(ModuleType moduleType)

Returns this attack's module corresponding to the given ModuleType.

Parameters:

moduleType - the ModuleType.

Returns:

the AbstractModule.

getModules

public java.util.Set<AbstractModule> getModules()

Returns all modules defined for this attack.

Returns:

all modules defined for this attack.

getName

public java.lang.String getName()

Returns this attack's name.

Returns:

this attack's name.

checkConditions

abstract boolean checkConditions(org.bukkit.event.Event event)

An abstract method to be implemented when a new AbstractSpecialAttack is created. Offers more customizability than the standard checkEligibility(Event) method.

Parameters:

event - the event.

Returns:

true if the event can cause this attack to occur.

checkDefaultConditions

static boolean checkDefaultConditions(org.bukkit.event.entity.EntityDamageByEntityEvent event,
                                      org.bukkit.entity.LivingEntity e,
                                      java.util.Set<org.bukkit.entity.EntityType> supportedMobs)

doAttack

abstract void doAttack(org.bukkit.event.Event event)

A method to implement all of the logic behind the attack, i.e. dealing damage, summoning entities, etc. The Event parameter is included in order to facilitate access to relevant information, i.e. the entity/entities involved.

Parameters:

event - the event which triggered the attack.

save

public void save(org.bukkit.configuration.ConfigurationSection configurationSection)

Serializes this attack's modules.

Parameters:

configurationSection - the ConfigurationSection to save to.

load

public void load(org.bukkit.configuration.ConfigurationSection configurationSection)

Deserializes this attack's modules.

Parameters:

configurationSection - the ConfigurationSection to read from.