EquipUtil.java :  » Game » Arianne-RPG-0.83 » games » stendhal » server » actions » equip » Java Open Source

package games.stendhal.server.actions.equip;

import games.stendhal.server.core.engine.StendhalRPZone;
import games.stendhal.server.entity.Entity;
import games.stendhal.server.entity.player.Player;

import java.util.List;

import marauroa.common.game.RPObject;

import org.apache.log4j.Logger;

/**
 * Useful method to deal with equipable items.
 */
public class EquipUtil {
  private static Logger logger = Logger.getLogger(EquipUtil.class);
  
  /**
   * The maximum distance a player can throw an item away from himself.
   */
  protected static final int MAX_THROWING_DISTANCE = 8;

  /**
   * Gets the object for the given id. Returns null when the item is not
   * available. Failure is written to the logger.
   * 
   * @param player
   *            the player
   * @param objectId
   *            the objects id
   * @return the object with the given id or null if the object is not
   *         available.
   */
  static Entity getEntityFromId(final Player player, final int objectId) {
    final StendhalRPZone zone = player.getZone();
    final RPObject.ID id = new RPObject.ID(objectId, zone.getID());

    if (!zone.has(id)) {
      logger.debug("Rejected because zone doesn't have object "
          + objectId);
      return null;
    }

    return (Entity) zone.get(id);
  }

  /**
   * Checks if the object is of one of the given class or one of its children.
   * 
   * @param validClasses
   *            list of valid class-objects
   * @param object
   *            the object to check
   * @return true when the class is in the list, else false
   */
  static boolean isCorrectClass(final List<Class< ? >> validClasses, final RPObject object) {
    for (final Class< ? > clazz : validClasses) {
      if (clazz.isInstance(object)) {
        return true;
      }
    }
    logger.debug("object " + object.getID()
        + " is not of the correct class. it is "
        + object.getClass().getName());
    return false;
  }
}