animscript.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 STARK_RESOURCES_ANIM_SCRIPT_H
#define STARK_RESOURCES_ANIM_SCRIPT_H

#include "common/str.h"

#include "engines/stark/resources/object.h"

namespace Stark {

namespace Formats {
class XRCReadStream;
}

namespace Resources {

class Anim;
class AnimScriptItem;

class AnimScript : public Object {
public:
    static const Type::ResourceType TYPE = Type::kAnimScript;

    AnimScript(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~AnimScript();

    // Resource API
    void onAllLoaded() override;
    void onGameLoop() override;
    void saveLoad(ResourceSerializer *serializer) override;

    void goToScriptItem(AnimScriptItem *item);

    bool hasReached(AnimScriptItem *item);

    bool isDone() const;

protected:
    void goToNextItem();
    int32 findItemIndex(AnimScriptItem *item);

    Anim *_anim;
    Common::Array<AnimScriptItem *> _items;

    int32 _nextItemIndex;
    int32 _msecsToNextUpdate;
    bool _done;
};

class AnimScriptItem : public Object {
public:
    static const Type::ResourceType TYPE = Type::kAnimScriptItem;

    enum Opcodes {
        kDisplayFrame        = 0,
        kPlayAnimSound       = 1,
        kGoToItem            = 2,
        kDisplayRandomFrame  = 3,
        kSleepRandomDuration = 4,
        kPlayStockSound      = 5
    };

    AnimScriptItem(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~AnimScriptItem();

    // Resource API
    void readData(Formats::XRCReadStream *stream) override;

    uint32 getOpcode() const { return _opcode; }

    uint32 getOperand() const { return _operand; }

    uint32 getDuration() const { return _duration; }

protected:
    void printData() override;

    uint32 _opcode;
    uint32 _operand;
    uint32 _duration;
};

} // End of namespace Resources
} // End of namespace Stark

#endif // STARK_RESOURCES_ANIM_SCRIPT_H