psclientchar.h

Go to the documentation of this file.

/*
 * psclientchar.h 
 *
 * Copyright (C) 2002 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.
 *
 * Manages details about the player as it talks to it's server version
 */
#ifndef PS_CLIENT_CHAR_H
#define PS_CLIENT_CHAR_H
//=============================================================================
// Crystal Space Includes
//=============================================================================
#include <csutil/ref.h>
#include <iutil/document.h>
#include <csutil/refarr.h>
#include <imesh/spritecal3d.h>
#include <csgeom/vector4.h>

//=============================================================================
// Project Includes
//=============================================================================
#include "net/cmdbase.h"
#include "net/charmessages.h"

#include "util/namegenerator.h"

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

struct iVFS;
struct iObjectRegistry;
struct iSector;
struct iMeshObjectFactory;

class MsgHandler;
class MsgEntry;

class psCelClient;
class psCreationManager;

class GEMClientObject;

struct Trait
{
    void Load( iDocumentNode * node);
    PSTRAIT_LOCATION ConvertTraitLocationString(const char *locationstring);

    static const char* locationString[];
    const char* GetLocationString() const;
    unsigned int uid;
    unsigned int next_trait_uid;
    Trait *next_trait,*prev_trait;
    unsigned int raceID;
    PSCHARACTER_GENDER gender;
    PSTRAIT_LOCATION location;
    csString name;
    csString mesh;
    csString material;
    csString subMesh;
    csVector3 shader;   
};


class psClientCharManager : public psClientNetSubscriber
{
public:
    psClientCharManager(iObjectRegistry *objectreg);    
    virtual ~psClientCharManager();
    bool Initialize( MsgHandler* msghandler, psCelClient* );
       
    bool Ready() { return ready; }
    
    virtual void HandleMessage( MsgEntry* me );
    
    psCreationManager* GetCreation() { return charCreation; }

    void SetTarget(GEMClientObject *newTarget, const char *action, bool notifyServer=true);

    void LockTarget(bool state);

    GEMClientObject * GetTarget() { return target; };

protected:
    void ChangeTrait(MsgEntry* me);

    void HandleAction(MsgEntry* me);

    void HandleEquipment(MsgEntry* me);

    void HandleEffect(MsgEntry* me);

    void HandleEffectStop(MsgEntry* me);

    void HandleRejectCharMessage(MsgEntry* me);

    void HandlePlaySound(MsgEntry* me);

    void HandleTargetUpdate(MsgEntry* me);

    csRef<MsgHandler>         msghandler;
    iObjectRegistry*          objectReg;
    csRef<iVFS>               vfs;

    psCreationManager* charCreation;

    unsigned int targetEffect;

    GEMClientObject * target;

    psCelClient *cel;
    bool ready;

    bool lockedTarget;

    csHash<unsigned int, uint32_t> effectMapper;
};


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

#define REQUESTING_CP -1


struct CustomChoice
{    
    void Load( iDocumentNode* node );
    csString mesh;
    csString material;
    csString name; 
    csString texture;
    PSCHARACTER_GENDER gender;
    int id;
};

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

struct MaterialSet
{
    void Load( iDocumentNode* node );
    csString name;
    PSCHARACTER_GENDER gender;
    csPDelArray<CustomChoice> materials;
    int id;
};


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

struct RaceDefinition
{
    csString name;              
    csString description;       
    
    csString femaleModelName;   
    csString maleModelName;

    bool femaleAvailable;
    bool maleAvailable;
            
    int startingCP;    
    
    // Camera positions for this race allows different heights
    csVector3 FollowPos, LookatPos, FirstPos, ViewerPos;
    
    csArray<Trait*> location[PSTRAIT_LOCATION_COUNT][PSCHARACTER_GENDER_COUNT];
    
    csVector3 zoomLocations[PSTRAIT_LOCATION_COUNT];
};

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

struct PathDefinition
{
    csString name;

    struct Bonus
    {
        csString name;
        float value;
    };

    csPDelArray<Bonus> statBonuses;
    csPDelArray<Bonus> skillBonuses;
    
    csString info;
    csString parents;
    csString life;
};

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

class psCreationManager : public psClientNetSubscriber
{
public:
    
    psCreationManager(iObjectRegistry *objectreg);
    virtual ~psCreationManager();

    void HandleMessage( MsgEntry* me );
   
    int GetRaceCP( int race );
    
    const char* GetRaceDescription( int race );
    
    RaceDefinition* GetRace( int race );
    RaceDefinition* GetRace( const char* name );

    typedef csPDelArray<PathDefinition>::Iterator PathIterator;
    PathIterator GetPathIterator();

    PathDefinition* GetPath(int i);

    typedef csPDelArray<Trait>::Iterator TraitIterator;
    TraitIterator GetTraitIterator() { return traits.GetIterator(); };
    Trait* GetTrait(unsigned int uid);
    
    void GetParentData();
    void GetChildhoodData();
    void GetLifeEventData();
    void GetTraitData();

    
    bool HasParentData() { return hasParentData; }
    bool HasChildhoodData() { return hasChildhoodData; }
    bool HasLifeEventData() { return hasLifeEventData; }

    const char* GetModelName( int race, int gender );
    
    csArray<CreationChoice> parentData;  
    
    csArray<CreationChoice> childhoodData;
 
    //
    csArray<LifeEventChoice> lifeEventData;
    
    const char* GetDescription( int choiceID );
    
    int GetCurrentCP() { return currentCP; }
    void SetCurrentCP( int value ) { currentCP = value; }
    
    void SetRace( int selectedRace );
    int  GetSelectedRace() { return selectedRace; }
    
    void SetGender( int gender ) { selectedGender = gender; }
    int  GetSelectedGender() { return selectedGender; }
    
    void UploadChar( bool doVerify = false );
    void SetName( const char* newName );
    const char* GetName();
    
    LifeEventChoice* FindLifeEvent( int idNumber );

    void AddChoice( int choice, int modifier = 1 );
    void RemoveChoice( uint32_t choice, int modifier = 1 );
    csArray<uint32_t> GetChoicesMade() { return choicesMade;}
    CreationChoice* GetChoice(int id);
    void AddLifeEvent( int event );
    void RemoveLifeEvent( uint32_t event );
    csArray<uint32_t> GetLifeChoices() { return lifeEventsMade;}
    size_t GetNumberOfLifeChoices() { return lifeEventsMade.GetSize(); }
    
    int GetCost(int idChoice);
    int GetLifeCost( int id );
    
    void SetCustomization( int face, int hairStyle, int beardStyle, int hairColour, int skinColour );
    void GetCustomization( int& face, int& hairStyle, int& beardStyle, int& hairColour, int& skinColour);
    
    void GenerateName(int type,csString &namebuffer,int max_low,int max_high)
    { nameGenerator->GenerateName( type, namebuffer, max_low, max_high ); }
        
    const char* GetLifeEventDescription( int id );

    bool IsAvailable(int id,int gender);
    
    void SetFatherMod( int mod ) { fatherMod = mod; }
    void SetMotherMod( int mod ) { motherMod = mod; }
    const char *GetFatherModAsText( void ) { switch (fatherMod) { case 2: return "Famous "; case 3: return "Exceptional "; default: return "";} }
    const char *GetMotherModAsText( void ) { switch (motherMod) { case 2: return "Famous "; case 3: return "Exceptional "; default: return "";} }

    void ClearChoices();
    void SetPath( const char* name ) { path = name; }
private:
    iObjectRegistry* objectReg;

    csString path;
    
    void LoadRaceInformation();

    void LoadPathInfo();
   
    csPDelArray<RaceDefinition> raceDescriptions;    

    csPDelArray<PathDefinition> pathDefinitions;

    csPDelArray<Trait> traits;    
    
    csRef<MsgHandler> msgHandler;
    
    bool hasParentData;
    bool hasChildhoodData;
    bool hasLifeEventData;
    bool hasTraitData;

    void HandleVerify( MsgEntry* me );
    void HandleParentsData( MsgEntry* me );  
    void HandleChildhoodData( MsgEntry* me );
    void HandleLifeEventData( MsgEntry* me );
    void HandleTraitData( MsgEntry* me );
    
    NameGenerationSystem * nameGenerator;
    
    // Data chosen in char creation screens
    csString selectedName;
    int selectedRace;
    int selectedGender;
    int currentCP;
    csArray<uint32_t> choicesMade;
    csArray<uint32_t> lifeEventsMade;     
    
    int selectedFace;
    int selectedHairStyle;
    int selectedBeardStyle;
    int selectedHairColour;
    int selectedSkinColour;  
    
    int fatherMod;
    int motherMod;
};



#endif