action.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 LASTEXPRESS_ACTION_H
#define LASTEXPRESS_ACTION_H

#include "lastexpress/shared.h"

#include "common/array.h"
#include "common/func.h"
#include "common/system.h"

namespace LastExpress {

#define DECLARE_ACTION(name) \
    SceneIndex action_##name(const SceneHotspot &hotspot) const

#define ADD_ACTION(name) \
    _actions.push_back(new Functor1MemConst<const SceneHotspot &, SceneIndex, Action>(this, &Action::action_##name));

#define IMPLEMENT_ACTION(name) \
    SceneIndex Action::action_##name(const SceneHotspot &hotspot) const { \
    debugC(6, kLastExpressDebugLogic, "Hotspot action: " #name "%s", hotspot.toString().c_str());

class LastExpressEngine;
class SceneHotspot;

class Action {
public:
    Action(LastExpressEngine *engine);
    ~Action();

    // Hotspot action
    SceneIndex processHotspot(const SceneHotspot &hotspot);

    // Cursor
    CursorStyle getCursor(const SceneHotspot &hotspot) const;

    // Animation
    void playAnimation(EventIndex index, bool debugMode = false) const;

    // Compartment action
    bool handleOtherCompartment(ObjectIndex object, bool doPlaySound, bool doLoadScene) const;

private:
    typedef Common::Functor1<const SceneHotspot &, SceneIndex> ActionFunctor;

    LastExpressEngine *_engine;
    Common::Array<ActionFunctor *> _actions;

    // Each action is of the form action_<name>(SceneHotspot *hotspot)
    //   - a pointer to each action is added to the _actions array
    //   - processHotspot simply calls the proper function given by the hotspot->action value
    //
    // Note: even though there are 44 actions, only 41 are used in processHotspot

    DECLARE_ACTION(inventory);
    DECLARE_ACTION(savePoint);
    DECLARE_ACTION(playSound);
    DECLARE_ACTION(playMusic);
    DECLARE_ACTION(knock);
    DECLARE_ACTION(compartment);
    DECLARE_ACTION(playSounds);
    DECLARE_ACTION(playAnimation);
    DECLARE_ACTION(openCloseObject);
    DECLARE_ACTION(setModel);
    DECLARE_ACTION(setItem);
    DECLARE_ACTION(knockInside);
    DECLARE_ACTION(pickItem);
    DECLARE_ACTION(dropItem);
    DECLARE_ACTION(enterCompartment);
    DECLARE_ACTION(leanOutWindow);
    DECLARE_ACTION(almostFall);
    DECLARE_ACTION(climbInWindow);
    DECLARE_ACTION(climbLadder);
    DECLARE_ACTION(climbDownTrain);
    DECLARE_ACTION(kronosSanctum);
    DECLARE_ACTION(escapeBaggage);
    DECLARE_ACTION(enterBaggage);
    DECLARE_ACTION(bombPuzzle);
    DECLARE_ACTION(27);
    DECLARE_ACTION(kronosConcert);
    DECLARE_ACTION(29);
    DECLARE_ACTION(catchBeetle);
    DECLARE_ACTION(exitCompartment);
    DECLARE_ACTION(outsideTrain);
    DECLARE_ACTION(firebirdPuzzle);
    DECLARE_ACTION(openMatchBox);
    DECLARE_ACTION(openBed);
    DECLARE_ACTION(dialog);
    DECLARE_ACTION(eggBox);
    DECLARE_ACTION(39);
    DECLARE_ACTION(bed);
    DECLARE_ACTION(playMusicChapter);
    DECLARE_ACTION(playMusicChapterSetupTrain);
    DECLARE_ACTION(switchChapter);
    DECLARE_ACTION(44);

    // Special dummy function
    DECLARE_ACTION(dummy);

    // Helpers
    void pickGreenJacket(bool process) const;
    void pickScarf(bool process) const;
    void pickCorpse(ObjectLocation bedPosition, bool process) const;
    void dropCorpse(bool process) const;

    void playCompartmentSoundEvents(ObjectIndex object) const;
};

} // End of namespace LastExpress

#endif // LASTEXPRESS_ACTION_H