File: magiceffectcheck.cpp

package info (click to toggle)
openmw 0.49.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,992 kB
  • sloc: cpp: 372,479; xml: 2,149; sh: 1,403; python: 797; makefile: 26
file content (143 lines) | stat: -rw-r--r-- 5,549 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
#include "magiceffectcheck.hpp"

#include <apps/opencs/model/doc/messages.hpp>
#include <apps/opencs/model/prefs/category.hpp>
#include <apps/opencs/model/prefs/setting.hpp>
#include <apps/opencs/model/world/idcollection.hpp>
#include <apps/opencs/model/world/record.hpp>
#include <apps/opencs/model/world/refidcollection.hpp>
#include <apps/opencs/model/world/refiddata.hpp>
#include <apps/opencs/model/world/resources.hpp>

#include <components/esm3/loadmgef.hpp>
#include <components/misc/resourcehelpers.hpp>

#include "../prefs/state.hpp"

namespace ESM
{
    struct Sound;
}

std::string CSMTools::MagicEffectCheckStage::checkObject(
    const ESM::RefId& id, const CSMWorld::UniversalId& type, const std::string& column) const
{
    CSMWorld::RefIdData::LocalIndex index = mObjects.getDataSet().searchId(id);
    if (index.first == -1)
        return (column + " '" + id.getRefIdString() + "' does not exist");
    else if (index.second != type.getType())
        return (column + " '" + id.getRefIdString() + "' does not have " + type.getTypeName() + " type");
    return std::string();
}

CSMTools::MagicEffectCheckStage::MagicEffectCheckStage(const CSMWorld::IdCollection<ESM::MagicEffect>& effects,
    const CSMWorld::IdCollection<ESM::Sound>& sounds, const CSMWorld::RefIdCollection& objects,
    const CSMWorld::Resources& icons, const CSMWorld::Resources& textures)
    : mMagicEffects(effects)
    , mSounds(sounds)
    , mObjects(objects)
    , mIcons(icons)
    , mTextures(textures)
{
    mIgnoreBaseRecords = false;
}

int CSMTools::MagicEffectCheckStage::setup()
{
    mIgnoreBaseRecords = CSMPrefs::get()["Reports"]["ignore-base-records"].isTrue();

    return mMagicEffects.getSize();
}

void CSMTools::MagicEffectCheckStage::perform(int stage, CSMDoc::Messages& messages)
{
    const CSMWorld::Record<ESM::MagicEffect>& record = mMagicEffects.getRecord(stage);

    // Skip "Base" records (setting!) and "Deleted" records
    if ((mIgnoreBaseRecords && record.mState == CSMWorld::RecordBase::State_BaseOnly) || record.isDeleted())
        return;

    ESM::MagicEffect effect = record.get();
    CSMWorld::UniversalId id(CSMWorld::UniversalId::Type_MagicEffect, CSMWorld::getRecordId(effect));

    if (effect.mData.mSpeed <= 0.0f)
    {
        messages.add(id, "Speed is less than or equal to zero", "", CSMDoc::Message::Severity_Error);
    }

    if (effect.mDescription.empty())
    {
        messages.add(id, "Description is missing", "", CSMDoc::Message::Severity_Warning);
    }

    if (effect.mData.mBaseCost < 0.0f)
    {
        messages.add(id, "Base cost is negative", "", CSMDoc::Message::Severity_Error);
    }

    if (effect.mIcon.empty())
    {
        messages.add(id, "Icon is missing", "", CSMDoc::Message::Severity_Error);
    }
    else
    {
        if (mIcons.searchId(effect.mIcon) == -1)
        {
            std::string ddsIcon = effect.mIcon;
            if (!(Misc::ResourceHelpers::changeExtensionToDds(ddsIcon) && mIcons.searchId(ddsIcon) != -1))
                messages.add(id, "Icon '" + effect.mIcon + "' does not exist", "", CSMDoc::Message::Severity_Error);
        }
    }

    if (!effect.mParticle.empty())
    {
        if (mTextures.searchId(effect.mParticle) == -1)
        {
            std::string ddsParticle = effect.mParticle;
            if (!(Misc::ResourceHelpers::changeExtensionToDds(ddsParticle) && mTextures.searchId(ddsParticle) != -1))
                messages.add(id, "Particle texture '" + effect.mParticle + "' does not exist", "",
                    CSMDoc::Message::Severity_Error);
        }
    }

    if (!effect.mCasting.empty())
    {
        const std::string error = checkObject(effect.mCasting, CSMWorld::UniversalId::Type_Static, "Casting object");
        if (!error.empty())
            messages.add(id, error, "", CSMDoc::Message::Severity_Error);
    }

    if (!effect.mHit.empty())
    {
        const std::string error = checkObject(effect.mHit, CSMWorld::UniversalId::Type_Static, "Hit object");
        if (!error.empty())
            messages.add(id, error, "", CSMDoc::Message::Severity_Error);
    }

    if (!effect.mArea.empty())
    {
        const std::string error = checkObject(effect.mArea, CSMWorld::UniversalId::Type_Static, "Area object");
        if (!error.empty())
            messages.add(id, error, "", CSMDoc::Message::Severity_Error);
    }

    if (!effect.mBolt.empty())
    {
        const std::string error = checkObject(effect.mBolt, CSMWorld::UniversalId::Type_Weapon, "Bolt object");
        if (!error.empty())
            messages.add(id, error, "", CSMDoc::Message::Severity_Error);
    }

    if (!effect.mCastSound.empty() && mSounds.searchId(effect.mCastSound) == -1)
        messages.add(id, "Casting sound '" + effect.mCastSound.getRefIdString() + "' does not exist", "",
            CSMDoc::Message::Severity_Error);
    if (!effect.mHitSound.empty() && mSounds.searchId(effect.mHitSound) == -1)
        messages.add(id, "Hit sound '" + effect.mHitSound.getRefIdString() + "' does not exist", "",
            CSMDoc::Message::Severity_Error);
    if (!effect.mAreaSound.empty() && mSounds.searchId(effect.mAreaSound) == -1)
        messages.add(id, "Area sound '" + effect.mAreaSound.getRefIdString() + "' does not exist", "",
            CSMDoc::Message::Severity_Error);
    if (!effect.mBoltSound.empty() && mSounds.searchId(effect.mBoltSound) == -1)
        messages.add(id, "Bolt sound '" + effect.mBoltSound.getRefIdString() + "' does not exist", "",
            CSMDoc::Message::Severity_Error);
}