Added 7 new functions and more documentation to class cScenarioPlayMode (#64)

* Added SetState to cScenarioPlayMode

* Added 6 new functions to cScenarioPlayMode.

4 member functions and 2 static functions. If anything goes wrong when calling these, feel free to adjust them where necessary.

- Special thanks to Rosalie and ERROR in their help with researching these earlier.

Author: Tenderi4

Spore ModAPI/SourceCode/DLL/AddressesSimulator.cpp

@@ -796,6 +796,13 @@ namespace Simulator
 		DefineAddress(Initialize, SelectAddress(0xF1F450, 0xF1F060));
 		DefineAddress(SetCurrentAct, SelectAddress(0xF1F260, 0xF1EE70));
 		DefineAddress(JumpToAct, SelectAddress(0xF1F7B0, 0xF1F3C0));
+		DefineAddress(SetState, SelectAddress(0xF1ADB0, 0xF1A9C0));
+		DefineAddress(UpdateGoals, SelectAddress(0xF1C780, 0xF1C390));
+		DefineAddress(Update, SelectAddress(0xF1FD50, 0xF1F960));
+		DefineAddress(CompleteAct, SelectAddress(0xF1F680, 0xF1F290));
+		DefineAddress(CheckGoalProgress, SelectAddress(0xF1F8D0, 0xF1F4E0));
+		DefineAddress(RemoveInvisibleClasses, SelectAddress(0xF1AFD0, 0xF1ABE0));
+		DefineAddress(ReadScenarioTuning, SelectAddress(0xF1E2F0, 0xF1DF00));
 	}
 
 	namespace Addresses(cPlanetRecord)

Spore ModAPI/SourceCode/Simulator/Scenario.cpp

@@ -74,5 +74,12 @@ namespace Simulator
 	auto_METHOD_VOID(cScenarioPlayMode, SetCurrentAct, Args(int index, bool arg), Args(index, arg));
 	auto_METHOD_VOID(cScenarioPlayMode, JumpToAct, Args(int actIndex), Args(actIndex));
 	auto_METHOD_VOID_(cScenarioPlayMode, Initialize);
+	auto_METHOD_VOID(cScenarioPlayMode, SetState, Args(ScenarioPlayModeState state), Args(state));
+	auto_METHOD_(cScenarioPlayMode, bool, UpdateGoals);
+	auto_METHOD_VOID(cScenarioPlayMode, Update, Args(int deltaTime), Args(deltaTime));
+	auto_METHOD_VOID_(cScenarioPlayMode, CompleteAct);
+	auto_METHOD_VOID_(cScenarioPlayMode, CheckGoalProgress);
+	auto_STATIC_METHOD_VOID_(cScenarioPlayMode, RemoveInvisibleClasses);
+	auto_STATIC_METHOD_VOID_(cScenarioPlayMode, ReadScenarioTuning);
 }
 #endif

Spore ModAPI/Spore/Simulator/cScenarioPlayMode.h

@@ -56,9 +56,28 @@ namespace Simulator
 	public:
 		//TODO check sub_F1EFC0
 
+		/// Called when starting the adventure in Play Mode.
 		void Initialize();
+		/// Sets the current act index of the active adventure.
 		void SetCurrentAct(int actIndex, bool = false);
+		/// Skips the adventure up to the given act index. Also works in reverse, i. e. going back to previous acts in the adventure. 
+		/// Using the same index as the current act will reset the adventure to the beginning of said act.
 		void JumpToAct(int actIndex);
+		/// Sets the active state of the adventure.
+		void SetState(ScenarioPlayModeState state);
+		/// Updates the current, active goals of the adventure.
+		bool UpdateGoals();
+		/// Update function of the adventure.
+		void Update(int deltaTime);
+		/// Completes the act, then moves the adventure into the next act. If in the last act, the adventure completes.
+		void CompleteAct();
+		/// Called by Update(). Checks if the current goals are clearable or not. 
+		void CheckGoalProgress();  
+
+		/// Removes objects that are supposed to be invisible during the current act.
+		static void RemoveInvisibleClasses();
+		static void ReadScenarioTuning();
+
 
 	public:
 		/* 0Ch */	cScenarioPlaySummary mSummary;
@@ -111,7 +130,15 @@ namespace Simulator
 	namespace Addresses(cScenarioPlayMode)
 	{
 		DeclareAddress(Initialize);		// 0xF1F450, 0xF1F060
-		DeclareAddress(SetCurrentAct);  // 0xF1F260, 0xF1EE70
+		DeclareAddress(SetCurrentAct);	// 0xF1F260, 0xF1EE70
 		DeclareAddress(JumpToAct);		// 0xF1F7B0, 0xF1F3C0
+		DeclareAddress(SetState);		// 0xF1ADB0, 0xF1A9C0
+		DeclareAddress(UpdateGoals);	// 0xF1C780, 0xF1C390
+		DeclareAddress(Update);			// 0xF1FD50, 0xF1F960
+		DeclareAddress(CompleteAct);	// 0xF1F680, 0xF1F290
+		DeclareAddress(CheckGoalProgress);	// 0xF1F8D0, 0xF1F4E0
+
+		DeclareAddress(RemoveInvisibleClasses); // 0xF1AFD0, 0xF1ABE0
+		DeclareAddress(ReadScenarioTuning); // 0xF1E2F0, 0xF1DF00
 	}
 }