myaac/system/libs/pot/OTS_Monster.php

<?php

/**#@+
 * @version 0.0.6
 * @since 0.0.6
 */

/**
 * @package POT
 * @version 0.1.3
 * @author Wrzasq <wrzasq@gmail.com>
 * @copyright 2007 - 2008 (C) by Wrzasq
 * @license http://www.gnu.org/licenses/lgpl-3.0.txt GNU Lesser General Public License, Version 3
 */

/**
 * Wrapper for monsters files DOMDocument.
 *
 * <p>
 * Note: as this class extends {@link http://www.php.net/manual/en/ref.dom.php DOMDocument class} and contains exacly file XML tree you can work on it as on normal DOM tree.
 * </p>
 *
 * @package POT
 * @version 0.1.3
 * @property-read string $name Monster name.
 * @property-read string $race Monster race.
 * @property-read int $experience Experience for killing monster.
 * @property-read int $speed Monster speed.
 * @property-read int|bool $manaCost Mana required (false if not possible).
 * @property-read int $health Hit points.
 * @property-read array $flags Flags.
 * @property-read array $voices List of sounds.
 * @property-read array $items List of possible loot.
 * @property-read array $immunities List of immunities.
 * @property-read int $defense Defense rate.
 * @property-read int $armor Armor rate.
 * @property-read array $defenses List of defenses.
 * @property-read array $attacks List of attacks.
 * @property-read array $look List of looks.
 */
class OTS_Monster extends DOMDocument
{
	private $loaded = false;
	public function loadXML(string $source , int $options = 0): bool
	{
		$this->loaded = parent::loadXML($source, $options);
		return $this->loaded;
	}

	public function loaded()
	{
		return $this->loaded;
	}
/**
 * Returns monster name.
 *
 * @return string Name.
 * @throws DOMException On DOM operation error.
 */
	public function getName()
	{
		return $this->documentElement->getAttribute('name');
	}

/**
 * Returns monster race.
 *
 * @return string Race.
 * @throws DOMException On DOM operation error.
 */
	public function getRace()
	{
		return $this->documentElement->getAttribute('race');
	}

/**
 * Returns amount of experience for killing this monster.
 *
 * @return int Experience points.
 * @throws DOMException On DOM operation error.
 */
	public function getExperience()
	{
		return (int) $this->documentElement->getAttribute('experience');
	}

/**
 * Returns monster speed.
 *
 * @return int Speed.
 * @throws DOMException On DOM operation error.
 */
	public function getSpeed()
	{
		return (int) $this->documentElement->getAttribute('speed');
	}

/**
 * Returns amount of mana required to summon this monster.
 *
 * @return int|bool Mana required (false if not possible).
 * @throws DOMException On DOM operation error.
 */
	public function getManaCost()
	{
		// check if it is possible to summon this monster
		if( $this->documentElement->hasAttribute('manacost') )
		{
			return (int) $this->documentElement->getAttribute('manacost');
		}
		else
		{
			return false;
		}
	}

/**
 * Returns monster HP.
 *
 * @return int Hit points.
 * @throws DOMException On DOM operation error.
 */
	public function getHealth()
	{
		return (int) $this->documentElement->getElementsByTagName('health')->item(0)->getAttribute('max');
	}

/**
 * Returns all monster flags (in format flagname => value).
 *
 * @return array Flags.
 * @throws DOMException On DOM operation error.
 */
	public function getFlags()
	{
		$flags = array();

		if ($this->documentElement->getElementsByTagName('flags')->item(0)) {
			foreach( $this->documentElement->getElementsByTagName('flags')->item(0)->getElementsByTagName('flag') as $flag)
			{
				$flag = $flag->attributes->item(0);

				$flags[$flag->nodeName] = (int) $flag->nodeValue;
			}
		}

		return $flags;
	}

/**
 * Returns specified flag value.
 *
 * @param string $flag Flag.
 * @return int|bool Flag value (false if not set).
 * @throws DOMException On DOM operation error.
 */
	public function getFlag($flag)
	{
		// searches for flag
		foreach( $this->documentElement->getElementsByTagName('flags')->item(0)->getElementsByTagName('flag') as $flag)
		{
			// found
			if( $flag->hasAttribute($flag) )
			{
				return (int) $flag->getAttribute($flag);
			}
		}

		// not found
		return false;
	}

/**
 * Returns voices that monster can sound.
 *
 * @return array List of voices.
 * @throws DOMException On DOM operation error.
 */
	public function getVoices()
	{
		$voices = array();

		$element = $this->documentElement->getElementsByTagName('voices')->item(0);

		// checks if it has any voices
		if( isset($element) )
		{
			// loads all voices
			foreach( $element->getElementsByTagName('voice') as $voice)
			{
				$voices[] = $voice->getAttribute('sentence');
			}
		}

		return $voices;
	}

/**
 * @return array List of item IDs.
 */
	public function getLoot()
	{
		$loot = array();

		$element = $this->documentElement->getElementsByTagName('loot')->item(0);

		// checks if it has any loot
		if( isset($element) )
		{
			// adds all items
			foreach( $element->getElementsByTagName('item') as $item)
			{
				$chance = $item->getAttribute('chance');
				if(empty($chance)) {
					$chance = $item->getAttribute('chance1');
					if(empty($chance)) {
						$chance = 100000;
					}
				}

				$count = $item->getAttribute('countmax');
				if(empty($count)) {
					$count = 1;
				}

				$id = $item->getAttribute('id');
				if(empty($id)) {
					$id = $item->getAttribute('name');
				}

				$loot[] = array('id' => $id, 'count' => $count, 'chance' => $chance);
			}
		}

		return $loot;
	}

/**
 * Returns all possible loot.
 *
 * <p>
 * In order to use this method you have to have global items list loaded.
 * </p>
 *
 * @version 0.1.0
 * @since 0.1.0
 * @return array List of item types.
 * @throws E_OTS_NotLoaded When there is no items list available in global POT instance.
 * @throws DOMException On DOM operation error.
 */
	public function getItems()
	{
		$loot = array();
		$keys = array();
		$items = POT::getInstance()->getItemsList();

		$element = $this->documentElement->getElementsByTagName('loot')->item(0);

		// checks if it has any loot
		if( isset($element) )
		{
			// adds all items
			foreach( $element->getElementsByTagName('item') as $item)
			{
				$id = $item->getAttribute('id');

				// avoid redundancy
				if( !in_array($id, $keys) )
				{
					$keys[] = $id;
					$loot[] = $items->getItemType($id);
				}
			}
		}

		return $loot;
	}

/**
 * Returns look of the monster.
 *
 * @return array Look with all the attributes of the look.
 * @throws DOMException On DOM operation error.
 */
	public function getLook()
	{
		$look = array();

		$element = $this->documentElement->getElementsByTagName('look')->item(0);

		if (!$element) {
			return $look;
		}

		$look['type'] = $element->getAttribute('type');
		$look['typeex'] = $element->getAttribute('typeex');
		$look['head'] = $element->getAttribute('head');
		$look['body'] = $element->getAttribute('body');
		$look['legs'] = $element->getAttribute('legs');
		$look['feet'] = $element->getAttribute('feet');
		$look['addons'] = $element->getAttribute('addons');
		$look['corpse'] = $element->getAttribute('corpse');

		return $look;
	}

/**
 * Returns all monster summons.
 *
 * @return array elements.
 * @throws DOMException On DOM operation error.
 */

	public function getSummons()
	{
		$summons = array();

		$element = $this->documentElement->getElementsByTagName('summons')->item(0);

		// checks if it has any Summons
		if( isset($element) )
		{
			// adds all summons
			foreach( $element->getElementsByTagName('summon') as $item)
			{
				$chance = $item->getAttribute('chance');
				$id = $item->getAttribute('name');
				$summons[] = array('name' => $id, 'chance' => $chance);
			}
		}
		return $summons;
	}

/**
 * Returns all monster elements.
 *
 * @return array elements.
 * @throws DOMException On DOM operation error.
 */
	public function getElements()
	{
		$elements = array();

		$element = $this->documentElement->getElementsByTagName('elements')->item(0);

		// checks if it has any elements
		if( isset($element) )
		{
			// read all elements
			foreach( $element->getElementsByTagName('element') as $elementv)
			{
				$elementv = $elementv->attributes->item(0);

				// checks if element is set
				if($elementv->nodeValue > 0)
				{
					 $elements[] = array('name' => ucfirst(str_replace('Percent', '', $elementv->nodeName)), 'percent' => $elementv->nodeValue);
				}
			}
		}

		return $elements;
	}

/**
 * Checks if monster has given element.
 *
 * @param string $name element to check.
 * @return bool element state.
 * @throws DOMException On DOM operation error.
 */
	public function hasElement($name)
	{
		$element = $this->documentElement->getElementsByTagName('elements')->item(0);

		// if doesn't have any elements obviously doesn't have this one too
		if( isset($element) )
		{
			// read all elements
			foreach( $element->getElementsByTagName('element') as $element)
			{
				// checks if this is what we are searching for
				if( $element->hasAttribute($name) )
				{
					return $element->getAttribute($name) > 0;
				}
			}
		}

		return false;
	}

/**
 * Returns all monster immunities.
 *
 * @return array Immunities.
 * @throws DOMException On DOM operation error.
 */
	public function getImmunities()
	{
		$immunities = array();

		$element = $this->documentElement->getElementsByTagName('immunities')->item(0);

		// checks if it has any immunities
		if( isset($element) )
		{
			// read all immunities
			foreach( $element->getElementsByTagName('immunity') as $immunity)
			{
				$immunity = $immunity->attributes->item(0);

				// checks if immunity is set
				if($immunity->nodeValue > 0)
				{
					$immunities[] = $immunity->nodeName;
				}
			}
		}

		return $immunities;
	}

/**
 * Checks if monster has given immunity.
 *
 * @param string $name Immunity to check.
 * @return bool Immunity state.
 * @throws DOMException On DOM operation error.
 */
	public function hasImmunity($name)
	{
		$element = $this->documentElement->getElementsByTagName('immunities')->item(0);

		// if doesn't have any immunities obviously doesn't have this one too
		if( isset($element) )
		{
			// read all immunities
			foreach( $element->getElementsByTagName('immunity') as $immunity)
			{
				// checks if this is what we are searching for
				if( $immunity->hasAttribute($name) )
				{
					return $immunity->getAttribute($name) > 0;
				}
			}
		}

		return false;
	}

/**
 * Returns monster defense rate.
 *
 * @return int Defense rate.
 * @throws DOMException On DOM operation error.
 */
	public function getDefense()
	{
		$element = $this->documentElement->getElementsByTagName('defenses')->item(0);

		// checks if defenses element is set
		if( isset($element) )
		{
			return (int) $element->getAttribute('defense');
		}

		return 0;
	}

/**
 * Returns monster armor.
 *
 * @return int Armor rate.
 * @throws DOMException On DOM operation error.
 */
	public function getArmor()
	{
		$element = $this->documentElement->getElementsByTagName('defenses')->item(0);

		// checks if defenses element is set
		if( isset($element) )
		{
			return (int) $element->getAttribute('armor');
		}

		return 0;
	}

/**
 * Returns list of special defenses.
 *
 * @return array List of defense effects.
 * @throws DOMException On DOM operation error.
 */
	public function getDefenses()
	{
		$defenses = array();

		$element = $this->documentElement->getElementsByTagName('defenses')->item(0);

		// checks if it has any defenses
		if( isset($element) )
		{
			foreach( $element->getElementsByTagName('defense') as $defense)
			{
				$defenses[] = $defense->getAttribute('name');
			}
		}

		return $defenses;
	}

/**
 * Returns list of monster attacks.
 *
 * @return array List of attafck effects.
 * @throws DOMException On DOM operation error.
 */
	public function getAttacks()
	{
		$attacks = array();

		$element = $this->documentElement->getElementsByTagName('attacks')->item(0);

		// checks if it has any defenses
		if( isset($element) )
		{
			foreach( $element->getElementsByTagName('attack') as $attack)
			{
				$attacks[] = $attack->getAttribute('name');
			}
		}

		return $attacks;
	}

/**
 * Magic PHP5 method.
 *
 * @version 0.1.0
 * @since 0.1.0
 * @param string $name Property name.
 * @return mixed Property value.
 * @throws OutOfBoundsException For non-supported properties.
 * @throws DOMException On DOM operation error.
 */
	public function __get($name)
	{
		switch($name)
		{
			case 'name':
				return $this->getName();

			case 'race':
				return $this->getRace();

			case 'experience':
				return $this->getExperience();

			case 'speed':
				return $this->getSpeed();

			case 'manaCost':
				return $this->getManaCost();

			case 'health':
				return $this->getHealth();

			case 'flags':
				return $this->getFlags();

			case 'voices':
				return $this->getVoices();

			case 'items':
				return $this->getItems();

			case 'immunities':
				return $this->getImmunities();

			case 'defense':
				return $this->getDefense();

			case 'armor':
				return $this->getArmor();

			case 'defenses':
				return $this->getDefenses();

			case 'attacks':
				return $this->getAttacks();

			case 'look':
				return $this->getLook();

			default:
				throw new OutOfBoundsException();
		}
	}

/**
 * Returns string representation of XML.
 *
 * <p>
 * If any display driver is currently loaded then it uses it's method. Otherwise just returns monster XML content.
 * </p>
 *
 * @version 0.1.3
 * @since 0.1.0
 * @return string String representation of object.
 */
	public function __toString()
	{
		$ots = POT::getInstance();

		// checks if display driver is loaded
		if( $ots->isDataDisplayDriverLoaded() )
		{
			return $ots->getDataDisplayDriver()->displayMonster($this);
		}

		return $this->saveXML();
	}
}

/**#@-*/

?>