Attempt to convert scenarios that used specials on boatable terrains, by inserting a "boat block" special in the front of each such chain

- This commit also introduces "boat block" and "horse block" specials as part of the IF_CONTEXT special node type.

osx/classes/outdoors.cpp

@@ -11,6 +11,7 @@
 #include <map>
 #include <sstream>
 
+#include "dlogutil.h"
 #include "classes.h"
 #include "oldstructs.h"
 
@@ -18,6 +19,18 @@ extern cScenario scenario;
 
 cOutdoors& cOutdoors::operator = (legacy::outdoor_record_type& old){
 	int i,j;
+	// Collect a list of unused special nodes, to be used for fixing specials that could be triggered in a boat.
+	std::vector<int> unused_special_slots;
+	for(i = 0; i < 60; i++) {
+		if(specials[i].type == eSpecType::NONE && specials[i].jumpto == -1) {
+			// Also make sure no specials jump to it
+			bool is_free = true;
+			for(j = 0; j < 60; j++) {
+				if(specials[j].jumpto == i) is_free = false;
+			}
+			if(is_free) unused_special_slots.push_back(i);
+		}
+	}
 	for(i = 0; i < 48; i++)
 		for(j = 0; j < 48; j++){
 			terrain[i][j] = old.terrain[i][j];
@@ -51,6 +64,34 @@ cOutdoors& cOutdoors::operator = (legacy::outdoor_record_type& old){
 						terrain[i][j] = 38;
 				}
 			}
+			if(scenario.ter_types[terrain[i][j]].boat_over) {
+				// Try to fix specials that could be triggered while in a boat
+				// (Boats never triggered specials in the old BoE, so we probably don't want them to trigger.)
+				int found_spec = -1;
+				for(int k = 0; i < 18; k++) {
+					if(i == special_locs[k].x && j == special_locs[k].y) {
+						found_spec = k;
+						break;
+					}
+				}
+				if(found_spec >= 0) {
+					if(!unused_special_slots.empty()) {
+						int found_spec_id = special_id[found_spec], use_slot = unused_special_slots.back();
+						unused_special_slots.pop_back();
+						cSpecial& node = specials[use_slot];
+						node.type = eSpecType::IF_CONTEXT;
+						node.ex1a = 101; // if in boat
+						node.ex1c = -1; // do nothing
+						node.jumpto = found_spec_id; // else jump here
+						special_id[found_spec] = use_slot;
+					} else {
+						std::stringstream sout;
+						sout << "In outdoor section (" << x << ',' << y << ") at (" << i << ',' << j << "); special node ID ";
+						sout << special_id[found_spec];
+						giveError("Warning: A special node was found that could be triggered from in a boat, which is probably not what the designer intended. An attempt to fix this has failed because there were not enough unused special nodes.", sout.str());
+					}
+				}
+			}
 		}
 	for(i = 0; i < 18; i++){
 		special_locs[i].x = old.special_locs[i].x;

osx/classes/outdoors.h

@@ -47,6 +47,7 @@ public:
 		
 		cCreature& operator = (legacy::outdoor_creature_type old);
 	};
+	short x,y; // Used while loading legacy scenarios.
 	ter_num_t terrain[48][48];
 	location special_locs[18];
 	unsigned short special_id[18];

osx/classes/regtown.cpp

@@ -11,16 +11,29 @@
 #include <map>
 #include <sstream>
 
+#include "dlogutil.h"
 #include "classes.h"
 #include "oldstructs.h"
 #include "fileio.h"
 
 extern cScenario scenario;
 
-void cTinyTown::append(legacy::tiny_tr_type& old){
+void cTinyTown::append(legacy::tiny_tr_type& old, int town_num){
 	int i,j;
 	cField the_field;
 	the_field.type = 2;
+	// Collect a list of unused special nodes, to be used for fixing specials that could be triggered in a boat.
+	std::vector<int> unused_special_slots;
+	for(i = 0; i < 100; i++) {
+		if(specials[i].type == eSpecType::NONE && specials[i].jumpto == -1) {
+			// Also make sure no specials jump to it
+			bool is_free = true;
+			for(j = 0; j < 100; j++) {
+				if(specials[j].jumpto == i) is_free = false;
+			}
+			if(is_free) unused_special_slots.push_back(i);
+		}
+	}
 	for (i = 0; i < 32; i++)
 		for (j = 0; j < 32; j++) {
 			_terrain[i][j] = old.terrain[i][j];
@@ -30,6 +43,33 @@ void cTinyTown::append(legacy::tiny_tr_type& old){
 				the_field.loc.y = j;
 				preset_fields.push_back(the_field);
 			}
+			if(scenario.ter_types[_terrain[i][j]].boat_over) {
+				// Try to fix specials that could be triggered while in a boat
+				// (Boats never triggered specials in the old BoE, so we probably don't want them to trigger.)
+				int found_spec = -1;
+				for(int k = 0; i < 50; k++) {
+					if(i == special_locs[k].x && j == special_locs[k].y) {
+						found_spec = k;
+						break;
+					}
+				}
+				if(found_spec >= 0) {
+					if(!unused_special_slots.empty()) {
+						int found_spec_id = spec_id[found_spec], use_slot = unused_special_slots.back();
+						unused_special_slots.pop_back();
+						cSpecial& node = specials[use_slot];
+						node.type = eSpecType::IF_CONTEXT;
+						node.ex1a = 101; // if in boat
+						node.ex1c = -1; // do nothing
+						node.jumpto = found_spec_id; // else jump here
+						spec_id[found_spec] = use_slot;
+					} else {
+						std::stringstream sout;
+						sout << "In town \"" << town_num << "\" at (" << i << ',' << j << "); special node ID " << spec_id[found_spec];
+						giveError("Warning: A special node was found that could be triggered from in a boat, which is probably not what the designer intended. An attempt to fix this has failed because there were not enough unused special nodes.", sout.str());
+					}
+				}
+			}
 		}
 	for (i = 0; i < 16; i++) {
 		_room_rect[i].top = old.room_rect[i].top;
@@ -58,10 +98,22 @@ void cTinyTown::append(legacy::tiny_tr_type& old){
 	}
 }
 
-void cMedTown::append(legacy::ave_tr_type& old){
+void cMedTown::append(legacy::ave_tr_type& old, int town_num){
 	int i,j;
 	cField the_field;
 	the_field.type = 2;
+	// Collect a list of unused special nodes, to be used for fixing specials that could be triggered in a boat.
+	std::vector<int> unused_special_slots;
+	for(i = 0; i < 100; i++) {
+		if(specials[i].type == eSpecType::NONE && specials[i].jumpto == -1) {
+			// Also make sure no specials jump to it
+			bool is_free = true;
+			for(j = 0; j < 100; j++) {
+				if(specials[j].jumpto == i) is_free = false;
+			}
+			if(is_free) unused_special_slots.push_back(i);
+		}
+	}
 	for (i = 0; i < 48; i++)
 		for (j = 0; j < 48; j++) {
 			_terrain[i][j] = old.terrain[i][j];
@@ -71,6 +123,33 @@ void cMedTown::append(legacy::ave_tr_type& old){
 				the_field.loc.y = j;
 				preset_fields.push_back(the_field);
 			}
+			if(scenario.ter_types[_terrain[i][j]].boat_over) {
+				// Try to fix specials that could be triggered while in a boat
+				// (Boats never triggered specials in the old BoE, so we probably don't want them to trigger.)
+				int found_spec = -1;
+				for(int k = 0; i < 50; k++) {
+					if(i == special_locs[k].x && j == special_locs[k].y) {
+						found_spec = k;
+						break;
+					}
+				}
+				if(found_spec >= 0) {
+					if(!unused_special_slots.empty()) {
+						int found_spec_id = spec_id[found_spec], use_slot = unused_special_slots.back();
+						unused_special_slots.pop_back();
+						cSpecial& node = specials[use_slot];
+						node.type = eSpecType::IF_CONTEXT;
+						node.ex1a = 101; // if in boat
+						node.ex1c = -1; // do nothing
+						node.jumpto = found_spec_id; // else jump here
+						spec_id[found_spec] = use_slot;
+					} else {
+						std::stringstream sout;
+						sout << "In town " << town_num << " at (" << i << ',' << j << "); special node ID " << spec_id[found_spec];
+						giveError("Warning: A special node was found that could be triggered from in a boat, which is probably not what the designer intended. An attempt to fix this has failed because there were not enough unused special nodes.", sout.str());
+					}
+				}
+			}
 		}
 	for (i = 0; i < 16; i++) {
 		_room_rect[i].top = old.room_rect[i].top;
@@ -99,10 +178,22 @@ void cMedTown::append(legacy::ave_tr_type& old){
 	}
 }
 
-void cBigTown::append(legacy::big_tr_type& old){
+void cBigTown::append(legacy::big_tr_type& old, int town_num){
 	int i,j;
 	cField the_field;
 	the_field.type = 2;
+	// Collect a list of unused special nodes, to be used for fixing specials that could be triggered in a boat.
+	std::vector<int> unused_special_slots;
+	for(i = 0; i < 100; i++) {
+		if(specials[i].type == eSpecType::NONE && specials[i].jumpto == -1) {
+			// Also make sure no specials jump to it
+			bool is_free = true;
+			for(j = 0; j < 100; j++) {
+				if(specials[j].jumpto == i) is_free = false;
+			}
+			if(is_free) unused_special_slots.push_back(i);
+		}
+	}
 	for (i = 0; i < 64; i++)
 		for (j = 0; j < 64; j++) {
 			_terrain[i][j] = old.terrain[i][j];
@@ -112,6 +203,33 @@ void cBigTown::append(legacy::big_tr_type& old){
 				the_field.loc.y = j;
 				preset_fields.push_back(the_field);
 			}
+			if(scenario.ter_types[_terrain[i][j]].boat_over) {
+				// Try to fix specials that could be triggered while in a boat
+				// (Boats never triggered specials in the old BoE, so we probably don't want them to trigger.)
+				int found_spec = -1;
+				for(int k = 0; i < 50; k++) {
+					if(i == special_locs[k].x && j == special_locs[k].y) {
+						found_spec = k;
+						break;
+					}
+				}
+				if(found_spec >= 0) {
+					if(!unused_special_slots.empty()) {
+						int found_spec_id = spec_id[found_spec], use_slot = unused_special_slots.back();
+						unused_special_slots.pop_back();
+						cSpecial& node = specials[use_slot];
+						node.type = eSpecType::IF_CONTEXT;
+						node.ex1a = 101; // if in boat
+						node.ex1c = -1; // do nothing
+						node.jumpto = found_spec_id; // else jump here
+						spec_id[found_spec] = use_slot;
+					} else {
+						std::stringstream sout;
+						sout << "In town " << town_num << " at (" << i << ',' << j << "); special node ID " << spec_id[found_spec];
+						giveError("Warning: A special node was found that could be triggered from in a boat, which is probably not what the designer intended. An attempt to fix this has failed because there were not enough unused special nodes.", sout.str());
+					}
+				}
+			}
 		}
 	for (i = 0; i < 16; i++) {
 		_room_rect[i].top = old.room_rect[i].top;

osx/classes/regtown.h

@@ -29,7 +29,7 @@ protected:
 	cCreature _creatures[60];
 	unsigned char _lighting[8][64];
 public:
-	void append(legacy::big_tr_type& old);
+	void append(legacy::big_tr_type& old, int town_num);
 	ter_num_t& terrain(size_t x, size_t y);
 	rectangle& room_rect(size_t i);
 	cCreature& creatures(size_t i);
@@ -50,7 +50,7 @@ protected:
 	cCreature _creatures[40];
 	unsigned char _lighting[6][48];
 public:
-	void append(legacy::ave_tr_type& old);
+	void append(legacy::ave_tr_type& old, int town_num);
 	ter_num_t& terrain(size_t x, size_t y);
 	rectangle& room_rect(size_t i);
 	cCreature& creatures(size_t i);
@@ -71,7 +71,7 @@ protected:
 	cCreature _creatures[30];
 	unsigned char _lighting[4][32];
 public:
-	void append(legacy::tiny_tr_type& old);
+	void append(legacy::tiny_tr_type& old, int town_num);
 	ter_num_t& terrain(size_t x, size_t y);
 	rectangle& room_rect(size_t i);
 	cCreature& creatures(size_t i);

osx/classes/town.cpp

@@ -14,9 +14,9 @@
 #include "classes.h"
 #include "oldstructs.h"
 
-void cTown::append(legacy::big_tr_type&){}
-void cTown::append(legacy::ave_tr_type&){}
-void cTown::append(legacy::tiny_tr_type&){}
+void cTown::append(legacy::big_tr_type&, int town_num){}
+void cTown::append(legacy::ave_tr_type&, int town_num){}
+void cTown::append(legacy::tiny_tr_type&, int town_num){}
 
 cTown& cTown::operator = (legacy::town_record_type& old){
 	int i;

osx/classes/town.h

@@ -111,9 +111,9 @@ public:
 	cSpeech talking;
 	
 	virtual ~cTown(){}
-	virtual void append(legacy::big_tr_type& old);
-	virtual void append(legacy::ave_tr_type& old);
-	virtual void append(legacy::tiny_tr_type& old);
+	virtual void append(legacy::big_tr_type& old, int town_num);
+	virtual void append(legacy::ave_tr_type& old, int town_num);
+	virtual void append(legacy::tiny_tr_type& old, int town_num);
 	virtual ter_num_t& terrain(size_t x, size_t y) = 0;
 	virtual rectangle& room_rect(size_t i) = 0;
 	virtual cCreature& creatures(size_t i) = 0;