ManaPlus
skillunitdb.cpp
Go to the documentation of this file.
1 /*
2  * The ManaPlus Client
3  * Copyright (C) 2008-2009 The Mana World Development Team
4  * Copyright (C) 2009-2010 The Mana Developers
5  * Copyright (C) 2011-2019 The ManaPlus Developers
6  * Copyright (C) 2019-2021 Andrei Karas
7  *
8  * This file is part of The ManaPlus Client.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <http://www.gnu.org/licenses/>.
22  */
23 
25 
26 #include "configuration.h"
27 
28 #include "resources/beingcommon.h"
29 #include "resources/beinginfo.h"
30 
32 
33 #include "utils/checkutils.h"
34 #include "utils/dtor.h"
35 #include "utils/gettext.h"
36 
37 #include "debug.h"
38 
39 namespace
40 {
42  bool mLoaded = false;
43 } // namespace
44 
46 {
47  if (mLoaded)
48  unload();
49 
50  logger->log1("Initializing skill unit database...");
51  loadXmlFile(paths.getStringValue("skillUnitsFile"), SkipError_false);
52  loadXmlFile(paths.getStringValue("skillUnitsPatchFile"), SkipError_true);
53  loadXmlDir("skillUnitsPatchDir", loadXmlFile)
54  mLoaded = true;
55 }
56 
57 void SkillUnitDb::loadXmlFile(const std::string &fileName,
58  const SkipError skipError)
59 {
60  XML::Document doc(fileName, UseVirtFs_true, skipError);
61  XmlNodeConstPtrConst rootNode = doc.rootNode();
62 
63  if ((rootNode == nullptr) || !xmlNameEqual(rootNode, "skillunits"))
64  {
65  logger->log("SkillUnitDb: Error while loading %s!",
66  fileName.c_str());
67  return;
68  }
69 
70  // iterate <skillunit>s
71  for_each_xml_child_node(skillUnitNode, rootNode)
72  {
73  if (xmlNameEqual(skillUnitNode, "include"))
74  {
75  const std::string name = XML::getProperty(skillUnitNode,
76  "name", "");
77  if (!name.empty())
78  loadXmlFile(name, skipError);
79  continue;
80  }
81  else if (!xmlNameEqual(skillUnitNode, "skillunit"))
82  {
83  continue;
84  }
85 
87  skillUnitNode, "id", -1), BeingTypeId);
88  if (id == BeingTypeId_negOne)
89  {
90  reportAlways("SkillUnitDb: skill unit with missing ID in %s!",
91  paths.getStringValue("skillUnitsFile").c_str())
92  continue;
93  }
94 
95  BeingInfo *currentInfo = nullptr;
96  if (mSkillUnitInfos.find(id) != mSkillUnitInfos.end())
97  currentInfo = mSkillUnitInfos[id];
98  if (currentInfo == nullptr)
99  currentInfo = new BeingInfo;
100 
101  currentInfo->setName(XML::langProperty(skillUnitNode,
102  // TRANSLATORS: unknown info name
103  "name", _("skill")));
104 
105  currentInfo->setTargetSelection(XML::getBoolProperty(skillUnitNode,
106  "targetSelection", true));
107 
108  BeingCommon::readBasicAttributes(currentInfo, skillUnitNode, "attack");
109  BeingCommon::readWalkingAttributes(currentInfo, skillUnitNode, 0);
110 
111  currentInfo->setDeadSortOffsetY(XML::getProperty(skillUnitNode,
112  "deadSortOffsetY", 31));
113 
114  SpriteDisplay display;
115  for_each_xml_child_node(spriteNode, skillUnitNode)
116  {
117  if (!XmlHaveChildContent(spriteNode))
118  continue;
119 
120  if (xmlNameEqual(spriteNode, "sprite"))
121  {
122  SpriteReference *const currentSprite = new SpriteReference;
123  currentSprite->sprite = XmlChildContent(spriteNode);
124  currentSprite->variant =
125  XML::getProperty(spriteNode, "variant", 0);
126  display.sprites.push_back(currentSprite);
127  }
128  else if (xmlNameEqual(spriteNode, "particlefx"))
129  {
130  std::string particlefx = XmlChildContent(spriteNode);
131  display.particles.push_back(particlefx);
132  }
133  }
134 
135  currentInfo->setDisplay(display);
136 
137  mSkillUnitInfos[id] = currentInfo;
138  }
139 }
140 
142 {
143  logger->log1("Unloading skill unit database...");
145  mSkillUnitInfos.clear();
146 
147  mLoaded = false;
148 }
149 
151 {
152  const BeingInfoIterator i = mSkillUnitInfos.find(id);
153 
154  if (i == mSkillUnitInfos.end())
155  {
156  reportAlways("SkillUnitDb: Warning, unknown skill unit id "
157  "%d requested",
158  toInt(id, int))
159  return BeingInfo::unknown;
160  }
161  return i->second;
162 }
static void loadXmlFile(const std::string &file, const std::string &name, BadgesInfos &arr, const SkipError skipError)
Definition: badgesdb.cpp:43
#define loadXmlDir(name, function)
Definition: beingcommon.h:39
BeingInfos::iterator BeingInfoIterator
Definition: beinginfo.h:410
std::map< BeingTypeId, BeingInfo * > BeingInfos
Definition: beinginfo.h:409
int BeingTypeId
Definition: beingtypeid.h:30
const BeingTypeId BeingTypeId_negOne
Definition: beingtypeid.h:31
#define reportAlways(...)
Definition: checkutils.h:253
void setTargetSelection(const bool n)
Definition: beinginfo.h:180
void setName(const std::string &name)
Definition: beinginfo.h:65
void setDisplay(const SpriteDisplay &display)
Definition: beinginfo.cpp:127
void setDeadSortOffsetY(const int n)
Definition: beinginfo.h:195
static BeingInfo * unknown
Definition: beinginfo.h:56
std::string getStringValue(const std::string &key) const
void log(const char *const log_text,...)
Definition: logger.cpp:269
void log1(const char *const log_text)
Definition: logger.cpp:238
xmlNodePtr rootNode()
Definition: libxml.cpp:169
Configuration paths
void delete_all(Container &c)
Definition: dtor.h:56
#define _(s)
Definition: gettext.h:35
#define toInt(val, name)
Definition: intdefines.h:47
#define fromInt(val, name)
Definition: intdefines.h:46
#define for_each_xml_child_node(var, parent)
Definition: libxml.h:161
Logger * logger
Definition: logger.cpp:89
void readBasicAttributes(BeingInfo *const info, xmlNode *const node, const std::string &hoverCursor)
Definition: beingcommon.cpp:37
void readWalkingAttributes(BeingInfo *const info, xmlNode *const node, const int moreBlockFlags)
Definition: beingcommon.cpp:60
void unload()
Definition: net.cpp:180
void loadXmlFile(const std::string &fileName, const SkipError skipError)
Definition: skillunitdb.cpp:57
BeingInfo * get(const BeingTypeId id)
std::string langProperty(const xmlNodePtr node, const char *const name, const std::string &def)
Definition: libxml.cpp:258
bool getBoolProperty(const xmlNodePtr node, const char *const name, const bool def)
Definition: libxml.cpp:269
int getProperty(const xmlNodePtr node, const char *const name, int def)
Definition: libxml.cpp:174
const bool SkipError_false
Definition: skiperror.h:30
const bool SkipError_true
Definition: skiperror.h:30
bool SkipError
Definition: skiperror.h:30
StringVect particles
Definition: spritedisplay.h:48
std::vector< SpriteReference * > sprites
Definition: spritedisplay.h:47
std::string sprite
std::string fileName
Definition: testmain.cpp:39
const bool UseVirtFs_true
Definition: usevirtfs.h:30