container.cpp

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#include <cassert>

#include "src/common/util.h"
#include "src/common/error.h"

#include "src/aurora/gff3file.h"

#include "src/aurora/nwscript/types.h"
#include "src/aurora/nwscript/variable.h"
#include "src/aurora/nwscript/ncsfile.h"

#include "src/engines/jade/script/container.h"

namespace Engines {

namespace Jade {

struct ScriptName {
    Script script;
    const char *name;
};

static const ScriptName kScriptNames[] = {
    {kScriptOnBlocked             , "OnBlocked"},
    {kScriptOnClick               , "OnClicked"},
    {kScriptOnClose               , "OnClose"},
    {kScriptOnCombatEnd           , "OnCombatEnd"},
    {kScriptOnConversation        , "OnConversation"},
    {kScriptOnCreate              , "OnCreate"},
    {kScriptOnDamage              , "OnDamaged"},
    {kScriptOnDead                , "OnDead"},
    {kScriptOnDeath               , "OnDeath"},
    {kScriptOnEnter               , "OnEnter"},
    {kScriptOnExit                , "OnExit"},
    {kScriptOnHeartbeat           , "OnHeartbeat"},
    {kScriptOnHeartbeat           , "OnHeartBeat"},
    {kScriptOnPerceptionAppeared  , "OnPerception"},
    {kScriptOnPerceptionVanished  , "OnPerceptionVan"},
    {kScriptOnSpawn               , "OnSpawn"},
    {kScriptOnSubCombatEnd        , "OnSubCombatEnd"},
    {kScriptOnSubCombatStart      , "OnSubCombatStart"},
    {kScriptOnUse                 , "OnUse"},
    {kScriptOnUserdefined         , "OnUserDefined"}
};

ScriptContainer::ScriptContainer() {
}

ScriptContainer::~ScriptContainer() {
}

const Common::UString &ScriptContainer::getScript(Script script) const {
    assert((script >= 0) && (script < kScriptMAX));

    return _scripts[script];
}

bool ScriptContainer::hasScript(Script script) const {
    return !getScript(script).empty();
}

void ScriptContainer::clearScripts() {
    for (size_t i = 0; i < kScriptMAX; i++)
        _scripts[i].clear();
}

void ScriptContainer::readScripts(const Aurora::GFF3Struct &gff) {
    clearScripts();

    if (gff.hasField("Scripts")) {
        const Aurora::GFF3Struct &scripts = gff.getStruct("Scripts");
        for (size_t i = 0; i < ARRAYSIZE(kScriptNames); i++) {
            const Script script = kScriptNames[i].script;
            const char *name = kScriptNames[i].name;

            _scripts[script] = scripts.getString(name, _scripts[script]);
        }
    }
}

void ScriptContainer::readScripts(const ScriptContainer &container) {
    for (size_t i = 0; i < kScriptMAX; i++)
        _scripts[i] = container._scripts[i];
}

bool ScriptContainer::runScript(Script script,
                                const Aurora::NWScript::ObjectReference owner,
                                const Aurora::NWScript::ObjectReference triggerer) {
    return runScript(getScript(script), owner, triggerer);
}

bool ScriptContainer::runScript(const Common::UString &script,
                                const Aurora::NWScript::ObjectReference owner,
                                const Aurora::NWScript::ObjectReference triggerer) {

    return runScript(script, Aurora::NWScript::NCSFile::getEmptyState(), owner, triggerer);
}

bool ScriptContainer::runScript(const Common::UString &script,
                                const Aurora::NWScript::ScriptState &state,
                                const Aurora::NWScript::ObjectReference owner,
                                const Aurora::NWScript::ObjectReference triggerer) {
    if (script.empty())
        return true;

    try {
        Aurora::NWScript::NCSFile ncs(script);

        const Aurora::NWScript::Variable &retVal = ncs.run(state, owner, triggerer);
        if (retVal.getType() == Aurora::NWScript::kTypeInt)
            return retVal.getInt() != 0;
        if (retVal.getType() == Aurora::NWScript::kTypeFloat)
            return retVal.getFloat() != 0.0f;

        return true;

    } catch (...) {
        Common::exceptionDispatcherWarning("Failed running script \"%s\"", script.c_str());
        return false;
    }

    return true;
}

} // End of namespace Jade

} // End of namespace Engines