org.starhope.appius.game.inventory.effects
Class SimpleMeleeWeapon

java.lang.Object
  org.starhope.appius.game.inventory.ItemEffects
      org.starhope.appius.game.inventory.effects.SimpleAbstractWeapon
          org.starhope.appius.game.inventory.effects.SimpleMeleeWeapon

public class SimpleMeleeWeapon
extends SimpleAbstractWeapon

A simple melée weapon that effects damage within a limited distance of the user.

Author:

brpocock@star-hope.org

Field Summary

Fields inherited from class org.starhope.appius.game.inventory.effects.SimpleAbstractWeapon

ammunition, attackDamage, avatarUseAction, hitAvatar, hitHandler, lastUsed, limitedAmmunition, maxAmmunition, missAvatar, missHandler, repeatRateMillis, useDelayMillis

Fields inherited from class org.starhope.appius.game.inventory.ItemEffects

item

Constructor Summary

SimpleMeleeWeapon(InventoryItem theItem)

Method Summary

void	use(String targetName, Coord3D targetCoords) The item is being used.

Methods inherited from class org.starhope.appius.game.inventory.effects.SimpleAbstractWeapon

checkAmmunition, checkRepeatRate, decreaseAmmunition, getAmmunition, getAvatarUseAction, getHitAvatar, getHitHandler, getMaxAmmunition, getMissAvatar, getMissHandler, isLimitedAmmunition, onAmmoCountChanged, setAmmunition, setAvatarUseAction, setHitAvatar, setHitHandler, setLimitedAmmunition, setMaxAmmunition, setMissAvatar, setMissHandler, setRepeatRateMillis

Methods inherited from class org.starhope.appius.game.inventory.ItemEffects

alter, canSwim, conflicts, considerAsVehicle, forItem, getDefenseGeometric, getDefenseLinear, getItem, isFloatingVehicle, isMountedAnimal, isWheeledVehicle, notifyEquipment, onDeEquip, onEquip, takeDamage

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMeleeWeapon

public SimpleMeleeWeapon(InventoryItem theItem)

Parameters:

theItem - the item being treated as a melée weapon.

Method Detail

use

public void use(String targetName,
                Coord3D targetCoords)

Description copied from class: ItemEffects

The item is being used. The optional target name and/or target coördinates may be provided.

Overrides:

use in class ItemEffects

Parameters:

targetName - a named object in the room against which the item is to be used

targetCoords - the coördinates in the room against which the item is to be used.

See Also:

ItemEffects.use(java.lang.String, org.starhope.appius.geometry.Coord3D)