telyn / c2ephp

agents/COB/AgentBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -104,7 +104,7 @@ 
         return $this->eventScripts[$whichScript];
     }
     /// @brief Gets the thumbnail of this agent as would be shown in the Injector
-    /** @return A SpriteFrame of the thumbnail
+    /** @return SpriteFrame SpriteFrame of the thumbnail
      */
     public function GetThumbnail() {
         return $this->thumbnail;
@@ -380,7 +380,7 @@ 
     /// @endcond
 
     /// @brief Creates a new COBDependency
-    /** @param $type The type of dependency ('sprite' or 'sound').
+    /** @param string $type The type of dependency ('sprite' or 'sound').
      * @param $name The name of the dependency (four characters, no file extension)
      */
     public function COBDependency($type,$name) {

Spacing +39 added lines, -39 removed lines

@@ -12,9 +12,9 @@ 
  */
 //@{
 /** Sprite dependency - 'sprite' */
-define('DEPENDENCY_SPRITE','sprite');
+define('DEPENDENCY_SPRITE', 'sprite');
 /** Sound dependency - 'sound' */
-define('DEPENDENCY_SOUND','sound');
+define('DEPENDENCY_SOUND', 'sound');
 //@}
 
 
@@ -54,7 +54,7 @@ 
      * @param $agentName The name of the agent (as displayed in the C2 injector)
      * @param $agentDescription The description of the agent (as displayed in the C2 injector)
      */
-    public function COBAgentBlock($agentName,$agentDescription) {
+    public function COBAgentBlock($agentName, $agentDescription) {
         parent::COBBlock(COB_BLOCK_AGENT);
         $this->agentName = $agentName;
         $this->agentDescription = $agentDescription;
@@ -115,10 +115,10 @@ 
      * above.
      * @return An array of COBDependency objects
      */
-    public function GetDependencies($type=null) {
+    public function GetDependencies($type = null) {
         $dependenciesToReturn = array();
-        foreach($this->dependencies as $dependency) {
-            if($type == null || $type == $dependency->GetType()) {
+        foreach ($this->dependencies as $dependency) {
+            if ($type == null || $type == $dependency->GetType()) {
                 $dependenciesToReturn[] = $dependency;
             }
         }
@@ -153,7 +153,7 @@ 
      * @param $dependency The COBDependency to add.
      */
     public function AddDependency(COBDependency $dependency) { 
-        if(!in_array($dependency->GetDependencyName(),$this->dependencies)) {
+        if (!in_array($dependency->GetDependencyName(), $this->dependencies)) {
             $this->dependencies[] = $dependency;
         }
     }
@@ -183,7 +183,7 @@ 
      * @param $time The date this agent was last injected as a UNIX timestamp
      */
     public function SetLastUsageDate($time) {
-        if($time > time()) {
+        if ($time > time()) {
             return false;
         } else {
             $this->lastUsageDate = $time;
@@ -217,7 +217,7 @@ 
      * @param $reserved2 The second reserved variable
      * @param $reserved3 The third reserved variable
      */
-    public function SetReserved($reserved1,$reserved2,$reserved3) {
+    public function SetReserved($reserved1, $reserved2, $reserved3) {
         $this->reserved1 = $reserved1;
         $this->reserved2 = $reserved2;
         $this->reserved3 = $reserved3;
@@ -226,7 +226,7 @@ 
     /** @param $frame The thumbnail as a SpriteFrame 
      */
     public function SetThumbnail(SpriteFrame $frame) {
-        if($this->thumbnail != null) {
+        if ($this->thumbnail != null) {
             throw new Exception('Thumbnail already added');
         }
         $this->thumbnail = $frame;
@@ -237,7 +237,7 @@ 
      * @param IReader $reader A StringReader or FileReader for the RCB
      */
     public function AddC1RemoveScriptFromRCB(IReader $reader) {
-        if($this->removeScript != '') {
+        if ($this->removeScript != '') {
             throw new Exception('Script already added!');
         }
         $rcb = new COB($reader);
@@ -253,7 +253,7 @@ 
      */
     public static function CreateFromReaderC2(IReader $reader) {
         $quantityAvailable = $reader->ReadInt(2);
-        if($quantityAvailable == 0xffff) {
+        if ($quantityAvailable == 0xffff) {
             $quantityAvailable = -1;
         }       
         $lastUsageDate = $reader->ReadInt(4);
@@ -262,50 +262,50 @@ 
         $expiryDay = $reader->ReadInt(1);
         $expiryMonth = $reader->ReadInt(1);
         $expiryYear = $reader->ReadInt(2);
-        $expiryDate = mktime(0,0,0,$expiryMonth,$expiryDay,$expiryYear);
+        $expiryDate = mktime(0, 0, 0, $expiryMonth, $expiryDay, $expiryYear);
 
-        $reserved = array($reader->ReadInt(4),$reader->ReadInt(4),$reader->ReadInt(4));
+        $reserved = array($reader->ReadInt(4), $reader->ReadInt(4), $reader->ReadInt(4));
 
         $agentName = $reader->ReadCString();
         $agentDescription = $reader->ReadCString();
 
-        $installScript = str_replace(',',"\n",$reader->ReadCString());
-        $removeScript = str_replace(',',"\n",$reader->ReadCString());
+        $installScript = str_replace(',', "\n", $reader->ReadCString());
+        $removeScript = str_replace(',', "\n", $reader->ReadCString());
 
         $numEventScripts = $reader->ReadInt(2);
 
         $eventScripts = array();
 
-        for($i=0;$i<$numEventScripts;$i++) {
-            $eventScripts[] = str_replace(',',"\n",$reader->ReadCString());
+        for ($i = 0; $i < $numEventScripts; $i++) {
+            $eventScripts[] = str_replace(',', "\n", $reader->ReadCString());
         }
         $numDependencies = $reader->ReadInt(2);
         $dependencies = array();
 
-        for($i=0;$i<$numDependencies;$i++) {
-            $type = ($reader->ReadInt(2) == 0)?DEPENDENCY_SPRITE:DEPENDENCY_SOUND;
+        for ($i = 0; $i < $numDependencies; $i++) {
+            $type = ($reader->ReadInt(2) == 0) ? DEPENDENCY_SPRITE : DEPENDENCY_SOUND;
             $name = $reader->ReadCString();
-            $dependencies[] = new COBDependency($type,$name);
+            $dependencies[] = new COBDependency($type, $name);
         }
         $thumbWidth = $reader->ReadInt(2);
         $thumbHeight = $reader->ReadInt(2);
 
-        $thumbnail = new S16Frame($reader,'565',$thumbWidth,$thumbHeight,$reader->GetPosition());
+        $thumbnail = new S16Frame($reader, '565', $thumbWidth, $thumbHeight, $reader->GetPosition());
         $reader->Skip($thumbHeight*$thumbWidth*2);
 
         //parsing finished, onto making an AgentBlock.
-        $agentBlock = new COBAgentBlock($agentName,$agentDescription);
+        $agentBlock = new COBAgentBlock($agentName, $agentDescription);
         $agentBlock->AddQuantityAvailable($quantityAvailable);
         $agentBlock->AddReuseInterval($reuseInterval);
         $agentBlock->AddExpiryDate($expiryDate);
         $agentBlock->AddLastUsageDate($lastUsageDate);
-        $agentBlock->AddReserved($reserved[0],$reserved[1],$reserved[2]);
+        $agentBlock->AddReserved($reserved[0], $reserved[1], $reserved[2]);
         $agentBlock->AddInstallScript($installScript);
         $agentBlock->AddRemoveScript($removeScript);
-        foreach($eventScripts as $eventScript) {
+        foreach ($eventScripts as $eventScript) {
             $agentBlock->AddEventScript($eventScript);
         }
-        foreach($dependencies as $dependency) {
+        foreach ($dependencies as $dependency) {
             $agentBlock->AddDependency($dependency);
         }
         $agentBlock->AddThumbnail($thumbnail);
@@ -319,27 +319,27 @@ 
      * 
      */
     public static function CreateFromReaderC1(IReader $reader) {
-        $quantityAvailable  = $reader->ReadInt(2);
+        $quantityAvailable = $reader->ReadInt(2);
         $expires_month = $reader->ReadInt(4);
         $expires_day = $reader->ReadInt(4);
         $expires_year = $reader->ReadInt(4);
-        $expiryDate = mktime(0,0,0,$expires_month,$expires_day,$expires_year);
+        $expiryDate = mktime(0, 0, 0, $expires_month, $expires_day, $expires_year);
 
         $numObjectScripts = $reader->ReadInt(2);
         $numInstallScripts = $reader->ReadInt(2);
         $quantityUsed = $reader->ReadInt(4);
         $objectScripts = array();
-        for($i=0;$i<$numObjectScripts;$i++) {
+        for ($i = 0; $i < $numObjectScripts; $i++) {
             $scriptsize = $reader->ReadInt(1);
-            if($scriptsize == 255) {
+            if ($scriptsize == 255) {
                 $scriptsize = $reader->ReadInt(2);
             }
             $objectScripts[$i] = $reader->Read($scriptsize);
         }
         $installScripts = array();
-        for($i=0;$i<$numInstallScripts;$i++) {
+        for ($i = 0; $i < $numInstallScripts; $i++) {
             $scriptsize = $reader->ReadInt(1);
-            if($scriptsize == 255) {
+            if ($scriptsize == 255) {
                 $scriptsize = $reader->ReadInt(2);
             }
             $installScripts[$i] = $reader->Read($scriptsize);
@@ -348,23 +348,23 @@ 
         $pictureHeight = $reader->ReadInt(4);
         $unknown = $reader->ReadInt(2);
         $sprframe = null;
-        if($pictureWidth > 0 || $pictureHeight > 0) {
-            $sprframe = new SPRFrame($reader,$pictureWidth,$pictureHeight);
+        if ($pictureWidth > 0 || $pictureHeight > 0) {
+            $sprframe = new SPRFrame($reader, $pictureWidth, $pictureHeight);
             $sprframe->Flip(); 
         }
 
         $agentName = $reader->Read($reader->ReadInt(1));
 
-        $agentBlock = new COBAgentBlock($agentName,'');
+        $agentBlock = new COBAgentBlock($agentName, '');
         $agentBlock->AddQuantityAvailable($quantityAvailable);
         $agentBlock->AddExpiryDate($expiryDate);
-        if($sprframe != null) {
+        if ($sprframe != null) {
             $agentBlock->AddThumbnail($sprframe);
         }
-        foreach($objectScripts as $objectScript) {
+        foreach ($objectScripts as $objectScript) {
             $agentBlock->AddEventScript($objectScript);
         }
-        $agentBlock->AddInstallScript(implode("\n*c2ephp Install script seperator\n",$installScripts));
+        $agentBlock->AddInstallScript(implode("\n*c2ephp Install script seperator\n", $installScripts));
         return $agentBlock;
     }
     /// @endcond
@@ -383,7 +383,7 @@ 
     /** @param $type The type of dependency ('sprite' or 'sound').
      * @param $name The name of the dependency (four characters, no file extension)
      */
-    public function COBDependency($type,$name) {
+    public function COBDependency($type, $name) {
         $this->type = $type;
         $this->name = $name;
     }

agents/COB/FileBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 
 	/// @brief Constructs a new COBFileBlock
     /**
-     * @param $type The file type
+     * @param string $type The file type
 	 * @param $name The file name (including extension)
 	 * @param $contents The contents of the file
 	 */

Indentation +34 added lines, -34 removed lines

@@ -6,38 +6,38 @@ 
 
     /// @cond INTERNAL_DOCS
     //
-	private $fileType;
-	private $fileName;
+    private $fileType;
+    private $fileName;
 	
-	private $reserved;
+    private $reserved;
     private $contents;
 
     /// @endcond
 
-	/// @brief Constructs a new COBFileBlock
+    /// @brief Constructs a new COBFileBlock
     /**
      * @param $type The file type
-	 * @param $name The file name (including extension)
-	 * @param $contents The contents of the file
-	 */
-	public function COBFileBlock($type,$name,$contents) {
-		parent::COBBlock(COB_BLOCK_FILE);
-		$this->fileType = $type;
-		$this->fileName = $name;
-		$this->contents = $contents;
+     * @param $name The file name (including extension)
+     * @param $contents The contents of the file
+     */
+    public function COBFileBlock($type,$name,$contents) {
+        parent::COBBlock(COB_BLOCK_FILE);
+        $this->fileType = $type;
+        $this->fileName = $name;
+        $this->contents = $contents;
     }
 
-	/// @brief Add the reserved data associated with this file block
+    /// @brief Add the reserved data associated with this file block
     /**
      * @param $reserved The reserved data
-	 */
-	public function AddReserved($reserved) {
-		$this->reserved = $reserved;
+     */
+    public function AddReserved($reserved) {
+        $this->reserved = $reserved;
     }
 
     /// @brief Get the name of the file
-	public function GetName() {
-		return $this->fileName;
+    public function GetName() {
+        return $this->fileName;
     }
 
     /// @brief Get the file's type
@@ -45,13 +45,13 @@ 
      * @return 'sprite' or 'sound' - i.e. one of the
      * COB_DEPENDENCY_* constants in COBAgentBlock
      */
-	public function GetFileType() {
-		return $this->fileType;
+    public function GetFileType() {
+        return $this->fileType;
     }
 
     /// @brief Get the contents of the file.
-	public function GetContents() {
-		return $this->contents;
+    public function GetContents() {
+        return $this->contents;
     }
 
     /// @brief Get the reserved data
@@ -59,8 +59,8 @@ 
      * Reserved data was never officially used.
      * @return A 4-byte integer.
      */
-	public function GetReserved() {
-		return $this->reserved;
+    public function GetReserved() {
+        return $this->reserved;
     }
 
     /// @cond INTERNAL_DOCS
@@ -68,16 +68,16 @@ 
     /// @brief Creates a new COBFileBlock from an IReader
     /**
      * @param $reader The reader the data's coming from
-	 */
-	public static function CreateFromReader(IReader $reader) {
-		$type = ($reader->ReadInt(2)==0)?'sprite':'sound';
-		$reserved = $reader->ReadInt(4);
-		$size = $reader->ReadInt(4);
-		$fileName = $reader->ReadCString();
-		$contents = $reader->Read($size);
-		$block = new COBFileBlock($type,$fileName,$contents);
-		$block->AddReserved($reserved);
-		return $block;
+     */
+    public static function CreateFromReader(IReader $reader) {
+        $type = ($reader->ReadInt(2)==0)?'sprite':'sound';
+        $reserved = $reader->ReadInt(4);
+        $size = $reader->ReadInt(4);
+        $fileName = $reader->ReadCString();
+        $contents = $reader->Read($size);
+        $block = new COBFileBlock($type,$fileName,$contents);
+        $block->AddReserved($reserved);
+        return $block;
     }
     /// @endcond
 }

Spacing +3 added lines, -3 removed lines

@@ -20,7 +20,7 @@ 
 	 * @param $name The file name (including extension)
 	 * @param $contents The contents of the file
 	 */
-	public function COBFileBlock($type,$name,$contents) {
+	public function COBFileBlock($type, $name, $contents) {
 		parent::COBBlock(COB_BLOCK_FILE);
 		$this->fileType = $type;
 		$this->fileName = $name;
@@ -70,12 +70,12 @@ 
      * @param $reader The reader the data's coming from
 	 */
 	public static function CreateFromReader(IReader $reader) {
-		$type = ($reader->ReadInt(2)==0)?'sprite':'sound';
+		$type = ($reader->ReadInt(2) == 0) ? 'sprite' : 'sound';
 		$reserved = $reader->ReadInt(4);
 		$size = $reader->ReadInt(4);
 		$fileName = $reader->ReadCString();
 		$contents = $reader->Read($size);
-		$block = new COBFileBlock($type,$fileName,$contents);
+		$block = new COBFileBlock($type, $fileName, $contents);
 		$block->AddReserved($reserved);
 		return $block;
     }

agents/CreatureHistory/CreatureHistory.php

Doc Comments +8 added lines, -8 removed lines

@@ -43,8 +43,8 @@ 
 
     /// @brief Construct a CreatureHistory object.
     /**
-     * @param $moniker The moniker of the creature
-     * @param $name The creature's name
+     * @param false|string $moniker The moniker of the creature
+     * @param false|string $name The creature's name
      * @param $gender The creature's gender
      * @param $genus The creature's genus (Grendel, ettin, norn, geat)
      * @param $species The creature's species (unsure of purpose)  
@@ -60,7 +60,7 @@ 
     /// @brief Compiles the CreatureHistory into CreaturesArchive data.
     /**
      * @param $format GLST_FORMAT_C3 or GLST_FORMAT_DS.
-     * @return A binary string ready for archiving and putting in a GLST block. 
+     * @return string binary string ready for archiving and putting in a GLST block. 
      */
     public function Compile($format=GLST_FORMAT_C3) {
         $data = '';
@@ -93,7 +93,7 @@ 
     /**
      * This is done by working out whether any DS-specific variables
      * are set.
-     * @return GLST_FORMAT_DS or GLST_FORMAT_C3.
+     * @return integer or GLST_FORMAT_C3.
      */
     public function GuessFormat() {
         return (isset($this->unknown1))?GLST_FORMAT_DS:GLST_FORMAT_C3;
@@ -112,7 +112,7 @@ 
     /**
      * Simply gets the nth event that happened in this history
      * @param $n the event number to get
-     * @return the $nth CreatureHistoryEvent 
+     * @return CreatureHistoryEvent $nth CreatureHistoryEvent 
      */
     public function GetEvent($n) {
         return $this->events[$n];
@@ -153,7 +153,7 @@ 
 
     /// Gets all the events in this history
     /**
-     * @return An array of CreatureHistoryEvents 
+     * @return CreatureHistoryEvent[] array of CreatureHistoryEvents 
      */
     public function GetEvents() {
         return $this->events;
@@ -229,7 +229,7 @@ 
     /**
      * This calls SetC3Unknown
      * @param $unknown1 First unknown variable
-     * @param $unknown2 Second unknown variable
+     * @param false|string $unknown2 Second unknown variable
      */
     public function SetDSUnknowns($unknown1,$unknown2) {
         $this->unknown1 = $unknown1;
@@ -238,7 +238,7 @@ 
 
     /// @brief Sets whether or not the creature is a veteran of the warp (DS only)
     /**
-     * @param $warpveteran A boolean (I think!)
+     * @param integer $warpveteran A boolean (I think!)
      */
     public function SetWarpVeteran($warpveteran) {
         $this->warpveteran = $warpveteran;

Indentation +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
      * @param $n the event number to remove
      */
     public function RemoveEvent($n) {
-       unset($this->events[$n]); 
+        unset($this->events[$n]); 
     }
 
     /// @brief Counts the events in the history

Spacing +27 added lines, -27 removed lines

@@ -10,10 +10,10 @@ 
  */
 ///@{
 /** Value: 1 */
-define('CREATUREHISTORY_GENDER_MALE',1);
+define('CREATUREHISTORY_GENDER_MALE', 1);
 
 /** Value: 2 */
-define('CREATUREHISTORY_GENDER_FEMALE',2);
+define('CREATUREHISTORY_GENDER_FEMALE', 2);
 ///@}
 
 /// @brief Class representing a creature's history.
@@ -49,7 +49,7 @@ 
      * @param $genus The creature's genus (Grendel, ettin, norn, geat)
      * @param $species The creature's species (unsure of purpose)  
      */
-    public function CreatureHistory($moniker,$name,$gender,$genus,$species) {
+    public function CreatureHistory($moniker, $name, $gender, $genus, $species) {
         $this->moniker = $moniker;
         $this->name = $name;
         $this->gender = $gender;
@@ -62,29 +62,29 @@ 
      * @param $format GLST_FORMAT_C3 or GLST_FORMAT_DS.
      * @return A binary string ready for archiving and putting in a GLST block. 
      */
-    public function Compile($format=GLST_FORMAT_C3) {
+    public function Compile($format = GLST_FORMAT_C3) {
         $data = '';
-        if($format != GLST_FORMAT_C3 && $format != GLST_FORMAT_DS) {
+        if ($format != GLST_FORMAT_C3 && $format != GLST_FORMAT_DS) {
             $format = $this->GuessFormat();
         }
-        if($format == GLST_FORMAT_DS) {
-            $data = pack('V',0x27);
+        if ($format == GLST_FORMAT_DS) {
+            $data = pack('V', 0x27);
         } else {
-            $data = pack('V',0x0C);
+            $data = pack('V', 0x0C);
         }
-        $data .= pack('V',1);
-        $data .= pack('V',32).$this->moniker;
-        $data .= pack('V',32).$this->moniker; //yeah, twice. Dunno why, CL are bonkers.
-        $data .= pack('V',strlen($this->name)).$this->name;
-        $data .= pack('VVVV',$this->gender,$this->genus,$this->species,count($this->events));
-        foreach($this->events as $event) {
+        $data .= pack('V', 1);
+        $data .= pack('V', 32).$this->moniker;
+        $data .= pack('V', 32).$this->moniker; //yeah, twice. Dunno why, CL are bonkers.
+        $data .= pack('V', strlen($this->name)).$this->name;
+        $data .= pack('VVVV', $this->gender, $this->genus, $this->species, count($this->events));
+        foreach ($this->events as $event) {
             $data .= $event->Compile($format);
         }
-        $data .= pack('V',$this->mutations);
-        $data .= pack('V',$this->crossoverpoints);
-        if($format == GLST_FORMAT_DS) {
-            $data .= pack('V',$this->unknown1);
-            $data .= pack('V',strlen($this->unknown2)).$this->unknown2;
+        $data .= pack('V', $this->mutations);
+        $data .= pack('V', $this->crossoverpoints);
+        if ($format == GLST_FORMAT_DS) {
+            $data .= pack('V', $this->unknown1);
+            $data .= pack('V', strlen($this->unknown2)).$this->unknown2;
         }
         return $data;
     }
@@ -96,7 +96,7 @@ 
      * @return GLST_FORMAT_DS or GLST_FORMAT_C3.
      */
     public function GuessFormat() {
-        return (isset($this->unknown1))?GLST_FORMAT_DS:GLST_FORMAT_C3;
+        return (isset($this->unknown1)) ? GLST_FORMAT_DS : GLST_FORMAT_C3;
     }
 
     /// @brief Adds an event to the end of a history.
@@ -143,8 +143,8 @@ 
      */
     public function GetEventsByType($type) {
         $matchingEvents = array();
-        foreach($this->events as $event) {
-            if($event->GetEventType() == $type) {
+        foreach ($this->events as $event) {
+            if ($event->GetEventType() == $type) {
                 $matchingEvents[] = $event;
             }
         }
@@ -172,11 +172,11 @@ 
      * @return 0 for failure, the generation of the creature otherwise.
      */
     public function GetCreatureGenerationNumber() {
-        if($pos = strpos('_',$this->moniker) == -1) {
+        if ($pos = strpos('_', $this->moniker) == -1) {
             return 0;
         } else {
-            $firstbit = substr($this->moniker,0,$pos);
-            if(is_numeric($firstbit)) {
+            $firstbit = substr($this->moniker, 0, $pos);
+            if (is_numeric($firstbit)) {
                 return $firstbit+0;
             }
             return 0;
@@ -218,7 +218,7 @@ 
         return $this->crossoverpoints;
     }
 
-    public function SetMutationsAndCrossovers($mutations,$crossovers) {
+    public function SetMutationsAndCrossovers($mutations, $crossovers) {
         $this->mutations = $mutations;
         $this->crossoverpoints = $crossovers;
     }
@@ -231,7 +231,7 @@ 
      * @param $unknown1 First unknown variable
      * @param $unknown2 Second unknown variable
      */
-    public function SetDSUnknowns($unknown1,$unknown2) {
+    public function SetDSUnknowns($unknown1, $unknown2) {
         $this->unknown1 = $unknown1;
         $this->unknown2 = $unknown2;
     }

agents/CreatureHistory/CreatureHistoryEvent.php

Doc Comments +1 added lines, -1 removed lines

@@ -158,7 +158,7 @@
      * This is called automatically by CreatureHistory, most users
      * should have no need to use this function themselves.
      * @param $format Which game to compile it for (a GLST_FORMAT_* constant)
-     * @return A binary string containing GLST data ready to be put into a GLST history.
+     * @return string binary string containing GLST data ready to be put into a GLST history.
      */
     public function Compile($format) {
         $data = pack('VVVVV',$this->eventtype,$this->worldtime,$this->creatureage,$this->timestamp,$this->lifestage);

Spacing +30 added lines, -30 removed lines

@@ -15,68 +15,68 @@ 
 //@{
 /** I was conceived by kisspopping or artificial insemination. \n
  * Value: 0 */
-define('CREATUREHISTORY_EVENT_CONCEIVED',0);
+define('CREATUREHISTORY_EVENT_CONCEIVED', 0);
 /** I was spliced from two other creatures \n
  * Value: 1 */
-define('CREATUREHISTORY_EVENT_SPLICED',1);
+define('CREATUREHISTORY_EVENT_SPLICED', 1);
 /** I was created by someone with a genetics kit \n
  * Value: 2 */
-define('CREATUREHISTORY_EVENT_ENGINEERED',2);
+define('CREATUREHISTORY_EVENT_ENGINEERED', 2);
 /** I hatched out of my egg. \n
  * Value: 3 */
-define('CREATUREHISTORY_EVENT_HATCHED',3);
+define('CREATUREHISTORY_EVENT_HATCHED', 3);
 /**
  * CreatureHistoryEvent::GetLifestage will tell you what lifestage I
  * am now. \n\n
  * Value: 4
  */
-define('CREATUREHISTORY_EVENT_AGED',4);
+define('CREATUREHISTORY_EVENT_AGED', 4);
 /** I was exported from this world \n
  * Value: 5 */
-define('CREATUREHISTORY_EVENT_EXPORTED',5);
+define('CREATUREHISTORY_EVENT_EXPORTED', 5);
 /** I joined this world \n
  * Value: 6 */
-define('CREATUREHISTORY_EVENT_IMPORTED',6);
+define('CREATUREHISTORY_EVENT_IMPORTED', 6);
 /** My journey through life ended. \n
  * Value: 7 */
-define('CREATUREHISTORY_EVENT_DIED',7);
+define('CREATUREHISTORY_EVENT_DIED', 7);
 /** I became pregnant. \n
  * Value: 8 */
-define('CREATUREHISTORY_EVENT_BECAMEPREGNANT',8);
+define('CREATUREHISTORY_EVENT_BECAMEPREGNANT', 8);
 /** I made someone else pregnant.  \n
  * Value: 9 */
-define('CREATUREHISTORY_EVENT_IMPREGNATED',9);
+define('CREATUREHISTORY_EVENT_IMPREGNATED', 9);
 /** My child hatched from its egg! \n
  * Value: 10 */
-define('CREATUREHISTORY_EVENT_CHILDBORN',10);
+define('CREATUREHISTORY_EVENT_CHILDBORN', 10);
 /** My mum laid my egg. \n
  * Value: 11 */
-define('CREATUREHISTORY_EVENT_MUMLAIDMYEGG',11);
+define('CREATUREHISTORY_EVENT_MUMLAIDMYEGG', 11);
 /** I laid an egg I was carrying. \n
  * Value: 12 */
-define('CREATUREHISTORY_EVENT_LAIDEGG',12);
+define('CREATUREHISTORY_EVENT_LAIDEGG', 12);
 /** A photo was taken of me. \n
  * Value: 13 */
-define('CREATUREHISTORY_EVENT_PHOTOTAKEN',13);
+define('CREATUREHISTORY_EVENT_PHOTOTAKEN', 13);
 /**
  * I was made by cloning another creature \n
  * This happens when you export a creature then import it more than
  * once. \n
  * Value: 14
  */
-define('CREATUREHISTORY_EVENT_IAMCLONED',14); 
+define('CREATUREHISTORY_EVENT_IAMCLONED', 14); 
 /** Another creature was made by cloning me. \n
  * This happens when you export a creature then import it more than
  * once. \n
  * Value: 15
  */
-define('CREATUREHISTORY_EVENT_CLONEDME',15);
+define('CREATUREHISTORY_EVENT_CLONEDME', 15);
 /** I left this world through the warp \n
  * Value: 16 */
-define('CREATUREHISTORY_EVENT_WARPEDOUT',16);
+define('CREATUREHISTORY_EVENT_WARPEDOUT', 16);
 /** I entered this world through the warp \n
  * Value: 17 */
-define('CREATUREHISTORY_EVENT_WARPEDIN',17);
+define('CREATUREHISTORY_EVENT_WARPEDIN', 17);
 //@}
 
 
@@ -126,7 +126,7 @@ 
      * @param $worldname The name of the world the creature was inhabiting at the time of this event 
      * @param $worldUID The UID of the world the creature was inhabiting at the the time of this event
      */
-    public function CreatureHistoryEvent($eventtype,$worldtime,$creatureage,$timestamp,$lifestage,$moniker1,$moniker2,$usertext,$photograph,$worldname,$worldUID) {
+    public function CreatureHistoryEvent($eventtype, $worldtime, $creatureage, $timestamp, $lifestage, $moniker1, $moniker2, $usertext, $photograph, $worldname, $worldUID) {
         $this->eventtype = $eventtype;
         $this->worldtime = $worldtime;
         $this->creatureage = $creatureage;
@@ -146,7 +146,7 @@ 
      * @param $unknown1 I don't know! But it comes right after the DSUID in the GLST format.
      * @param $unknown2 I don't know! But it comes right after unknown1.
      */
-    public function AddDSInfo($DSUserID,$unknown1,$unknown2) {
+    public function AddDSInfo($DSUserID, $unknown1, $unknown2) {
         $this->dockingstationuser = $DSUserID;
         $this->unknown1 = $unknown1;
         $this->unknown2 = $unknown2;
@@ -161,16 +161,16 @@ 
      * @return A binary string containing GLST data ready to be put into a GLST history.
      */
     public function Compile($format) {
-        $data = pack('VVVVV',$this->eventtype,$this->worldtime,$this->creatureage,$this->timestamp,$this->lifestage);
-        $data .= pack('V',strlen($this->moniker1)).$this->moniker1;
-        $data .= pack('V',strlen($this->moniker2)).$this->moniker2;
-        $data .= pack('V',strlen($this->usertext)).$this->usertext;
-        $data .= pack('V',strlen($this->photograph)).$this->photograph;
-        $data .= pack('V',strlen($this->worldname)).$this->worldname;
-        $data .= pack('V',strlen($this->worldUID)).$this->worldUID;
-        if($format == GLST_FORMAT_DS) {
-            $data .= pack('V',strlen($this->dockingstationuser)).$this->dockingstationuser;
-            $data .= pack('VV',$this->unknown1,$this->unknown2);
+        $data = pack('VVVVV', $this->eventtype, $this->worldtime, $this->creatureage, $this->timestamp, $this->lifestage);
+        $data .= pack('V', strlen($this->moniker1)).$this->moniker1;
+        $data .= pack('V', strlen($this->moniker2)).$this->moniker2;
+        $data .= pack('V', strlen($this->usertext)).$this->usertext;
+        $data .= pack('V', strlen($this->photograph)).$this->photograph;
+        $data .= pack('V', strlen($this->worldname)).$this->worldname;
+        $data .= pack('V', strlen($this->worldUID)).$this->worldUID;
+        if ($format == GLST_FORMAT_DS) {
+            $data .= pack('V', strlen($this->dockingstationuser)).$this->dockingstationuser;
+            $data .= pack('VV', $this->unknown1, $this->unknown2);
         }
         return $data;
     }

agents/PRAY/AGNTBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -11,7 +11,7 @@ 
      * Makes a new AGNTBlock. \n
      * If $prayfile is not null, all the data about this AGNTBlock
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile associated with this AGNT block.
+     * @param PRAYFile $prayfile The PRAYFile associated with this AGNT block.
      * It is allowed to be null.
      * @param $name The name of this block.
      * @param $content This block's content.
@@ -75,7 +75,7 @@ 
         return $this->GetTag('Dependency Count');
     }
     /// @brief Gets the dependency specified
-    /** @param $dependency The number of the dependency to get. 1-based.
+    /** @param integer $dependency The number of the dependency to get. 1-based.
      * return A PrayDependency object describing the file the agent depends on
      */
     

Spacing +21 added lines, -21 removed lines

@@ -18,8 +18,8 @@ 
      * @param $flags Any flags this block may have. I think this is a
      * single byte. Check http://www.creatureswiki.net/wiki/PRAY
      */
-    public function AGNTBlock($prayfile,$name,$content,$flags) {
-        parent::TagBlock($prayfile,$name,$content,$flags,PRAY_BLOCK_AGNT);
+    public function AGNTBlock($prayfile, $name, $content, $flags) {
+        parent::TagBlock($prayfile, $name, $content, $flags, PRAY_BLOCK_AGNT);
     }
 
     /// @brief Gets the agent's name.
@@ -36,12 +36,12 @@ 
      * If the description doesn't exist in the language specified, falls back on English rather than returning nothing.
      * @param $localisation The two-letter language code (e.g. de, fr) to get. If not specified, english is used.
      */ 
-    public function GetAgentDescription($localisation='') {
-        if($localisation == '') {
+    public function GetAgentDescription($localisation = '') {
+        if ($localisation == '') {
             return $this->GetTag('Agent Description');
         } else {
             $description = $this->GetTag('Agent Description-'.$localisation);
-            if($description == '') {
+            if ($description == '') {
                 $description = $this->GetTag('Agent Description'); 
             }
             return $description;
@@ -63,8 +63,8 @@ 
      * Gets the first script, or if you specified which script, that one.
      * @param $script Which script to get as an integer. The first script is script 1.
      */
-    public function GetScript($script=1) {
-        if($script > 0 && $script <= $this->GetScriptCount()) {
+    public function GetScript($script = 1) {
+        if ($script > 0 && $script <= $this->GetScriptCount()) {
             return $this->GetTag('Script '.$script);            
         }
         throw new Exception('Script doesn\'t exist!');
@@ -82,14 +82,14 @@ 
     public function GetDependency($dependency) {
         $file = $this->GetTag('Dependency '.$dependency);
         $category = $this->GetTag('Dependency Category '.$dependency);
-        return new PrayDependency($category,$file);
+        return new PrayDependency($category, $file);
     }
     /// @brief Gets all the files this agent depends on.
     /** return An array of PrayDependency objects.
      */
     public function GetDependencies() {
         $dependencies = array();
-        for($i = 1; $i <= $this->GetDependencyCount(); $i++) {
+        for ($i = 1; $i <= $this->GetDependencyCount(); $i++) {
             $dependencies[] = $this->GetDependency($i);
         }
         return $dependencies;
@@ -153,40 +153,40 @@ 
      */
     public function GetAgentAnimationAsSpriteFrame() {
         $animationFile = $this->GetAgentAnimationFile();
-        if($animationFile == '') {
+        if ($animationFile == '') {
             $animationFile = $this->GetAgentAnimationGallery();
-            if($animationFile == '') {
+            if ($animationFile == '') {
                 throw new Exception('No animation file!');
             }
             $animationFile .= '.c16';
         }
         $animationFirstImage = $this->GetAgentAnimationFirstImage();
         $animationString = $this->GetAgentAnimationString();
-        if($animationFirstImage == '') {
+        if ($animationFirstImage == '') {
             $animationFirstImage = 0;
         }
-        if($animationString == '') {
+        if ($animationString == '') {
             $animationString = 0;
         }
-        if(($position = strpos($animationString,' ')) !== false) {
-            $animationString = substr($animationString,0,$position);
+        if (($position = strpos($animationString, ' ')) !== false) {
+            $animationString = substr($animationString, 0, $position);
         }
         $prayfile = $this->GetPrayFile();
-        if($prayfile == null) {
+        if ($prayfile == null) {
             throw new Exception('No PRAY file to get the icon from!');
         }
         $iconBlock = $prayfile->GetBlockByName($animationFile);
-        if($iconBlock->GetType() != 'FILE') {
+        if ($iconBlock->GetType() != 'FILE') {
             throw new Exception('The block with the animation\'s filename is not a file block!');
         }
-        $type = strtolower(substr($animationFile,-3));
+        $type = strtolower(substr($animationFile, -3));
         $icon = null;
-        if($type == 'c16') {
+        if ($type == 'c16') {
             $icon = new C16File(new StringReader($iconBlock->GetData()));
-        } else if($type == 's16') {
+        } else if ($type == 's16') {
             $icon = new S16File(new StringReader($iconBlock->GetData()));
         }
-        if($icon == null) {
+        if ($icon == null) {
             throw new Exception('For one reason or another, couldn\'t make a sprite file for the agent.');
         }
         return $icon->GetFrame($animationFirstImage+$animationString);

agents/PRAY/BinaryBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
     }
     /// @brief Compile the BinaryBlock
     /**
-     * @return The compiled BinaryBlock as a binary string.
+     * @return string compiled BinaryBlock as a binary string.
      */
 	public function Compile() {
 		return $this->EncodeBlockHeader(strlen($this->binarydata)).$this->binarydata;

Indentation +7 added lines, -7 removed lines

@@ -13,7 +13,7 @@ 
 class BinaryBlock extends PrayBlock {
     /// @cond INTERNAL_DOCS
     
-	private $binarydata;
+    private $binarydata;
     /// @endcond
 
     /// @brief Instantiate a BinaryBlock
@@ -22,17 +22,17 @@ 
      * @param $name The block's name.
      * @param $content The content of the block as a binary string.
      */
-	public function BinaryBlock($type,$name,$content) {
-		parent::PrayBlock(null,$name,'',0,$type);
-		$this->binarydata = $content;
+    public function BinaryBlock($type,$name,$content) {
+        parent::PrayBlock(null,$name,'',0,$type);
+        $this->binarydata = $content;
     }
     /// @brief Compile the BinaryBlock
     /**
      * @return The compiled BinaryBlock as a binary string.
      */
-	public function Compile() {
-		return $this->EncodeBlockHeader(strlen($this->binarydata)).$this->binarydata;
-	}
+    public function Compile() {
+        return $this->EncodeBlockHeader(strlen($this->binarydata)).$this->binarydata;
+    }
 }
 
 ?>

Spacing +2 added lines, -2 removed lines

@@ -22,8 +22,8 @@
      * @param $name The block's name.
      * @param $content The content of the block as a binary string.
      */
-	public function BinaryBlock($type,$name,$content) {
-		parent::PrayBlock(null,$name,'',0,$type);
+	public function BinaryBlock($type, $name, $content) {
+		parent::PrayBlock(null, $name, '', 0, $type);
 		$this->binarydata = $content;
     }
     /// @brief Compile the BinaryBlock

agents/PRAY/CREABlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
     /**
      * If $prayfile is not null, all the data about this CREABlock
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile associated with this CREA block.
+     * @param PRAYFile $prayfile The PRAYFile associated with this CREA block.
      * It is allowed to be null.
      * @param $name The name of this block.
      * @param $content This block's content.

Spacing +2 added lines, -2 removed lines

@@ -16,8 +16,8 @@
      * @param $content This block's content.
      * @param $flags Any flags this block may have
      */
-    public function CREABlock($prayfile,$name,$content,$flags) {
-        parent::CreaturesArchiveBlock($prayfile,$name,$content,$flags,PRAY_BLOCK_CREA);
+    public function CREABlock($prayfile, $name, $content, $flags) {
+        parent::CreaturesArchiveBlock($prayfile, $name, $content, $flags, PRAY_BLOCK_CREA);
     }
     /// @cond INTERNAL_DOCS
     

agents/PRAY/CreaturesArchiveBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
      * @param $name The name of this block
      * @param $content This block's binary data.
      * @param $flags the flags of this block
-     * @param $type This block's type as one of the PRAY_BLOCK_* constants
+     * @param string $type This block's type as one of the PRAY_BLOCK_* constants
      */
     public function CreaturesArchiveBlock(&$prayfile,$name,$content,$flags,$type) {
         parent::PrayBlock($prayfile,$name,$content,$flags,$type);

Spacing +6 added lines, -6 removed lines

@@ -17,10 +17,10 @@ 
      * @param $flags the flags of this block
      * @param $type This block's type as one of the PRAY_BLOCK_* constants
      */
-    public function CreaturesArchiveBlock(&$prayfile,$name,$content,$flags,$type) {
-        parent::PrayBlock($prayfile,$name,$content,$flags,$type);
-        if($prayfile instanceof PRAYFile) {
-            if(!$this->DeArchive()) {
+    public function CreaturesArchiveBlock(&$prayfile, $name, $content, $flags, $type) {
+        parent::PrayBlock($prayfile, $name, $content, $flags, $type);
+        if ($prayfile instanceof PRAYFile) {
+            if (!$this->DeArchive()) {
                 throw new Exception('De-Archiving failed, block probably wasn\'t a CreaturesArchive type');
             }
         }
@@ -30,9 +30,9 @@ 
     /// DeArchives this block
     private function DeArchive() {
         $content = $this->GetData();
-        if($content{0} == 'C') {
+        if ($content{0} == 'C') {
             $content = DeArchive($content);

-            if($content !== false) {

+            if ($content !== false) {

                 $this->SetData($content);
                 return true;

             }

agents/PRAY/DFAMBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
     /**
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
-	 * @param $prayfile The PRAYFile that this DFAM block belongs to.
+	 * @param PRAYFile $prayfile The PRAYFile that this DFAM block belongs to.
 	 * @param $name The block's name.
 	 * @param $content The binary data of this block. May be null.
 	 * @param $flags The block's flags

Indentation +8 added lines, -8 removed lines

@@ -13,14 +13,14 @@
     /**
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
-	 * @param $prayfile The PRAYFile that this DFAM block belongs to.
-	 * @param $name The block's name.
-	 * @param $content The binary data of this block. May be null.
-	 * @param $flags The block's flags
-	 */
-	public function DFAMBlock($prayfile,$name,$content,$flags) {
-		parent::TagBlock($prayfile,$name,$content,$flags,PRAY_BLOCK_DFAM);
+     * @param $prayfile The PRAYFile that this DFAM block belongs to.
+     * @param $name The block's name.
+     * @param $content The binary data of this block. May be null.
+     * @param $flags The block's flags
+     */
+    public function DFAMBlock($prayfile,$name,$content,$flags) {
+        parent::TagBlock($prayfile,$name,$content,$flags,PRAY_BLOCK_DFAM);
 
-	}
+    }
 }
 ?>

Spacing +2 added lines, -2 removed lines

@@ -18,8 +18,8 @@
 	 * @param $content The binary data of this block. May be null.
 	 * @param $flags The block's flags
 	 */
-	public function DFAMBlock($prayfile,$name,$content,$flags) {
-		parent::TagBlock($prayfile,$name,$content,$flags,PRAY_BLOCK_DFAM);
+	public function DFAMBlock($prayfile, $name, $content, $flags) {
+		parent::TagBlock($prayfile, $name, $content, $flags, PRAY_BLOCK_DFAM);
 
 	}
 }