#include <iteminfo.h>

Public Member Functions
	ItemInfo ()

	~ItemInfo ()

void	setId (const int id)

int	getId () const

void	setName (const std::string &name)

const std::string &	getName () const

const std::string	getName (const ItemColor color) const

void	setNameEn (const std::string &name)

const std::string &	getNameEn () const

const std::string	getNameEn (const ItemColor color) const

const std::string	getLink () const

void	setDisplay (const SpriteDisplay &display)

const SpriteDisplay &	getDisplay () const

void	setDescription (const std::string &description)

const std::string &	getDescription () const

const std::string	getDescription (const ItemColor color) const

void	setEffect (const std::string &effect)

const std::string &	getEffect () const

void	setType (const ItemDbTypeT type)

void	setUseButton (const std::string &str)

const std::string &	getUseButton () const

void	setUseButton2 (const std::string &str)

const std::string &	getUseButton2 () const

ItemDbTypeT	getType () const

void	setWeight (const int weight)

int	getWeight () const

int	getView () const

void	setView (const int view)

void	setSprite (const std::string &animationFile, const GenderT gender, const int race)

const std::string &	getSprite (const GenderT gender, const BeingTypeId race) const

void	setAttackAction (const std::string &attackAction)

void	setSkyAttackAction (const std::string &attackAction)

void	setWaterAttackAction (const std::string &attackAction)

void	setRideAttackAction (const std::string &attackAction)

void	setMissileParticleFile (const std::string &s)

MissileInfo &	getMissile ()

const MissileInfo &	getMissileConst () const

void	setHitEffectId (const int s)

int	getHitEffectId () const

void	setCriticalHitEffectId (const int s)

int	getCriticalHitEffectId () const

void	setMissEffectId (const int s)

int	getMissEffectId () const

const std::string &	getAttackAction () const

const std::string &	getSkyAttackAction () const

const std::string &	getWaterAttackAction () const

const std::string &	getRideAttackAction () const

int	getAttackRange () const

void	setAttackRange (const int r)

void	addSound (const ItemSoundEvent::Type event, const std::string &filename, const int delay)

const SoundInfo &	getSound (const ItemSoundEvent::Type event) const

int	getDrawBefore (const int direction) const

void	setDrawBefore (const int direction, const int n)

int	getDrawAfter (const int direction) const

void	setDrawAfter (const int direction, const int n)

int	getDrawPriority (const int direction) const

void	setDrawPriority (const int direction, const int n)

const IntMap &	getTags () const

void	addTag (const int tag)

void	setRemoveSprites ()

bool	isRemoveSprites () const

void	setMaxFloorOffsetX (const int i)

void	setMaxFloorOffsetY (const int i)

int	getMaxFloorOffsetX () const

int	getMaxFloorOffsetY () const

bool	isRemoveItemId (int id) const

void	setCardColor (const ItemColor color)

ItemColor	getCardColor () const

int	getReplaceToSpriteId (int id) const

IntMap *	addReplaceSprite (const int sprite, const int direction)

const SpriteToItemMap *	getSpriteToItemReplaceMap (const int directions) const

std::string	getDyeColorsString (const ItemColor color) const

std::string	getDyeIconColorsString (const ItemColor color) const

void	setColorsList (const std::string &name)

void	setIconColorsList (const std::string &name)

bool	isHaveColors () const

bool	isHaveIconColors () const

std::string	getColorsListName () const

std::string	getIconColorsListName () const

const std::string	replaceColors (std::string str, const ItemColor color) const

void	setPickupCursor (const std::string &cursor)

void	setPickupCursor (const CursorT &cursor)

CursorT	getPickupCursor () const

void	setProtected (const bool b)

bool	isProtected () const

int	getColorsSize () const

int	getIconColorsSize () const

std::string	getColorName (const ItemColor idx) const

std::string	getColor (const ItemColor idx) const

std::string	getIconColorName (const ItemColor idx) const

std::string	getIconColor (const ItemColor idx) const

std::vector< ItemMenuItem > &	getInventoryMenu ()

std::vector< ItemMenuItem > &	getStorageMenu ()

std::vector< ItemMenuItem > &	getCartMenu ()

const std::vector< ItemMenuItem > &	getInventoryMenuConst () const A_CONST

const std::vector< ItemMenuItem > &	getStorageMenuConst () const A_CONST

const std::vector< ItemMenuItem > &	getCartMenuConst () const A_CONST

Data Fields
int	mDrawBefore [10]

int	mDrawAfter [10]

int	mDrawPriority [10]

Static Private Member Functions
static void	setSpriteOrder (int *const ptr, const int direction, const int n, const int def)

Private Attributes
SpriteDisplay	mDisplay

MissileInfo	mMissile

std::string	mName

std::string	mNameEn

std::string	mDescription

std::string	mEffect

std::string	mUseButton

std::string	mUseButton2

ItemDbTypeT	mType

int	mWeight

int	mView

int	mId

bool	mIsRemoveSprites

SpriteToItemMap *	mSpriteToItemReplaceMap [10]

std::vector< SpriteToItemMap * >	mSpriteToItemReplaceList

std::string	mAttackAction

std::string	mSkyAttackAction

std::string	mWaterAttackAction

std::string	mRideAttackAction

int	mAttackRange

std::string	mMissileParticle

std::map< int, std::string >	mAnimationFiles

std::map< ItemSoundEvent::Type, SoundInfoVect >	mSounds

std::map< int, int >	mTags

const std::map< ItemColor, ItemColorData > *	mColorsList

const std::map< ItemColor, ItemColorData > *	mIconColorsList

std::vector< ItemMenuItem >	mInventoryMenu

std::vector< ItemMenuItem >	mStorageMenu

std::vector< ItemMenuItem >	mCartMenu

std::string	mColorsListName

std::string	mIconColorsListName

ItemColor	mCardColor

int	mHitEffectId

int	mCriticalHitEffectId

int	mMissEffectId

int	maxFloorOffsetX

int	maxFloorOffsetY

CursorT	mPickupCursor

bool	mProtected

Detailed Description

Defines a class for storing item infos. This includes information used when the item is equipped.

Definition at line 53 of file iteminfo.h.

Constructor & Destructor Documentation

◆ ItemInfo()

ItemInfo::ItemInfo ( )

Constructor.

Definition at line 43 of file iteminfo.cpp.

                    :
     mDisplay(),
     mMissile(),
     mName(),
     mNameEn(),
     mDescription(),
     mEffect(),
     mUseButton(),
     mUseButton2(),
     mType(ItemDbType::UNUSABLE),
     mWeight(0),
     mView(0),
     mId(0),
     mIsRemoveSprites(false),
     mSpriteToItemReplaceList(),
     mAttackAction(SpriteAction::INVALID),
     mSkyAttackAction(SpriteAction::INVALID),
     mWaterAttackAction(SpriteAction::INVALID),
     mRideAttackAction(SpriteAction::INVALID),
     mAttackRange(0),
     mMissileParticle(),
     mAnimationFiles(),
     mSounds(),
     mTags(),
     mColorsList(nullptr),
     mIconColorsList(nullptr),
     mInventoryMenu(),
     mStorageMenu(),
     mCartMenu(),
     mColorsListName(),
     mIconColorsListName(),
     mCardColor(ItemColor_zero),
     mHitEffectId(-1),
     mCriticalHitEffectId(-1),
     mMissEffectId(-1),
     maxFloorOffsetX(mapTileSize),
     maxFloorOffsetY(mapTileSize),
     mPickupCursor(Cursor::CURSOR_POINTER),
     mProtected(false)
 {
     for (int f = 0; f < 10; f ++)
     {
         mSpriteToItemReplaceMap[f] = nullptr;
         mDrawBefore[f] = -1;
         mDrawAfter[f] = -1;
         mDrawPriority[f] = 0;
     }
 }

References mDrawAfter, mDrawBefore, mDrawPriority, and mSpriteToItemReplaceMap.

◆ ~ItemInfo()

ItemInfo::~ItemInfo ( )

Definition at line 92 of file iteminfo.cpp.

 {
     delete_all(mSpriteToItemReplaceList);
     mSpriteToItemReplaceList.clear();
     for (int f = 0; f < 10; f ++)
         mSpriteToItemReplaceMap[f] = nullptr;
 }

References delete_all(), mSpriteToItemReplaceList, and mSpriteToItemReplaceMap.

Member Function Documentation

◆ addReplaceSprite()

IntMap * ItemInfo::addReplaceSprite	(	const int	sprite,
		const int	direction
	)

Definition at line 174 of file iteminfo.cpp.

 {
     if (direction < 0 || direction >= 10)
         return nullptr;
  
     SpriteToItemMap *spMap = mSpriteToItemReplaceMap[direction];
  
     if (spMap == nullptr)
     {
         spMap = new SpriteToItemMap;
         mSpriteToItemReplaceMap[direction] = spMap;
         mSpriteToItemReplaceList.push_back(spMap);
     }
  
     SpriteToItemMap::iterator it = spMap->find(sprite);
     if (it == spMap->end())
     {
         IntMap tmp;
         (*mSpriteToItemReplaceMap[direction])[sprite] = tmp;
         it = mSpriteToItemReplaceMap[direction]->find(sprite);
     }
     return &it->second;
 }

References mSpriteToItemReplaceList, and mSpriteToItemReplaceMap.

◆ addSound()

void ItemInfo::addSound	(	const ItemSoundEvent::Type	event,
		const std::string &	filename,
		const int	delay
	)

Definition at line 153 of file iteminfo.cpp.

 {
     mSounds[event].push_back(SoundInfo(
         filename,
         delay));
 }

References mSounds.

◆ addTag()

void ItemInfo::addTag ( const int tag )

inline

Definition at line 226 of file iteminfo.h.

227 { mTags[tag] = 1; }

References mTags.

Referenced by ItemDB::load().

◆ getAttackAction()

const std::string& ItemInfo::getAttackAction ( ) const

inline

Definition at line 186 of file iteminfo.h.

187 { return mAttackAction; }

References mAttackAction.

Referenced by ItemDB::loadXmlFile().

◆ getAttackRange()

int ItemInfo::getAttackRange ( ) const

inline

Definition at line 198 of file iteminfo.h.

199 { return mAttackRange; }

References mAttackRange.

Referenced by ItemDB::loadXmlFile().

◆ getCardColor()

ItemColor ItemInfo::getCardColor ( ) const

inline

Definition at line 252 of file iteminfo.h.

253 { return mCardColor; }

References mCardColor.

Referenced by ItemDB::loadXmlFile().

◆ getCartMenu()

std::vector<ItemMenuItem>& ItemInfo::getCartMenu ( )

inline

Definition at line 323 of file iteminfo.h.

324 { return mCartMenu; }

References mCartMenu.

◆ getCartMenuConst()

const std::vector<ItemMenuItem>& ItemInfo::getCartMenuConst ( ) const

inline

Definition at line 330 of file iteminfo.h.

331 { return mCartMenu; }

References mCartMenu.

◆ getColor()

std::string ItemInfo::getColor ( const ItemColor idx ) const

Definition at line 430 of file iteminfo.cpp.

 {
     if (mColorsList == nullptr)
         return std::string();
  
     const std::map <ItemColor, ItemColorData>::const_iterator
         it = mColorsList->find(idx);
     if (it == mColorsList->end())
     {
         reportAlways("Color %d for palette %s not found",
             CAST_S32(idx),
             mColorsListName.c_str())
         return std::string();
     }
     return it->second.color;
 }

References CAST_S32, mColorsList, mColorsListName, and reportAlways.

◆ getColorName()

std::string ItemInfo::getColorName ( const ItemColor idx ) const

Definition at line 413 of file iteminfo.cpp.

 {
     if (mColorsList == nullptr)
         return std::string();
  
     const std::map <ItemColor, ItemColorData>::const_iterator
         it = mColorsList->find(idx);
     if (it == mColorsList->end())
     {
         reportAlways("Color %d for palette %s not found",
             CAST_S32(idx),
             mColorsListName.c_str())
         return std::string();
     }
     return it->second.name;
 }

References CAST_S32, mColorsList, mColorsListName, and reportAlways.

Referenced by CharCreateDialog::updateLook().

◆ getColorsListName()

std::string ItemInfo::getColorsListName ( ) const

inline

Definition at line 279 of file iteminfo.h.

280 { return mColorsListName; }

References mColorsListName.

Referenced by ItemDB::loadXmlFile().

◆ getColorsSize()

int ItemInfo::getColorsSize ( ) const

inline

Definition at line 304 of file iteminfo.h.

305 { return mColorsList != nullptr ? CAST_S32(mColorsList->size()) : 0; }

References CAST_S32, and mColorsList.

Referenced by CharCreateDialog::updateLook().

◆ getCriticalHitEffectId()

int ItemInfo::getCriticalHitEffectId ( ) const

inline

Definition at line 177 of file iteminfo.h.

178 { return mCriticalHitEffectId; }

References mCriticalHitEffectId.

Referenced by ItemDB::loadXmlFile().

◆ getDescription() [1/2]

const std::string& ItemInfo::getDescription ( ) const

inline

Definition at line 100 of file iteminfo.h.

101 { return mDescription; }

References mDescription.

Referenced by ItemDB::loadXmlFile(), and ItemPopup::setItem().

◆ getDescription() [2/2]

const std::string ItemInfo::getDescription ( const ItemColor color ) const

Definition at line 253 of file iteminfo.cpp.

 {
     return replaceColors(mDescription, color);
 }

References mDescription, and replaceColors().

◆ getDisplay()

const SpriteDisplay& ItemInfo::getDisplay ( ) const

inline

Definition at line 94 of file iteminfo.h.

95 { return mDisplay; }

References mDisplay.

Referenced by ItemPopup::setItem().

◆ getDrawAfter()

int ItemInfo::getDrawAfter ( const int direction ) const

Definition at line 392 of file iteminfo.cpp.

 {
     if (direction < 0 || direction >= 10)
         return -1;
     return mDrawAfter[direction];
 }

References mDrawAfter.

◆ getDrawBefore()

int ItemInfo::getDrawBefore ( const int direction ) const

Definition at line 385 of file iteminfo.cpp.

 {
     if (direction < 0 || direction >= 10)
         return -1;
     return mDrawBefore[direction];
 }

References mDrawBefore.

◆ getDrawPriority()

int ItemInfo::getDrawPriority ( const int direction ) const

Definition at line 399 of file iteminfo.cpp.

 {
     if (direction < 0 || direction >= 10)
         return 0;
     return mDrawPriority[direction];
 }

References mDrawPriority.

◆ getDyeColorsString()

std::string ItemInfo::getDyeColorsString ( const ItemColor color ) const

Definition at line 227 of file iteminfo.cpp.

 {
     if ((mColorsList == nullptr) || mColorsListName.empty())
         return "";
  
     const std::map <ItemColor, ItemColorData>::const_iterator
         it = mColorsList->find(color);
     if (it == mColorsList->end())
         return "";
  
     return it->second.color;
 }

References mColorsList, and mColorsListName.

Referenced by EAthena::BeingRecv::processBeingChangeLookContinue(), and CharCreateDialog::updateHair().

◆ getDyeIconColorsString()

std::string ItemInfo::getDyeIconColorsString ( const ItemColor color ) const

Definition at line 240 of file iteminfo.cpp.

 {
     if ((mIconColorsList == nullptr) || mIconColorsListName.empty())
         return "";
  
     const std::map <ItemColor, ItemColorData>::const_iterator
         it = mIconColorsList->find(color);
     if (it == mIconColorsList->end())
         return "";
  
     return it->second.color;
 }

References mIconColorsList, and mIconColorsListName.

Referenced by ItemPopup::setItem().

◆ getEffect()

const std::string& ItemInfo::getEffect ( ) const

inline

Definition at line 109 of file iteminfo.h.

110 { return mEffect; }

References mEffect.

Referenced by ItemDB::loadXmlFile(), and ItemPopup::setItem().

◆ getHitEffectId()

int ItemInfo::getHitEffectId ( ) const

inline

Definition at line 171 of file iteminfo.h.

172 { return mHitEffectId; }

References mHitEffectId.

Referenced by ItemDB::loadXmlFile().

◆ getIconColor()

std::string ItemInfo::getIconColor ( const ItemColor idx ) const

Definition at line 464 of file iteminfo.cpp.

 {
     if (mIconColorsList == nullptr)
         return std::string();
  
     const std::map <ItemColor, ItemColorData>::const_iterator
         it = mIconColorsList->find(idx);
     if (it == mIconColorsList->end())
     {
         reportAlways("Color %d for palette %s not found",
             CAST_S32(idx),
             mColorsListName.c_str())
         return std::string();
     }
     return it->second.color;
 }

References CAST_S32, mColorsListName, mIconColorsList, and reportAlways.

◆ getIconColorName()

std::string ItemInfo::getIconColorName ( const ItemColor idx ) const

Definition at line 447 of file iteminfo.cpp.

 {
     if (mIconColorsList == nullptr)
         return std::string();
  
     const std::map <ItemColor, ItemColorData>::const_iterator
         it = mIconColorsList->find(idx);
     if (it == mIconColorsList->end())
     {
         reportAlways("Color %d for palette %s not found",
             CAST_S32(idx),
             mColorsListName.c_str())
         return std::string();
     }
     return it->second.name;
 }

References CAST_S32, mColorsListName, mIconColorsList, and reportAlways.

◆ getIconColorsListName()

std::string ItemInfo::getIconColorsListName ( ) const

inline

Definition at line 282 of file iteminfo.h.

283 { return mIconColorsListName; }

References mIconColorsListName.

Referenced by ItemDB::loadXmlFile().

◆ getIconColorsSize()

int ItemInfo::getIconColorsSize ( ) const

inline

Definition at line 307 of file iteminfo.h.

         {
             return mIconColorsList != nullptr ?
                 CAST_S32(mIconColorsList->size()) : 0;
         }

References CAST_S32, and mIconColorsList.

◆ getId()

int ItemInfo::getId ( ) const

inline

Definition at line 68 of file iteminfo.h.

69 { return mId; }

References mId.

Referenced by ItemAmountWindow::action(), replaceItemLinks(), and ItemPopup::setItem().

◆ getInventoryMenu()

std::vector<ItemMenuItem>& ItemInfo::getInventoryMenu ( )

inline

Definition at line 319 of file iteminfo.h.

320 { return mInventoryMenu; }

References mInventoryMenu.

◆ getInventoryMenuConst()

const std::vector<ItemMenuItem>& ItemInfo::getInventoryMenuConst ( ) const

inline

Definition at line 326 of file iteminfo.h.

327 { return mInventoryMenu; }

References mInventoryMenu.

◆ getLink()

const std::string ItemInfo::getLink ( ) const

Definition at line 481 of file iteminfo.cpp.

 {
     return strprintf("[@@%d|%s@@]", mId, mName.c_str());
 }

References mId, mName, and strprintf().

◆ getMaxFloorOffsetX()

int ItemInfo::getMaxFloorOffsetX ( ) const

inline

Definition at line 241 of file iteminfo.h.

242 { return maxFloorOffsetX; }

References maxFloorOffsetX.

◆ getMaxFloorOffsetY()

int ItemInfo::getMaxFloorOffsetY ( ) const

inline

Definition at line 244 of file iteminfo.h.

245 { return maxFloorOffsetY; }

References maxFloorOffsetY.

◆ getMissEffectId()

int ItemInfo::getMissEffectId ( ) const

inline

Definition at line 183 of file iteminfo.h.

184 { return mMissEffectId; }

References mMissEffectId.

Referenced by ItemDB::loadXmlFile().

◆ getMissile()

MissileInfo& ItemInfo::getMissile ( )

inline

Definition at line 162 of file iteminfo.h.

163 { return mMissile; }

References mMissile.

◆ getMissileConst()

const MissileInfo& ItemInfo::getMissileConst ( ) const

inline

Definition at line 165 of file iteminfo.h.

166 { return mMissile; }

References mMissile.

Referenced by ItemDB::loadXmlFile().

◆ getName() [1/2]

const std::string& ItemInfo::getName ( ) const

inline

Definition at line 74 of file iteminfo.h.

75 { return mName; }

References mName.

Referenced by ShopWindow::announce(), ItemDB::loadXmlFile(), ItemContainer::mousePressed(), anonymous_namespace{itemcontainer.cpp}::SortItemAlphaFunctor::operator()(), anonymous_namespace{itemcontainer.cpp}::SortItemTypeFunctor::operator()(), ShopWindow::processRequest(), BrowserBoxTools::replaceLinkCommands(), ItemPopup::setItem(), CharCreateDialog::updateHair(), CharCreateDialog::updateLook(), and ItemContainer::updateMatrix().

◆ getName() [2/2]

const std::string ItemInfo::getName ( const ItemColor color ) const

Definition at line 258 of file iteminfo.cpp.

 {
     return replaceColors(mName, color);
 }

References mName, and replaceColors().

◆ getNameEn() [1/2]

const std::string& ItemInfo::getNameEn ( ) const

inline

Definition at line 83 of file iteminfo.h.

84 { return mNameEn; }

References mNameEn.

◆ getNameEn() [2/2]

const std::string ItemInfo::getNameEn ( const ItemColor color ) const

Definition at line 263 of file iteminfo.cpp.

 {
     return replaceColors(mNameEn, color);
 }

References mNameEn, and replaceColors().

◆ getPickupCursor()

CursorT ItemInfo::getPickupCursor ( ) const

inline

Definition at line 295 of file iteminfo.h.

296 { return mPickupCursor; }

References mPickupCursor.

◆ getReplaceToSpriteId()

int ItemInfo::getReplaceToSpriteId ( int id ) const

◆ getRideAttackAction()

const std::string& ItemInfo::getRideAttackAction ( ) const

inline

Definition at line 195 of file iteminfo.h.

196 { return mRideAttackAction; }

References mRideAttackAction.

Referenced by ItemDB::loadXmlFile().

◆ getSkyAttackAction()

const std::string& ItemInfo::getSkyAttackAction ( ) const

inline

Definition at line 189 of file iteminfo.h.

190 { return mSkyAttackAction; }

References mSkyAttackAction.

Referenced by ItemDB::loadXmlFile().

◆ getSound()

const SoundInfo & ItemInfo::getSound ( const ItemSoundEvent::Type event ) const

Definition at line 161 of file iteminfo.cpp.

 {
     static const SoundInfo empty("", 0);
     std::map<ItemSoundEvent::Type, SoundInfoVect>::const_iterator i;
  
     i = mSounds.find(event);
  
     if (i == mSounds.end())
         return empty;
     return (!i->second.empty()) ? i->second[CAST_U32(rand())
         % i->second.size()] : empty;
 }

References CAST_U32, empty, and mSounds.

Referenced by ItemSoundManager::getSoundEffect().

◆ getSprite()

const std::string & ItemInfo::getSprite	(	const GenderT	gender,
		const BeingTypeId	race
	)		const

Definition at line 100 of file iteminfo.cpp.

 {
     if (mView != 0)
     {
         // Forward the request to the item defining how to view this item
         return ItemDB::get(mView).getSprite(gender, race);
     }
     static const std::string empty;
     std::map<int, std::string>::const_iterator i =
         mAnimationFiles.find(CAST_S32(gender) +
         toInt(race, int) * 4);
  
     if (i != mAnimationFiles.end())
         return i->second;
     i = mAnimationFiles.find(CAST_S32(gender));
     if (i != mAnimationFiles.end())
         return i->second;
     return empty;
 }

References CAST_S32, empty, ItemDB::get(), getSprite(), mAnimationFiles, mView, and toInt.

Referenced by Inventory::findItemBySprite(), and getSprite().

◆ getSpriteToItemReplaceMap()

const SpriteToItemMap * ItemInfo::getSpriteToItemReplaceMap ( const int directions ) const

Definition at line 293 of file iteminfo.cpp.

 {
     if (direction < 0 || direction >= 10)
         return nullptr;
  
     const SpriteToItemMap *const spMap = mSpriteToItemReplaceMap[direction];
     if (spMap != nullptr)
         return spMap;
     if (direction == SpriteDirection::UPLEFT
         || direction == SpriteDirection::UPRIGHT)
     {
         return mSpriteToItemReplaceMap[SpriteDirection::UP];
     }
  
     if (direction == SpriteDirection::DOWNLEFT
         || direction == SpriteDirection::DOWNRIGHT)
     {
         return mSpriteToItemReplaceMap[SpriteDirection::DOWN];
     }
  
     return nullptr;
 }

References SpriteDirection::DOWN, SpriteDirection::DOWNLEFT, SpriteDirection::DOWNRIGHT, mSpriteToItemReplaceMap, SpriteDirection::UP, SpriteDirection::UPLEFT, and SpriteDirection::UPRIGHT.

◆ getStorageMenu()

std::vector<ItemMenuItem>& ItemInfo::getStorageMenu ( )

inline

Definition at line 321 of file iteminfo.h.

322 { return mStorageMenu; }

References mStorageMenu.

◆ getStorageMenuConst()

const std::vector<ItemMenuItem>& ItemInfo::getStorageMenuConst ( ) const

inline

Definition at line 328 of file iteminfo.h.

329 { return mStorageMenu; }

References mStorageMenu.

◆ getTags()

const IntMap& ItemInfo::getTags ( ) const

inline

Definition at line 223 of file iteminfo.h.

224 { return mTags; }

References mTags.

◆ getType()

ItemDbTypeT ItemInfo::getType ( ) const

inline

Definition at line 127 of file iteminfo.h.

128 { return mType; }

References mType.

Referenced by ItemDB::loadXmlFile(), anonymous_namespace{itemcontainer.cpp}::SortItemTypeFunctor::operator()(), and ItemPopup::setItem().

◆ getUseButton()

const std::string& ItemInfo::getUseButton ( ) const

inline

Definition at line 118 of file iteminfo.h.

119 { return mUseButton; }

References mUseButton.

Referenced by ItemDB::loadXmlFile().

◆ getUseButton2()

const std::string& ItemInfo::getUseButton2 ( ) const

inline

Definition at line 124 of file iteminfo.h.

125 { return mUseButton2; }

References mUseButton2.

◆ getView()

int ItemInfo::getView ( ) const

inline

Definition at line 136 of file iteminfo.h.

137 { return mView; }

References mView.

Referenced by ItemDB::loadXmlFile().

◆ getWaterAttackAction()

const std::string& ItemInfo::getWaterAttackAction ( ) const

inline

Definition at line 192 of file iteminfo.h.

193 { return mWaterAttackAction; }

References mWaterAttackAction.

Referenced by ItemDB::loadXmlFile().

◆ getWeight()

int ItemInfo::getWeight ( ) const

inline

Definition at line 133 of file iteminfo.h.

134 { return mWeight; }

References mWeight.

Referenced by ItemDB::loadXmlFile(), and ItemPopup::setItem().

◆ isHaveColors()

bool ItemInfo::isHaveColors ( ) const

inline

Definition at line 273 of file iteminfo.h.

274 { return !mColorsListName.empty(); }

References mColorsListName.

◆ isHaveIconColors()

bool ItemInfo::isHaveIconColors ( ) const

inline

Definition at line 276 of file iteminfo.h.

277 { return !mIconColorsListName.empty(); }

References mIconColorsListName.

◆ isProtected()

bool ItemInfo::isProtected ( ) const

inline

Definition at line 301 of file iteminfo.h.

302 { return mProtected; }

References mProtected.

◆ isRemoveItemId()

bool ItemInfo::isRemoveItemId ( int id ) const

◆ isRemoveSprites()

bool ItemInfo::isRemoveSprites ( ) const

inline

Definition at line 232 of file iteminfo.h.

233 { return mIsRemoveSprites; }

References mIsRemoveSprites.

◆ replaceColors()

const std::string ItemInfo::replaceColors	(	std::string	str,
		const ItemColor	color
	)		const

Definition at line 268 of file iteminfo.cpp.

 {
     std::string name;
     if ((mColorsList != nullptr) && !mColorsListName.empty())
     {
         const std::map <ItemColor, ItemColorData>::const_iterator
             it = mColorsList->find(color);
         if (it == mColorsList->end())
             name = "unknown";
         else
             name = it->second.name;
     }
     else
     {
         name = "unknown";
     }
  
     str = replaceAll(str, "%color%", name);
     if (!name.empty())
         name[0] = CAST_S8(toupper(name[0]));
  
     return replaceAll(str, "%Color%", name);
 }

References CAST_S8, mColorsList, mColorsListName, and replaceAll().

Referenced by getDescription(), getName(), and getNameEn().

◆ setAttackAction()

void ItemInfo::setAttackAction ( const std::string & attackAction )

Definition at line 121 of file iteminfo.cpp.

 {
     if (attackAction.empty())
         mAttackAction = SpriteAction::ATTACK;  // (Equal to unarmed animation)
     else
         mAttackAction = attackAction;
 }

References SpriteAction::ATTACK(), and mAttackAction.

◆ setAttackRange()

void ItemInfo::setAttackRange ( const int r )

inline

Definition at line 201 of file iteminfo.h.

202 { mAttackRange = r; }

References mAttackRange.

◆ setCardColor()

void ItemInfo::setCardColor ( const ItemColor color )

inline

Definition at line 249 of file iteminfo.h.

250 { mCardColor = color; }

References mCardColor.

◆ setColorsList()

void ItemInfo::setColorsList ( const std::string & name )

Definition at line 199 of file iteminfo.cpp.

 {
     if (name.empty())
     {
         mColorsList = nullptr;
         mColorsListName.clear();
     }
     else
     {
         mColorsList = ColorDB::getColorsList(name);
         mColorsListName = name;
     }
 }

References ColorDB::getColorsList(), mColorsList, and mColorsListName.

◆ setCriticalHitEffectId()

void ItemInfo::setCriticalHitEffectId ( const int s )

inline

Definition at line 174 of file iteminfo.h.

175 { mCriticalHitEffectId = s; }

References mCriticalHitEffectId.

◆ setDescription()

void ItemInfo::setDescription ( const std::string & description )

inline

Definition at line 97 of file iteminfo.h.

98 { mDescription = description; }

References mDescription.

◆ setDisplay()

void ItemInfo::setDisplay ( const SpriteDisplay & display )

inline

Definition at line 91 of file iteminfo.h.

92 { mDisplay = display; }

References mDisplay.

Referenced by ItemDB::load().

◆ setDrawAfter()

void ItemInfo::setDrawAfter	(	const int	direction,
		const int	n
	)

Definition at line 375 of file iteminfo.cpp.

 {
     setSpriteOrder(&mDrawAfter[0], direction, n, -1);
 }

References mDrawAfter, and setSpriteOrder().

◆ setDrawBefore()

void ItemInfo::setDrawBefore	(	const int	direction,
		const int	n
	)

Definition at line 370 of file iteminfo.cpp.

 {
     setSpriteOrder(&mDrawBefore[0], direction, n, -1);
 }

References mDrawBefore, and setSpriteOrder().

◆ setDrawPriority()

void ItemInfo::setDrawPriority	(	const int	direction,
		const int	n
	)

Definition at line 380 of file iteminfo.cpp.

 {
     setSpriteOrder(&mDrawPriority[0], direction, n, 0);
 }

References mDrawPriority, and setSpriteOrder().

◆ setEffect()

void ItemInfo::setEffect ( const std::string & effect )

inline

Definition at line 106 of file iteminfo.h.

107 { mEffect = effect; }

References mEffect.

◆ setHitEffectId()

void ItemInfo::setHitEffectId ( const int s )

inline

Definition at line 168 of file iteminfo.h.

169 { mHitEffectId = s; }

References mHitEffectId.

◆ setIconColorsList()

void ItemInfo::setIconColorsList ( const std::string & name )

Definition at line 213 of file iteminfo.cpp.

 {
     if (name.empty())
     {
         mIconColorsList = nullptr;
         mIconColorsListName.clear();
     }
     else
     {
         mIconColorsList = ColorDB::getColorsList(name);
         mIconColorsListName = name;
     }
 }

References ColorDB::getColorsList(), mIconColorsList, and mIconColorsListName.

◆ setId()

void ItemInfo::setId ( const int id )

inline

Definition at line 65 of file iteminfo.h.

66 { mId = id; }

References mId.

◆ setMaxFloorOffsetX()

void ItemInfo::setMaxFloorOffsetX ( const int i )

inline

Definition at line 235 of file iteminfo.h.

236 { maxFloorOffsetX = i; }

References maxFloorOffsetX.

◆ setMaxFloorOffsetY()

void ItemInfo::setMaxFloorOffsetY ( const int i )

inline

Definition at line 238 of file iteminfo.h.

239 { maxFloorOffsetY = i; }

References maxFloorOffsetY.

◆ setMissEffectId()

void ItemInfo::setMissEffectId ( const int s )

inline

Definition at line 180 of file iteminfo.h.

181 { mMissEffectId = s; }

References mMissEffectId.

◆ setMissileParticleFile()

void ItemInfo::setMissileParticleFile ( const std::string & s )

inline

Definition at line 159 of file iteminfo.h.

160 { mMissile.particle = s; }

MissileInfo::particle

std::string particle

Definition: missileinfo.h:41

References mMissile, and MissileInfo::particle.

◆ setName()

void ItemInfo::setName ( const std::string & name )

inline

Definition at line 71 of file iteminfo.h.

72 { mName = name; }

References mName.

Referenced by ItemDB::load().

◆ setNameEn()

void ItemInfo::setNameEn ( const std::string & name )

inline

Definition at line 80 of file iteminfo.h.

81 { mNameEn = name; }

References mNameEn.

◆ setPickupCursor() [1/2]

void ItemInfo::setPickupCursor ( const CursorT & cursor )

inline

Definition at line 292 of file iteminfo.h.

293 { mPickupCursor = cursor; }

References mPickupCursor.

◆ setPickupCursor() [2/2]

void ItemInfo::setPickupCursor ( const std::string & cursor )

inline

Definition at line 289 of file iteminfo.h.

290 { return setPickupCursor(Cursors::stringToCursor(cursor)); }

ItemInfo::setPickupCursor

void setPickupCursor(const std::string &cursor)

Definition: iteminfo.h:289

Cursors::stringToCursor

CursorT stringToCursor(const std::string &name)

Definition: cursors.cpp:60

References Cursors::stringToCursor().

◆ setProtected()

void ItemInfo::setProtected ( const bool b )

inline

Definition at line 298 of file iteminfo.h.

299 { mProtected = b; }

References mProtected.

◆ setRemoveSprites()

void ItemInfo::setRemoveSprites ( )

inline

Definition at line 229 of file iteminfo.h.

230 { mIsRemoveSprites = true; }

References mIsRemoveSprites.

◆ setRideAttackAction()

void ItemInfo::setRideAttackAction ( const std::string & attackAction )

Definition at line 145 of file iteminfo.cpp.

 {
     if (attackAction.empty())
         mRideAttackAction = SpriteAction::ATTACKRIDE;
     else
         mRideAttackAction = attackAction;
 }

References SpriteAction::ATTACKRIDE(), and mRideAttackAction.

◆ setSkyAttackAction()

void ItemInfo::setSkyAttackAction ( const std::string & attackAction )

Definition at line 129 of file iteminfo.cpp.

 {
     if (attackAction.empty())
         mSkyAttackAction = SpriteAction::ATTACKSKY;
     else
         mSkyAttackAction = attackAction;
 }

References SpriteAction::ATTACKSKY(), and mSkyAttackAction.

◆ setSprite()

void ItemInfo::setSprite	(	const std::string &	animationFile,
		const GenderT	gender,
		const int	race
	)

Definition at line 406 of file iteminfo.cpp.

 {
     mAnimationFiles[CAST_S32(gender) + race * 4] = animationFile;
 }

References CAST_S32, and mAnimationFiles.

Referenced by ItemDB::load().

◆ setSpriteOrder()

void ItemInfo::setSpriteOrder	(	int *const	ptr,
		const int	direction,
		const int	n,
		const int	def
	)

staticprivate

Definition at line 317 of file iteminfo.cpp.

 {
     switch (direction)
     {
         case -1:
         {
             for (int f = 0; f < 10; f ++)
             {
                 if (ptr[f] == def)
                     ptr[f] = n;
             }
             return;
         }
         case -2:
         {
             ptr[SpriteDirection::DOWN] = n;
             ptr[SpriteDirection::DOWNLEFT] = n;
             ptr[SpriteDirection::DOWNRIGHT] = n;
             return;
         }
         case -3:
         {
             ptr[SpriteDirection::UP] = n;
             ptr[SpriteDirection::UPLEFT] = n;
             ptr[SpriteDirection::UPRIGHT] = n;
             return;
         }
         default:
             break;
     }
     if (direction < 0 || direction >= 9)
         return;
  
     if (direction == SpriteDirection::UP)
     {
         if (ptr[SpriteDirection::UPLEFT] == def)
             ptr[SpriteDirection::UPLEFT] = n;
         if (ptr[SpriteDirection::UPRIGHT] == def)
             ptr[SpriteDirection::UPRIGHT] = n;
     }
     else if (direction == SpriteDirection::DOWN)
     {
         if (ptr[SpriteDirection::DOWNLEFT] == def)
             ptr[SpriteDirection::DOWNLEFT] = n;
         if (ptr[SpriteDirection::DOWNRIGHT] == def)
             ptr[SpriteDirection::DOWNRIGHT] = n;
     }
     ptr[direction] = n;
 }

References SpriteDirection::DOWN, SpriteDirection::DOWNLEFT, SpriteDirection::DOWNRIGHT, SpriteDirection::UP, SpriteDirection::UPLEFT, and SpriteDirection::UPRIGHT.

Referenced by setDrawAfter(), setDrawBefore(), and setDrawPriority().

◆ setType()

void ItemInfo::setType ( const ItemDbTypeT type )

inline

Definition at line 112 of file iteminfo.h.

113 { mType = type; }

References mType.

◆ setUseButton()

void ItemInfo::setUseButton ( const std::string & str )

inline

Definition at line 115 of file iteminfo.h.

116 { mUseButton = str; }

References mUseButton.

◆ setUseButton2()

void ItemInfo::setUseButton2 ( const std::string & str )

inline

Definition at line 121 of file iteminfo.h.

122 { mUseButton2 = str; }

References mUseButton2.

◆ setView()

void ItemInfo::setView ( const int view )

inline

Definition at line 139 of file iteminfo.h.

140 { mView = view; }

References mView.

◆ setWaterAttackAction()

void ItemInfo::setWaterAttackAction ( const std::string & attackAction )

Definition at line 137 of file iteminfo.cpp.

 {
     if (attackAction.empty())
         mWaterAttackAction = SpriteAction::ATTACKWATER;
     else
         mWaterAttackAction = attackAction;
 }

References SpriteAction::ATTACKWATER(), and mWaterAttackAction.

◆ setWeight()

void ItemInfo::setWeight ( const int weight )

inline

Definition at line 130 of file iteminfo.h.

131 { mWeight = weight; }

References mWeight.

Field Documentation

◆ mAnimationFiles

std::map<int, std::string> ItemInfo::mAnimationFiles

private

Maps gender to sprite filenames.

Definition at line 376 of file iteminfo.h.

Referenced by getSprite(), and setSprite().

◆ mAttackAction

std::string ItemInfo::mAttackAction

private

Attack type, in case of weapon. See SpriteAction in spritedef.h for more info. Attack action sub-types (bow, sword, ...) are defined in items.xml.

Definition at line 366 of file iteminfo.h.

Referenced by getAttackAction(), and setAttackAction().

◆ mAttackRange

int ItemInfo::mAttackRange

private

Attack range, will be zero if non weapon.

Definition at line 370 of file iteminfo.h.

Referenced by getAttackRange(), and setAttackRange().

◆ maxFloorOffsetX

int ItemInfo::maxFloorOffsetX

private

Definition at line 392 of file iteminfo.h.

Referenced by getMaxFloorOffsetX(), and setMaxFloorOffsetX().

◆ maxFloorOffsetY

int ItemInfo::maxFloorOffsetY

private

Definition at line 393 of file iteminfo.h.

Referenced by getMaxFloorOffsetY(), and setMaxFloorOffsetY().

◆ mCardColor

ItemColor ItemInfo::mCardColor

private

Definition at line 388 of file iteminfo.h.

Referenced by getCardColor(), and setCardColor().

◆ mCartMenu

std::vector<ItemMenuItem> ItemInfo::mCartMenu

private

Definition at line 385 of file iteminfo.h.

Referenced by getCartMenu(), and getCartMenuConst().

◆ mColorsList

const std::map<ItemColor, ItemColorData>* ItemInfo::mColorsList

private

Definition at line 381 of file iteminfo.h.

Referenced by getColor(), getColorName(), getColorsSize(), getDyeColorsString(), replaceColors(), and setColorsList().

◆ mColorsListName

std::string ItemInfo::mColorsListName

private

Definition at line 386 of file iteminfo.h.

Referenced by getColor(), getColorName(), getColorsListName(), getDyeColorsString(), getIconColor(), getIconColorName(), isHaveColors(), replaceColors(), and setColorsList().

◆ mCriticalHitEffectId

int ItemInfo::mCriticalHitEffectId

private

Definition at line 390 of file iteminfo.h.

Referenced by getCriticalHitEffectId(), and setCriticalHitEffectId().

◆ mDescription

std::string ItemInfo::mDescription

private

Short description.

Definition at line 347 of file iteminfo.h.

Referenced by getDescription(), and setDescription().

◆ mDisplay

SpriteDisplay ItemInfo::mDisplay

private

Display info (like icon)

Definition at line 343 of file iteminfo.h.

Referenced by getDisplay(), and setDisplay().

◆ mDrawAfter

int ItemInfo::mDrawAfter[10]

Definition at line 334 of file iteminfo.h.

Referenced by getDrawAfter(), ItemInfo(), and setDrawAfter().

◆ mDrawBefore

int ItemInfo::mDrawBefore[10]

Definition at line 333 of file iteminfo.h.

Referenced by getDrawBefore(), ItemInfo(), and setDrawBefore().

◆ mDrawPriority

int ItemInfo::mDrawPriority[10]

Definition at line 335 of file iteminfo.h.

Referenced by getDrawPriority(), ItemInfo(), Being::recalcSpritesOrder(), and setDrawPriority().

◆ mEffect

std::string ItemInfo::mEffect

private

Description of effects.

Definition at line 348 of file iteminfo.h.

Referenced by getEffect(), and setEffect().

◆ mHitEffectId

int ItemInfo::mHitEffectId

private

Definition at line 389 of file iteminfo.h.

Referenced by getHitEffectId(), and setHitEffectId().

◆ mIconColorsList

const std::map<ItemColor, ItemColorData>* ItemInfo::mIconColorsList

private

Definition at line 382 of file iteminfo.h.

Referenced by getDyeIconColorsString(), getIconColor(), getIconColorName(), getIconColorsSize(), and setIconColorsList().

◆ mIconColorsListName

std::string ItemInfo::mIconColorsListName

private

Definition at line 387 of file iteminfo.h.

Referenced by getDyeIconColorsString(), getIconColorsListName(), isHaveIconColors(), and setIconColorsList().

◆ mId

int ItemInfo::mId

private

Item ID

Definition at line 354 of file iteminfo.h.

Referenced by getId(), getLink(), and setId().

◆ mInventoryMenu

std::vector<ItemMenuItem> ItemInfo::mInventoryMenu

private

Definition at line 383 of file iteminfo.h.

Referenced by getInventoryMenu(), and getInventoryMenuConst().

◆ mIsRemoveSprites

bool ItemInfo::mIsRemoveSprites

private

Definition at line 355 of file iteminfo.h.

Referenced by isRemoveSprites(), and setRemoveSprites().

◆ mMissEffectId

int ItemInfo::mMissEffectId

private

Definition at line 391 of file iteminfo.h.

Referenced by getMissEffectId(), and setMissEffectId().

◆ mMissile

MissileInfo ItemInfo::mMissile

private

Definition at line 344 of file iteminfo.h.

Referenced by getMissile(), getMissileConst(), and setMissileParticleFile().

◆ mMissileParticle

std::string ItemInfo::mMissileParticle

private

Definition at line 373 of file iteminfo.h.

◆ mName

std::string ItemInfo::mName

private

Definition at line 345 of file iteminfo.h.

Referenced by getLink(), getName(), and setName().

◆ mNameEn

std::string ItemInfo::mNameEn

private

Definition at line 346 of file iteminfo.h.

Referenced by getNameEn(), and setNameEn().

◆ mPickupCursor

CursorT ItemInfo::mPickupCursor

private

Definition at line 394 of file iteminfo.h.

Referenced by getPickupCursor(), and setPickupCursor().

◆ mProtected

bool ItemInfo::mProtected

private

Definition at line 395 of file iteminfo.h.

Referenced by isProtected(), and setProtected().

◆ mRideAttackAction

std::string ItemInfo::mRideAttackAction

private

Definition at line 369 of file iteminfo.h.

Referenced by getRideAttackAction(), and setRideAttackAction().

◆ mSkyAttackAction

std::string ItemInfo::mSkyAttackAction

private

Definition at line 367 of file iteminfo.h.

Referenced by getSkyAttackAction(), and setSkyAttackAction().

◆ mSounds

std::map<ItemSoundEvent::Type, SoundInfoVect> ItemInfo::mSounds

private

Stores the names of sounds to be played at certain event.

Definition at line 379 of file iteminfo.h.

Referenced by addSound(), and getSound().

◆ mSpriteToItemReplaceList

std::vector<SpriteToItemMap*> ItemInfo::mSpriteToItemReplaceList

private

Definition at line 359 of file iteminfo.h.

Referenced by addReplaceSprite(), and ~ItemInfo().

◆ mSpriteToItemReplaceMap

SpriteToItemMap* ItemInfo::mSpriteToItemReplaceMap[10]

private

Definition at line 357 of file iteminfo.h.

Referenced by addReplaceSprite(), getSpriteToItemReplaceMap(), ItemInfo(), and ~ItemInfo().

◆ mStorageMenu

std::vector<ItemMenuItem> ItemInfo::mStorageMenu

private

Definition at line 384 of file iteminfo.h.

Referenced by getStorageMenu(), and getStorageMenuConst().

◆ mTags

std::map<int, int> ItemInfo::mTags

private

Definition at line 380 of file iteminfo.h.

Referenced by addTag(), and getTags().

◆ mType

ItemDbTypeT ItemInfo::mType

private

Item type.

Definition at line 351 of file iteminfo.h.

Referenced by getType(), and setType().

◆ mUseButton

std::string ItemInfo::mUseButton

private

Definition at line 349 of file iteminfo.h.

Referenced by getUseButton(), and setUseButton().

◆ mUseButton2

std::string ItemInfo::mUseButton2

private

Definition at line 350 of file iteminfo.h.

Referenced by getUseButton2(), and setUseButton2().

◆ mView

int ItemInfo::mView

private

Item ID of how this item looks.

Definition at line 353 of file iteminfo.h.

Referenced by getSprite(), getView(), and setView().

◆ mWaterAttackAction

std::string ItemInfo::mWaterAttackAction

private

Definition at line 368 of file iteminfo.h.

Referenced by getWaterAttackAction(), and setWaterAttackAction().

◆ mWeight

int ItemInfo::mWeight

private

Weight in grams.

Definition at line 352 of file iteminfo.h.

Referenced by getWeight(), and setWeight().

The documentation for this class was generated from the following files:

src/resources/iteminfo.h (986a3bf)
src/resources/iteminfo.cpp (986a3bf)

Public Member Functions

Data Fields

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ItemInfo()

◆ ~ItemInfo()

Member Function Documentation

◆ addReplaceSprite()

◆ addSound()

◆ addTag()

◆ getAttackAction()

◆ getAttackRange()

◆ getCardColor()

◆ getCartMenu()

◆ getCartMenuConst()

◆ getColor()

◆ getColorName()

◆ getColorsListName()

◆ getColorsSize()

◆ getCriticalHitEffectId()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getDisplay()

◆ getDrawAfter()

◆ getDrawBefore()

◆ getDrawPriority()

◆ getDyeColorsString()

◆ getDyeIconColorsString()

◆ getEffect()

◆ getHitEffectId()

◆ getIconColor()

◆ getIconColorName()

◆ getIconColorsListName()

◆ getIconColorsSize()

◆ getId()

◆ getInventoryMenu()

◆ getInventoryMenuConst()

◆ getLink()

◆ getMaxFloorOffsetX()

◆ getMaxFloorOffsetY()

◆ getMissEffectId()

◆ getMissile()

◆ getMissileConst()

◆ getName() [1/2]

◆ getName() [2/2]

◆ getNameEn() [1/2]

◆ getNameEn() [2/2]

◆ getPickupCursor()

◆ getReplaceToSpriteId()

◆ getRideAttackAction()

◆ getSkyAttackAction()

◆ getSound()

◆ getSprite()

◆ getSpriteToItemReplaceMap()

◆ getStorageMenu()

◆ getStorageMenuConst()

◆ getTags()

◆ getType()

◆ getUseButton()

◆ getUseButton2()

◆ getView()

◆ getWaterAttackAction()

◆ getWeight()

◆ isHaveColors()

◆ isHaveIconColors()

◆ isProtected()

◆ isRemoveItemId()

◆ isRemoveSprites()

◆ replaceColors()

◆ setAttackAction()

◆ setAttackRange()

◆ setCardColor()

◆ setColorsList()

◆ setCriticalHitEffectId()

◆ setDescription()

◆ setDisplay()

◆ setDrawAfter()

◆ setDrawBefore()