wyvern.kernel.combat
Class HitEvent

java.lang.Object
  extended bywyvern.kernel.properties.PList
      extended bywyvern.kernel.commands.EventImpl
          extended bywyvern.kernel.commands.TargetedEvent
              extended bywyvern.kernel.combat.HitEvent
All Implemented Interfaces:
Broadcaster, CommandEvent, PropertyList

public final class HitEvent
extends TargetedEvent

The event that's used in the Hit phase of the combat sequence.

Version:
1.0, Aug 21, 2003
Author:
Steve Yegge

Field Summary
 
Fields inherited from class wyvern.kernel.commands.TargetedEvent
cloneError_, location_, quantity_, target_, targetName_
 
Fields inherited from class wyvern.kernel.commands.EventImpl
agent_, appendToFile_, argString_, argStringParsed_, argv_, argvParsed_, delay_, failureMessage_, filterObjects_, filters_, handler_, map_, modified_, originalText_, playerOriginated_, redirectFile_, redirecting_, sendToAgent_, successMessage_, verb_, vetoed_, wizParsed_
 
Fields inherited from class wyvern.kernel.properties.PList
readOnly_
 
Fields inherited from interface wyvern.lib.PropertyList
PROPERTY_PACKAGE
 
Constructor Summary
HitEvent()
          Constructs a new HitEvent
HitEvent(CommandEvent initial)
          Constructs a new HitEvent
 
Method Summary
 Attack getAttack()
          Returns the weapon or attack used
 AttackType getAttackType()
          Returns the attack type.
 BodyPart getHitLocation()
          Returns Body part hit during the attack, if any.
 java.lang.String getWeaponSkill()
          Returns Weapon skill used for the event.
 void setAttack(Attack attack)
          Sets the weapon or attack used
 void setAttackType(AttackType type)
          Sets the type of attack.
 void setHitLocation(BodyPart hitLocation)
          Sets Body part hit during the attack, if any.
 void setWeaponSkill(java.lang.String weaponSkill)
          Sets Weapon skill used for the event.
 
Methods inherited from class wyvern.kernel.commands.TargetedEvent
getCloneErrorMsg, getLocation, getQuantity, getTarget, getTargetName, hasTarget, isQuantified, isTargetSpecifiedByHashcode, setLocation, setQuantified, setQuantity, setTarget, setTargetName
 
Methods inherited from class wyvern.kernel.commands.EventImpl
broadcast, broadcast, broadcast, broadcast, broadcast, checkVeto, fail, filterMessage, findAllMatches, findByHashcode, findInMap, findNeighbor, findObject, findTarget, getAgent, getArgs, getArgString, getDelay, getFailureMessage, getFilterObjects, getFilters, getHandler, getMap, getOriginalText, getRedirectFile, getSuccessMessage, getVerb, hasArgs, isAppending, isModified, isMonster, isPlayer, isPlayerOriginated, isRedirecting, isSendingToAgent, isVetoed, isWizard, main, message, message, noArgs, parseArgString, parseARGV, parseVerb, profileParsing, redirectMessage, runPostHooks, runPreHooks, searchInv, searchInvAndMapNearby, searchInvAndMapUnder, searchInvByHashcode, searchMapNearby, searchMapUnder, searchMapUnderByHashcode, setAgent, setArgs, setDelay, setFailureMessage, setHandler, setMap, setModified, setOriginalText, setPlayerOriginated, setSuccessMessage, setVerb, setVeto, toString, veto
 
Methods inherited from class wyvern.kernel.properties.PList
addProperty, addTransientProperty, adjustDoubleProperty, adjustIntProperty, adjustLongProperty, adjustTransientDoubleProperty, adjustTransientIntProperty, adjustTransientLongProperty, countLocalProperties, debugProperties, dismantlePropertyList, getDoubleProperty, getInheritedProperty, getInteger, getIntProperty, getLocalProperties, getLocalProperty, getLongProperty, getParent, getPersistentDoubleProperty, getPersistentIntProperty, getPersistentLocalProperties, getPersistentLongProperty, getPersistentProperty, getProfilingInfo, getProperties, getProperties, getPropertiesIncludingTransients, getPropertiesIncludingTransients, getProperty, getSerializableProperties, getSerializableProperty, getStringProperty, getTransientDoubleProperty, getTransientIntProperty, getTransientLongProperty, getTransientProperties, getTransientProperty, hasLocalProperty, hasPersistentProperty, hasProperty, hasTransientProperty, inheritProperty, isReadOnly, isRemoved, isTransientlyRemoved, printLocalProperties, printProperties, printProperties, printTransientProperties, removeProperty, removeTransientProperty, setDoubleProperty, setIntProperty, setLongProperty, setParent, setProperty, setReadOnly, setTransientDoubleProperty, setTransientIntProperty, setTransientLongProperty, setTransientProperty, toString, transientlyRemoveProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface wyvern.lib.PropertyList
addProperty, addTransientProperty, adjustDoubleProperty, adjustIntProperty, adjustLongProperty, adjustTransientDoubleProperty, adjustTransientIntProperty, adjustTransientLongProperty, countLocalProperties, getDoubleProperty, getInheritedProperty, getIntProperty, getLocalProperties, getLocalProperty, getLongProperty, getParent, getPersistentDoubleProperty, getPersistentIntProperty, getPersistentLocalProperties, getPersistentLongProperty, getPersistentProperty, getProperties, getProperties, getPropertiesIncludingTransients, getPropertiesIncludingTransients, getProperty, getSerializableProperties, getSerializableProperty, getStringProperty, getTransientDoubleProperty, getTransientIntProperty, getTransientLongProperty, getTransientProperties, getTransientProperty, hasLocalProperty, hasPersistentProperty, hasProperty, hasTransientProperty, inheritProperty, isReadOnly, isRemoved, isTransientlyRemoved, printLocalProperties, printProperties, printProperties, printTransientProperties, removeProperty, removeTransientProperty, setDoubleProperty, setIntProperty, setLongProperty, setParent, setProperty, setReadOnly, setTransientDoubleProperty, setTransientIntProperty, setTransientLongProperty, setTransientProperty, toString, transientlyRemoveProperty
 

Constructor Detail

HitEvent

public HitEvent()
Constructs a new HitEvent


HitEvent

public HitEvent(CommandEvent initial)
Constructs a new HitEvent

Method Detail

getAttack

public Attack getAttack()
Returns the weapon or attack used

Returns:
the weapon or attack used

setAttack

public void setAttack(Attack attack)
Sets the weapon or attack used

Parameters:
attack - the weapon or attack used

setAttackType

public void setAttackType(AttackType type)
Sets the type of attack.


getAttackType

public AttackType getAttackType()
Returns the attack type.


getWeaponSkill

public java.lang.String getWeaponSkill()
Returns Weapon skill used for the event.

Returns:
Weapon skill used for the event.

setWeaponSkill

public void setWeaponSkill(java.lang.String weaponSkill)
Sets Weapon skill used for the event.

Parameters:
weaponSkill - Weapon skill used for the event.

getHitLocation

public BodyPart getHitLocation()
Returns Body part hit during the attack, if any.

Returns:
Body part hit during the attack, if any.

setHitLocation

public void setHitLocation(BodyPart hitLocation)
Sets Body part hit during the attack, if any.

Parameters:
hitLocation - Body part hit during the attack, if any.