OpenMW/apps/openmw/mwworld/localscripts.hpp

#ifndef GAME_MWWORLD_LOCALSCRIPTS_H
#define GAME_MWWORLD_LOCALSCRIPTS_H

#include <list>
#include <string>

#include "ptr.hpp"

namespace ESMS
{
    struct ESMStore;
}

namespace MWWorld
{
    /// \brief List of active local scripts
    class LocalScripts
    {
            std::list<std::pair<std::string, Ptr> > mScripts;
            std::list<std::pair<std::string, Ptr> >::iterator mIter;
            MWWorld::Ptr mIgnore;
            const ESMS::ESMStore& mStore;

        public:

            LocalScripts (const ESMS::ESMStore& store);

            void setIgnore (const Ptr& ptr);
            ///< Mark a single reference for ignoring during iteration over local scripts (will revoke
            /// previous ignores).

            void startIteration();
            ///< Set the iterator to the begin of the script list.

            bool isFinished() const;
            ///< Is iteration finished?

            std::pair<std::string, Ptr> getNext();
            ///< Get next local script (must not be called if isFinished())

            void add (const std::string& scriptName, const Ptr& ptr);
            ///< Add script to collection of active local scripts.

            void addCell (Ptr::CellStore *cell);
            ///< Add all local scripts in a cell.

            void clear();
            ///< Clear active local scripts collection.

            void clearCell (Ptr::CellStore *cell);
            ///< Remove all scripts belonging to \a cell.

            void remove (const Ptr& ptr);
            ///< Remove script for given reference (ignored if reference does not have a scirpt listed).
    };
}

#endif