scripting_effect.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef SCRIPTING_EFFECT_H_INCLUDED
#define SCRIPTING_EFFECT_H_INCLUDED

namespace Common {
class SeekableReadStream;
struct Point;
class WriteStream;
}

namespace ZVision {

class ZVision;

class ScriptingEffect {
public:

    enum ScriptingEffectType {
        SCRIPTING_EFFECT_ANIM  = 1,
        SCRIPTING_EFFECT_AUDIO = 2,
        SCRIPTING_EFFECT_DISTORT = 4,
        SCRIPTING_EFFECT_PANTRACK = 8,
        SCRIPTING_EFFECT_REGION = 16,
        SCRIPTING_EFFECT_TIMER = 32,
        SCRIPTING_EFFECT_TTYTXT = 64,
        SCRIPTING_EFFECT_UNKNOWN = 128,
        SCRIPTING_EFFECT_ALL = 255
    };

    ScriptingEffect() : _engine(0), _key(0), _type(SCRIPTING_EFFECT_UNKNOWN) {}
    ScriptingEffect(ZVision *engine, uint32 key, ScriptingEffectType type) : _engine(engine), _key(key), _type(type) {}
    virtual ~ScriptingEffect() {}

    uint32 getKey() {
        return _key;
    }
    ScriptingEffectType getType() {
        return _type;
    }

    virtual bool process(uint32 deltaTimeInMillis) {
        return false;
    }
    virtual void serialize(Common::WriteStream *stream) {}
    virtual void deserialize(Common::SeekableReadStream *stream) {}
    virtual inline bool needsSerialization() {
        return false;
    }

    virtual bool stop() {
        return true;
    }
    virtual void kill() {}

protected:
    ZVision *_engine;
    uint32 _key;
    ScriptingEffectType _type;

// Static member functions
public:

};
} // End of namespace ZVision

#endif // SCRIPTING_EFFECT_H_INCLUDED