aboutsummaryrefslogtreecommitdiffstats
path: root/inc/Monster.inc
diff options
context:
space:
mode:
Diffstat (limited to 'inc/Monster.inc')
-rw-r--r--inc/Monster.inc44
1 files changed, 41 insertions, 3 deletions
diff --git a/inc/Monster.inc b/inc/Monster.inc
index c7063ec..4450b59 100644
--- a/inc/Monster.inc
+++ b/inc/Monster.inc
@@ -1,20 +1,58 @@
<?php
-
+/**
+ * Represent an Item in the shop or in the Inventory.
+ *
+ * @author Alexandre Renoux
+ * @author Pierre-Emmanuel Novac
+ */
class Monster {
+ /**
+ * Name of the Monster.
+ */
public $name = "";
+
+ /**
+ * Monster's icon.
+ */
public $icon = "";
- public $desc = "";
+
+ /**
+ * Monster's description.
+ */
+ public $desc = ""; // TODO: unused
+
+ /**
+ * HP of the Monster.
+ */
public $hp = 1;
+
+ /**
+ * Exp given by this monster.
+ */
public $xp = 0;
+
+ /**
+ * Monster's level.
+ */
public $level = 1;
+
+ /**
+ * Monster's constructor
+ *
+ * @param string $name Monster's name
+ * @param int $level Monster's level
+ * @param int $hp Monster's HP
+ * @param int $xp Exp given by the Monster
+ * @param string $icon Item's icon
+ * @return void
+ */
function __construct($name, $level, $hp, $xp, $icon) {
$this->name = $name;
$this->level = $level;
$this->hp = $hp;
$this->xp = $xp;
$this->icon = $icon;
-
}
}