NEVERHOOD: Split sprites from their scenes in modules 1700 and 1800

This also reduces inter-header dependencies

1 files changed, 2 insertions, 392 deletions

diff --git a/engines/neverhood/modules/module1900.cpp b/engines/neverhood/modules/module1900.cpp
index 29c20083f9..3538c14cf8 100644
--- a/engines/neverhood/modules/module1900.cpp
+++ b/engines/neverhood/modules/module1900.cpp
@@ -20,8 +20,9 @@
  *
  */
 
-#include "neverhood/modules/module1900.h"
 #include "neverhood/gamemodule.h"
+#include "neverhood/modules/module1900.h"
+#include "neverhood/modules/module1900_sprites.h"
 
 namespace Neverhood {
 
@@ -84,8 +85,6 @@ void Module1900::updateScene() {
 	}
 }
 
-// Scene1901
-
 Scene1901::Scene1901(NeverhoodEngine *vm, Module *parentModule, int which)
 	: Scene(vm, parentModule) {
 
@@ -126,395 +125,6 @@ Scene1901::Scene1901(NeverhoodEngine *vm, Module *parentModule, int which)
 
 }
 
-static const NPoint kAsScene1907SymbolGroundPositions[] = {
-	{160, 310}, { 90, 340}, {210, 335},
-	{210, 380}, {310, 340}, {290, 400},
-	{400, 375}, {370, 435}, {475, 415}
-};
-
-static const NPoint kAsScene1907SymbolPluggedInPositions[] = {
-	{275, 125}, {244, 125}, {238, 131},
-	{221, 135}, {199, 136}, {168, 149},
-	{145, 152}, {123, 154}, {103, 157}
-};
-
-static const NPoint kAsScene1907SymbolGroundHitPositions[] = {
-	{275, 299}, {244, 299}, {238, 305},
-	{221, 309}, {199, 310}, {168, 323},
-	{145, 326}, {123, 328}, {103, 331}
-};
-
-static const NPoint kAsScene1907SymbolPluggedInDownPositions[] = {
-	{275, 136}, {244, 156}, {238, 183},
-	{221, 207}, {199, 228}, {168, 262},
-	{145, 285}, {123, 307}, {103, 331}
-};
-
-static const uint32 kAsScene1907SymbolFileHashes[] = {
-	0x006A1034, 0x006A1010, 0x006A1814,
-	0x006A1016, 0x006A0014, 0x002A1014,
-	0x00EA1014, 0x206A1014, 0x046A1414
-};
-
-bool AsScene1907Symbol::_plugInFailed = false;
-int AsScene1907Symbol::_plugInTryCount = 0;
-
-AsScene1907Symbol::AsScene1907Symbol(NeverhoodEngine *vm, Scene1907 *parentScene, int elementIndex, int positionIndex)
-	: AnimatedSprite(vm, 1000 - positionIndex), _parentScene(parentScene), _elementIndex(elementIndex), _isMoving(false) {
-
-	_plugInFailed = false;
-	_plugInTryCount = 0;
-
-	if (getGlobalVar(V_STAIRS_PUZZLE_SOLVED)) {
-		_isPluggedIn = true;
-		_currPositionIndex = elementIndex;
-		if (!getGlobalVar(V_STAIRS_DOWN)) {
-			_x = kAsScene1907SymbolPluggedInPositions[_currPositionIndex].x;
-			_y = kAsScene1907SymbolPluggedInPositions[_currPositionIndex].y;
-		} else {
-			_x = kAsScene1907SymbolPluggedInDownPositions[_currPositionIndex].x;
-			_y = kAsScene1907SymbolPluggedInDownPositions[_currPositionIndex].y;
-		}
-		createSurface1(kAsScene1907SymbolFileHashes[_elementIndex], 1000 + _currPositionIndex);
-		startAnimation(kAsScene1907SymbolFileHashes[_elementIndex], -1, -1);
-		_newStickFrameIndex = STICK_LAST_FRAME;
-	} else {
-		_isPluggedIn = false;
-		_currPositionIndex = positionIndex;
-		loadSound(0, 0x74231924);
-		loadSound(1, 0x36691914);
-		loadSound(2, 0x5421D806);
-		_parentScene->setPositionFree(_currPositionIndex, false);
-		_x = kAsScene1907SymbolGroundPositions[_currPositionIndex].x;
-		_y = kAsScene1907SymbolGroundPositions[_currPositionIndex].y;
-		createSurface1(kAsScene1907SymbolFileHashes[_elementIndex], 1000 + _currPositionIndex);
-		startAnimation(kAsScene1907SymbolFileHashes[_elementIndex], 0, -1);
-		_newStickFrameIndex = 0;
-	}
-	_collisionBoundsOffset.set(0, 0, 80, 80);
-	Sprite::updateBounds();
-	SetUpdateHandler(&AnimatedSprite::update);
-	SetMessageHandler(&AsScene1907Symbol::handleMessage);
-
-}
-
-void AsScene1907Symbol::update() {
-	updateAnim();
-	handleSpriteUpdate();
-	updatePosition();
-	if (_plugInFailed && _plugInTryCount == 0)
-		_plugInFailed = false;
-}
-
-uint32 AsScene1907Symbol::handleMessage(int messageNum, const MessageParam &param, Entity *sender) {
-	uint32 messageResult = Sprite::handleMessage(messageNum, param, sender);
-	switch (messageNum) {
-	case 0x1011:
-		if (!_isPluggedIn && !_plugInFailed) {
-			tryToPlugIn();
-			messageResult = 1;
-		} else
-			messageResult = 0;
-		break;
-	}
-	return messageResult;
-}
-
-uint32 AsScene1907Symbol::hmTryToPlugIn(int messageNum, const MessageParam &param, Entity *sender) {
-	uint32 messageResult = Sprite::handleMessage(messageNum, param, sender);
-	switch (messageNum) {
-	case 0x3002:
-		gotoNextState();
-		break;
-	}
-	return messageResult;
-}
-
-void AsScene1907Symbol::suTryToPlugIn() {
-	_currStep++;
-	_x -= _deltaX;
-	_y -= _deltaY;
-	if (_currStep == 16) {
-		_x -= _smallDeltaX;
-		_y -= _smallDeltaY;
-		SetSpriteUpdate(NULL);
-	}
-}
-
-void AsScene1907Symbol::suFallOff() {
-	if (_fallOffDelay != 0) {
-		_fallOffDelay--;
-	} else {
-		_y += _yAccel;
-		_yAccel += 8;
-		if (_y >= kAsScene1907SymbolGroundHitPositions[_currPositionIndex].y) {
-			_y = kAsScene1907SymbolGroundHitPositions[_currPositionIndex].y;
-			stFallOffHitGround();
-		}
-	}
-}
-
-void AsScene1907Symbol::suFallOffHitGround() {
-
-	if (_x == _someX - _xBreak)
-		_x -= _smallDeltaX;
-	else
-		_x -= _deltaX;
-
-	if (_y == kAsScene1907SymbolGroundHitPositions[_currPositionIndex].y) {
-		_y -= _someY;
-	}
-
-	if (_currStep < 8) {
-		_y -= _yAccel;
-		_yAccel -= 4;
-		if (_yAccel < 0)
-			_yAccel = 0;
-	} else if (_currStep < 15) {
-		_y += _yAccel;
-		_yAccel += 4;
-	} else {
-		_y = kAsScene1907SymbolGroundPositions[_newPositionIndex].y;
-		cbFallOffHitGroundEvent();
-	}
-
-	_currStep++;
-}
-
-void AsScene1907Symbol::suMoveDown() {
-	_y += _yIncr;
-	if (_yIncr < 11)
-		_yIncr++;
-	if (_y >= kAsScene1907SymbolPluggedInDownPositions[_elementIndex].y) {
-		_y = kAsScene1907SymbolPluggedInDownPositions[_elementIndex].y;
-		_isMoving = false;
-		SetSpriteUpdate(NULL);
-	}
-}
-
-void AsScene1907Symbol::suMoveUp() {
-	_y -= _yIncr;
-	if (getGlobalVar(V_WALL_BROKEN)) {
-		if (_y - (9 + (_elementIndex > 5 ? 31 : 0)) < kAsScene1907SymbolPluggedInPositions[_elementIndex].y)
-			_yIncr--;
-		else
-			_yIncr++;
-	} else
-		_yIncr = 2;
-	if (_yIncr > 9)
-		_yIncr = 9;
-	else if (_yIncr < 1)
-		_yIncr = 1;
-	if (_y < kAsScene1907SymbolPluggedInPositions[_elementIndex].y) {
-		_y = kAsScene1907SymbolPluggedInPositions[_elementIndex].y;
-		_isMoving = false;
-		SetSpriteUpdate(NULL);
-	}
-}
-
-void AsScene1907Symbol::tryToPlugIn() {
-	_isPluggedIn = true;
-	_plugInTryCount++;
-	_newPositionIndex = _parentScene->getNextPosition();
-	_parentScene->setPositionFree(_currPositionIndex, true);
-	sendMessage(_parentScene, 0x1022, 1100 + _newPositionIndex);
-	startAnimation(kAsScene1907SymbolFileHashes[_elementIndex], 0, -1);
-	SetUpdateHandler(&AsScene1907Symbol::update);
-	SetMessageHandler(&AsScene1907Symbol::hmTryToPlugIn);
-	SetSpriteUpdate(&AsScene1907Symbol::suTryToPlugIn);
-	_currStep = 0;
-	_deltaX = (_x - kAsScene1907SymbolPluggedInPositions[_newPositionIndex].x) / 16;
-	_smallDeltaX = _x - _deltaX * 16 - kAsScene1907SymbolPluggedInPositions[_newPositionIndex].x;
-	_deltaY = (_y - kAsScene1907SymbolPluggedInPositions[_newPositionIndex].y) / 16;
-	_smallDeltaY = _y - _deltaY * 16 - kAsScene1907SymbolPluggedInPositions[_newPositionIndex].y;
-	if (_elementIndex == _newPositionIndex) {
-		NextState(&AsScene1907Symbol::stPlugIn);
-	} else {
-		_plugInFailed = true;
-		NextState(&AsScene1907Symbol::stPlugInFail);
-	}
-}
-
-void AsScene1907Symbol::fallOff(int newPositionIndex, int fallOffDelay) {
-	_isPluggedIn = false;
-	_newPositionIndex = newPositionIndex;
-	_fallOffDelay = fallOffDelay;
-	_parentScene->setPositionFree(_newPositionIndex, false);
-	_x = kAsScene1907SymbolPluggedInPositions[_currPositionIndex].x;
-	_y = kAsScene1907SymbolPluggedInPositions[_currPositionIndex].y;
-	_someX = _x;
-	_someY = _y;
-	startAnimation(kAsScene1907SymbolFileHashes[_elementIndex], -1, 0);
-	_playBackwards = true;
-	_newStickFrameIndex = STICK_LAST_FRAME;
-	_currStep = 0;
-	_yAccel = 1;
-	SetUpdateHandler(&AsScene1907Symbol::update);
-	SetMessageHandler(&AsScene1907Symbol::handleMessage);
-	SetSpriteUpdate(&AsScene1907Symbol::suFallOff);
-}
-
-void AsScene1907Symbol::stFallOffHitGround() {
-	playSound(1);
-	sendMessage(_parentScene, 0x1022, 1000 + _newPositionIndex);
-	Entity::_priority = 1000 - _newPositionIndex;
-	_parentScene->removeCollisionSprite(this);
-	_parentScene->addCollisionSprite(this);
-	SetSpriteUpdate(&AsScene1907Symbol::suFallOffHitGround);
-	NextState(&AsScene1907Symbol::cbFallOffHitGroundEvent);
-	_newStickFrameIndex = 0;
-	_currStep = 0;
-	_yAccel = 30;
-	_deltaX = (_x - kAsScene1907SymbolGroundPositions[_newPositionIndex].x) / 15;
-	_xBreak = _deltaX * 15;
-	_smallDeltaX = _x - kAsScene1907SymbolGroundPositions[_newPositionIndex].x - _xBreak;
-	_someY = 0;
-	if (kAsScene1907SymbolGroundHitPositions[_currPositionIndex].y > kAsScene1907SymbolGroundPositions[_newPositionIndex].y)
-		_someY = kAsScene1907SymbolGroundHitPositions[_currPositionIndex].y - kAsScene1907SymbolGroundPositions[_newPositionIndex].y;
-}
-
-void AsScene1907Symbol::cbFallOffHitGroundEvent() {
-	_currPositionIndex = _newPositionIndex;
-	if (_plugInTryCount > 0)
-		_plugInTryCount--;
-	startAnimation(kAsScene1907SymbolFileHashes[_elementIndex], 0, -1);
-	_newStickFrameIndex = 0;
-	SetUpdateHandler(&AnimatedSprite::update);
-	SetMessageHandler(&AsScene1907Symbol::handleMessage);
-	SetSpriteUpdate(NULL);
-	updateBounds();
-	playSound(2);
-}
-
-void AsScene1907Symbol::stPlugIn() {
-	playSound(0);
-	_currPositionIndex = _newPositionIndex;
-	stopAnimation();
-	SetMessageHandler(&AsScene1907Symbol::handleMessage);
-	SetSpriteUpdate(NULL);
-	if (_elementIndex == 8)
-		sendMessage(_parentScene, 0x2001, 0);
-}
-
-void AsScene1907Symbol::stPlugInFail() {
-	_currPositionIndex = _newPositionIndex;
-	stopAnimation();
-	_parentScene->plugInFailed();
-}
-
-void AsScene1907Symbol::moveUp() {
-	startAnimation(kAsScene1907SymbolFileHashes[_elementIndex], -1, -1);
-	stopAnimation();
-	SetMessageHandler(&AsScene1907Symbol::handleMessage);
-	SetSpriteUpdate(&AsScene1907Symbol::suMoveUp);
-	_yIncr = 1;
-	_isMoving = true;
-}
-
-void AsScene1907Symbol::moveDown() {
-	startAnimation(kAsScene1907SymbolFileHashes[_elementIndex], -1, -1);
-	stopAnimation();
-	SetMessageHandler(&AsScene1907Symbol::handleMessage);
-	SetSpriteUpdate(&AsScene1907Symbol::suMoveDown);
-	_yIncr = 4;
-	_isMoving = true;
-}
-
-SsScene1907UpDownButton::SsScene1907UpDownButton(NeverhoodEngine *vm, Scene1907 *parentScene, AsScene1907Symbol *asScene1907Symbol)
-	: StaticSprite(vm, 1400), _parentScene(parentScene), _asScene1907Symbol(asScene1907Symbol),
-	_countdown1(0) {
-
-	loadSprite(0x64516424, kSLFDefDrawOffset | kSLFDefPosition | kSLFDefCollisionBoundsOffset, 1400);
-	setVisible(false);
-	loadSound(0, 0x44061000);
-	SetUpdateHandler(&SsScene1907UpDownButton::update);
-	SetMessageHandler(&SsScene1907UpDownButton::handleMessage);
-	if (getGlobalVar(V_STAIRS_PUZZLE_SOLVED)) {
-		if (getGlobalVar(V_STAIRS_DOWN))
-			setToDownPosition();
-		else
-			setToUpPosition();
-	}
-}
-
-void SsScene1907UpDownButton::update() {
-	updatePosition();
-	if (_countdown1 != 0 && (--_countdown1 == 0)) {
-		setVisible(false);
-		sendMessage(_parentScene, 0x2000, 0);
-	}
-}
-
-uint32 SsScene1907UpDownButton::handleMessage(int messageNum, const MessageParam &param, Entity *sender) {
-	uint32 messageResult = Sprite::handleMessage(messageNum, param, sender);
-	switch (messageNum) {
-	case 0x1011:
-		if (_countdown1 == 0 && !_asScene1907Symbol->isMoving() && getGlobalVar(V_STAIRS_PUZZLE_SOLVED)) {
-			setVisible(true);
-			_countdown1 = 4;
-			updatePosition();
-			playSound(0);
-		}
-		messageResult = 1;
-	}
-	return messageResult;
-}
-
-void SsScene1907UpDownButton::setToUpPosition() {
-	_y = _spriteResource.getPosition().y;
-	updateBounds();
-	updatePosition();
-}
-
-void SsScene1907UpDownButton::setToDownPosition() {
-	_y = _spriteResource.getPosition().y + 174;
-	updateBounds();
-	updatePosition();
-}
-
-AsScene1907WaterHint::AsScene1907WaterHint(NeverhoodEngine *vm)
-	: AnimatedSprite(vm, 1400) {
-
-	createSurface1(0x110A1061, 1500);
-	_x = 320;
-	_y = 240;
-	startAnimation(0x110A1061, 0, -1);
-	_newStickFrameIndex = 0;
-	setVisible(false);
-	_needRefresh = true;
-	AnimatedSprite::updatePosition();
-	SetUpdateHandler(&AsScene1907WaterHint::update);
-	SetMessageHandler(&Sprite::handleMessage);
-}
-
-void AsScene1907WaterHint::update() {
-	updateAnim();
-	updatePosition();
-}
-
-uint32 AsScene1907WaterHint::hmShowing(int messageNum, const MessageParam &param, Entity *sender) {
-	uint32 messageResult = Sprite::handleMessage(messageNum, param, sender);
-	switch (messageNum) {
-	case 0x3002:
-		gotoNextState();
-		break;
-	}
-	return messageResult;
-}
-
-void AsScene1907WaterHint::show() {
-	setVisible(true);
-	startAnimation(0x110A1061, 0, -1);
-	SetMessageHandler(&AsScene1907WaterHint::hmShowing);
-	NextState(&AsScene1907WaterHint::hide);
-}
-
-void AsScene1907WaterHint::hide() {
-	stopAnimation();
-	setVisible(false);
-	SetMessageHandler(&Sprite::handleMessage);
-}
-
 Scene1907::Scene1907(NeverhoodEngine *vm, Module *parentModule)
 	: Scene(vm, parentModule), _currMovingSymbolIndex(0), _pluggedInCount(0),
 	_moveDownCountdown(0), _moveUpCountdown(0), _countdown3(0), _hasPlugInFailed(false) {