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/kotor/script/container.h"

namespace Engines {

namespace KotOR {

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

static const ScriptName kScriptNames[] = {
    {kScriptAccelerate,    "OnAccelerate"    },
    {kScriptActivateItem,  "Mod_OnActvtItem" },
    {kScriptAnimate,       "OnAnimEvent"     },
    {kScriptAquireItem,    "Mod_OnAcquirItem"},
    {kScriptAttacked,      "OnMeleeAttacked" },
    {kScriptAttacked,      "ScriptAttacked"  },
    {kScriptBlocked,       "ScriptOnBlocked" },
    {kScriptBreak,         "OnBrake"         },
    {kScriptClick,         "OnClick"         },
    {kScriptClosed,        "OnClosed"        },
    {kScriptCreate,        "OnCreate"        },
    {kScriptDamaged,       "OnDamage"        },
    {kScriptDamaged,       "OnDamaged"       },
    {kScriptDamaged,       "ScriptDamaged"   },
    {kScriptDeath,         "OnDeath"         },
    {kScriptDeath,         "ScriptDeath"     },
    {kScriptDialogue,      "ScriptDialogue"  },
    {kScriptDisarm,        "OnDisarm"        },
    {kScriptDisturbed,     "OnInvDisturbed"  },
    {kScriptDisturbed,     "ScriptDisturbed" },
    {kScriptEndDialogue,   "OnEndDialogue"   },
    {kScriptEndDialogue,   "ScriptEndDialogu"},
    {kScriptEndRound,      "ScriptEndRound"  },
    {kScriptEnter,         "Mod_OnClientEntr"},
    {kScriptEnter,         "OnEnter"         },
    {kScriptEnter,         "OnEntered"       },
    {kScriptEnter,         "ScriptOnEnter"   },
    {kScriptExhausted,     "OnExhausted"     },
    {kScriptExit,          "Mod_OnClientLeav"},
    {kScriptExit,          "OnExit"          },
    {kScriptExit,          "ScriptOnExit"    },
    {kScriptFailToOpen,    "OnFailToOpen"    },
    {kScriptFire,          "OnFire"          },
    {kScriptHeartbeart,    "ScriptHeartbeat" },
    {kScriptHeartbeat,     "Mod_OnHeartbeat" },
    {kScriptHeartbeat,     "OnHeartbeat"     },
    {kScriptHitBullet,     "OnHitBullet"     },
    {kScriptHitFollower,   "OnHitFollower"   },
    {kScriptHitObstacle,   "OnHitObstacle"   },
    {kScriptHitWorld,      "OnHitWorld"      },
    {kScriptLock,          "OnLock"          },
    {kScriptModuleLoad,    "Mod_OnModLoad"   },
    {kScriptModuleStart,   "Mod_OnModStart"  },
    {kScriptNotice,        "ScriptOnNotice"  },
    {kScriptOpen,          "OnOpen"          },
    {kScriptOpenStore,     "OnOpenStore"     },
    {kScriptPlayerDeath,   "Mod_OnPlrDeath"  },
    {kScriptPlayerDying,   "Mod_OnPlrDying"  },
    {kScriptPlayerLevelUp, "Mod_OnPlrLvlUp"  },
    {kScriptPlayerRespawn, "Mod_OnSpawnBtnDn"},
    {kScriptPlayerRest,    "Mod_OnPlrRest"   },
    {kScriptRest,          "ScriptRested"    },
    {kScriptSpawn,         "ScriptSpawn"     },
    {kScriptSpellCastAt,   "OnSpellCastAt"   },
    {kScriptSpellCastAt,   "ScriptSpellAt"   },
    {kScriptTrackLoop,     "OnTrackLoop"     },
    {kScriptTrapTriggered, "OnTrapTriggered" },
    {kScriptUnaquireItem,  "Mod_OnUnAqreItem"},
    {kScriptUnlock,        "OnUnlock"        },
    {kScriptUsed,          "OnUsed"          },
    {kScriptUserdefined,   "Mod_OnUsrDefined"},
    {kScriptUserdefined,   "OnUserDefined"   },
    {kScriptUserdefined,   "ScriptUserDefine"}
};

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, bool clear) {
    if (clear)
        clearScripts();

    for (size_t i = 0; i < ARRAYSIZE(kScriptNames); i++) {
        const Script script = kScriptNames[i].script;
        const char  *name   = kScriptNames[i].name;

        if (!_scripts[script].empty())
            continue;

        Common::UString scriptName = gff.getString(name);
        _scripts[script] = scriptName;

        if (!scriptName.empty())
            assert(!_scripts[script].empty());
    }
}

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 KotOR

} // End of namespace Engines