agents/CreatureHistory/CreatureHistory.php

Go to the documentation of this file.

<?php
require_once(dirname(__FILE__).'/CreatureHistoryEvent.php');
require_once(dirname(__FILE__).'/../PRAY/GLSTBlock.php');




define('CREATUREHISTORY_GENDER_MALE',1);

define('CREATUREHISTORY_GENDER_FEMALE',2);


class CreatureHistory {


    private $events;
    private $moniker;
    private $name;
    private $gender;
    private $genus;
    private $species;
    private $warpveteran;


    //TODO: find out what unknowns are` 
    private $mutations; 
    private $crossoverpoints;
    private $unknown1; 
    private $unknown2; 



    public function CreatureHistory($moniker,$name,$gender,$genus,$species) {
        $this->moniker = $moniker;
        $this->name = $name;
        $this->gender = $gender;
        $this->genus = $genus;
        $this->species = $species;
    }


    public function Compile($format=GLST_FORMAT_C3) {
        $data = '';
        if($format != GLST_FORMAT_C3 && $format != GLST_FORMAT_DS) {
            $format = $this->GuessFormat();
        }
        if($format == GLST_FORMAT_DS) {
            $data = pack('V',0x27);
        } else {
            $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 .= $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;
        }
        return $data;
    }


    public function GuessFormat() {
        return (isset($this->unknown1))?GLST_FORMAT_DS:GLST_FORMAT_C3;
    }


    public function AddEvent(CreatureHistoryEvent $event) {
        $this->events[] = $event;
    }


    public function GetEvent($n) {
        return $this->events[$n];
    }


    public function RemoveEvent($n) {
       unset($this->events[$n]); 
    }


    public function CountEvents() {
        return sizeof($this->events);
    }


    public function GetEventsByType($type) {
        $matchingEvents = array();
        foreach($this->events as $event) {
            if($event->GetEventType() == $type) {
                $matchingEvents[] = $event;
            }
        }
        return $matchingEvents;
    }


    public function GetEvents() {
        return $this->events;
    } 

    public function GetCreatureMoniker() {
        return $this->moniker;
    }


    public function GetCreatureGenerationNumber() {
        if($pos = strpos('_',$this->moniker) == -1) {
            return 0;
        } else {
            $firstbit = substr($this->moniker,0,$pos);
            if(is_numeric($firstbit)) {
                return $firstbit+0;
            }
            return 0;
        }
    }

    public function GetCreatureName() {
        return $this->name;
    }

    public function GetCreatureGender() {
        return $this->gender;
    }

    public function GetCreatureGenus() {
        return $this->genus;
    }

    public function GetCreatureSpecies() {
        return $this->species;
    }

    public function GetCreatureIsWarpVeteran() {
        return $this->warpveteran;
    }

    public function GetCreatureMutations() {
        return $this->mutations;
    }

    public function GetCreatureCrossoverPoints() {
        return $this->crossoverpoints;
    }

    public function SetMutationsAndCrossovers($mutations,$crossovers) {
        $this->mutations = $mutations;
        $this->crossoverpoints = $crossovers;
    }



    public function SetDSUnknowns($unknown1,$unknown2) {
        $this->unknown1 = $unknown1;
        $this->unknown2 = $unknown2;
    }


    public function SetWarpVeteran($warpveteran) {
        $this->warpveteran = $warpveteran;
    }
}

?>