pscharacterloader.h

Go to the documentation of this file.

/*
 * pscharacterloader.h
 *
 * Copyright (C) 2001 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * 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 (version 2 of the License)
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */




#ifndef __PSCHARACTERLOADER_H__
#define __PSCHARACTERLOADER_H__

//=============================================================================
// Crystal Space Includes
//=============================================================================

//=============================================================================
// Project Includes
//=============================================================================
#include "util/gameevent.h"

#include <idal.h>      // Database Abstraction Layer Interface

#include "../gem.h"

//=============================================================================
// Local Includes
//=============================================================================


class csMutex;
class psCharacterList;
class psSectorInfo;
class psCharacter;
class psItem;
class psItemStats;
class gemActor;

/*  Why isn't there a LoadItem() call here?
 *
 *  At the time of initial design the circumstances under which an item entry will be loaded are unclear.
 *  It is virtually guaranteed that item entries will need to be loaded when a character is loaded as the character's
 *    inventory (list of items) will be necessary.
 *  It is undecided wether some, all or no items in the world and not on a character will be saved to the database.
 *    If they are saved it is likely that many items will be loaded all at once - possibly based on location data
 *    (x,y,z,sector), possibly based on some other criteria.
 */

class psCharacterLoader
{
public:
    psCharacterLoader();

    ~psCharacterLoader();

    bool Initialize();

    psCharacterList* LoadCharacterList(AccountID accountid);


    psCharacter** LoadAllNPCCharacterData(psSectorInfo* sector,int &count);

    psCharacter* LoadCharacterData(PID pid, bool forceReload);

    psCharacter* QuickLoadCharacterData(PID pid, bool noInventory);

    bool NewCharacterData(AccountID accountid, psCharacter* chardata);
    bool NewNPCCharacterData(AccountID accountid,psCharacter* chardata);
    unsigned int InsertNewCharacterData(const char** fieldnames, psStringArray &fieldvalues);

    bool SaveCharacterData(psCharacter* chardata,gemActor* actor,bool charRecordOnly=false);

    bool DeleteCharacterData(PID pid, csString &error);


    PID FindCharacterID(const char* character_name, bool excludeNPCs=true);

    PID FindCharacterID(AccountID accountID, const char* character_name);

    bool AccountOwner(const char* characterName, AccountID accountID);

    bool UpdateCharacterSkill(PID pid, unsigned int skill_id,
                              unsigned int skill_z, unsigned int skill_y, unsigned int skill_rank);


private:

    bool ClearCharacterAdvantages(PID pid);
    bool SaveCharacterAdvantage(PID pid, unsigned int advantage_id);
    bool ClearCharacterSkills(PID pid);
    bool ClearCharacterTraits(PID pid);
    bool SaveCharacterSkill(PID pid,unsigned int skill_id,
                            unsigned int skill_z, unsigned int skill_y, unsigned int skill_rank);
    bool SaveCharacterTrait(PID pid, unsigned int trait_id);
    bool UpdateQuestAssignments(psCharacter* chr);
    bool ClearCharacterSpell(psCharacter* character);
    bool SaveCharacterSpell(psCharacter* character);

};

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


class psSaveCharEvent : public psGameEvent, public iDeleteObjectCallback
{
public:
    enum Type
    {
        SAVE_PERIOD = 600000
    };

    gemActor* actor;     

    psSaveCharEvent(gemActor* actor);

    ~psSaveCharEvent();

    virtual void Trigger();  // Abstract event processing function

    virtual void DeleteObjectCallback(iDeleteNotificationObject* object);
};

#endif