Map action 507 for printing a message with the remaining map objects #1266

FS-21 · 2024-05-19T17:02:19Z

A message will be printed with a list of alive map objects.
If no CSFKey is mentioned (value 0) it will use the default header text Remaining: .
HouseIndex points to any house index of the map. Multiplayer 4475-4482 & 8997 indexes are valid.
If HouseIndex is set -1 then [AIHousesListsIndex] will be used as index of a list of countries in the [AIHousesList] section located in rulesmd.ini. If any map object match the ownership with one of the list it will be counted.
[AITargetTypesIndex] is the index of an entry in the [AITargetTypes] section located in rulesmd.ini. Each alive map object listed here will be counted.
If [AITargetTypesIndex] is negative this value will be evaluated as a positive index in [AITargetTypesIndex] but instead of printing a list of alive map objects and the respective count it will appear as an unique global count of all the alive map objects listed in [AITargetTypes].
MesageDelay is the time (in minutes) of the message displayed. If the value is 0 then the duration of the message will be the default MesageDelay value specified in rulesmd.ini.
Be aware a message can't show more than 6 lines so if [AITargetTypes] contains more than 5 map objects then the first lines won't appear.

In mycampaign.map:

[Actions]
...
ID=ActionCount,[Action1],507,4,[CSFKey],[HouseIndex],[AIHousesListsIndex],[AITargetTypesIndex],[MesageDelay],A,[ActionX]
...

--- Example 1 ---
507,4,0,5,0,-39,30,A

No CSF entry so it will show as first line "Remaining: ".
5 is the index of a specific house in the map we want to count its objects.
0 is ignored here because we mentioned previously an unique house.
-39 in this case is the entry 39 of [AITargetTypes] that only contain a SAM Turret defense. Because the value is negative the message won't appear the name of the structure.
30 means the message duration will be half minute.

If tehre are 7 SAM turrets of that house with index "5" then the result would look like "Remaining: 7".

--- Example 2 ---
507,4,0,5,0,39,0,A

No CSF entry so it will show as first line "Remaining: ".
5 is the index of a specific house in the map we want to count its objects.
0 is ignored here because we mentioned previously an unique house.
39 in this case is the entry 39 of [AITargetTypes] that only contain a SAM Turret defense and a Laser defense. Because the value is positive the message will show the name of the map objects.
0 means MesageDelay value will be the default specified in rulesmd.ini.

If there are 7 SAM turrets & 2 Laser defenses of that house with index "5" then the result would look like:
"Remaining:
SAM Turret: 7
Laser Turret: 2"

…-print-remaining-technos

github-actions · 2024-05-19T17:06:29Z

Nightly build for this pull request:

compiled-dll-12e787cf6b196c5e118270330c517e23aa191f17.zip
These artifacts will expire in 90 days and will not be available for download after that time.

This comment is automatic and is meant to allow guests to get latest nightly builds for this pull request without registering. It is updated on every successful build.

MortonPL

I don't think this is ready to be used as of now. Refer to review comments and compiler warnings.

MortonPL · 2024-05-23T12:30:10Z

src/Ext/TAction/Body.cpp

+		// Multiplayer house index (Player@A - Player@H)
+		param3 = pThis->Param3 - HouseClass::PlayerAtA;
+	}
+	else if (pThis->Param3 - 8997 == 0)


Suggested change

else if (pThis->Param3 - 8997 == 0)

else if (pThis->Param3 == 8997)

MortonPL · 2024-05-23T12:31:43Z

src/Ext/TAction/Body.cpp

+	// Obtain houses
+	int param3 = pThis->Param3;
+
+	if (pThis->Param3 - HouseClass::PlayerAtA >= 0 && pThis->Param3 - HouseClass::PlayerAtA < 8997)


Suggested change

if (pThis->Param3 - HouseClass::PlayerAtA >= 0 && pThis->Param3 - HouseClass::PlayerAtA < 8997)

if (pThis->Param3 >= HouseClass::PlayerAtA && pThis->Param3 <= HouseClass::PlayerAtH)

MortonPL · 2024-05-23T12:36:01Z

src/Ext/TAction/Body.cpp

+	else if (pThis->Param3 > 8997)
+	{
+		Debug::Log("Map action %d: Invalid house index '%d'. This action will be skipped.\n", (int)pThis->ActionKind, pThis->Param3);
+		return true;
+	}
+
+	if (param3 >= 0)
+	{
+		pHousesList.push_back(HouseClass::Array->GetItem(param3));
+	}


What if we have only 4 houses, but set this param to i.e. 6? Or 5000?

MortonPL · 2024-05-23T12:41:23Z

src/Ext/TAction/Body.cpp

+		return true;
+	// Example:
+	// ID=ActionCount,[Action1],507,4,[CSFKey],[HouseIndex],[AIHousesLists Index],[AITargetTypes Index],[MesageDelay],A,[ActionX]
+	std::vector<HouseClass*> pHousesList;


This is not a pointer, so it shouldn't have the p prefix.

MortonPL · 2024-05-23T12:51:05Z

src/Ext/Rules/Body.cpp

@@ -66,6 +67,7 @@ void RulesExt::ExtData::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)

 	const char* sectionAITargetTypes = "AITargetTypes";
 	const char* sectionAIScriptsList = "AIScriptsList";
+	const char* sectionAIHousesList = "AIHousesList";


Why is it called AIHousesList when it lists house types and not houses, and got nothing to do with being AI controlled?

MortonPL · 2024-05-23T13:38:58Z

src/Ext/TAction/Body.cpp

+				if (pTechno->Owner == pHouse)
+				{
+					globalRemaining++;
+					nRemaining++;
+				}


There should be a break here as there can be only one owner of an object.

MortonPL · 2024-05-23T13:46:36Z

src/Ext/TAction/Body.cpp

+		if (globalRemaining > 0)
+		{
+			wchar_t strInteger[24] = { 0 };
+			swprintf_s(strInteger, L"%d", globalRemaining);
+			wcscat_s(message, strInteger);
+			textToShow = true;
+		}


When there are no remaining objects, nothing will be printed. Is this intentional? If so, then it should be explicitly mentioned in the documentation.

MortonPL · 2024-05-23T13:54:12Z

src/Ext/TAction/Body.cpp

+			if (technosRemaining[i] == 0)
+				continue;


Same as the previous comment about skipping 0 objects.

MortonPL · 2024-05-23T14:01:27Z

src/Ext/TAction/Body.cpp

+		if (listIdx >= 0)
+			housesList = RulesExt::Global()->AIHousesLists.at(listIdx);


What if index is bigger than the number of elements?

MortonPL · 2024-05-23T14:40:09Z

docs/AI-Scripting-and-Mapping.md

+- If `HouseIndex` is set `-1` then `[AIHousesListsIndex]` will be used as index of a list of countries in the `[AIHousesList]` section located in `rulesmd.ini`. If any map object match the ownership with one of the list it will be counted.
+- `[AITargetTypesIndex]` is the index of an entry in the `[AITargetTypes]` section located in `rulesmd.ini`. Each alive map object listed here will be counted.
+- If `[AITargetTypesIndex]` is negative this value will be evaluated as a positive index in `[AITargetTypesIndex]` but instead of printing a list of alive map objects and the respective count it will appear as an unique global count of all the alive map objects listed in `[AITargetTypes]`.


Can't say I'm a fan of controlling behavior like that. IMO it's better to have multiple actions with different behavior and well defined parameters.

FS-21 added 4 commits May 19, 2024 17:50

Initial commit

bcafb90

fix

4f85d0b

update documentation

9b9ae70

Merge remote-tracking branch 'origin/develop' into feature/map-action…

a349151

…-print-remaining-technos

MortonPL requested changes May 23, 2024

View reviewed changes

MortonPL added the Needs improvement label May 23, 2024

chaserli force-pushed the develop branch from 7a22efe to c801eb9 Compare June 9, 2024 14:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Map action 507 for printing a message with the remaining map objects #1266

Map action 507 for printing a message with the remaining map objects #1266

FS-21 commented May 19, 2024 •

edited

github-actions bot commented May 19, 2024

MortonPL left a comment

MortonPL May 23, 2024

MortonPL May 23, 2024

MortonPL May 23, 2024

MortonPL May 23, 2024

MortonPL May 23, 2024

MortonPL May 23, 2024

MortonPL May 23, 2024

MortonPL May 23, 2024

MortonPL May 23, 2024

MortonPL May 23, 2024

	else if (pThis->Param3 - 8997 == 0)
	else if (pThis->Param3 == 8997)

	if (pThis->Param3 - HouseClass::PlayerAtA >= 0 && pThis->Param3 - HouseClass::PlayerAtA < 8997)
	if (pThis->Param3 >= HouseClass::PlayerAtA && pThis->Param3 <= HouseClass::PlayerAtH)

		if (listIdx >= 0)
		housesList = RulesExt::Global()->AIHousesLists.at(listIdx);

Map action 507 for printing a message with the remaining map objects #1266

Are you sure you want to change the base?

Map action 507 for printing a message with the remaining map objects #1266

Conversation

FS-21 commented May 19, 2024 • edited

github-actions bot commented May 19, 2024

MortonPL left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FS-21 commented May 19, 2024 •

edited