class.hpp

Go to the documentation of this file.

#ifndef GAME_MWWORLD_CLASS_H
#define GAME_MWWORLD_CLASS_H

#include <map>
#include <memory>
#include <string>
#include <vector>

#include "ptr.hpp"

namespace ESM
{
    struct ObjectState;
}

namespace MWRender
{
    class RenderingInterface;
}

namespace MWPhysics
{
    class PhysicsSystem;
}

namespace MWMechanics
{
    class CreatureStats;
    class NpcStats;
    struct Movement;
}

namespace MWGui
{
    struct ToolTipInfo;
}

namespace ESM
{
    struct Position;
}

namespace MWWorld
{
    class ContainerStore;
    class InventoryStore;
    class CellStore;
    class Action;

    class Class
    {
            static std::map<std::string, std::shared_ptr<Class> > sClasses;

            std::string mTypeName;

            // not implemented
            Class (const Class&);
            Class& operator= (const Class&);

        protected:

            Class();

            std::shared_ptr<Action> defaultItemActivate(const Ptr &ptr, const Ptr &actor) const;

            virtual Ptr copyToCellImpl(const ConstPtr &ptr, CellStore &cell) const;

        public:

            virtual ~Class();

            const std::string& getTypeName() const {
                return mTypeName;
            }

            virtual void insertObjectRendering (const Ptr& ptr, const std::string& mesh, MWRender::RenderingInterface& renderingInterface) const;
            virtual void insertObject(const Ptr& ptr, const std::string& mesh, MWPhysics::PhysicsSystem& physics) const;

            virtual std::string getName (const ConstPtr& ptr) const = 0;

            virtual void adjustPosition(const MWWorld::Ptr& ptr, bool force) const;

            virtual MWMechanics::CreatureStats& getCreatureStats (const Ptr& ptr) const;

            virtual bool hasToolTip (const ConstPtr& ptr) const;

            virtual MWGui::ToolTipInfo getToolTipInfo (const ConstPtr& ptr, int count) const;

            virtual bool showsInInventory (const ConstPtr& ptr) const;

            virtual MWMechanics::NpcStats& getNpcStats (const Ptr& ptr) const;

            virtual bool hasItemHealth (const ConstPtr& ptr) const;

            virtual int getItemHealth (const ConstPtr& ptr) const;

            virtual int getItemMaxHealth (const ConstPtr& ptr) const;

            virtual void hit(const Ptr& ptr, float attackStrength, int type=-1) const;

            virtual void onHit(const MWWorld::Ptr &ptr, float damage, bool ishealth, const MWWorld::Ptr &object, const MWWorld::Ptr &attacker, const osg::Vec3f &hitPosition, bool successful) const;

            virtual void block (const Ptr& ptr) const;

            virtual bool canBeActivated(const Ptr& ptr) const;

            virtual std::shared_ptr<Action> activate (const Ptr& ptr, const Ptr& actor) const;

            virtual std::shared_ptr<Action> use (const Ptr& ptr, bool force=false)
                const;

            virtual ContainerStore& getContainerStore (const Ptr& ptr) const;

            virtual InventoryStore& getInventoryStore (const Ptr& ptr) const;

            virtual bool hasInventoryStore (const Ptr& ptr) const;

            virtual void lock (const Ptr& ptr, int lockLevel) const;

            virtual void unlock (const Ptr& ptr) const;

            virtual bool canLock (const ConstPtr& ptr) const;

            virtual void setRemainingUsageTime (const Ptr& ptr, float duration) const;

            virtual float getRemainingUsageTime (const ConstPtr& ptr) const;

            virtual std::string getScript (const ConstPtr& ptr) const;

            virtual float getSpeed (const Ptr& ptr) const;

            virtual float getJump(const MWWorld::Ptr &ptr) const;

            virtual MWMechanics::Movement& getMovementSettings (const Ptr& ptr) const;

            virtual osg::Vec3f getRotationVector (const Ptr& ptr) const;

            virtual std::pair<std::vector<int>, bool> getEquipmentSlots (const ConstPtr& ptr) const;

            virtual int getEquipmentSkill (const ConstPtr& ptr)
                const;

            virtual int getValue (const ConstPtr& ptr) const;

            virtual float getCapacity (const MWWorld::Ptr& ptr) const;

            virtual float getEncumbrance (const MWWorld::Ptr& ptr) const;

            virtual float getNormalizedEncumbrance (const MWWorld::Ptr& ptr) const;

            virtual bool apply (const MWWorld::Ptr& ptr, const std::string& id,
                const MWWorld::Ptr& actor) const;

            virtual void skillUsageSucceeded (const MWWorld::Ptr& ptr, int skill, int usageType, float extraFactor=1.f) const;

            virtual bool isEssential (const MWWorld::ConstPtr& ptr) const;

            virtual std::string getUpSoundId (const ConstPtr& ptr) const;

            virtual std::string getDownSoundId (const ConstPtr& ptr) const;

            virtual std::string getSoundIdFromSndGen(const Ptr &ptr, const std::string &type) const;

            virtual float getArmorRating (const MWWorld::Ptr& ptr) const;

            virtual std::string getInventoryIcon (const MWWorld::ConstPtr& ptr) const;

            virtual std::string getEnchantment (const MWWorld::ConstPtr& ptr) const;

            virtual int getEnchantmentPoints (const MWWorld::ConstPtr& ptr) const;

            virtual void adjustScale(const MWWorld::ConstPtr& ptr, osg::Vec3f& scale, bool rendering) const;

            virtual bool canSell (const MWWorld::ConstPtr& item, int npcServices) const;

            virtual int getServices (const MWWorld::ConstPtr& actor) const;

            virtual std::string getModel(const MWWorld::ConstPtr &ptr) const;

            virtual bool useAnim() const;

            virtual void getModelsToPreload(const MWWorld::Ptr& ptr, std::vector<std::string>& models) const;

            virtual std::string applyEnchantment(const MWWorld::ConstPtr &ptr, const std::string& enchId, int enchCharge, const std::string& newName) const;

            virtual std::pair<int, std::string> canBeEquipped(const MWWorld::ConstPtr &ptr, const MWWorld::Ptr &npc) const;

            virtual float getWeight (const MWWorld::ConstPtr& ptr) const;

            virtual bool isPersistent (const MWWorld::ConstPtr& ptr) const;

            virtual bool isKey (const MWWorld::ConstPtr& ptr) const { return false; }

            virtual bool isGold(const MWWorld::ConstPtr& ptr) const { return false; }

            virtual bool allowTelekinesis(const MWWorld::ConstPtr& ptr) const { return true; }
            
            virtual int getBloodTexture (const MWWorld::ConstPtr& ptr) const;

            virtual Ptr copyToCell(const ConstPtr &ptr, CellStore &cell, int count) const;

            virtual Ptr copyToCell(const ConstPtr &ptr, CellStore &cell, const ESM::Position &pos, int count) const;

            virtual bool isActivator() const {
                return false;
            }

            virtual bool isActor() const {
                return false;
            }

            virtual bool isNpc() const {
                return false;
            }

            virtual bool isDoor() const {
                return false;
            }

            virtual bool isBipedal(const MWWorld::ConstPtr& ptr) const;
            virtual bool canFly(const MWWorld::ConstPtr& ptr) const;
            virtual bool canSwim(const MWWorld::ConstPtr& ptr) const;
            virtual bool canWalk(const MWWorld::ConstPtr& ptr) const;
            bool isPureWaterCreature(const MWWorld::Ptr& ptr) const;
            bool isPureFlyingCreature(const MWWorld::Ptr& ptr) const;
            bool isPureLandCreature(const MWWorld::Ptr& ptr) const;
            bool isMobile(const MWWorld::Ptr& ptr) const;

            virtual int getSkill(const MWWorld::Ptr& ptr, int skill) const;

            virtual void readAdditionalState (const MWWorld::Ptr& ptr, const ESM::ObjectState& state)
                const;

            virtual void writeAdditionalState (const MWWorld::ConstPtr& ptr, ESM::ObjectState& state)
                const;

            static const Class& get (const std::string& key);

            static void registerClass (const std::string& key,  std::shared_ptr<Class> instance);

            virtual int getBaseGold(const MWWorld::ConstPtr& ptr) const;

            virtual bool isClass(const MWWorld::ConstPtr& ptr, const std::string &className) const;

            virtual int getDoorState (const MWWorld::ConstPtr &ptr) const;
            virtual void setDoorState (const MWWorld::Ptr &ptr, int state) const;

            virtual void respawn (const MWWorld::Ptr& ptr) const {}

            virtual void restock (const MWWorld::Ptr& ptr) const {}

            virtual std::string getSound(const MWWorld::ConstPtr& ptr) const;

            virtual int getBaseFightRating (const MWWorld::ConstPtr& ptr) const;

            virtual std::string getPrimaryFaction (const MWWorld::ConstPtr& ptr) const;
            virtual int getPrimaryFactionRank (const MWWorld::ConstPtr& ptr) const;

            virtual float getEffectiveArmorRating(const MWWorld::ConstPtr& armor, const MWWorld::Ptr& actor) const;
    };
}

#endif