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_NWN2_CREATURE_H
#define ENGINES_NWN2_CREATURE_H

#include <vector>
#include <list>

#include "src/common/types.h"
#include "src/common/ptrlist.h"
#include "src/common/ustring.h"

#include "src/aurora/types.h"

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

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

namespace Engines {

namespace NWN2 {

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

    // Basic visuals

    void loadModel();   
    void unloadModel(); 

    void show(); 
    void hide(); 

    // Basic properties

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

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

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

    uint32 getSubRace() const;
    void setSubRace(uint32 subRace);

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

    uint8 getHitDice() const;

    uint8 getAbility(Ability ability) const;
     int8 getSkillRank(uint32 skill) const;
    bool  hasFeat(uint32 feat) const;

    const Common::UString &getDeity() const;

    uint8 getGoodEvil() const;
    uint8 getLawChaos() const;

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

    uint32 getAge() const;

    uint32 getXP() const;

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

    // 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(); 

    void highlight(bool enabled);

    bool click(Object *triggerer = 0);

private:
    typedef Common::PtrList<Graphics::Aurora::Model> ModelParts;

    struct Class {
        uint32 classID; 
        uint16 level;   
    };

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

    uint32 _gender;  
    uint32 _race;    
    uint32 _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; 

    uint8 _armorVisualType;
    uint8 _armorVariation;

    uint8 _bootsVisualType;
    uint8 _bootsVariation;

    uint8 _appearanceHead;  
    uint8 _appearanceMHair; 
    uint8 _appearanceFHair; 

    ModelParts _modelParts;


    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 loadClasses (const Aurora::GFF3Struct &gff,
                             std::vector<Class> &classes, uint8 &hitDice);

    // Model loaders

    Common::UString getBaseModel(const Common::UString &base);
    bool loadArmorModel(const Common::UString &body, const Common::UString &armor,
                        uint8 visualType, uint8 variation);
    bool loadHeadModel(uint8 appearance);
    bool loadHairModel(uint8 appearance);

    static Aurora::GFF3File *openPC(const Common::UString &bic, bool local);
};

} // End of namespace NWN2

} // End of namespace Engines

#endif // ENGINES_NWN2_CREATURE_H