Script.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program 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 2
 *   of the License, or (at your option) any later version.
 *
 *   This program 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 this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Benjamin Knecht
 *   Co-authors:
 *      Damian 'Mozork' Frick
 *
 */

#ifndef _Script_H__
#define _Script_H__

#include "objects/ObjectsPrereqs.h"

#include <string>
#include <vector>

#include "core/BaseObject.h"
#include "network/ClientConnectionListener.h"

namespace orxonox
{

    enum class ScriptMode
    {
        normal, 
        lua 
    };

    class _ObjectsExport Script : public BaseObject, public ClientConnectionListener
    {
        public:
            Script(Context* context);
            virtual ~Script();

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; 
            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode) override; 

            bool trigger(bool triggered, BaseObject* trigger); 
            void execute(unsigned int clientId, bool onLoad = false); 
            static void executeHelper(const std::string& code, const std::string& mode, bool needsGraphics); 

            inline void setCode(const std::string& code)
                { code_ = code; }
            inline const std::string& getCode() const
                { return code_; }

            void setMode(const std::string& mode); 
            const std::string& getMode(void); 

            inline void setOnLoad(bool onLoad)
                { this->onLoad_ = onLoad; }
            inline bool isOnLoad(void)
                { return this->onLoad_; }

            void setTimes(int times); 

            inline int getTimes(void)
                { return this->times_; }

            void setNeedsGraphics(bool needsGraphics)
                { this->needsGraphics_ = needsGraphics; }
            bool getNeedsGraphics(void)
                { return this->needsGraphics_; }

            void setForAll(bool forAll)
                { this->forAll_ = forAll; }
            bool isForAll(void)
                { return this->forAll_; }

            virtual void clientConnected(unsigned int clientId) override; 
            virtual void clientDisconnected(unsigned int clientid) override {}

        private:
            static const std::string NORMAL;
            static const std::string LUA;
            static const int INF;

            std::string code_; 
            ScriptMode mode_; 
            std::string modeStr_; 
            bool onLoad_; 
            int times_; 
            bool needsGraphics_; 
            bool forAll_; 

            int remainingExecutions_; 

            void modeChanged(); 

            inline void setMode(ScriptMode mode)
                { this->mode_ = mode; }
    };
}

#endif /* _Script_H__ */