creature.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_NWN_CREATURE_H
#define ENGINES_NWN_CREATURE_H

#include <vector>
#include <list>

#include "src/common/types.h"
#include "src/common/scopedptr.h"
#include "src/common/ptrvector.h"
#include "src/common/ustring.h"

#include "src/aurora/types.h"

#include "src/graphics/aurora/types.h"
#include "src/graphics/aurora/texturehandle.h"

#include "src/engines/nwn/types.h"
#include "src/engines/nwn/object.h"

namespace Engines {

namespace NWN {

class Item;

class Creature : public Object {
public:
    Creature();
    Creature(const Aurora::GFF3Struct &creature);
    Creature(const Common::UString &bic, bool local);
    ~Creature();

    uint32 lastChangedGUIDisplay() const;

    // Basic visuals

    void loadModel();   
    void unloadModel(); 

    void show(); 
    void hide(); 

    // Basic properties

    const Common::UString &getFirstName() const;
    const Common::UString &getLastName() const;

    Gender getGender() const;
    void setGender(Gender gender);
    bool isFemale() const;

    uint32 getRace() const;
    void setRace(uint32 race);

    void setPortrait(const Common::UString &portrait);
    const Common::UString &getPortrait() const;

    const Common::UString &getConvRace() const;
    const Common::UString &getConvrace() const;
    const Common::UString &getConvRaces() const;

    const Common::UString &getSubRace() const;

    void getClass(uint32 position, uint32 &classID, uint16 &level) const;
    uint16 getClassLevel(uint32 classID) const;
    void changeClassLevel(uint32 classID, int16 levelChange);

    const Common::UString &getConvClass() const;
    const Common::UString &getConvclass() const;
    const Common::UString &getConvClasses() const;

    Common::UString getClassString() const;

    uint8 getHitDice() const;

    uint8 getAbility(Ability ability) const;
    void setAbility(Ability ability, uint8 score);
    int8 getSkillRank(uint32 skill) const;
    void setSkillRank(size_t skill, uint8 rank);
    void setFeat(uint32 feat);
    bool hasFeat(uint32 feat) const;

    const Common::UString &getDeity() const;

    uint8 getGoodEvil() const;
    void setGoodEvil(uint8 goodness);
    uint8 getLawChaos() const;
    void setLawChaos(uint8 lawfulness);

    void setSoundSet(uint32 soundSet);

    bool isPC() const; 
    bool isDM() const; 

    uint32 getAge() const;

    uint32 getXP() const;

    int32 getCurrentHP() const;
    int32 getMaxHP() const;

    uint8 getStartingPackage() const;
    void setStartingPackage(uint8 package);

    void getDomains(uint32 classID, uint8 &domain1, uint8 &domain2);
    void setDomains(uint32 classID, uint8 domain1, uint8 domain2);

    bool hasSpell(uint32 classID, size_t spellLevel, uint16 spell);
    void setSchool(uint32 classID, uint8 school);
    void setKnownSpell(uint32 classID, size_t spellLevel, uint16 spell);
    void setMemorizedSpell(uint32 classID, size_t spellLevel, uint16 spell);

    void setAppearance(uint32 appearanceID);
    void setPhenotype(uint32 phenotype);
    void setColorSkin(uint32 colorSkin);
    void setColorHair(uint32 colorHair);
    void setColorTatto1(uint32 colorTattoo1);
    void setColorTatto2(uint32 colorTattoo2);
    void setHead(uint32 headID);

    void addEquippedItem(Item *item);

    // Object/Object interactions

    void setArea(Area *area);

    void addAssociate(Creature &associate, AssociateType type);
    void removeAssociate(Creature &ssociate);

    Creature *getAssociate(AssociateType type, size_t nth = 1) const;

    Creature *getMaster() const;
    void setMaster(Creature *master = 0);

    bool isCommandable() const;
    void setCommandable(bool commandable);

    // Positioning

    void setPosition(float x, float y, float z);
    void setOrientation(float x, float y, float z, float angle);

    // Object/Cursor interactions

    void enter(); 
    void leave(); 

    virtual void highlight(bool enabled);

    virtual bool click(Object *triggerer = 0);

    // Animation

    void playAnimation(const Common::UString &animation = "", bool restart = true,
                       float length = 0.0f, float speed = 1.0f);
    void playAnimation(Animation animation, bool restart = true,
                       float length = 0.0f, float speed = 1.0f);


    static void getPCListInfo(const Common::UString &bic, bool local,
                              Common::UString &name, Common::UString &classes,
                              Common::UString &portrait);

private:
    enum BodyPartType {
        kBodyPartHead       = 0,
        kBodyPartNeck          ,
        kBodyPartTorso         ,
        kBodyPartPelvis        ,
        kBodyPartBelt          ,
        kBodyPartRightFoot     ,
        kBodyPartLeftFoot      ,
        kBodyPartRightShin     ,
        kBodyPartLeftShin      ,
        kBodyPartLeftThigh     ,
        kBodyPartRightThigh    ,
        kBodyPartRightFArm     ,
        kBodyPartLeftFArm      ,
        kBodyPartRightBicep    ,
        kBodyPartLeftBicep     ,
        kBodyPartRightShoul    ,
        kBodyPartLeftShoul     ,
        kBodyPartRightHand     ,
        kBodyPartLeftHand      ,
        kBodyPartMAX
    };

    struct Class {
        uint32 classID; 
        uint16 level;   

        uint8 domain1; 
        uint8 domain2; 

        uint8 school; 

        std::vector<std::vector<uint16> > knownList;     
        std::vector<std::vector<uint16> > memorizedList; 

        Class();
    };

    struct Associate {
        AssociateType type;  
        Creature *associate; 

        Associate(AssociateType t = kAssociateTypeNone, Creature *a = 0);
    };

    struct BodyPart {
        uint32 id;      
        uint32 idArmor; 

        Common::UString modelName;   
        Common::UString textureName; 

        std::list<Graphics::Aurora::TextureHandle> textures;

        BodyPart();
    };

    uint32 _lastChangedGUIDisplay;

    Common::UString _firstName; 
    Common::UString _lastName;  

    Gender _gender; 
    uint32 _race;   

    Common::UString _subRace; 

    bool _isPC; 
    bool _isDM; 

    uint32 _age; 

    uint32 _xp; 

    int32 _baseHP;    
    int32 _bonusHP;   
    int32 _currentHP; 

    uint8 _abilities[kAbilityMAX]; 

    std::vector<Class>  _classes; 
    std::vector<int8>   _skills;  
    std::vector<uint32> _feats;   

    uint8 _hitDice; 

    Common::UString _deity; 

    uint8 _goodEvil; 
    uint8 _lawChaos; 

    uint32 _appearanceID; 
    uint32 _phenotype;    

    uint8 _startingPackage; 

    std::vector<BodyPart> _bodyParts; 

    Common::PtrVector<Item> _equippedItems; 

    Common::UString _partsSuperModelName; 

    Common::UString _environmentMap; 

    uint32 _colorSkin;    
    uint32 _colorHair;    
    uint32 _colorTattoo1; 
    uint32 _colorTattoo2; 

    uint32 _colorMetal1; 
    uint32 _colorMetal2; 
    uint32 _colorLeather1; 
    uint32 _colorLeather2; 
    uint32 _colorCloth1; 
    uint32 _colorCloth2; 

    Creature *_master;                
    std::list<Associate> _associates; 

    bool _isCommandable;

    Common::ScopedPtr<Graphics::Aurora::Model> _model; 


    void init();
    void loadCharacter(const Common::UString &bic, bool local);
    void load(const Aurora::GFF3Struct &creature);

    void load(const Aurora::GFF3Struct &instance, const Aurora::GFF3Struct *blueprint);

    void loadProperties(const Aurora::GFF3Struct &gff);

    static void loadPortrait(const Aurora::GFF3Struct &gff, Common::UString &portrait);
    static void loadClasses (const Aurora::GFF3Struct &gff,
                             std::vector<Class> &classes, uint8 &hitDice);

    void loadEquippedItems(const Aurora::GFF3Struct &gff);

    void constructPartName(const Common::UString &type, uint32 id,
                                     const Common::UString &gender,
                                     const Common::UString &race,
                                     const Common::UString &phenoType,
                                     Common::UString &part);

    void constructPartName(const Common::UString &type, uint32 id,
                                     const Common::UString &gender,
                                     const Common::UString &race,
                                     const Common::UString &phenoType,
                                     const Common::UString &phenoTypeAlt,
                                     Aurora::FileType fileType,
                                     Common::UString &part);

    void constructModelName(const Common::UString &type, uint32 id,
                            const Common::UString &gender,
                            const Common::UString &race,
                            const Common::UString &phenoType,
                            const Common::UString &phenoTypeAlt,
                            Common::UString &model,
                            Common::UString &texture);

    void getPartModels(); 
    void getArmorModels(); 

    Class *findClass(uint32 classID);

    void finishPLTs(const std::list<Graphics::Aurora::TextureHandle> &plts);

    static Aurora::GFF3File *openPC(const Common::UString &bic, bool local);
    static void getClassString(const std::vector<Class> &classes, Common::UString &str);

    bool createTooltip(Tooltip::Type type);
};

} // End of namespace NWN

} // End of namespace Engines

#endif // ENGINES_NWN_CREATURE_H