scummvm/engines/lab/processroom.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/>.
 *
 */

/*
 * This code is based on Labyrinth of Time code with assistance of
 *
 * Copyright (c) 1993 Terra Nova Development
 * Copyright (c) 2004 The Wyrmkeep Entertainment Co.
 *
 */

#ifndef LAB_PROCESSROOM_H
#define LAB_PROCESSROOM_H

namespace Lab {

enum ActionType {
	kActionPlaySound = 1,
	kActionPlaySoundLooping = 2,
	kActionShowDiff = 3,
	kActionShowDiffLooping = 4,
	kActionLoadDiff = 5,
	kActionLoadBitmap = 6,	// unused
	kActionShowBitmap = 7,	// unused
	kActionTransition = 8,
	kActionNoUpdate = 9,
	kActionForceUpdate = 10,
	kActionShowCurPict = 11,
	kActionSetElement = 12,
	kActionUnsetElement = 13,
	kActionShowMessage = 14,
	kActionShowMessages = 15,
	kActionChangeRoom = 16,
	kActionSetCloseup = 17,
	kActionMainView = 18,
	kActionSubInv = 19,
	kActionAddInv = 20,
	kActionShowDir = 21,
	kActionWaitSecs = 22,
	kActionStopMusic = 23,
	kActionStartMusic = 24,
	kActionChangeMusic = 25,
	kActionResetMusic = 26,
	kActionFillMusic = 27,
	kActionWaitSound = 28,
	kActionClearSound = 29,
	kActionWinMusic = 30,
	kActionWinGame = 31,
	kActionLostGame = 32,	// unused
	kActionResetBuffer = 33,
	kActionSpecialCmd = 34,
	kActionCShowMessage = 35,
	kActionPlaySoundNoWait = 36
};

enum RuleType {
	kRuleTypeNone = 0,
	kRuleTypeAction = 1,
	kRuleTypeOperate = 2,
	kRuleTypeGoForward = 3,
	kRuleTypeConditions = 4,	// unused?
	kRuleTypeTurn = 5,
	kRuleTypeGoMainView = 6,
	kRuleTypeTurnFromTo = 7
};

enum RuleAction {
	kRuleActionTake = 0,
	kRuleActionMove = 1,	// unused?
	kRuleActionOpenDoor = 2,	// unused?
	kRuleActionCloseDoor = 3,	// unused?
	kRuleActionTakeDef = 4
};

enum Condition {
	kCondBeltGlowing = 70,
	kCondBridge1 = 104,
	kCondNoNews = 135,
	kCondBridge0 = 148,
	kCondLampOn = 151,
	kCondNoClean = 152,
	kCondDirty = 175,
	kCondUsedHelmet = 184
};

enum MapDoors {
	kDoorLeftNorth = 1,
	kDoorLeftEast = 2,
	kDoorLeftSouth = 4,
	kDoorLeftWest = 8,

	kDoorMiddleNorth = 16,
	kDoorRightNorth = 32,
	kDoorMiddleSouth = 64,
	kDoorRightSouth = 128,

	kDoorMiddleEast = 16,
	kDoorBottomEast = 32,
	kDoorMiddleWest = 64,
	kDoorBottomWest = 128
};

enum SpecialRoom {
	kNormalRoom = 0,
	kUpArrowRoom,
	kDownArrowRoom,
	kBridgeRoom,
	kVerticalCorridor,
	kHorizontalCorridor,
	kMedMaze,
	kHedgeMaze,
	kSurMaze,
	kMultiMazeF1,
	kMultiMazeF2,
	kMultiMazeF3
};

struct CloseData {
	uint16 _x1, _y1, _x2, _y2;
	int16 _closeUpType;          // if > 0, an object.  If < 0, an item
	uint16 _depth;               // Level of the closeup.
	Common::String _graphicName;
	Common::String _message;
	CloseDataList _subCloseUps;
};

struct ViewData {
	Common::Array<int16> _condition;
	Common::String _graphicName;
	CloseDataList _closeUps;
};

struct Action {
	ActionType _actionType;
	int16 _param1;
	int16 _param2;
	int16 _param3;
	Common::Array<Common::String> _messages;
};

struct Rule {
	RuleType _ruleType;
	int16 _param1;
	int16 _param2;
	Common::Array<int16> _condition;
	ActionList _actionList;
};

struct RoomData {
	uint16 _doors[4];
	byte _transitionType;
	ViewDataList _view[4];
	RuleList _rules;
	Common::String _roomMsg;
};

struct InventoryData {
	uint16 _quantity;
	Common::String _name;
	Common::String _bitmapName;
};

struct MapData {
	uint16 _x, _y, _pageNumber;
	SpecialRoom _specialID;
	uint32 _mapFlags;
};

} // End of namespace Lab

#endif // LAB_PROCESSROOM_H