being.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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; either version 2 of the License, or
 *  any later version.
 *
 *  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, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "actorsprite.h"
#include "eventlistener.h"
#include "gui/gui.h"
#include "map.h"
#include "position.h"
#include "vector.h"
 
#include "utils/time.h"
 
#include <guichan/color.hpp>
#include <guichan/deathlistener.hpp>
 
#include <cstdint>
#include <map>
#include <set>
#include <string>
#include <vector>
 
#define STATUS_EFFECTS 32
 
#define SPEECH_TIME 500
#define SPEECH_MAX_TIME 10000
 
class BeingInfo;
class FlashText;
class Guild;
class ItemInfo;
class Particle;
class Party;
struct Position;
class SpeechBubble;
class Text;
 
enum class Gender
{
    Neutral,
    Male,
    Female
};
 
class Being : public ActorSprite, public EventListener, public gcn::DeathListener
{
    public:
        enum Action
        {
            STAND,
            MOVE,
            ATTACK,
            SIT,
            DEAD,
            HURT
        };
 
        enum Speech
        {
            NO_SPEECH = 0,
            TEXT_OVERHEAD,
            NO_NAME_IN_BUBBLE,
            NAME_IN_BUBBLE
        };
 
        enum AttackType
        {
            HIT = 0x00,
            CRITICAL = 0x0a,
            MULTI = 0x08,
            REFLECT = 0x04,
            FLEE = 0x0b
        };
 
        enum BeingDirection
        {
            DOWN = 1,
            LEFT = 2,
            UP = 4,
            RIGHT = 8
        };
 
        Being(int id, Type type, int subtype, Map *map);
 
        ~Being() override;
 
        Type getType() const final
        { return mType; }
 
        void setType(Type type, int subtype);
 
        void clearPath();
 
        void setDestination(int ex, int ey);
 
        const Vector &getDestination() const
        { return mDest; }
 
        int getTileX() const override
        { return mPos.x / mMap->getTileWidth(); }
 
        int getTileY() const override
        { return mPos.y / mMap->getTileHeight(); }
 
        void setSpeech(const std::string &text, int time = 5000);
 
        void takeDamage(Being *attacker, int damage,
                        AttackType type, int attackId = 1);
 
        void handleAttack(Being *victim, int damage, int attackId = 1);
 
        const ItemInfo *getEquippedWeapon() const
        { return mEquippedWeapon; }
 
        const std::string &getName() const
        { return mName; }
 
        void setName(const std::string &name);
 
        bool getShowName() const
        { return mShowName; }
 
        void setShowName(bool doShowName);
 
        void setPartyName(const std::string &name) { mPartyName = name; }
 
        const std::string &getPartyName() const { return mPartyName; }
 
        void setGuildName(const std::string &name);
 
        void setGuildPos(const std::string &pos);
 
        void addGuild(Guild *guild);
 
        void removeGuild(int id);
 
        Guild *getGuild(const std::string &guildName) const;
 
        Guild *getGuild(int id) const;
 
        const std::map<int, Guild*> &getGuilds() const
        { return mGuilds; }
 
        void clearGuilds();
 
        short getNumberOfGuilds() const
        { return mGuilds.size(); }
 
        bool isInParty() const
        { return mParty != nullptr; }
 
        void setParty(Party *party);
 
        Party *getParty() const
        { return mParty; }
 
        void setSprite(unsigned slot, int id,
                       const std::string &color = std::string(),
                       bool isWeapon = false);
 
        void setSpriteID(unsigned slot, int id);
 
        void setSpriteColor(unsigned slot,
                            const std::string &color = std::string());
 
        unsigned getSpriteCount() const
        { return mSpriteStates.size(); }
 
        bool drawnWhenBehind() const override;
 
        void logic() override;
 
        void drawSpeech(int offsetX, int offsetY);
 
        uint16_t getSubType() const { return mSubType; }
 
        const BeingInfo &getInfo() const
        { return *mInfo; }
 
        bool isTargetSelection() const;
 
        TargetCursorSize getTargetCursorSize() const override;
 
        Cursor getHoverCursor() const;
 
        unsigned char getWalkMask() const;
 
        Map::BlockType getBlockType() const override;
 
        void setMoveSpeed(const Vector &speed);
 
        void setAttackSpeed(int speed) { mAttackSpeed = speed; }
 
        int getAttackSpeed() const { return mAttackSpeed; }
 
        virtual void setAction(Action action, int attackId = 1);
 
        void setAction(const std::string &action);
 
        Action getCurrentAction() const { return mAction; }
 
        bool isAlive() const { return mAction != DEAD; }
 
        uint8_t getDirection() const { return mDirection; }
 
        void setDirection(uint8_t direction);
 
        SpriteDirection getSpriteDirection() const
        { return SpriteDirection(mSpriteDirection); }
 
        void setPosition(const Vector &pos) final;
 
        void setPosition(float x, float y, float z = 0.0f)
        {
            setPosition(Vector(x, y, z));
        }
 
        int getCollisionRadius() const;
 
        void fireMissile(Being *target, const std::string &particle);
 
        void setStatusEffect(int id, bool active);
 
        const Path &getPath() const { return mPath; }
 
        void flashName(int time);
 
        int getDamageTaken() const
        { return mDamageTaken; }
 
        void updateName();
 
        void setGender(Gender gender);
 
        Gender getGender() const
        { return mGender; }
 
        bool isGM() const
        { return mIsGM; }
 
        void setGM(bool gm);
 
        void setIp(int ip);
 
        int getIp() const { return mIp; }
 
        bool canTalk();
 
        void talkTo();
 
        // EventListener
        void event(Event::Channel channel, const Event &event) override;
 
        // gcn::DeathListener
        void death(const gcn::Event &event) override;
 
        void setMap(Map *map) final;
 
        void lookAt(const Vector &destVec);
        void lookAt(const Position &destPos)
        { lookAt(Vector(destPos.x, destPos.y)); }
 
    protected:
        struct SpriteState {
            int id = 0;
            int visibleId = 0;
            std::string color;
            std::vector<ParticleHandle> particles;
        };
 
        void setPath(const Path &path);
 
        void updateNamePosition();
 
        void addSpriteParticles(SpriteState &spriteState, const SpriteDisplay &display);
        void restoreAllSpriteParticles();
 
        void updateColors();
        void updatePlayerSprites();
 
        int getSpeechTextYPosition() const;
 
        virtual void pathFinished() {}
 
        virtual void updateStatusEffect(int index, bool newStatus);
 
        const BeingInfo *mInfo;
 
        Timer mActionTimer;     
        Timer mSpeechTimer;
 
        int mAttackSpeed = 350; 
        Action mAction = STAND;     
        int mSubType = 0xFFFF;      
        uint8_t mDirection = DOWN;                  
        uint8_t mSpriteDirection = DIRECTION_DOWN;  
        std::string mName;              
        std::string mPartyName;
 
        FlashText *mDispName = nullptr;
        const gcn::Color *mNameColor;
        bool mShowName = false;
 
        const ItemInfo *mEquippedWeapon = nullptr;
 
        Path mPath;
        std::string mSpeech;
        Text *mText = nullptr;
 
        Vector mDest;  
        std::vector<SpriteState> mSpriteStates;
        bool mRestoreParticlesOnLogic = false;
 
        Gender mGender = Gender::Neutral;
 
        // Character guild information
        std::map<int, Guild*> mGuilds;
        Party *mParty = nullptr;
 
        bool mIsGM = false;
 
    private:
        void updateMovement();
 
        Type mType = UNKNOWN;
 
        std::set<int> mStatusEffects;   
        std::map<int, ParticleHandle> mStatusParticleEffects;
 
        SpeechBubble *mSpeechBubble;
 
        Vector mMoveSpeed;
 
        Vector mSpeedPixelsPerSecond;
 
        int mDamageTaken = 0;
        int mIp = 0;
};