scummvm/engines/titanic/game/arboretum_gate.cpp

/* 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.
 *
 */

#include "titanic/game/arboretum_gate.h"
#include "titanic/translation.h"

namespace Titanic {

BEGIN_MESSAGE_MAP(CArboretumGate, CBackground)
	ON_MESSAGE(ChangeSeasonMsg)
	ON_MESSAGE(ActMsg)
	ON_MESSAGE(MovieEndMsg)
	ON_MESSAGE(LeaveViewMsg)
	ON_MESSAGE(TurnOff)
	ON_MESSAGE(MouseButtonDownMsg)
	ON_MESSAGE(EnterViewMsg)
	ON_MESSAGE(TurnOn)
END_MESSAGE_MAP()

bool CArboretumGate::_gotSpeechCentre;
bool CArboretumGate::_disabled;
int CArboretumGate::_initialFrame;

CArboretumGate::CArboretumGate() : CBackground() {
	_arboretumViewName = "NULL";
	_exitViewName = "NULL";
	_seasonNum = SEASON_SUMMER;
	_unused1 = 0;
	_startFrameSpringOff = 244;
	_endFrameSpringOff = 304;
	_startFrameSummerOff = 122;
	_endFrameSummerOff = 182;
	_startFrameAutumnOff1 = 183;
	_endFrameAutumnOff1 = 243;
	_startFrameAutumnOff2 = 665;
	_endFrameAutumnOff2 = 724;
	_startFrameWinterOff1 = 61;
	_endFrameWinterOff1 = 121;
	_startFrameWinterOff2 = 0;
	_endFrameWinterOff2 = 60;
	_startFrameSpringOn = 485;
	_endFrameSpringOn = 544;
	_startFrameSummerOn = 425;
	_endFrameSummerOn = 484;
	_startFrameAutumnOn1 = 545;
	_endFrameAutumnOn1 = 604;
	_startFrameAutumnOn2 = 605;
	_endFrameAutumnOn2 = 664;
	_startFrameWinterOn1 = 305;
	_endFrameWinterOn1 = 364;
	_startFrameWinterOn2 = 365;
	_endFrameWinterOn2 = 424;
}

void CArboretumGate::save(SimpleFile *file, int indent) {
	file->writeNumberLine(1, indent);
	file->writeNumberLine(_seasonNum, indent);
	file->writeNumberLine(_gotSpeechCentre, indent);
	file->writeNumberLine(_initialFrame, indent);
	file->writeNumberLine(_disabled, indent);
	file->writeQuotedLine(_arboretumViewName, indent);
	file->writeNumberLine(_unused1, indent);
	file->writeNumberLine(_startFrameSpringOff, indent);
	file->writeNumberLine(_endFrameSpringOff, indent);
	file->writeNumberLine(_startFrameSummerOff, indent);
	file->writeNumberLine(_endFrameSummerOff, indent);
	file->writeNumberLine(_startFrameAutumnOff1, indent);
	file->writeNumberLine(_endFrameAutumnOff1, indent);
	file->writeNumberLine(_startFrameAutumnOff2, indent);
	file->writeNumberLine(_endFrameAutumnOff2, indent);
	file->writeNumberLine(_startFrameWinterOff1, indent);
	file->writeNumberLine(_endFrameWinterOff1, indent);
	file->writeNumberLine(_startFrameWinterOff2, indent);
	file->writeNumberLine(_endFrameWinterOff2, indent);
	file->writeNumberLine(_startFrameSpringOn, indent);
	file->writeNumberLine(_endFrameSpringOn, indent);
	file->writeNumberLine(_startFrameSummerOn, indent);
	file->writeNumberLine(_endFrameSummerOn, indent);
	file->writeNumberLine(_startFrameAutumnOn1, indent);
	file->writeNumberLine(_endFrameAutumnOn1, indent);
	file->writeNumberLine(_startFrameAutumnOn2, indent);
	file->writeNumberLine(_endFrameAutumnOn2, indent);
	file->writeNumberLine(_startFrameWinterOn1, indent);
	file->writeNumberLine(_endFrameWinterOn1, indent);
	file->writeNumberLine(_startFrameWinterOn2, indent);
	file->writeNumberLine(_endFrameWinterOn2, indent);
	file->writeQuotedLine(_exitViewName, indent);

	if (g_language == Common::DE_DEU) {
		// German version replicated all the frame fields for some reason
		file->writeNumberLine(_startFrameSpringOff, indent);
		file->writeNumberLine(_endFrameSpringOff, indent);
		file->writeNumberLine(_startFrameSpringOn, indent);
		file->writeNumberLine(_endFrameSpringOn, indent);
		file->writeNumberLine(_startFrameAutumnOff2, indent);
		file->writeNumberLine(_endFrameAutumnOff2, indent);
		file->writeNumberLine(_endFrameAutumnOn2, indent);
		file->writeNumberLine(_startFrameAutumnOn2, indent);
		file->writeNumberLine(_startFrameAutumnOff1, indent);
		file->writeNumberLine(_endFrameAutumnOff1, indent);
		file->writeNumberLine(_startFrameAutumnOn1, indent);
		file->writeNumberLine(_endFrameAutumnOn1, indent);
		file->writeNumberLine(_startFrameSummerOff, indent);
		file->writeNumberLine(_endFrameSummerOff, indent);
		file->writeNumberLine(_startFrameSummerOn, indent);
		file->writeNumberLine(_endFrameSummerOn, indent);
		file->writeNumberLine(_startFrameWinterOff2, indent);
		file->writeNumberLine(_endFrameWinterOff2, indent);
		file->writeNumberLine(_startFrameWinterOn2, indent);
		file->writeNumberLine(_endFrameWinterOn2, indent);
		file->writeNumberLine(_startFrameWinterOff1, indent);
		file->writeNumberLine(_endFrameWinterOff1, indent);
		file->writeNumberLine(_startFrameWinterOn1, indent);
		file->writeNumberLine(_endFrameWinterOn1, indent);
	}

	CBackground::save(file, indent);
}

void CArboretumGate::load(SimpleFile *file) {
	file->readNumber();
	_seasonNum = (Season)file->readNumber();
	_gotSpeechCentre = file->readNumber();
	_initialFrame = file->readNumber();
	_disabled = file->readNumber();
	_arboretumViewName = file->readString();
	_unused1 = file->readNumber();
	_startFrameSpringOff = file->readNumber();
	_endFrameSpringOff = file->readNumber();
	_startFrameSummerOff = file->readNumber();
	_endFrameSummerOff = file->readNumber();
	_startFrameAutumnOff1 = file->readNumber();
	_endFrameAutumnOff1 = file->readNumber();
	_startFrameAutumnOff2 = file->readNumber();
	_endFrameAutumnOff2 = file->readNumber();
	_startFrameWinterOff1 = file->readNumber();
	_endFrameWinterOff1 = file->readNumber();
	_startFrameWinterOff2 = file->readNumber();
	_endFrameWinterOff2 = file->readNumber();
	_startFrameSpringOn = file->readNumber();
	_endFrameSpringOn = file->readNumber();
	_startFrameSummerOn = file->readNumber();
	_endFrameSummerOn = file->readNumber();
	_startFrameAutumnOn1 = file->readNumber();
	_endFrameAutumnOn1 = file->readNumber();
	_startFrameAutumnOn2 = file->readNumber();
	_endFrameAutumnOn2 = file->readNumber();
	_startFrameWinterOn1 = file->readNumber();
	_endFrameWinterOn1 = file->readNumber();
	_startFrameWinterOn2 = file->readNumber();
	_endFrameWinterOn2 = file->readNumber();
	_exitViewName = file->readString();

	if (g_language == Common::DE_DEU) {
		// German version replicated all the frame fields for some reason
		_startFrameSpringOff = file->readNumber();
		_endFrameSpringOff = file->readNumber();
		_startFrameSpringOn = file->readNumber();
		_endFrameSpringOn = file->readNumber();
		_startFrameAutumnOff2 = file->readNumber();
		_endFrameAutumnOff2 = file->readNumber();
		_endFrameAutumnOn2 = file->readNumber();
		_startFrameAutumnOn2 = file->readNumber();
		_startFrameAutumnOff1 = file->readNumber();
		_endFrameAutumnOff1 = file->readNumber();
		_startFrameAutumnOn1 = file->readNumber();
		_endFrameAutumnOn1 = file->readNumber();
		_startFrameSummerOff = file->readNumber();
		_endFrameSummerOff = file->readNumber();
		_startFrameSummerOn = file->readNumber();
		_endFrameSummerOn = file->readNumber();
		_startFrameWinterOff2 = file->readNumber();
		_endFrameWinterOff2 = file->readNumber();
		_startFrameWinterOn2 = file->readNumber();
		_endFrameWinterOn2 = file->readNumber();
		_startFrameWinterOff1 = file->readNumber();
		_endFrameWinterOff1 = file->readNumber();
		_startFrameWinterOn1 = file->readNumber();
		_endFrameWinterOn1 = file->readNumber();
	}

	CBackground::load(file);
}

bool CArboretumGate::ChangeSeasonMsg(CChangeSeasonMsg *msg) {
	_seasonNum = (Season)((_seasonNum + 1) % 4);
	return true;
}

bool CArboretumGate::ActMsg(CActMsg *msg) {
	if (msg->_action == "PlayerGetsSpeechCentre") {
		_gotSpeechCentre = true;
		CVisibleMsg visibleMsg(true);
		visibleMsg.execute("SpCtrOverlay");
	} else if (msg->_action == "ExitLFrozen") {
		if (_disabled) {
			_exitViewName = "FrozenArboretum.Node 2.W";
			CTurnOn onMsg;
			onMsg.execute(this);
		} else {
			changeView("FrozenArboretum.Node 2.W");
		}
	} else if (msg->_action == "ExitRFrozen") {
		if (_disabled) {
			_exitViewName = "FrozenArboretum.Node 2.E";
			CTurnOn onMsg;
			onMsg.execute(this);
		} else {
			changeView("FrozenArboretum.Node 2.E");
		}
	} else if (msg->_action == "ExitLNormal") {
		if (_disabled) {
			_exitViewName = "Arboretum.Node 2.W";
			CTurnOn onMsg;
			onMsg.execute(this);
		} else {
			changeView("Arboretum.Node 2.W");
		}
	} else if (msg->_action == "ExitRNormal") {
		if (_disabled) {
			_exitViewName = "Arboretum.Node 2.E";
			CTurnOn onMsg;
			onMsg.execute(this);
		} else {
			changeView("Arboretum.Node 2.E");
		}
	}

	return true;
}

bool CArboretumGate::MovieEndMsg(CMovieEndMsg *msg) {
	setVisible(!_disabled);

	if (_arboretumViewName != "NULL") {
		changeView(_arboretumViewName);
	} else if (_exitViewName != "NULL") {
		changeView(_exitViewName);
		_exitViewName = "NULL";
	}

	return true;
}

bool CArboretumGate::LeaveViewMsg(CLeaveViewMsg *msg) {
	return false;
}

bool CArboretumGate::TurnOff(CTurnOff *msg) {
	if (!_disabled) {
		switch (_seasonNum) {
		case SEASON_SUMMER:
			playMovie(_startFrameSummerOff, _endFrameSummerOff, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			break;

		case SEASON_AUTUMN:
			if (_gotSpeechCentre) {
				playMovie(_startFrameAutumnOff2, _endFrameAutumnOff2, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			} else {
				playMovie(_startFrameAutumnOff1, _endFrameAutumnOff1, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			}
			break;

		case SEASON_WINTER:
			if (_gotSpeechCentre) {
				playMovie(_startFrameWinterOff2, _endFrameWinterOff2, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			} else {
				playMovie(_startFrameWinterOff1, _endFrameWinterOff1, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			}
			break;

		case SEASON_SPRING:
			playMovie(_startFrameSpringOff, _endFrameSpringOff, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			break;

		default:
			break;
		}

		_disabled = true;
		CArboretumGateMsg gateMsg(1);
		gateMsg.execute("Arboretum", nullptr, MSGFLAG_SCAN);
	}

	return true;
}

bool CArboretumGate::TurnOn(CTurnOn *msg) {
	if (_disabled) {
		CArboretumGateMsg gateMsg(0);
		gateMsg.execute("Arboretum");
		setVisible(true);

		switch (_seasonNum) {
		case SEASON_SUMMER:
			playMovie(_startFrameSummerOn, _endFrameSummerOn, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			break;

		case SEASON_AUTUMN:
			if (_gotSpeechCentre) {
				playMovie(_startFrameAutumnOn2, _endFrameAutumnOn2, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			} else {
				playMovie(_startFrameAutumnOn1, _endFrameAutumnOn1, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			}
			break;

		case SEASON_WINTER:
			if (_gotSpeechCentre) {
				playMovie(_startFrameWinterOn2, _endFrameWinterOn2, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			} else {
				playMovie(_startFrameWinterOn1, _endFrameWinterOn1, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			}
			break;

		case SEASON_SPRING:
			playMovie(_startFrameSpringOn, _endFrameSpringOn, MOVIE_WAIT_FOR_FINISH | MOVIE_NOTIFY_OBJECT);
			break;

		default:
			break;
		}

		_disabled = false;
	}

	return true;
}

bool CArboretumGate::MouseButtonDownMsg(CMouseButtonDownMsg *msg) {
	if (!_disabled) {
		CTurnOff offMsg;
		offMsg.execute(this);
	}

	return true;
}

bool CArboretumGate::EnterViewMsg(CEnterViewMsg *msg) {
	setVisible(!_disabled);

	if (!_disabled) {
		// Only entered when we enter the Arboretum Gate view when in non-winter.
		// When in winter, the landing dock by the Arboretum has a different
		// "frozen water" view, and when the door is open, it changes to the
		// standard Arboretum.2.N view for the Arboretum, skipping this block
		switch (_seasonNum) {
		case SEASON_SUMMER:
			_initialFrame = _startFrameSummerOff;
			break;

		case SEASON_AUTUMN:
			_initialFrame = _gotSpeechCentre ? _startFrameAutumnOff2 : _startFrameAutumnOff1;
			break;

		case SEASON_WINTER:
			_initialFrame = _gotSpeechCentre ? _startFrameWinterOff2 : _startFrameWinterOff1;
			break;

		case SEASON_SPRING:
			_initialFrame = _startFrameSpringOff;
			break;

		default:
			break;
		}

		loadFrame(_initialFrame);
	}

	return true;
}

} // End of namespace Titanic