Phobos-developers · FS-21 · Mar 31, 2022 · Mar 31, 2022 · Mar 31, 2022 · Apr 10, 2022
diff --git a/CREDITS.md b/CREDITS.md
@@ -134,10 +134,9 @@ This page lists all the individual contributions to the project by their author.
   - Power plant damage factor
 - **FS-21**:
   - Dump Object Info enhancements
-  - `Powered.KillSpawns`
-  - `Spawner.LimitRange`
   - Majority of ScriptType actions
   - ScriptType Action 14004: Force Global `OnlyTargetHouseEnemy` value in Teams
+  - Script actions for managing AI Triggers
   - MC deployer fixes
   - Help with docs
   - Automatic Passenger Deletion logic

diff --git a/Phobos.vcxproj b/Phobos.vcxproj
@@ -132,6 +132,7 @@
     <ClCompile Include="src\Ext\Scenario\Hooks.Waypoints.cpp" />
     <!-- src\Ext\Script -->
     <ClCompile Include="src\Ext\Script\Body.cpp" />
+    <ClCompile Include="src\Ext\Script\Body.ManageAITriggers.cpp" />
     <ClCompile Include="src\Ext\Script\Hooks.cpp" />
     <ClCompile Include="src\Ext\Script\Mission.Attack.cpp" />
     <ClCompile Include="src\Ext\Script\Mission.Move.cpp" />

diff --git a/docs/AI-Scripting-and-Mapping.md b/docs/AI-Scripting-and-Mapping.md
@@ -508,6 +508,87 @@ In `aimd.ini`:
 x=16005,0
 ```
 
+### `16006` Set House Index For Managing AI Triggers
+
+- Set the house index for enabling and disabling triggers. The indexes aren't the ones used in [Countries], these are internal in-game House indexes.
+
+In `aimd.ini`:
+```ini
+[SOMESCRIPTTYPE]  ; ScriptType
+x=16006,n           ; integer
+```
+
+- The possible argument values are:
+
+| *Argument* | *Description*                          |
+| :--------: | :-------------------------------------------: |
+| 4475-4482  | Multiplayer start location indexes |
+| 8997       | Special case that returns the house index of the Team object |
+| >= 0       | House index. Neutral houses can be used |
+| -1         | Random non-neutral House |
+| -2         | Find the first Neutral house available |
+| -3         | Random Human Player alive |
+
+### `16007` Enable Or Disable All AI Triggers
+
+- All AI triggers will be enabled or disabled.
+You must set the affected side with action `16012` and house with action `16006`.
+
+In `aimd.ini`:
+```ini
+[SOMESCRIPTTYPE]  ; ScriptType
+x=16007,n           ; integer, 1 == enable, 0 == disable
+```
+
+### `16008` Enable AI Triggers From List
+
+- When executed this action enable all AI trigger types from the selected list in `AITriggersList`. The second parameter is a 0-based index from the new section `AITriggersList` explained below.
+
+In `aimd.ini`:
+```ini
+[SOMESCRIPTTYPE]  ; ScriptType
+x=16008,n
+```
+
+The second parameter is a 0-based index for the `AITriggersList` section that specifies the list of possible `AITriggerTypes` that can be evaluated. The new `AITriggersList` section must be declared in `rulesmd.ini` for making this script work:
+
+In `rulesmd.ini`:
+```ini
+[AITriggersList]  ; List of AITriggerTypes lists
+0=SOMEAITRIGGERTYPE,SOMEOTHERAITRIGGERTYPE,SAMPLETRIGGERTYPE
+1=ANOTHERTRIGGERTYPE,YETANOTHERTRIGGERTYPE
+; ...
+```
+
+### `16009` Disable AI Triggers From List
+
+- Works silimar to the Action `16008`. When executed this action disable all AI trigger types from the selected list in `AITriggersList`. The second parameter is a 0-based index from the new section `AITriggersList`.
+
+### `16010` Disable AI Triggers If Contains Any Objects From the List
+
+- Works silimar to the Action `16011`. When executed this action all AI Trigger Types that contains any unit of the selected list in `AITargetTypes` will be disabled. The second parameter is a 0-based index from the new section `AITargetTypes`.
+
+### `16011` Enable AI Triggers If Contains Any Objects From the List
+
+- When executed this action all AI trigger types that contains any unit of the selected list in `AITargetTypes` will be enabled. The second parameter is a 0-based index from the new section `AITargetTypes`.
+
+In `aimd.ini`:
+```ini
+[SOMESCRIPTTYPE]  ; ScriptType
+x=16011,n
+```
+
+### `16012` Set Side Index For Managing AI Triggers
+
+- Set the side index for enabling and disabling triggers.
+0 means any side.
+
+In `aimd.ini`:
+```ini
+[SOMESCRIPTTYPE]  ; ScriptType
+x=16012,n           ; integer, where 0 > n, default -1
+```
+
 ### `18000-18999` Variable Manipulation
 
 #### `18000-18023` Edit Variable

diff --git a/docs/Whats-New.md b/docs/Whats-New.md
@@ -328,6 +328,13 @@ HideShakeEffects=false           ; boolean
   10103=Load Onto Transports,0,0,1,[LONG DESC]
   10104=Chronoshift to Enemy Base,20,0,1,[LONG DESC]
   14004=Force Global OnlyTargetHouseEnemy value in Teams,20,0,1,[LONG DESC]
+  16006=Set House Index For Managing AI Triggers,20,0,1,[LONG DESC]
+  16007=Enable Or Disable All AI Triggers,21,0,1,[LONG DESC]
+  16008=Enable AI Triggers From List,28,0,1,[LONG DESC]
+  16009=Disable AI Triggers From List,28,0,1,[LONG DESC]
+  16010=Disable AI Triggers If Contains Any Objects From the List,29,0,1,[LONG DESC]
+  16011=Enable AI Triggers If Contains Any Objects From the List,29,0,1,[LONG DESC]
+  16012=Set Side Index For Managing AI Triggers,20,0,1,[LONG DESC]
   18000=Local variable set,22,0,1,[LONG DESC]
   18001=Local variable add,22,0,1,[LONG DESC]
   18002=Local variable minus,22,0,1,[LONG DESC]
@@ -408,6 +415,12 @@ HideShakeEffects=false           ; boolean
   25=Local variables,-4
   26=Global variables,-5
   27=Global variables,-6
+  28=AI Scripts List, -7
+  29=AI Target Type,-8
+
+  [ScriptParamTypes]
+  7=AIScriptsList,1,1,0
+  8=AITargetTypes,1,1,0
   ```
 ````
 
@@ -421,6 +434,7 @@ HideShakeEffects=false           ; boolean
 #### New:
 - [Customized transport plane for teams](AI-Scripting-and-Mapping.md#customized-transport-plane-for-teams) (by FlyStar)
 - [Modify ammo on impact](New-or-Enhanced-Logics.md#modify-ammo-on-impact) (by FS-21)
+- [Script actions for managing AI Triggers](AI-Scripting-and-Mapping.md#script-actions-for-managing-ai-triggers) (by FS-21)
 
 #### Vanilla fixes:
 - Fixed the bug where a building with `Factory=BuildingType` owned by the AI did not play `ProductionAnim` when placing a produced building (by Noble_Fish)
@@ -951,6 +965,7 @@ HideShakeEffects=false           ; boolean
 - Building airstrike target eligibility customization (by Starkku)
 - IvanBomb detonation & image display optionally centered on buildings (by Starkku)
 - Forcing specific weapon against cloaked or disguised targets (by Starkku)
+- Script action for enabling & disabling AI Triggers (by FS-21)
 - Customizable ROF random delay (by Starkku)
 - Animation with `Tiled=yes` now supports `CustomPalette` (by ststl)
 - Toggleable `DieSound` when grinding (by Trsdy)

diff --git a/src/Ext/House/Body.cpp b/src/Ext/House/Body.cpp
@@ -586,6 +586,73 @@ float HouseExt::GetRestrictedFactoryPlantMult(TechnoTypeClass* pTechnoType) cons
 	return 1.0f - ((1.0f - mult) * pTechnoTypeExt->FactoryPlant_Multiplier);
 }
 
+int HouseExt::GetHouseIndex(int param, TeamClass* pTeam, TActionClass* pTAction)
+{
+	if ((pTeam && pTAction) || (param == 8997 && !pTeam && !pTAction))
+		return -1;
+
+	int houseIdx = -1;
+	std::vector<int> housesListIdx;
+
+	// Check special cases
+	if (param < 0)
+	{
+		if (param < -3)
+			return -1;
+
+		for (auto pHouse : HouseClass::Array)
+		{
+			if (param == -2 && pHouse->IsNeutral())
+			{
+				houseIdx = pHouse->ArrayIndex;
+				break;
+			}
+			else if (!pHouse->Defeated && !pHouse->IsObserver())
+			{
+				if ((param == -1 && !pHouse->Type->MultiplayPassive) // Random non-neutral player
+					|| (param == -3 && !pHouse->IsObserver())) // Random human player
+				{
+					housesListIdx.push_back(pHouse->ArrayIndex);
+				}
+
+				if (housesListIdx.size() > 0)
+					houseIdx = housesListIdx.at(ScenarioClass::Instance->Random.RandomRanged(0, housesListIdx.size() - 1));
+				else
+					return -1;
+			}
+		}
+
+		return houseIdx;
+	}
+
+	// Check a specific house of the map
+	if (param >= HouseClass::PlayerAtA && param <= HouseClass::PlayerAtH)
+	{
+		// Is a multiplayer house index (Player@A - Player@H) ?
+		houseIdx = param - HouseClass::PlayerAtA;
+	}
+	else if (param == 8997)
+	{
+		// Is the owner of the trigger ?
+		houseIdx = pTeam ? pTeam->Owner->ArrayIndex : pTAction->TeamType->Owner->ArrayIndex;
+	}
+	else if (param > 8997 || HouseClass::Array.Count <= param)
+	{
+		// Is a invalid index value
+		if (pTAction)
+			Debug::Log(__FUNCTION__": Invalid house index '%d'. This action could be skipped.\n", (int)pTAction->ActionKind, param);
+
+		return -1;
+	}
+
+	HouseClass* pHouse = HouseClass::Array.GetItem(houseIdx);
+
+	if (!pHouse->Defeated && !pHouse->IsObserver())
+		return houseIdx;
+
+	return -1;
+}
+
 void HouseExt::SetForceOnlyTargetHouseEnemy(HouseClass* pThis, int mode)
 {
 	const auto pHouseExt = HouseExt::Fetch(pThis);

diff --git a/src/Ext/House/Body.h b/src/Ext/House/Body.h
@@ -1,5 +1,6 @@
 #pragma once
 #include <HouseClass.h>
+#include <TActionClass.h>
 
 #include <Ext/HouseType/Body.h>
 
@@ -171,6 +172,7 @@ class HouseExt final : public AbstractExt, public Detach::Listener<BuildingClass
 	static int ActiveHarvesterCount(HouseClass* pThis);
 	static int TotalHarvesterCount(HouseClass* pThis);
 	static HouseClass* GetHouseKind(OwnerHouseKind kind, bool allowRandom, HouseClass* pDefault, HouseClass* pInvoker = nullptr, HouseClass* pVictim = nullptr);
+	static int GetHouseIndex(int param, TeamClass* pTeam, TActionClass* pTAction);
 	static CellClass* GetEnemyBaseGatherCell(HouseClass* pTargetHouse, HouseClass* pCurrentHouse, CoordStruct defaultCurrentCoords, SpeedType speedTypeZone, int extraDistance = 0);
 	static void GetAIChronoshiftSupers(HouseClass* pThis, SuperClass*& pSuperCSphere, SuperClass*& pSuperCWarp);
 

diff --git a/src/Ext/Rules/Body.cpp b/src/Ext/Rules/Body.cpp
@@ -659,6 +659,24 @@ void RulesExt::ExtData::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 
 		this->AIScriptsLists.emplace_back(std::move(objectsList));
 	}
+
+	// Section AITriggersList
+	int triggerItemsCount = pINI->GetKeyCount("AITriggersList");
+	for (int i = 0; i < triggerItemsCount; ++i)
+	{
+		std::vector<AITriggerTypeClass*> objectsList;
+
+		char* context = nullptr;
+		pINI->ReadString("AITriggersList", pINI->GetKeyName("AITriggersList", i), "", Phobos::readBuffer);
+
+		for (char *cur = strtok_s(Phobos::readBuffer, Phobos::readDelims, &context); cur; cur = strtok_s(nullptr, Phobos::readDelims, &context))
+		{
+			AITriggerTypeClass* pNewTrigger = GameCreate<AITriggerTypeClass>(cur); // Note: Don't use ::FindOrAllocate(cur) here...
+			objectsList.emplace_back(pNewTrigger);
+		}
+
+		this->AITriggersLists.emplace_back(std::move(objectsList));
+	}
 }
 
 // this should load everything that TypeData is not dependant on
@@ -695,6 +713,7 @@ void RulesExt::ExtData::Serialize(T& Stm)
 	Stm
 		.Process(this->AITargetTypesLists)
 		.Process(this->AIScriptsLists)
+		.Process(this->AITriggersLists)
 		.Process(this->Storage_TiberiumIndex)
 		.Process(this->HarvesterDumpAmount)
 		.Process(this->InfantryGainSelfHealCap)

diff --git a/src/Ext/Rules/Body.h b/src/Ext/Rules/Body.h
@@ -1,5 +1,6 @@
 #pragma once
 
+#include <AITriggerTypeClass.h>
 #include <Utilities/Container.h>
 #include <Utilities/TemplateDef.h>
 
@@ -24,6 +25,7 @@ class RulesExt
 	public:
 		std::vector<std::vector<TechnoTypeClass*>> AITargetTypesLists;
 		std::vector<std::vector<ScriptTypeClass*>> AIScriptsLists;
+		std::vector<std::vector<AITriggerTypeClass*>> AITriggersLists;
 
 		Valueable<int> Storage_TiberiumIndex;
 		Valueable<float> HarvesterDumpAmount;