scummvm/engines/xeen/scripts.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 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.
 *
 */

#ifndef XEEN_SCRIPTS_H
#define XEEN_SCRIPTS_H

#include "common/scummsys.h"
#include "common/system.h"
#include "common/serializer.h"
#include "common/stack.h"
#include "common/str-array.h"
#include "xeen/files.h"
#include "xeen/party.h"

namespace Xeen {

enum Opcode {
	OP_None			= 0x00,
	OP_Display0x01	= 0x01,
	OP_DoorTextSml	= 0x02,
	OP_DoorTextLrg	= 0x03,
	OP_SignText		= 0x04,
	OP_NPC			= 0x05,
	OP_PlayFX		= 0x06,
	OP_TeleportAndExit = 0x07,
	OP_If1			= 0x08,
	OP_If2			= 0x09,
	OP_If3			= 0x0A,
	OP_MoveObj		= 0x0B,
	OP_TakeOrGive	= 0x0C,
	OP_NoAction		= 0x0D,
	OP_Remove		= 0x0E,
	OP_SetChar		= 0x0F,
	OP_Spawn		= 0x10,
	OP_DoTownEvent	= 0x11,
	OP_Exit			= 0x12,
	OP_AfterMap		= 0x13,
	OP_GiveExtended = 0x14,
	OP_ConfirmWord	= 0x15,
	OP_Damage		= 0x16,
	OP_JumpRnd		= 0x17,
	OP_AfterEvent	= 0x18,
	OP_CallEvent	= 0x19,
	OP_Return		= 0x1A,
	OP_SetVar		= 0x1B,
	OP_TakeOrGive_2 = 0x1C,
	OP_TakeOrGive_3 = 0x1D,
	OP_CutsceneEndClouds = 0x1E,
	OP_TeleportAndContinue = 0x1F,
	OP_WhoWill		= 0x20,
	OP_RndDamage	= 0x21,
	OP_MoveWallObj	= 0x22,
	OP_AlterCellFlag= 0x23,
	OP_AlterHed		= 0x24,
	OP_DisplayStat	= 0x25,
	OP_TakeOrGive_4	= 0x26,
	OP_SeatTextSml	= 0x27,
	OP_PlayEventVoc = 0x28,
	OP_DisplayBottom = 0x29,
	OP_IfMapFlag	= 0x2A,
	OP_SelRndChar	= 0x2B,
	OP_GiveEnchanted= 0x2C,
	OP_ItemType		= 0x2D,
	OP_MakeNothingHere = 0x2E,
	OP_NoAction_2	= 0x2F,
	OP_ChooseNumeric= 0x30,
	OP_DisplayBottomTwoLines = 0x31,
	OP_DisplayLarge	= 0x32,
	OP_ExchObj		= 0x33,
	OP_FallToMap	= 0x34,
	OP_DisplayMain	= 0x35,
	OP_Goto			= 0x36,
	OP_ConfirmWord_2= 0x37,
	OP_GotoRandom	= 0x38,
	OP_CutsceneEndDarkside = 0x39,
	OP_CutsceneEdWorld = 0x3A,
	OP_FlipWorld	= 0x3B,
	OP_PlayCD		= 0x3C
};

class XeenEngine;

class MazeEvent {
public:
	Common::Point _position;
	int _direction;
	int _line;
	Opcode _opcode;
	Common::Array<byte> _parameters;
public:
	MazeEvent();

	void synchronize(Common::Serializer &s);
};

class MazeEvents : public Common::Array<MazeEvent> {
public:
	Common::StringArray _text;
public:
	void synchronize(XeenSerializer &s);
};

struct StackEntry : public Common::Point {
	int line;

	StackEntry(const Common::Point &pt, int l) : Common::Point(pt), line(l) {}
};

struct MirrorEntry {
	Common::String _name;
	int _mapId;
	Common::Point _position;
	int _direction;

	MirrorEntry() : _mapId(0), _direction(DIR_ALL) {}

	bool synchronize(Common::SeekableReadStream &s);
};

class Scripts {
private:
	XeenEngine *_vm;
	int _treasureItems;
	int _lineNum;
	int _charIndex;
	int _mirrorId;
	int _refreshIcons;
	int _scriptResult;
	bool _scriptExecuted;
	bool _var50;
	int _windowIndex;
	bool _redrawDone;
	MazeEvent *_event;
	Common::Point _currentPos;
	Common::Stack<StackEntry> _stack;
	Common::String _message;
	Common::String _displayMessage;

	/**
	 * Handles executing a given script command
	 */
	bool doOpcode(MazeEvent &event);

	/**
	 * Do nothing
	 */
	bool cmdDoNothing(Common::Array<byte> &params);

	/**
	 * Display a msesage on-screen
	 */
	bool cmdDisplay1(Common::Array<byte> &params);

	/**
	 * Displays a door text message using the small font
	 */
	bool cmdDoorTextSml(Common::Array<byte> &params);

	/**
	 * Displays a door text message using the large font
	 */
	bool cmdDoorTextLrg(Common::Array<byte> &params);

	/**
	 * Show a sign text on-screen
	 */
	bool cmdSignText(Common::Array<byte> &params);

	/**
	 * Show an NPC interaction message
	 */
	bool cmdNPC(Common::Array<byte> &params);

	/**
	 * Play a sound FX
	 */
	bool cmdPlayFX(Common::Array<byte> &params);

	/**
	 * Handles teleportation
	 */
	bool cmdTeleport(Common::Array<byte> &params);

	/**
	 * Do a conditional check
	 */
	bool cmdIf(Common::Array<byte> &params);

	/**
	 * Moves the position of an object
	 */
	bool cmdMoveObj(Common::Array<byte> &params);
	
	/**
	 * Take or give amounts from various character or party figures
	 */
	bool cmdTakeOrGive(Common::Array<byte> &params);

	/**
	 * Removes an object from the playfield
	 */
	bool cmdRemove(Common::Array<byte> &params);

	/**
	 * Set the currently active character for other script operations
	 */
	bool cmdSetChar(Common::Array<byte> &params);

	/**
	 * Spawn a monster
	 */
	bool cmdSpawn(Common::Array<byte> &params);

	/**
	 * Does various things that can be done within towns, like visiting
	 * banks, guilds, etc.
	 */
	bool cmdDoTownEvent(Common::Array<byte> &params);

	/**
	 * Stop executing the script
	 */
	bool cmdExit(Common::Array<byte> &params);

	/**
	 * Changes the value for the wall on a given cell
	 */
	bool cmdAlterMap(Common::Array<byte> &params);

	/**
	 *
	 */
	bool cmdGiveExtended(Common::Array<byte> &params);
	
	/**
	 * Confirms with the player for initiating the endgame
	 */
	bool cmdConfirmEnding(Common::Array<byte> &params);
	
	/**
	 * Deals damage to a character
	 */
	bool cmdDamage(Common::Array<byte> &params);

	/**
	 * Jump if a random number matches a given value
	 */
	bool cmdJumpRnd(Common::Array<byte> &params);

	/**
	 * Alter an existing event
	 */
	bool cmdAlterEvent(Common::Array<byte> &params);

	/**
	 * Stores the current location and line for later resuming, and set up to execute
	 * a script at a given location
	 */
	bool cmdCallEvent(Common::Array<byte> &params);

	/**
	 * Return from executing a script to the script location that previously
	 * called the script
	 */
	bool cmdReturn(Common::Array<byte> &params);
	bool cmdSetVar(Common::Array<byte> &params);
	bool cmdCutsceneEndClouds(Common::Array<byte> &params);
	bool cmdWhoWill(Common::Array<byte> &params);
	bool cmdRndDamage(Common::Array<byte> &params);
	bool cmdMoveWallObj(Common::Array<byte> &params);
	bool cmdAlterCellFlag(Common::Array<byte> &params);
	bool cmdAlterHed(Common::Array<byte> &params);
	bool cmdDisplayStat(Common::Array<byte> &params);
	bool cmdSeatTextSml(Common::Array<byte> &params);
	bool cmdPlayEventVoc(Common::Array<byte> &params);
	bool cmdDisplayBottom(Common::Array<byte> &params);
	bool cmdIfMapFlag(Common::Array<byte> &params);
	bool cmdSelRndChar(Common::Array<byte> &params);
	bool cmdGiveEnchanted(Common::Array<byte> &params);
	bool cmdItemType(Common::Array<byte> &params);

	/**
	 * Disable all the scripts at the party's current position
	 */
	bool cmdMakeNothingHere(Common::Array<byte> &params);
	bool cmdCheckProtection(Common::Array<byte> &params);

	/**
	 * Given a number of options, and a list of line numbers associated with
	 * those options, jumps to whichever line for the option the user selects
	 */
	bool cmdChooseNumeric(Common::Array<byte> &params);
	bool cmdDisplayBottomTwoLines(Common::Array<byte> &params);
	bool cmdDisplayLarge(Common::Array<byte> &params);

	/**
	 * Exchange the positions of two objects in the maze
	 */
	bool cmdExchObj(Common::Array<byte> &params);
	bool cmdFallToMap(Common::Array<byte> &params);
	bool cmdDisplayMain(Common::Array<byte> &params);

	/**
	 * Jumps to a given line number if the surface at relative cell position 1 matches
	 * a specified surface.
	 * @remarks		This opcode is apparently never actually used
	 */
	bool cmdGoto(Common::Array<byte> &params);

	/**
	 * Pick a random value from the parameter list and jump to that line number
	 */
	bool cmdGotoRandom(Common::Array<byte> &params);
	bool cmdCutsceneEndDarkside(Common::Array<byte> &params);
	bool cmdCutsceneEdWorld(Common::Array<byte> &params);
	bool cmdFlipWorld(Common::Array<byte> &params);
	bool cmdPlayCD(Common::Array<byte> &params);

	int whoWill(int v1, int v2, int v3);

	void doEndGame();

	void doEndGame2();

	void doWorldEnd();

	void doEnding(const Common::String &endStr, int v2);

	/**
	 * This monstrosity handles doing the various types of If checks on various data
	 */
	bool ifProc(int action, uint32 mask, int mode, int charIndex);

	bool copyProtectionCheck();

	void display(bool justifyFlag, int var46);
public:
	int _animCounter;
	bool _eventSkipped;
	int _whoWill;
	DamageType _nEdamageType;
	int _itemType;
	int _v2;
	Common::Array<MirrorEntry> _mirror;
public:
	Scripts(XeenEngine *vm);

	int checkEvents();

	void openGrate(int wallVal, int action);
};

} // End of namespace Xeen

#endif /* XEEN_SCRIPTS_H */