handle drops before the drop script is fired, move the C1 snapping code to after...

[openc2e.git] / SFCFile.cpp

/*
 *  SFCFile.cpp
 *  openc2e
 *
 *  Created by Alyssa Milburn on Sat 21 Oct 2006.
 *  Copyright (c) 2006-2008 Alyssa Milburn. All rights reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 */

#include "SFCFile.h"
#include "World.h"
#include "Engine.h"
#include "MetaRoom.h"
#include "Room.h"
#include "exceptions.h"

/*
 * sfcdumper.py has better commentary on this format - use it for debugging
 * and make sure to update it if you update this!
 */

#define TYPE_MAPDATA 1
#define TYPE_CGALLERY 2
#define TYPE_CDOOR 3
#define TYPE_CROOM 4
#define TYPE_ENTITY 5
#define TYPE_COMPOUNDOBJECT 6
#define TYPE_BLACKBOARD 7
#define TYPE_VEHICLE 8
#define TYPE_LIFT 9
#define TYPE_SIMPLEOBJECT 10
#define TYPE_POINTERTOOL 11
#define TYPE_CALLBUTTON 12
#define TYPE_SCENERY 13
#define TYPE_OBJECT 100

#include <boost/format.hpp>
#define sfccheck(x) if (!(x)) throw creaturesException(std::string("failure while reading SFC file: '" #x "' in " __FILE__ " at line ") + boost::str(boost::format("%d") % __LINE__));

SFCFile::~SFCFile() {
        // This contains all the objects we've constructed, so we can just zap this and
        // everything neatly disappears.
        for (std::vector<SFCClass *>::iterator i = storage.begin(); i != storage.end(); i++) {
                delete *i;
        }
}

void SFCFile::read(std::istream *i) {
        ourStream = i;

        mapdata = (MapData *)slurpMFC(TYPE_MAPDATA);
        sfccheck(mapdata);

        // TODO: hackery to seek to the next bit
        uint8 x = 0;
        while (x == 0) x = read8();
        ourStream->seekg(-1, std::ios::cur);

        uint32 numobjects = read32();
        for (unsigned int i = 0; i < numobjects; i++) {
                SFCObject *o = (SFCObject *)slurpMFC(TYPE_OBJECT);
                sfccheck(o);
                objects.push_back(o);
        }

        uint32 numscenery = read32();
        for (unsigned int i = 0; i < numscenery; i++) {
                SFCScenery *o = (SFCScenery *)slurpMFC(TYPE_SCENERY);
                sfccheck(o);
                scenery.push_back(o);
        }

        uint32 numscripts = read32();
        for (unsigned int i = 0; i < numscripts; i++) {
                SFCScript x;
                x.read(this);
                scripts.push_back(x);
        }

        scrollx = read32();
        scrolly = read32();
        
        // TODO
}

bool validSFCType(unsigned int type, unsigned int reqtype) {
        if (reqtype == 0) return true;
        if (type == reqtype) return true;
        if ((reqtype == TYPE_OBJECT) && (type >= TYPE_COMPOUNDOBJECT)) return true;
        if ((reqtype == TYPE_COMPOUNDOBJECT) && (type >= TYPE_COMPOUNDOBJECT) && (type <= TYPE_LIFT)) return true;

        return false;
}

SFCClass *SFCFile::slurpMFC(unsigned int reqtype) {
        sfccheck(!ourStream->fail());

        // read the pid (this only works up to 0x7ffe, but we'll cope)
        uint16 pid = read16();

        if (pid == 0) {
                // null object
                return 0;
        } else if (pid == 0xffff) {
                // completely new class, read details
                uint16 schemaid = read16();
                uint16 strlen = read16();
                char *temp = new char[strlen];
                ourStream->read(temp, strlen);
                std::string classname(temp, strlen);
                delete[] temp;
                
                pid = storage.size();
                
                // push a null onto the stack
                storage.push_back(0);

                // set the types array as necessary
                if (classname == "MapData")
                        types[pid] = TYPE_MAPDATA;
                else if (classname == "CGallery")
                        types[pid] = TYPE_CGALLERY;
                else if (classname == "CDoor")
                        types[pid] = TYPE_CDOOR;
                else if (classname == "CRoom")
                        types[pid] = TYPE_CROOM;
                else if (classname == "Entity")
                        types[pid] = TYPE_ENTITY;
                else if (classname == "CompoundObject")
                        types[pid] = TYPE_COMPOUNDOBJECT;
                else if (classname == "Blackboard")
                        types[pid] = TYPE_BLACKBOARD;
                else if (classname == "Vehicle")
                        types[pid] = TYPE_VEHICLE;
                else if (classname == "Lift")
                        types[pid] = TYPE_LIFT;
                else if (classname == "SimpleObject")
                        types[pid] = TYPE_SIMPLEOBJECT;
                else if (classname == "PointerTool")
                        types[pid] = TYPE_POINTERTOOL;
                else if (classname == "CallButton")
                        types[pid] = TYPE_CALLBUTTON;
                else if (classname == "Scenery")
                        types[pid] = TYPE_SCENERY;
                else
                        throw creaturesException(std::string("SFCFile doesn't understand class name '") + classname + "'!");
        } else if ((pid & 0x8000) != 0x8000) {
                // return an existing object
                pid -= 1;
                sfccheck(pid < storage.size());
                sfccheck(validSFCType(types[pid], reqtype));
                SFCClass *temp = storage[pid];
                sfccheck(temp);
                return temp;
        } else {
                uint16 oldpid = pid;
                // create a new object of an existing class
                pid ^= 0x8000;
                pid -= 1;
                sfccheck(pid < storage.size());
                sfccheck(!(storage[pid]));
        }

        SFCClass *newobj;

        // construct new object of specified type
        sfccheck(validSFCType(types[pid], reqtype));
        switch (types[pid]) {
                case TYPE_MAPDATA: newobj = new MapData(this); break;
                case TYPE_CGALLERY: newobj = new CGallery(this); break;
                case TYPE_CDOOR: newobj = new CDoor(this); break;
                case TYPE_CROOM: newobj = new CRoom(this); break;
                case TYPE_ENTITY: newobj = new SFCEntity(this); break;
                case TYPE_COMPOUNDOBJECT: newobj = new SFCCompoundObject(this); break;
                case TYPE_BLACKBOARD: newobj = new SFCBlackboard(this); break;
                case TYPE_VEHICLE: newobj = new SFCVehicle(this); break;
                case TYPE_LIFT: newobj = new SFCLift(this); break;
                case TYPE_SIMPLEOBJECT: newobj = new SFCSimpleObject(this); break;
                case TYPE_POINTERTOOL: newobj = new SFCPointerTool(this); break;
                case TYPE_CALLBUTTON: newobj = new SFCCallButton(this); break;
                case TYPE_SCENERY: newobj = new SFCScenery(this); break;
                default:
                        throw creaturesException("SFCFile didn't find a valid type in internal variable, argh!");
        }

        if (validSFCType(types[pid], TYPE_COMPOUNDOBJECT)) reading_compound = true;
        else if (types[pid] == TYPE_SCENERY) reading_scenery = true;

        // push the object onto storage, and make it deserialize itself
        types[storage.size()] = types[pid];
        storage.push_back(newobj);
        newobj->read();

        if (validSFCType(types[pid], TYPE_COMPOUNDOBJECT)) reading_compound = false;
        else if (types[pid] == TYPE_SCENERY) reading_scenery = false;

        // return this new object
        return newobj;
}

uint8 SFCFile::read8() {
        char temp[1];
        ourStream->read(temp, 1);
        return temp[0];
}

uint16 SFCFile::read16() {
        char temp[2];
        ourStream->read(temp, 2);
        uint16 *i = (uint16 *)&temp;
        return swapEndianShort(*i);
}

uint32 SFCFile::read32() {
        char temp[4];
        ourStream->read(temp, 4);
        uint32 *i = (uint32 *)&temp;
        return swapEndianLong(*i);
}

std::string SFCFile::readstring() {
        uint32 strlen = read8();
        if (strlen == 0xff) {
                strlen = read16();
                if (strlen == 0xffff)
                        strlen = read32();
        }

        return readBytes(strlen);
}

std::string SFCFile::readBytes(unsigned int n) {
        char *temp = new char[n];
        ourStream->read(temp, n);
        std::string t = std::string(temp, n);
        delete[] temp;
        return t;
}

void SFCFile::setVersion(unsigned int v) {
        if (v == 0) {
                sfccheck(world.gametype == "c1");
        } else if (v == 1) {
                sfccheck(world.gametype == "c2");
        } else {
                throw creaturesException(boost::str(boost::format("unknown version# %d") % v));
        }

        ver = v;
}

// ------------------------------------------------------------------

void MapData::read() {
        // read version (0 = c1, 1 = c2)
        unsigned int ver = read32();
        sfccheck((ver == 0) || (ver == 1));
        parent->setVersion(ver);

        // discard unknown bytes
        read32();
        if (parent->version() == 1) {
                read32();
                read32();
        }

        // background sprite
        background = (CGallery *)slurpMFC(TYPE_CGALLERY);
        sfccheck(background);

        // room data
        uint32 norooms = read32();
        for (unsigned int i = 0; i < norooms; i++) {
                if (parent->version() == 0) {
                        CRoom *temp = new CRoom(parent);
                        temp->id = i;
                        temp->left = reads32();
                        temp->top = read32();
                        temp->right = reads32();
                        temp->bottom = read32();
                        temp->roomtype = read32();
                        sfccheck(temp->roomtype < 3);
                        rooms.push_back(temp);
                } else {
                        CRoom *temp = (CRoom*)slurpMFC(TYPE_CROOM);
                        sfccheck(temp);
                        rooms.push_back(temp);
                }
        }

        // read groundlevel data
        if (parent->version() == 0) {
                for (unsigned int i = 0; i < 261; i++) {
                        read32(); // TODO
                }

                readBytes(800); // TODO
        }
}

MapData::~MapData() {
        // In C1, we create rooms which aren't MFC objects, so we need to destroy them afterwards.
        if (parent->version() == 0) {
                for (std::vector<CRoom *>::iterator i = rooms.begin(); i != rooms.end(); i++) {
                        delete *i;
                }
        }
}

void CGallery::read() {
        noframes = read32();
        filename = parent->readBytes(4);
        firstimg = read32();
        
        // discard unknown bytes
        read32();

        for (unsigned int i = 0; i < noframes; i++) {
                // discard unknown bytes
                read8(); read8(); read8();
                // discard width, height and offset
                read32(); read32(); read32();
        }
}

void CDoor::read() {
        openness = read8();
        otherroom = read16();
        
        // discard unknown bytes
        sfccheck(read16() == 0);
}

void CRoom::read() {
        id = read32();

        // magic constant?
        sfccheck(read16() == 2);

        left = read32();
        top = read32();
        right = read32();
        bottom = read32();

        for (unsigned int i = 0; i < 4; i++) {
                uint16 nodoors = read16();
                for (unsigned int j = 0; j < nodoors; j++) {
                        CDoor *temp = (CDoor*)slurpMFC(TYPE_CDOOR);
                        sfccheck(temp);
                        doors[i].push_back(temp);
                }
        }

        roomtype = read32(); sfccheck(roomtype < 4);

        floorvalue = read8();
        inorganicnutrients = read8();
        organicnutrients = read8();
        temperature = read8();
        heatsource = reads32();

        pressure = read8();
        pressuresource = reads32();

        windx = reads32();
        windy = reads32();

        lightlevel = read8();
        lightsource = reads32();

        radiation = read8();
        radiationsource = reads32();

        // discard unknown bytes
        readBytes(800);

        uint16 nopoints = read16();
        for (unsigned int i = 0; i < nopoints; i++) {
                uint32 x = read32();
                uint32 y = read32();
                floorpoints.push_back(std::pair<uint32, uint32>(x, y));
        }

        // discard unknown bytes
        sfccheck(read32() == 0);

        music = readstring();
        dropstatus = read32(); sfccheck(dropstatus < 3);
}

void SFCEntity::read() {
        // read sprite
        sprite = (CGallery *)slurpMFC(TYPE_CGALLERY);
        sfccheck(sprite);

        // read current frame and offset from base
        currframe = read8();
        imgoffset = read8();

        // read zorder, x, y
        zorder = reads32();
        x = read32();
        y = read32();

        // check if this agent is animated at present
        uint8 animbyte = read8();
        if (animbyte) {
                sfccheck(animbyte == 1);
                haveanim = true;

                // read the animation frame
                animframe = read8();

                // read the animation string
                std::string tempstring;
                if (parent->version() == 0) tempstring = readBytes(32);
                else tempstring = readBytes(99);
                // chop off non-null-terminated bits
                animstring = std::string(tempstring.c_str());
        } else haveanim = false;

        if (parent->readingScenery()) return;

        if (parent->readingCompound()) {
                relx = read32();
                rely = read32();
                return;
        }

        // read part zorder
        partzorder = read32();

        // read bhvrclick
        bhvrclick[0] = (signed char)read8();
        bhvrclick[1] = (signed char)read8();
        bhvrclick[2] = (signed char)read8();

        // read BHVR touch
        bhvrtouch = read8();

        if (parent->version() == 0) return;

        // read pickup handles/points
        uint16 num_pickup_handles = read16();
        for (unsigned int i = 0; i < num_pickup_handles; i++) {
                pickup_handles.push_back(std::pair<uint32, uint32>(read32(), read32()));
        }
        uint16 num_pickup_points = read16();
        for (unsigned int i = 0; i < num_pickup_points; i++) {
                pickup_points.push_back(std::pair<uint32, uint32>(read32(), read32()));
        }
}

void SFCObject::read() {
        // read genus, family and species
        if (parent->version() == 0) {
                //sfccheck(read8() == 0);
                read8(); // discard unused portion of CLAS, i guess (so far has been 0 or 255)
                species = read8();
                genus = read8();
                family = read8();
        } else {
                genus = read8();
                family = read8();
                sfccheck(read16() == 0);
                species = read16();
        }

        if (parent->version() == 0) {
                // discard unknown byte
                read8();
        } else {
                // read UNID
                unid = read32();

                // discard unknown byte
                read8();
        }

        // read ATTR
        if (parent->version() == 0)
                attr = read8();
        else
                attr = read16();

        // discard unknown bytes
        if (parent->version() == 1)
                sfccheck(read16() == 0);

        // read unknown coords
        left = read32();
        top = read32();
        right = read32();
        bottom = read32();

        // discard unknown bytes
        read16();

        // read ACTV
        actv = read8();

        // read sprite
        sprite = (CGallery *)slurpMFC(TYPE_CGALLERY);
        sfccheck(sprite);

        tickreset = read32();
        tickstate = read32();
        sfccheck(tickreset >= tickstate);

        // discard unknown bytes
        sfccheck(read16() == 0);

        // read currently-looping sound, if any
        currentsound = readBytes(4);
        if (currentsound[0] == 0)
                currentsound.clear();

        // read object variables
        for (unsigned int i = 0; i < (parent->version() == 0 ? 3 : 100); i++)
                variables[i] = read32();

        if (parent->version() == 1) {
                // read physics values
                size = read8();
                range = read32();
        
                // TODO: this is mysterious and unknown
                gravdata = read32();

                // read physics values
                accg = read32();
                velx = reads32();
                vely = reads32();
                rest = read32();
                aero = read32();

                // discard unknown bytes
                readBytes(6);

                // read threats
                threat = read8();

                // read flags
                uint8 flags = read8();
                frozen = (flags & 0x02);
        }

        // read scripts
        uint32 numscripts = read32();
        for (unsigned int i = 0; i < numscripts; i++) {
                SFCScript x;
                x.read(parent);
                scripts.push_back(x);
        }
}

void SFCCompoundObject::read() {
        SFCObject::read();

        uint32 numparts = read32();

        for (unsigned int i = 0; i < numparts; i++) {
                SFCEntity *e = (SFCEntity *)slurpMFC(TYPE_ENTITY);
                if (!e) {
                        sfccheck(i != 0);
                        // if entity is null, discard unknown bytes
                        readBytes(8);
                }
                if (i == 0) sfccheck((e->relx == 0) && (e->rely == 0));

                // push the entity, even if it is null..
                parts.push_back(e);
        }

        // read hotspot coordinates
        for (unsigned int i = 0; i < 6; i++) {
                hotspots[i].left = reads32();
                hotspots[i].top = reads32();
                hotspots[i].right = reads32();
                hotspots[i].bottom = reads32();
        }
        
        // read hotspot function data
        for (unsigned int i = 0; i < 6; i++) {
                // (this is actually a map of function->hotspot)
                hotspots[i].function = reads32();
        }

        if (parent->version() == 1) {
                // read C2-specific hotspot function data (again, actually maps function->hotspot)
                for (unsigned int i = 0; i < 6; i++) {
                        hotspots[i].message = read16();
                        sfccheck(read16() == 0);
                }
                for (unsigned int i = 0; i < 6; i++) {
                        hotspots[i].mask = read8();
                }
        }
}

void SFCBlackboard::read() {
        SFCCompoundObject::read();

        // read text x/y position and colours
        if (parent->version() == 0) {
                backgroundcolour = read8();
                chalkcolour = read8();
                aliascolour = read8();
                textx = read8();
                texty = read8();
        } else {
                backgroundcolour = read32();
                chalkcolour = read32();
                aliascolour = read32();
                textx = read8();
                texty = read8();
        }

        // read blackboard strings
        for (unsigned int i = 0; i < (parent->version() == 0 ? 16 : 48); i++) {
                uint32 value = read32();
                std::string str = readBytes(11);
                // chop off non-null-terminated bits
                str = std::string(str.c_str());
                strings.push_back(std::pair<uint32, std::string>(value, str));
        }
}

void SFCVehicle::read() {
        SFCCompoundObject::read();

        xvec = reads32();
        yvec = reads32();
        bump = read8();
        
        // discard unknown bytes
        read16();
        unsigned short x = read16();
        if (parent->version() == 1)
                sfccheck(x == 0);
        read16();
        sfccheck(read8() == 0);

        // read cabin boundaries
        cabinleft = read32();
        cabintop = read32();
        cabinright = read32();
        cabinbottom = read32();

        // discard unknown bytes
        sfccheck(read32() == 0);
}

void SFCLift::read() {
        SFCVehicle::read();

        nobuttons = read32();
        currentbutton = read32();
        
        // discard unknown bytes
        sfccheck(readBytes(5) == std::string("\xff\xff\xff\xff\x00", 5));

        for (unsigned int i = 0; i < 8; i++) {
                callbuttony[i] = read32();

                // discard unknown bytes
                sfccheck(read16() == 0);
        }

        // discard unknown bytes
        if (parent->version() == 1)
                read32();
}

void SFCSimpleObject::read() {
        SFCObject::read();

        entity = (SFCEntity *)slurpMFC(TYPE_ENTITY);
}

void SFCPointerTool::read() {
        SFCSimpleObject::read();

        // discard unknown bytes
        if (parent->version() == 0)
                readBytes(35);
        else
                readBytes(51);
}

void SFCCallButton::read() {
        SFCSimpleObject::read();

        ourLift = (SFCLift *)slurpMFC(TYPE_LIFT);
        liftid = read8();
}

void SFCScript::read(SFCFile *f) {
        if (f->version() == 0) {
                eventno = f->read8();
                species = f->read8();
                genus = f->read8();
                family = f->read8();
        } else {
                genus = f->read8();
                family = f->read8();
                eventno = f->read16();
                species = f->read16();
        }
        data = f->readstring();
}

// ------------------------------------------------------------------

void SFCFile::copyToWorld() {
        // add the map data
        mapdata->copyToWorld();

        // install scripts
        for (std::vector<SFCScript>::iterator i = scripts.begin(); i != scripts.end(); i++) {
                i->install();
        }
        
        // create normal objects
        for (std::vector<SFCObject *>::iterator i = objects.begin(); i != objects.end(); i++) {
                (*i)->copyToWorld();
        }

        // create scenery
        for (std::vector<SFCScenery *>::iterator i = scenery.begin(); i != scenery.end(); i++) {
                (*i)->copyToWorld();
        }

        // move the camera to the correct position
        world.camera.moveTo(scrollx, scrolly, jump);

        // patch agents
        // TODO: do we really need to do this, and if so, should it be done here?
        // I like this for now because it makes debugging suck a lot less - fuzzie
        for (std::list<boost::shared_ptr<Agent> >::iterator i = world.agents.begin(); i != world.agents.end(); i++) {
                boost::shared_ptr<Agent> a = (*i);

                #define NUM_SFC_PATCHES 5

                /* version, family, genus, species, variable# */
                unsigned int patchdata[NUM_SFC_PATCHES][5] = {
                { 1, 2, 20, 10, 10 }, // c2's Pitz
                { 1, 2, 17, 2, 1 }, // c2's bees
                { 1, 2, 1, 50, 0 }, // c2 flask thing
                { 1, 2, 25, 1, 1}, // c2 tomatoes
                { 1, 2, 25, 6, 1} // c2 nuts
                };

                for (unsigned int j = 0; j < NUM_SFC_PATCHES; j++) {
                        if (version() == patchdata[j][0] && a->family == patchdata[j][1] && a->genus == patchdata[j][2] && a->species == patchdata[j][3]) {
                                // patch variable to actually refer to an agent
                                unsigned int varno = patchdata[j][4];
                                for (std::vector<SFCObject *>::iterator i = objects.begin(); i != objects.end(); i++) {
                                        if ((*i)->unid == (uint32)a->var[varno].getInt()) {
                                                a->var[varno].setAgent((*i)->copiedAgent());
                                                break;
                                        }
                                }

                                if (a->var[varno].hasInt()) {
                                        a->var[varno].setAgent(0);
                                        // This is useful to enable when you're testing a new patch.
                                        //std::cout << "Warning: Couldn't apply agent patch #" << j << "!" << std::endl;
                                }
                        }
                }
        }
}

#include "sprImage.h"
#include <iostream>

void MapData::copyToWorld() {
        // find the background sprite
        shared_ptr<creaturesImage> spr = world.gallery.getImage(background->filename);
        sfccheck(spr);

        // check for Terra Nornia's corrupt background sprite
        if (background->filename == "buro") {
                // apply stupid hack
                // TODO: can't we have a better check, eg checking if offsets are identical?
                std::cout << "Applying hack for probably-corrupt Terra Nornia background." << std::endl;
                sprImage *buro = dynamic_cast<sprImage *>(spr.get());
                if (buro)
                        buro->fixBufferOffsets();
        }

        // create the global metaroom
        // TODO: hardcoded size bad?
        unsigned int w = parent->version() == 0 ? 1200 : 2400;
        MetaRoom *m = new MetaRoom(0, 0, 8352, w, background->filename, spr, true);
        world.map.addMetaRoom(m);

        for (std::vector<CRoom *>::iterator i = rooms.begin(); i != rooms.end(); i++) {
                // retrieve our room data
                CRoom *src = *i;

                // create a new room, set the type
                shared_ptr<Room> r(new Room(src->left, src->right, src->top, src->top, src->bottom, src->bottom));
                r->type.setInt(src->roomtype);

                // add the room to the world, ensure it matches the id we retrieved
                unsigned int roomid = m->addRoom(r);
                // TODO: correct check?
                sfccheck(roomid == src->id);

                if (parent->version() == 1) {
                        // set floor points
                        r->floorpoints = src->floorpoints;

                        // set CAs
                        r->intr.setInt(src->inorganicnutrients);
                        r->ontr.setInt(src->organicnutrients);
                        r->temp.setInt(src->temperature);
                        r->pres.setInt(src->pressure);
                        r->lite.setInt(src->lightlevel);
                        r->radn.setInt(src->radiation);
                        r->hsrc.setInt(src->heatsource);
                        r->psrc.setInt(src->pressuresource);
                        r->lsrc.setInt(src->lightsource);
                        r->rsrc.setInt(src->radiationsource);

                        // set wind x/y
                        r->windx = src->windx;
                        r->windy = src->windy;

                        r->dropstatus.setInt(src->dropstatus);
                        r->floorvalue.setInt(src->floorvalue);

                        r->music = src->music;
                }
        }

        if (parent->version() == 0) return;

        for (std::vector<CRoom *>::iterator i = rooms.begin(); i != rooms.end(); i++) {
                CRoom *src = *i;

                for (unsigned int j = 0; j < 4; j++) {
                        for (std::vector<CDoor *>::iterator k = src->doors[j].begin(); k < src->doors[j].end(); k++) {
                                CDoor *door = *k;
                                shared_ptr<Room> r1 = world.map.getRoom(src->id);
                                shared_ptr<Room> r2 = world.map.getRoom(door->otherroom);
                
                                if (r1->doors.find(r2) == r1->doors.end()) {
                                        // create a new door between rooms!
                                        RoomDoor *roomdoor = new RoomDoor();
                                        roomdoor->first = r1;
                                        roomdoor->second = r2;
                                        roomdoor->perm = door->openness;
                                        r1->doors[r2] = roomdoor;
                                        r2->doors[r1] = roomdoor;
                                        // TODO: ADDR adds to nearby?
                                } else {
                                        // sanity check
                                        RoomDoor *roomdoor = r1->doors[r2];
                                        sfccheck(roomdoor->perm == door->openness);
                                }
                        }
                }
        }

        // TODO: misc data?
}

void copyEntityData(SFCEntity *entity, DullPart *p) {
        // pose
        p->setBase(entity->imgoffset);
        p->setPose(entity->currframe - entity->imgoffset);
        
        // animation
        if (entity->haveanim) {
                for (unsigned int i = 0; i < entity->animstring.size(); i++) {
                        if (entity->animstring[i] == 'R')
                                p->animation.push_back(255);
                        else {
                                sfccheck(entity->animstring[i] >= 48 && entity->animstring[i] <= 57);
                                p->animation.push_back(entity->animstring[i] - 48);
                        }
                }

                // TODO: should make sure animation position == current pose
                if (entity->animframe < p->animation.size()) {
                        if (p->animation[entity->animframe] == 255)
                                p->setFrameNo(0);
                        else
                                p->setFrameNo(entity->animframe);
                } else p->animation.clear();
        }
}

#include "CompoundAgent.h"

void SFCCompoundObject::copyToWorld() {
        sfccheck(parts.size() > 0);

        // construct our equivalent object, if necessary
        if (!ourAgent)
                ourAgent = new CompoundAgent(family, genus, species, parts[0]->zorder, parts[0]->sprite->filename, parts[0]->sprite->firstimg, parts[0]->sprite->noframes);

        // initialise the agent, move it into position
        CompoundAgent *a = ourAgent;
        a->finishInit();
        a->moveTo(parts[0]->x, parts[0]->y);
        a->queueScript(7); // enter scope
        
        if (parent->version() == 1) world.setUNID(a, unid);

        // TODO: c1 attributes!
        // C2 attributes are a subset of c2e ones
        a->setAttributes(attr);
        
        a->actv.setInt(actv);
        // TODO: this is to activate mover scripts in c1, does it apply to c2 too? is it correct at all?
        if ((parent->version() == 0) && actv) { a->actv.setInt(0); a->queueScript(actv); }

        // ticking
        a->tickssincelasttimer = tickstate;
        if (a->tickssincelasttimer == tickreset) a->tickssincelasttimer = 0;
        a->timerrate = tickreset;
        
        for (unsigned int i = 0; i < (parent->version() == 0 ? 3 : 100); i++)
                a->var[i].setInt(variables[i]);

        if (parent->version() == 1) {
                a->size.setInt(size);
                a->thrt.setInt(threat);
                a->range.setInt(range);
                a->accg.setInt(accg);
                a->grav.setInt(gravdata == 0xFFFFFFFF ? 0 : 1); // TODO
                a->velx.setInt(velx);
                a->vely.setInt(vely);
                a->rest.setInt(rest);
                a->aero.setInt(aero);
                a->paused = frozen; // TODO
        }

        for (unsigned int i = 0; i < parts.size(); i++) {
                SFCEntity *e = parts[i];
                if (!e) continue;
                DullPart *p;
                if (i == 0) {
                        p = (DullPart *)a->part(0);
                } else {
                        p = new DullPart(a, i, e->sprite->filename, e->sprite->firstimg, e->relx, e->rely, e->zorder - parts[0]->zorder);
                        a->addPart(p);
                }

                copyEntityData(e, p);
        }

        // add hotspots
        for (unsigned int i = 0; i < 6; i++) {
                a->setHotspotLoc(i, hotspots[i].left, hotspots[i].top, hotspots[i].right, hotspots[i].bottom);
                a->setHotspotFunc(i, hotspots[i].function);
                if (parent->version() == 1) {
                        a->setHotspotFuncDetails(i, hotspots[i].message, hotspots[i].mask);
                }
        }

        if (currentsound.size() != 0) {
                a->playAudio(currentsound, true, true);
        }
}

#include "SimpleAgent.h"

void SFCSimpleObject::copyToWorld() {
        // construct our equivalent object
        if (!ourAgent) {
                ourAgent = new SimpleAgent(family, genus, species, entity->zorder, sprite->filename, sprite->firstimg, sprite->noframes);
        }
        SimpleAgent *a = ourAgent;

        a->finishInit();
        //a->moveTo(entity->x - (a->part(0)->getWidth() / 2), entity->y - (a->part(0) -> getHeight() / 2));
        a->moveTo(entity->x, entity->y);
        a->queueScript(7); // enter scope

        if (parent->version() == 1) world.setUNID(a, unid);
        
        // copy data from ourselves
        
        // TODO: c1 attributes!
        // C2 attributes are a subset of c2e ones
        a->setAttributes(attr);
        
        a->actv.setInt(actv);
        // TODO: this is to activate mover scripts in c1, does it apply to c2 too? is it correct at all?
        if ((parent->version() == 0) && actv) a->queueScript(actv);

        // copy bhvrclick data
        a->clac[0] = entity->bhvrclick[0];
        a->clac[1] = entity->bhvrclick[1];
        a->clac[2] = entity->bhvrclick[2];

        // ticking
        a->tickssincelasttimer = tickstate;
        if (a->tickssincelasttimer == tickreset) a->tickssincelasttimer = 0;
        a->timerrate = tickreset;
        
        for (unsigned int i = 0; i < (parent->version() == 0 ? 3 : 100); i++)
                a->var[i].setInt(variables[i]);
        
        if (parent->version() == 1) {
                a->size.setInt(size);
                a->thrt.setInt(threat);
                a->range.setInt(range);
                a->accg.setInt(accg);
                a->grav.setInt(gravdata == 0xFFFFFFFF ? 0 : 1); // TODO
                a->velx.setInt(velx);
                a->vely.setInt(vely);
                a->rest.setInt(rest);
                a->aero.setInt(aero);
                a->paused = frozen; // TODO
        }

        // copy data from entity
        DullPart *p = (DullPart *)a->part(0);
        copyEntityData(entity, p);
        
        // TODO: bhvr
        // TODO: pickup handles/points
        
        if (currentsound.size() != 0) {
                a->playAudio(currentsound, true, true);
        }
}

void SFCPointerTool::copyToWorld() {
        // don't copy the cursor, for now at least :-)
}

#include "Blackboard.h"

void SFCBlackboard::copyToWorld() {
        ourAgent = new Blackboard(family, genus, species, parts[0]->zorder, parts[0]->sprite->filename, parts[0]->sprite->firstimg, parts[0]->sprite->noframes, textx, texty, backgroundcolour, chalkcolour, aliascolour);
        Blackboard *a = dynamic_cast<Blackboard *>(ourAgent);

        SFCCompoundObject::copyToWorld();

        for (unsigned int i = 0; i < strings.size(); i++) {
                a->addBlackboardString(i, strings[i].first, strings[i].second);
        }
}

#include "Vehicle.h"

void SFCVehicle::copyToWorld() {
        if (!ourAgent) {
                ourAgent = new Vehicle(family, genus, species, parts[0]->zorder, parts[0]->sprite->filename, parts[0]->sprite->firstimg, parts[0]->sprite->noframes);
        }
        Vehicle *a = dynamic_cast<Vehicle *>(ourAgent);
        assert(a);

        SFCCompoundObject::copyToWorld();

        // set cabin rectangle and plane
        a->setCabinRect(cabinleft, cabintop, cabinright, cabinbottom);
        a->cabinplane = 95; // TODO: arbitarily-chosen value (see also Vehicle constructor)

        // set bump, xvec and yvec
        a->bump = bump;
        a->xvec.setInt(xvec);
        a->yvec.setInt(yvec);
}

#include "Lift.h"

void SFCLift::copyToWorld() {
        Lift *a = new Lift(family, genus, species, parts[0]->zorder, parts[0]->sprite->filename, parts[0]->sprite->firstimg, parts[0]->sprite->noframes);
        ourAgent = a;

        SFCVehicle::copyToWorld();

        // set current button
        a->currentbutton = currentbutton;
        
        // set call button y locations
        for (unsigned int i = 0; i < nobuttons; i++) {
                a->callbuttony.push_back(callbuttony[i]);
        }
}

#include "CallButton.h"

void SFCCallButton::copyToWorld() {
        CallButton *a = new CallButton(family, genus, species, entity->zorder, sprite->filename, sprite->firstimg, sprite->noframes);
        ourAgent = a;

        SFCSimpleObject::copyToWorld();

        // set lift
        sfccheck(ourLift->ourAgent);
        assert(dynamic_cast<Lift *>(ourLift->ourAgent));
        a->lift = ourLift->ourAgent;

        a->buttonid = liftid;
}

void SFCScenery::copyToWorld() {
        SFCSimpleObject::copyToWorld();
        SpritePart *p = dynamic_cast<SpritePart *>(ourAgent->part(0));
        assert(p);
        p->is_transparent = true;
}

#include <boost/format.hpp>
#include <sstream>

#include "caosScript.h"

void SFCScript::install() {
        std::string scriptinfo = boost::str(boost::format("<SFC script %d, %d, %d: %d>") % (int)family % (int)genus % species % eventno);
        caosScript script(world.gametype, scriptinfo);
        std::istringstream s(data);
        try {
                script.parse(s);
                script.installInstallScript(family, genus, species, eventno);
                script.installScripts();
        } catch (creaturesException &e) {
                std::cerr << "installation of \"" << scriptinfo << "\" failed due to exception " << e.prettyPrint() << std::endl;
        } catch (std::exception &e) {
                std::cerr << "installation of \"" << scriptinfo << "\" failed due to exception " << e.what() << std::endl;
        }
}

/* vim: set noet: */