mission.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Based on the original sources
 *   Faery Tale II -- The Halls of the Dead
 *   (c) 1993-1996 The Wyrmkeep Entertainment Co.
 */

#ifndef SAGA2_MISSION_H
#define SAGA2_MISSION_H

#include "saga2/objects.h"

namespace Saga2 {

//  Used to store a record of mission knowledge that
//  has been added to an actor, and will be deleted after
//  the mission is destructed.
struct KnowledgeID {
    ObjectID    id;
    uint16      kID;
};

class ActiveMission;

#include "common/pack-start.h"

//  Mission flags
enum missionFlags {
    kInUse = (1 << 0)               // this mission struct in use
};

struct ActiveMissionData {
    //  Store the unique ID of this active mission, and the
    //  object ID of the generator.
    uint16          missionID;          // ID of this instance
    ObjectID        generatorID;        // ObjectID of generator instance
    uint16          missionScript;      // script for this mission
    uint16          missionFlags;       // various mission flags

    //  Specific variables relating to the mission which can
    //  be defined by the script writer.
    uint8           missionVars[32];

    //  Record what resources were created for this mission
    ObjectID        missionObjectList[32];
    KnowledgeID     missionKnowledgeList[32];
    uint16          numObjectIDs,
                    numKnowledgeIDs;

    ActiveMission *aMission; // ActiveMission this ActiveMissionData belongs to
} PACKED_STRUCT;

#include "common/pack-end.h"

class ActiveMission {

    friend void initMissions();
    friend void cleanupMissions();

public:

    ActiveMissionData _data;

public:
    static ActiveMission *newMission(ObjectID genID, uint16 script);
    static int  findMission(ObjectID genID);
    static ActiveMission *missionAddress(int index);

    void read(Common::InSaveFile *in);
    void write(Common::MemoryWriteStreamDynamic *out);

    void cleanup();

    bool spaceForObject() {
        return _data.numObjectIDs < ARRAYSIZE(_data.missionObjectList);
    }

    //  Add record of object creation to mission
    bool addObjectID(ObjectID objID);

    //  Add record of object creation to mission
    bool removeObjectID(ObjectID objID);

    //  Add record of knowledge creation to mission
    bool addKnowledgeID(ObjectID actor, uint16 knowledgeID);

    //  Add record of knowledge creation to mission
    bool removeKnowledgeID(ObjectID actor, uint16 knowledgeID);

    int16 getMissionID() {
        return _data.missionID;
    }

    uint16 getScript() {
        return _data.missionScript;
    }
};

//  Initialize the active mission list
void initMissions();

void saveMissions(Common::OutSaveFile *out);
void loadMissions(Common::InSaveFile *in);

//  Cleanup the active mission list
inline void cleanupMissions() { /* do nothing */ }

} // end of namespace Saga2

#endif