TextCommand Class Reference

#include <textcommand.h>

Public Member Functions
	TextCommand (const int id, const std::string &symbol, const std::string &command, const std::string &comment, const CommandTargetT type, const std::string &icon, const unsigned int basicLvl, const MagicSchoolT school, const unsigned int schoolLvl, const unsigned int mana)
	TextCommand (const int id, const std::string &symbol, const std::string &command, const std::string &comment, const CommandTargetT type, const std::string &icon)
	TextCommand (const int id)
	~TextCommand ()
std::string	getName () const
std::string	getCommand () const
std::string	getComment () const
std::string	getSymbol () const
int	getId () const
CommandTargetT	getTargetType () const
std::string	getIcon () const
unsigned int	getMana () const
MagicSchoolT	getSchool () const
unsigned	getBaseLvl () const
unsigned	getSchoolLvl () const
void	setMana (const unsigned int mana)
void	setSchool (const MagicSchoolT school)
void	setBaseLvl (const unsigned int baseLvl)
void	setSchoolLvl (const unsigned int schoolLvl)
TextCommandTypeT	getCommandType () const
void	setCommandType (const TextCommandTypeT commandType)
void	setCommand (const std::string &command)
void	setComment (const std::string &comment)
void	setSymbol (const std::string &symbol)
void	setId (const int id)
void	setTargetType (const CommandTargetT targetType)
void	setIcon (const std::string &icon)
bool	isEmpty () const
Image *	getImage () const

Protected Attributes
std::string	mCommand
std::string	mComment
std::string	mSymbol
CommandTargetT	mTargetType
std::string	mIcon
int	mId
unsigned int	mMana
MagicSchoolT	mSchool
unsigned	mBaseLvl
unsigned	mSchoolLvl
TextCommandTypeT	mCommandType
Image *	mImage

Private Member Functions
void	loadImage ()

Detailed Description

Represents one or more instances of a certain item type.

Definition at line 41 of file textcommand.h.

Constructor & Destructor Documentation

TextCommand() [1/3]

TextCommand::TextCommand	(	const int	id,
		const std::string &	symbol,
		const std::string &	command,
		const std::string &	comment,
		const CommandTargetT	type,
		const std::string &	icon,
		const unsigned int	basicLvl,
		const MagicSchoolT	school,
		const unsigned int	schoolLvl,
		const unsigned int	mana
	)

Constructor.

Definition at line 40 of file textcommand.cpp.

                                                  :
    mCommand(command),
    mComment(comment),
    mSymbol(symbol),
    mTargetType(type),
    mIcon(icon),
    mId(id),
    mMana(mana),
    mSchool(school),
    mBaseLvl(basicLvl),
    mSchoolLvl(schoolLvl),
    mCommandType(TextCommandType::Magic),
    mImage(nullptr)
{
    loadImage();
}

References loadImage().

TextCommand() [2/3]

TextCommand::TextCommand	(	const int	id,
		const std::string &	symbol,
		const std::string &	command,
		const std::string &	comment,
		const CommandTargetT	type,
		const std::string &	icon
	)

Constructor.

Definition at line 67 of file textcommand.cpp.

                                                :
    mCommand(command),
    mComment(comment),
    mSymbol(symbol),
    mTargetType(type),
    mIcon(icon),
    mId(id),
#ifdef TMWA_SUPPORT
    mMana(0U),
    mSchool(MagicSchool::SkillMagic),
    mBaseLvl(0),
    mSchoolLvl(0),
    mCommandType(TextCommandType::Text),
#endif  // TMWA_SUPPORT
    mImage(nullptr)
{
    loadImage();
}

References loadImage().

TextCommand() [3/3]

TextCommand::TextCommand ( const int  id )

explicit

Constructor.

Definition at line 91 of file textcommand.cpp.

                                     :
    mCommand(""),
    mComment(""),
    mSymbol(""),
    mTargetType(CommandTarget::NoTarget),
    mIcon(""),
    mId(id),
#ifdef TMWA_SUPPORT
    mMana(0U),
    mSchool(MagicSchool::SkillMagic),
    mBaseLvl(0),
    mSchoolLvl(0),
    mCommandType(TextCommandType::Text),
#endif  // TMWA_SUPPORT
    mImage(nullptr)
{
    loadImage();
}

References loadImage().

~TextCommand()

TextCommand::~TextCommand

(

)

Destructor.

Definition at line 111 of file textcommand.cpp.

{
    if (mImage != nullptr)
    {
        mImage->decRef();
        mImage = nullptr;
    }
}

References mImage.

Member Function Documentation

getBaseLvl()

unsigned TextCommand::getBaseLvl ( ) const

inline

Definition at line 110 of file textcommand.h.

        { return mBaseLvl; }

References mBaseLvl.

Referenced by SpellManager::invoke(), SpellManager::save(), and TextCommandEditor::TextCommandEditor().

getCommand()

std::string TextCommand::getCommand ( ) const

inline

Definition at line 85 of file textcommand.h.

        { return mCommand; }

References mCommand.

Referenced by SpellManager::autoComplete(), SpellManager::invoke(), SpellManager::invokeSpell(), SpellManager::save(), and TextCommandEditor::TextCommandEditor().

getCommandType()

TextCommandTypeT TextCommand::getCommandType ( ) const

inline

Definition at line 128 of file textcommand.h.

        { return mCommandType; }

References mCommandType.

Referenced by SpellManager::invoke(), SpellManager::save(), and TextCommandEditor::TextCommandEditor().

getComment()

std::string TextCommand::getComment ( ) const

inline

Definition at line 88 of file textcommand.h.

        { return mComment; }

References mComment.

Referenced by SpellPopup::setItem(), and TextCommandEditor::TextCommandEditor().

getIcon()

std::string TextCommand::getIcon ( ) const

inline

Definition at line 100 of file textcommand.h.

        { return mIcon; }

References mIcon.

Referenced by TextCommandEditor::TextCommandEditor().

getId()

int TextCommand::getId ( ) const

inline

Definition at line 94 of file textcommand.h.

        { return mId; }

References mId.

Referenced by SpellManager::addSpell(), DragDrop::dragCommand(), SpellShortcutContainer::mouseDragged(), SpellShortcutContainer::mouseReleased(), and SpellManager::swap().

getImage()

Image* TextCommand::getImage ( ) const

inline

Definition at line 156 of file textcommand.h.

        { return mImage; }

References mImage.

Referenced by DragDrop::dragCommand(), ItemShortcutContainer::draw(), SpellShortcutContainer::draw(), ItemShortcutContainer::safeDraw(), and SpellShortcutContainer::safeDraw().

getMana()

unsigned int TextCommand::getMana ( ) const

inline

Definition at line 104 of file textcommand.h.

        { return mMana; }

References mMana.

Referenced by SpellManager::invoke(), SpellManager::save(), and TextCommandEditor::TextCommandEditor().

getName()

std::string TextCommand::getName ( ) const

inline

Definition at line 82 of file textcommand.h.

        { return mCommand; }

References mCommand.

Referenced by SpellPopup::setItem().

getSchool()

MagicSchoolT TextCommand::getSchool ( ) const

inline

Definition at line 107 of file textcommand.h.

        { return mSchool; }

References mSchool.

Referenced by SpellManager::invoke(), SpellManager::save(), and TextCommandEditor::TextCommandEditor().

getSchoolLvl()

unsigned TextCommand::getSchoolLvl ( ) const

inline

Definition at line 113 of file textcommand.h.

        { return mSchoolLvl; }

References mSchoolLvl.

Referenced by SpellManager::invoke(), SpellManager::save(), and TextCommandEditor::TextCommandEditor().

getSymbol()

std::string TextCommand::getSymbol ( ) const

inline

Definition at line 91 of file textcommand.h.

        { return mSymbol; }

References mSymbol.

Referenced by DragDrop::dragCommand(), ItemShortcutContainer::draw(), SpellShortcutContainer::draw(), ItemShortcutContainer::safeDraw(), SpellShortcutContainer::safeDraw(), SpellManager::save(), and TextCommandEditor::TextCommandEditor().

getTargetType()

CommandTargetT TextCommand::getTargetType ( ) const

inline

Definition at line 97 of file textcommand.h.

        { return mTargetType; }

References mTargetType.

Referenced by SpellManager::autoComplete(), SpellManager::invoke(), SpellManager::save(), and TextCommandEditor::TextCommandEditor().

isEmpty()

bool TextCommand::isEmpty ( ) const

inline

Definition at line 153 of file textcommand.h.

        { return mCommand.empty() && mSymbol.empty(); }

References mCommand, and mSymbol.

Referenced by ItemShortcutContainer::draw(), SpellShortcutContainer::draw(), SpellShortcutContainer::mouseMoved(), SpellShortcutContainer::mouseReleased(), ItemShortcutContainer::safeDraw(), and SpellShortcutContainer::safeDraw().

loadImage()

void TextCommand::loadImage ( )

private

Definition at line 120 of file textcommand.cpp.

{
    if (mImage != nullptr)
    {
        mImage->decRef();
        mImage = nullptr;
    }
 
    if (mIcon.empty() ||
        !ItemDB::exists(mIcon))
    {
        return;
    }
 
    const ItemInfo &info = ItemDB::get(mIcon);
    const SpriteDisplay &display = info.getDisplay();
    mImage = Loader::getImage(pathJoin(paths.getStringValue("itemIcons"),
        display.image));
 
    if (mImage == nullptr)
        mImage = Theme::getImageFromTheme("unknown-item.png");
}

References ItemDB::exists(), ItemDB::get(), Loader::getImage(), Theme::getImageFromTheme(), Configuration::getStringValue(), SpriteDisplay::image, Actions::info(), mIcon, mImage, pathJoin(), and paths.

Referenced by setIcon(), and TextCommand().

setBaseLvl()

void TextCommand::setBaseLvl ( const unsigned int  baseLvl )

inline

Definition at line 122 of file textcommand.h.

        { mBaseLvl = baseLvl; }

References mBaseLvl.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setCommand()

void TextCommand::setCommand ( const std::string &  command )

inline

Definition at line 135 of file textcommand.h.

        { mCommand = command; }

References mCommand.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setCommandType()

void TextCommand::setCommandType ( const TextCommandTypeT  commandType )

inline

Definition at line 131 of file textcommand.h.

        { mCommandType = commandType; }

References mCommandType.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setComment()

void TextCommand::setComment ( const std::string &  comment )

inline

Definition at line 138 of file textcommand.h.

        { mComment = comment; }

References mComment.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setIcon()

void TextCommand::setIcon ( const std::string &  icon )

inline

Definition at line 150 of file textcommand.h.

        { mIcon = icon; loadImage(); }

References loadImage(), and mIcon.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setId()

void TextCommand::setId ( const int  id )

inline

Definition at line 144 of file textcommand.h.

        { mId = id; }

References mId.

Referenced by SpellManager::swap().

setMana()

void TextCommand::setMana ( const unsigned int  mana )

inline

Definition at line 116 of file textcommand.h.

        { mMana = mana; }

References mMana.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setSchool()

void TextCommand::setSchool ( const MagicSchoolT  school )

inline

Definition at line 119 of file textcommand.h.

        { mSchool = school; }

References mSchool.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setSchoolLvl()

void TextCommand::setSchoolLvl ( const unsigned int  schoolLvl )

inline

Definition at line 125 of file textcommand.h.

        { mSchoolLvl = schoolLvl; }

References mSchoolLvl.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setSymbol()

void TextCommand::setSymbol ( const std::string &  symbol )

inline

Definition at line 141 of file textcommand.h.

        { mSymbol = symbol; }

References mSymbol.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

setTargetType()

void TextCommand::setTargetType ( const CommandTargetT  targetType )

inline

Definition at line 147 of file textcommand.h.

        { mTargetType = targetType; }

References mTargetType.

Referenced by TextCommandEditor::deleteCommand(), and TextCommandEditor::save().

Field Documentation

mBaseLvl

unsigned TextCommand::mBaseLvl

protected

Definition at line 172 of file textcommand.h.

Referenced by getBaseLvl(), and setBaseLvl().

mCommand

std::string TextCommand::mCommand

protected

Definition at line 163 of file textcommand.h.

Referenced by getCommand(), getName(), isEmpty(), and setCommand().

mCommandType

TextCommandTypeT TextCommand::mCommandType

protected

Definition at line 174 of file textcommand.h.

Referenced by getCommandType(), and setCommandType().

mComment

std::string TextCommand::mComment

protected

Definition at line 164 of file textcommand.h.

Referenced by getComment(), and setComment().

mIcon

std::string TextCommand::mIcon

protected

Definition at line 167 of file textcommand.h.

Referenced by getIcon(), loadImage(), and setIcon().

mId

int TextCommand::mId

protected

Definition at line 168 of file textcommand.h.

Referenced by getId(), and setId().

mImage

Image* TextCommand::mImage

protected

Definition at line 177 of file textcommand.h.

Referenced by getImage(), loadImage(), and ~TextCommand().

mMana

unsigned int TextCommand::mMana

protected

Definition at line 170 of file textcommand.h.

Referenced by getMana(), and setMana().

mSchool

MagicSchoolT TextCommand::mSchool

protected

Definition at line 171 of file textcommand.h.

Referenced by getSchool(), and setSchool().

mSchoolLvl

unsigned TextCommand::mSchoolLvl

protected

Definition at line 173 of file textcommand.h.

Referenced by getSchoolLvl(), and setSchoolLvl().

mSymbol

std::string TextCommand::mSymbol

protected

Definition at line 165 of file textcommand.h.

Referenced by getSymbol(), isEmpty(), and setSymbol().

mTargetType

CommandTargetT TextCommand::mTargetType

protected

Definition at line 166 of file textcommand.h.

Referenced by getTargetType(), and setTargetType().

---

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

• src/textcommand.h (986a3bf)
• src/textcommand.cpp (986a3bf)