src/org/sevenchan/dongs/enchantment/Enchantment.as

   1 package org.sevenchan.dongs.enchantment
   2 {
   3         import org.sevenchan.dongs.Creature;
   4         import flash.utils.getQualifiedClassName;
   5         import org.sevenchan.dongs.Item;
   6         import org.sevenchan.dongs.screens.CombatScreen;
   7
   8         /**
   9          * MAGICK
  10          * @author Harbinger
  11          */
  12         public class Enchantment
  13         {
  14                 /**
  15                  * Cancel being added to new host.
  16                  */
  17                 public var cancelAddition:Boolean = false;
  18
  19                 public function Enchantment()
  20                 {
  21
  22                 }
  23
  24                 /**
  25                  * When first added to some poor sap's Enchantments
  26                  */
  27                 public function onInit(newHost:Creature):String
  28                 {
  29                         return "";
  30                 }
  31
  32                 /**
  33                  * Unique name for every enchantment (so the enchantment can remove itself).
  34                  * @return
  35                  */
  36                 public function getID():String
  37                 {
  38                         throw new Error("FATAL ERROR: " + getQualifiedClassName(this) + " does not specify a custom getID()!");
  39                         return "";
  40                 }
  41
  42                 /**
  43                  * Do stuff after host wins/loses.
  44                  * @param       hostWon
  45                  * @param       other
  46                  */
  47                 public function onCombatComplete(hostWon:Boolean, other:Creature):void
  48                 {
  49
  50                 }
  51
  52                 /**
  53                  * Do stuff when combat begins
  54                  * @param       other
  55                  */
  56                 public function onCombatInit(other:Creature):void
  57                 {
  58
  59                 }
  60
  61                 /**
  62                  * Do stuff when it's my host's turn
  63                  * @param       other
  64                  * @return Skip turn?
  65                  */
  66                 public function onMyCombatTurn(screen:CombatScreen,other:Creature):Boolean
  67                 {
  68                         return false;
  69                 }
  70
  71                 /**
  72                  * Can the player attack?
  73                  * @param       player
  74                  * @param       other
  75                  * @return
  76                  */
  77                 public function canAttack(player:Creature, other:Creature):Boolean
  78                 {
  79                         return true;
  80                 }
  81
  82                 /**
  83                  * Can the player run?
  84                  * @param       player
  85                  * @param       other
  86                  * @return
  87                  */
  88                 public function canRun(player:Creature, other:Creature):Boolean
  89                 {
  90                         return true;
  91                 }
  92
  93                 /**
  94                  * Do stuff after each screen update.
  95                  * @return
  96                  */
  97                 public function onScreenUpdate():void
  98                 {
  99                 }
 100
 101                 public static const INTERCEPT_ACTION_NONE:int = -1;
 102                 public static const INTERCEPT_ACTION_USE:int = 0;
 103                 public static const INTERCEPT_ACTION_TOSS:int = 1;
 104                 /**
 105                  * Inventory received
 106                  * @param       item
 107                  * @return intercept action
 108                  */
 109                 public function onInventoryReceived(item:Item):int { return INTERCEPT_ACTION_NONE; }
 110                 /**
 111                  * Inventory received
 112                  * @param       item
 113                  * @return intercept action
 114                  */
 115                 public function onInventorySent(item:Item):int { return INTERCEPT_ACTION_NONE; }
 116
 117                 public function getName():String
 118                 {
 119                         trace("ERROR: " + getQualifiedClassName(this) + " does not specify a custom getName()!");
 120                         return getID() + " [WIP?]";
 121                 }
 122
 123                 public function getDescr():String
 124                 {
 125                         trace("ERROR: " + getQualifiedClassName(this) + " does not specify a custom getDescr()!");
 126                         return "???";
 127                 }
 128
 129                 public static function isLockedOut(subj:Creature):Boolean
 130                 {
 131                         return subj.hasEnchantment("paralyze") || subj.hasEnchantment("hunger");
 132                 }
 133                 public static function canAttack(subj:Creature,combatant:Creature):Boolean
 134                 {
 135                         for each(var e:Enchantment in subj.enchantments)
 136                         {
 137                                 if (!e.canAttack(subj, combatant))
 138                                         return false;
 139                         }
 140                         return true;
 141                 }
 142                 public static function canRun(subj:Creature,combatant:Creature):Boolean
 143                 {
 144                         for each(var e:Enchantment in subj.enchantments)
 145                         {
 146                                 if (!e.canRun(subj, combatant))
 147                                         return false;
 148                         }
 149                         return true;
 150                 }
 151
 152                 public static function getLockoutEffectText(subj:Creature):String
 153                 {
 154                         if (subj.hasEnchantment("paralyze"))
 155                                 return "PARALYZED";
 156                         if (subj.hasEnchantment("hunger"))
 157                                 return "HUNGRY";
 158                         return "IDKLOL";
 159                 }
 160         }
 161
 162 }