/*
* The Mana World
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World 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.
*
* The Mana World 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 The Mana World; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef _TMW_BEING_H
#define _TMW_BEING_H
#include <list>
#include <memory>
#include <SDL_types.h>
#include <string>
#include <vector>
#include "animatedsprite.h"
#include "effectmanager.h"
#include "map.h"
#include "sprite.h"
#include "gui/speechbubble.h"
#include "resources/colordb.h"
#define FIRST_IGNORE_EMOTE 14
class AnimatedSprite;
class Equipment;
class ItemInfo;
class Item;
class Map;
class Graphics;
class Particle;
class SpeechBubble;
class Text;
/**
* A position along a being's path.
*/
struct PATH_NODE
{
/**
* Constructor.
*/
PATH_NODE(unsigned short x, unsigned short y):
x(x), y(y)
{ }
unsigned short x;
unsigned short y;
};
typedef std::list<PATH_NODE> Path;
typedef Path::iterator PathIterator;
class Being : public Sprite
{
public:
enum Type {
UNKNOWN,
PLAYER,
NPC,
MONSTER
};
/**
* Action the being is currently performing.
*/
enum Action {
STAND,
WALK,
ATTACK,
SIT,
DEAD,
HURT
};
enum Sprite {
BASE_SPRITE = 0,
SHOE_SPRITE,
BOTTOMCLOTHES_SPRITE,
TOPCLOTHES_SPRITE,
MISC1_SPRITE,
MISC2_SPRITE,
HAIR_SPRITE,
HAT_SPRITE,
CAPE_SPRITE,
GLOVES_SPRITE,
WEAPON_SPRITE,
SHIELD_SPRITE,
VECTOREND_SPRITE
};
enum TargetCursorSize {
TC_SMALL = 0,
TC_MEDIUM,
TC_LARGE,
NUM_TC
};
/**
* Directions, to be used as bitmask values
*/
enum { DOWN = 1, LEFT = 2, UP = 4, RIGHT = 8 };
Uint16 mJob; /**< Job (player job, npc, monster, ) */
Uint16 mX, mY; /**< Tile coordinates */
Action mAction; /**< Action the being is performing */
Uint16 mFrame;
Uint16 mWalkTime;
Uint8 mEmotion; /**< Currently showing emotion */
Uint8 mEmotionTime; /**< Time until emotion disappears */
Uint16 mAttackSpeed; /**< Attack speed */
/**
* Constructor.
*/
Being(int id, int job, Map *map);
/**
* Destructor.
*/
virtual ~Being();
/**
* Removes all path nodes from this being.
*/
void clearPath();
/**
* Sets a new destination for this being to walk to.
*/
virtual void setDestination(Uint16 destX, Uint16 destY);
/**
* Puts a "speech balloon" above this being for the specified amount
* of time.
*
* @param text The text that should appear.
* @param time The amount of time the text should stay in milliseconds.
*/
void setSpeech(const std::string &text, Uint32 time);
/**
* Puts a damage bubble above this being.
*
* @param amount The amount of damage.
*/
virtual void takeDamage(int amount);
/**
* Puts a crit notification bubble above this being.
*/
virtual void showCrit();
/**
* Handles an attack of another being by this being.
*
* @param victim The attacked being.
* @param damage The amount of damage dealt (0 means miss).
*/
virtual void handleAttack(Being *victim, int damage);
/**
* Returns the name of the being.
*/
const std::string& getName() const { return mName; }
/**
* Sets the name for the being.
*
* @param name The name that should appear.
*/
virtual void setName(const std::string &name) { mName = name; }
/**
* Gets the hair color for this being.
*/
int getHairColor() const
{ return mHairColor; }
/**
* Gets the hair style for this being.
*/
int getHairStyle() const
{ return mHairStyle; }
/**
* Get the number of hairstyles implemented
*/
static int getNumOfHairstyles() { return mNumberOfHairstyles; }
/**
* Sets the hair style and color for this being.
*/
virtual void setHairStyle(int style, int color);
/**
* Sets visible equipments for this being.
*/
virtual void setSprite(int slot, int id, std::string color = "");
/**
* Sets the gender of this being.
*/
virtual void setGender(int gender) { mGender = gender; }
/**
* Gets the gender of this being.
*/
int getGender() const { return mGender; }
/**
* Makes this being take the next step of his path.
*/
virtual void nextStep();
virtual void setGM() { mIsGM = true; }
/**
* Performs being logic.
*/
virtual void logic();
/**
* Draws the speech text above the being.
*/
void drawSpeech(Graphics *graphics, int offsetX, int offsetY);
/**
* Draws the emotion picture above the being.
*/
void drawEmotion(Graphics *graphics, int offsetX, int offsetY);
/**
* Returns the type of the being.
*/
virtual Type getType() const;
/**
* Gets the walk speed.
*/
Uint16 getWalkSpeed() const { return mWalkSpeed; }
/**
* Sets the walk speed.
*/
void setWalkSpeed(Uint16 speed) { mWalkSpeed = speed; }
/**
* Gets the sprite id.
*/
Uint32 getId() const { return mId; }
/**
* Sets the sprite id.
*/
void setId(Uint32 id) { mId = id; }
/**
* Sets the map the being is on
*/
void setMap(Map *map);
/**
* Sets the current action.
*/
virtual void setAction(Action action);
/**
* Returns the current direction.
*/
Uint8 getDirection() const { return mDirection; }
/**
* Sets the current direction.
*/
void setDirection(Uint8 direction);
/**
* Gets the current action.
*/
int getWalkTime() { return mWalkTime; }
/**
* Returns the direction the being is facing.
*/
SpriteDirection getSpriteDirection() const;
/**
* Draws this being to the given graphics context.
*
* @see Sprite::draw(Graphics, int, int)
*/
virtual void draw(Graphics *graphics, int offsetX, int offsetY) const;
/**
* Returns the pixel X coordinate.
*/
int getPixelX() const { return mPx; }
/**
* Returns the pixel Y coordinate.
*
* @see Sprite::getPixelY()
*/
int getPixelY() const { return mPy; }
/**
* Get the current X pixel offset.
*/
int getXOffset() const { return getOffset(LEFT, RIGHT); }
/**
* Get the current Y pixel offset.
*/
int getYOffset() const { return getOffset(UP, DOWN); }
/**
* Returns the horizontal size of the current base sprite of the being
*/
virtual int getWidth() const;
/**
* Returns the vertical size of the current base sprite of the being
*/
virtual int getHeight() const;
/**
* Returns the required size of a target cursor for this being.
*/
virtual Being::TargetCursorSize getTargetCursorSize() const
{ return TC_MEDIUM; }
/**
* Take control of a particle.
*/
void controlParticle(Particle *particle);
void setEmote(Uint8 emotion, Uint8 emote_time)
{
mEmotion = emotion;
mEmotionTime = emote_time;
}
// Target cursor being used by the being
Image *mTargetCursor;
const std::auto_ptr<Equipment> mEquipment;
protected:
/**
* Sets the new path for this being.
*/
void setPath(const Path &path);
/**
* Let the sub-classes react to a replacement
*/
virtual void updateCoords() {}
/**
* Trigger visual effect, with components
*
* \param effectId ID of the effect to trigger
* \param sfx Whether to trigger sound effects
* \param gfx Whether to trigger graphical effects
*/
void internalTriggerEffect(int effectId, bool sfx, bool gfx);
Uint32 mId; /**< Unique sprite id */
Uint16 mWalkSpeed; /**< Walking speed */
Uint8 mDirection; /**< Facing direction */
Map *mMap; /**< Map on which this being resides */
std::string mName; /**< Name of character */
SpriteIterator mSpriteIterator;
bool mIsGM;
bool mParticleEffects; /**< Whether to display particles or not */
/** Engine-related infos about weapon. */
const ItemInfo* mEquippedWeapon;
static int mNumberOfHairstyles; /** Number of hair styles in use */
Path mPath;
std::string mSpeech;
Text *mText;
Uint16 mHairStyle, mHairColor;
Uint8 mGender;
Uint32 mSpeechTime;
Sint32 mPx, mPy; /**< Pixel coordinates */
std::vector<AnimatedSprite*> mSprites;
std::vector<int> mSpriteIDs;
std::vector<std::string> mSpriteColors;
std::list<Particle *> mChildParticleEffects;
private:
/**
* Calculates the offset in the given directions.
* If walking in direction 'neg' the value is negated.
*/
int getOffset(char pos, char neg) const;
// Speech Bubble components
SpeechBubble *mSpeechBubble;
static int instances; /**< Number of Being instances */
static ImageSet *emotionSet; /**< Emoticons used by beings */
};
#endif