script.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_SCRIPT_H
#define STARK_RESOURCES_SCRIPT_H

#include "common/str.h"

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

namespace Stark {

namespace Formats {
class XRCReadStream;
}

namespace Resources {

class Command;

class Script : public Object {
public:
    static const Type::ResourceType TYPE = Type::kScript;

    enum SubType {
        kSubTypeGameEvent = 4,
        kSubTypePlayerAction = 5,
        kSubTypeDialog = 6
    };

    enum ScriptType {
        kScriptTypeOnGameEvent = 0,
        kScriptTypePassiveDialog = 1,
        kScriptTypeOnPlayerAction = 2,
        kScriptType3 = 3,
        kScriptType4 = 4
    };

    enum GameEvent {
        kGameEventOnGameLoop = 0,
        kGameEventOnEnterLocation = 1,
        kGameEventOnExitLocation = 2
    };

    enum CallMode {
        kCallModeGameLoop = 1,
        kCallModeExitLocation = 2,
        kCallModeEnterLocation = 3,
        kCallModePlayerAction = 4,
        kCallModeDialogCreateSelections = 5,
        kCallModeDialogAnswer = 6
    };

    enum ResumeStatus {
        kResumeComplete,
        kResumeAbort,
        kResumeSuspend
    };

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

    // Resource API
    void readData(Formats::XRCReadStream *stream) override;
    void saveLoad(ResourceSerializer *serializer) override;
    void saveLoadCurrent(ResourceSerializer *serializer) override;
    void onAllLoaded() override;
    void onGameLoop() override;

    void reset();

    bool isEnabled();

    void enable(bool value);

    void stop();

    bool isOnBegin();

    bool isOnEnd();

    Command *getBeginCommand();

    void execute(uint32 callMode);

    void pause(int32 msecs);

    void suspend(Object *cause);

    bool isSuspended();

    Object *getSuspendingResource() const;

    bool shouldExecute(uint32 callMode);

    void goToNextCommand();

    void addReturnObject(Object *object);

    void setResumeStatus(ResumeStatus status);

protected:
    void print(uint depth) override;
    void printData() override;

    void updateSuspended();

    void resumeCallerExecution(Object *callerObject);

    uint32 _scriptType;
    uint32 _runEvent;
    uint32 _minChapter;
    uint32 _maxChapter;
    bool _shouldResetGameSpeed;

    bool _enabled;
    Command *_nextCommand;

    int32 _pauseTimeLeft;
    Object *_suspendingResource;
    ResumeStatus _resumeStatus;

    Common::Array<Object *> _returnObjects;
};

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

#endif // STARK_RESOURCES_SCRIPT_H