Merge remote-tracking branch 'upstream/develop' into multiweapon

# Conflicts:
#	docs/Whats-New.md

Author: Coronia

CREDITS.md

@@ -70,6 +70,7 @@ This page lists all the individual contributions to the project by their author.
   - Ability for deployed infantry to use both weapons
   - Observer PCX loading screen
   - Original `Arcing` elevation inaccuracy fix
+  - Display banner improvement
   - Official CN docs for Build#29 and previous versions
 - **secsome (SEC-SOME)**:
   - Debug info dump hotkey
@@ -288,6 +289,7 @@ This page lists all the individual contributions to the project by their author.
   - `601 House owns TechnoType` and `602 House doesn't own TechnoType` trigger events
   - Voxel light source position customization
   - Extending `Power` to all TechnoTypes
+  - Display banner by triggers
   - Help with docs
 - **ChrisLv_CN** (work relicensed under [following permission](https://github.com/Phobos-developers/Phobos/blob/develop/images/ChrisLv-relicense.png)):
   - General assistance
@@ -414,6 +416,7 @@ This page lists all the individual contributions to the project by their author.
   - Fix the bug that `DamageSelf` and `AllowDamageOnSelf` are ineffective on airforce
   - Customize limit when engineer repair a building
   - Fix the bug that damaged particle dont disappear after building has repaired by engineer
+  - Display banner improvement
 - **Apollo** - Translucent SHP drawing patches
 - **ststl**:
   - Customizable `ShowTimer` priority of superweapons
@@ -422,6 +425,7 @@ This page lists all the individual contributions to the project by their author.
   - Unlimited `AlternateFLH` entries
   - Build limit group
   - Customizing whether passengers are kicked out when an aircraft fires
+  - Display banner by triggers
   - New SuperWeapon Type template
   - Fix the issue where some units crashed after the deployment transformation
 - **TwinkleStar**:
@@ -509,6 +513,7 @@ This page lists all the individual contributions to the project by their author.
   - Allow player's self-healing effects to be benefited by allied or `PlayerControl=true` houses
   - Power plant damage factor
   - Allow faking digital display for `InfoType=Health` at disguise
+  - Display banner improvement and doc
 - **NaotoYuuki** - Vertical & meteor trajectory projectile prototypes
 - **handama** - AI script action to `16005 Jump Back To Previous Script`
 - **TaranDahl (航味麻酱)**:

Phobos.vcxproj

@@ -90,8 +90,10 @@
     <ClCompile Include="src\Misc\Hooks.VeinholeMonster.cpp" />
     <ClCompile Include="src\Misc\PhobosToolTip.cpp" />
     <ClCompile Include="src\Misc\TextInput.cpp" />
+    <ClCompile Include="src\New\Entity\BannerClass.cpp" />
     <ClCompile Include="src\New\Entity\ShieldClass.cpp" />
     <ClCompile Include="src\Misc\RetryDialog.cpp" />
+    <ClCompile Include="src\New\Type\BannerTypeClass.cpp" />
     <ClCompile Include="src\New\Type\Affiliated\DroppodTypeClass.cpp" />
     <ClCompile Include="src\New\Type\DigitalDisplayTypeClass.cpp" />
     <ClCompile Include="src\New\Type\InsigniaTypeClass.cpp" />
@@ -247,6 +249,8 @@
     <ClInclude Include="src\Misc\FlyingStrings.h" />
     <ClInclude Include="src\Misc\PhobosToolTip.h" />
     <ClInclude Include="src\Misc\SyncLogging.h" />
+    <ClInclude Include="src\New\Entity\BannerClass.h" />
+    <ClInclude Include="src\New\Type\BannerTypeClass.h" />
     <ClInclude Include="src\New\Type\Affiliated\TypeConvertGroup.h" />
     <ClInclude Include="src\New\Type\Affiliated\DroppodTypeClass.h" />
     <ClInclude Include="src\New\Type\DigitalDisplayTypeClass.h" />

docs/AI-Scripting-and-Mapping.md

@@ -666,6 +666,47 @@ ID=ActionCount,[Action1],608,0,0,[HouseIndex],0,0,0,A,[ActionX]
 ...
 ```
 
+###`800-802` Display Banner
+
+- Display a 'banner' at a fixed location that is relative to the screen.
+  - Action `800` will create a new banner or replace the banner with the same Banner ID if it exists. Using a local variable's value when displaying a text banner.
+  - Action `801` will create a new banner or replace the banner with the same Banner ID if it exists. Using a global variable's value when displaying a text banner.
+  - Action `802` will delete the banner corresponding to the set Banner ID.
+- To make use of this, you need to set the properties of a `BannerType` in your ini file. The banner can either be a `PCX` file, a Shape (`SHP`) file or a `CSF` text. If multiple are set the first one in the above listed order takes effect.
+  - `SHP.Palette` controls the palette that'll be used when drawing a banner for Shape file.
+  - `CSF.Color` controls the color of the text that'll be used when drawing a text banner.
+  - `CSF.Background` controls whether a black background will be displayed below the text banner.
+  - `CSF.VariableFormat` controls the way to print a variable together with the text banner.
+    - `none` will make the text banner not display the variable.
+    - `variable` will make the text banner display the variable alone and will ignore the text in `CSF`.
+    - `prefix`/`prefixed` will make the text banner display the variable before any other text.
+    - `surfix`/`surfixed` will make the text banner display the variable after any other text.
+
+In `rulesmd.ini`:
+```ini
+[BannerTypes]
+0=SOMEBANNER
+
+[SOMEBANNER]                ; BannerType
+PCX=                        ; filename - excluding the .pcx extension
+SHP=                        ; filename - excluding the .shp extension
+SHP.Palette=palette.pal     ; filename - excluding the .pal extension
+CSF=                        ; CSF entry key
+CSF.Color=                  ; integer - R,G,B, defaults to MessageTextColor of the owner Side
+CSF.Background=false        ; boolean
+CSF.VariableFormat=none     ; List of Variable Format Enumeration (none|variable|prefix/prefixed|surfix/surfixed)
+```
+
+In `mycampaign.map`:
+```ini
+[Actions]
+...
+ID=ActionCount,[Action1],800,4,[SOMEBANNER],[Unique ID],[Horizontal position],[Vertical position],[VariableIndex],A,[ActionX]
+ID=ActionCount,[Action1],801,4,[SOMEBANNER],[Unique ID],[Horizontal position],[Vertical position],[VariableIndex],A,[ActionX]
+ID=ActionCount,[Action1],802,0,[Unique ID],0,0,0,0,A,[ActionX]
+...
+```
+
 ## Trigger events
 
 ### `500-511` Variable comparation

docs/Whats-New.md

@@ -117,6 +117,10 @@ HideLightFlashEffects=false      ; boolean
   68=House,1,2
   69=Non-inert,10
   70=AITargetTypes index,0
+  101=BannerType,0
+  102=Horizontal position,0
+  103=Vertical position,0
+  104=Banner ID,0
 
   [EventsRA2]
   500=Local variable is greater than,48,6,0,0,[LONG DESC],0,1,500,1
@@ -175,6 +179,9 @@ HideLightFlashEffects=false      ; boolean
   606=Edit hate-value (Phobos),0,2,55,6,0,0,0,0,0, Edit the hate-value that trigger houses to other houses. -1 works for all houses.,0,1,606
   607=Clear hate-value (Phobos),0,2,0,0,0,0,0,0,0, Clear the hate-value that trigger houses to other houses. -1 works for all houses.,0,1,607
   608=Set force enemy (Phobos),0,0,2,0,0,0,0,0,0, Force an enemy, it will not change with the change of hate-value. -1 will remove the forced enemy, -2 will never have any enemies.,0,1,608
+  800=Display banner and local variable (Phobos),4,101,104,102,103,3,0,0,0,Draw banner on screen and replace banner with same ID,0,1,800
+  001=Display banner and global variable (Phobos),4,101,104,102,103,35,0,0,0,Draw banner on screen and replace banner with same ID,0,1,801
+  802=Delete banner (Phobos),0,104,0,0,0,0,0,0,0,Delete banner with ID,0,1,802
 
   ; FOLLOWING ENTRIES REQUIRE FA2SP.DLL (by secsome)
   [ScriptTypeLists]
@@ -396,6 +403,7 @@ New:
 - [Warhead activation target health thresholds](Fixed-or-Improved-Logics.md#customizable-warhead-trigger-conditions) (by FS-21 & Kerbiter)
 - [Customize limit and sound when engineer repair a building](New-or-Enhanced-Logics.md#engineer-repair-customization) (by NetsuNegi)
 - [Customizable debris trailer anim spawn delay](Fixed-or-Improved-Logics.md#customizable-debris-trailer-anim-spawn-delay) (by CrimRecya)
+- [Display banner](AI-Scripting-and-Mapping.md#display-banner) (by Morton & ststl)
 - Support for more optional weapons (by FlyStar)
 
 Vanilla fixes:

src/Ext/Rules/Body.cpp

@@ -9,6 +9,7 @@
 #include <New/Type/LaserTrailTypeClass.h>
 #include <New/Type/DigitalDisplayTypeClass.h>
 #include <New/Type/AttachEffectTypeClass.h>
+#include <New/Type/BannerTypeClass.h>
 #include <New/Type/InsigniaTypeClass.h>
 #include <New/Type/SelectBoxTypeClass.h>
 #include <Utilities/Patch.h>
@@ -38,6 +39,7 @@ void RulesExt::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 	ShieldTypeClass::LoadFromINIList(pINI);
 	LaserTrailTypeClass::LoadFromINIList(&CCINIClass::INI_Art);
 	AttachEffectTypeClass::LoadFromINIList(pINI);
+	BannerTypeClass::LoadFromINIList(pINI);
 	InsigniaTypeClass::LoadFromINIList(pINI);
 
 	Data->LoadBeforeTypeData(pThis, pINI);

src/Ext/TAction/Body.cpp

@@ -1,15 +1,15 @@
 #include "Body.h"
 
-#include <SessionClass.h>
 #include <MessageListClass.h>
-#include <HouseClass.h>
-#include <CRT.h>
-#include <SuperWeaponTypeClass.h>
-#include <SuperClass.h>
-#include <Ext/SWType/Body.h>
-#include <Utilities/SavegameDef.h>
 
 #include <Ext/Scenario/Body.h>
+#include <Ext/SWType/Body.h>
+
+#include <New/Entity/BannerClass.h>
+
+#include <New/Type/BannerTypeClass.h>
+
+#include <Utilities/SavegameDef.h>
 #include <Ext/House/Body.h>
 
 //Static init
@@ -78,6 +78,13 @@ bool TActionExt::Execute(TActionClass* pThis, HouseClass* pHouse, ObjectClass* p
 	case PhobosTriggerAction::SetForceEnemy:
 		return TActionExt::SetForceEnemy(pThis, pHouse, pObject, pTrigger, location);
 
+	case PhobosTriggerAction::CreateBannerGlobal:
+		return TActionExt::CreateBannerGlobal(pThis, pHouse, pObject, pTrigger, location);
+	case PhobosTriggerAction::CreateBannerLocal:
+		return TActionExt::CreateBannerLocal(pThis, pHouse, pObject, pTrigger, location);
+	case PhobosTriggerAction::DeleteBanner:
+		return TActionExt::DeleteBanner(pThis, pHouse, pObject, pTrigger, location);
+
 	default:
 		bHandled = false;
 		return true;
@@ -364,7 +371,7 @@ bool TActionExt::RunSuperWeaponAt(TActionClass* pThis, int X, int Y)
 		if (pExecuteHouse)
 		{
 			auto const pSuper = pExecuteHouse->Supers.Items[swIdx];
-	
+
 			CDTimerClass old_timer = pSuper->RechargeTimer;
 			pSuper->SetReadiness(true);
 			pSuper->Launch(targetLocation, false);
@@ -512,6 +519,64 @@ bool TActionExt::SetForceEnemy(TActionClass* pThis, HouseClass* pHouse, ObjectCl
 	return true;
 }
 
+static void CreateOrReplaceBanner(TActionClass* pTAction, bool isGlobal)
+{
+	const auto pBannerType = BannerTypeClass::Find(pTAction->Text);
+
+	if (!pBannerType)
+		return;
+
+	auto& banners = BannerClass::Array;
+
+	const auto it = std::find_if(banners.begin(), banners.end(),
+		[pTAction](const std::unique_ptr<BannerClass>& pBanner)
+		{
+			return pBanner->ID == pTAction->Param3;
+		});
+
+	if (it != banners.end())
+	{
+		auto& pBanner = *it;
+		pBanner->Type = pBannerType;
+		pBanner->Position = { static_cast<int>(pTAction->Param4 / 100.0 * DSurface::ViewBounds.Width), static_cast<int>(pTAction->Param5 / 100.0 * DSurface::ViewBounds.Height) };
+		pBanner->Variable = pTAction->Param6;
+		pBanner->IsGlobalVariable = isGlobal;
+	}
+	else
+	{
+		banners.emplace_back(
+			std::make_unique<BannerClass>(pBannerType, pTAction->Param3, Point2D { pTAction->Param4, pTAction->Param5 }, pTAction->Param6, isGlobal)
+		);
+	}
+}
+
+bool TActionExt::CreateBannerGlobal(TActionClass* pThis, HouseClass* pHouse, ObjectClass* pObject, TriggerClass* pTrigger, CellStruct const& location)
+{
+	CreateOrReplaceBanner(pThis, true);
+	return true;
+}
+
+bool TActionExt::CreateBannerLocal(TActionClass* pThis, HouseClass* pHouse, ObjectClass* pObject, TriggerClass* pTrigger, CellStruct const& location)
+{
+	CreateOrReplaceBanner(pThis, false);
+	return true;
+}
+
+bool TActionExt::DeleteBanner(TActionClass* pThis, HouseClass* pHouse, ObjectClass* pObject, TriggerClass* pTrigger, CellStruct const& location)
+{
+	const auto it = std::find_if(BannerClass::Array.cbegin(), BannerClass::Array.cend(),
+		[pThis](const std::unique_ptr<BannerClass>& pBanner)
+		{
+			return pBanner->ID == pThis->Value;
+		});
+
+	if (it != BannerClass::Array.cend())
+		BannerClass::Array.erase(it);
+
+	return true;
+}
+
+
 // =============================
 // container
 

src/Ext/TAction/Body.h

@@ -23,6 +23,10 @@ enum class PhobosTriggerAction : unsigned int
 	EditAngerNode = 606,
 	ClearAngerNode = 607,
 	SetForceEnemy = 608,
+
+	CreateBannerGlobal = 800, // any banner w/ global variable
+	CreateBannerLocal = 801, // any banner w/ local variable
+	DeleteBanner = 802,
 };
 
 class TActionExt
@@ -72,6 +76,10 @@ class TActionExt
 	ACTION_FUNC(ClearAngerNode);
 	ACTION_FUNC(SetForceEnemy);
 
+	ACTION_FUNC(CreateBannerGlobal);
+	ACTION_FUNC(CreateBannerLocal);
+	ACTION_FUNC(DeleteBanner);
+
 	static bool RunSuperWeaponAt(TActionClass* pThis, int X, int Y);
 
 #undef ACTION_FUNC

src/Ext/Techno/Body.cpp

@@ -3,10 +3,8 @@
 #include <AircraftClass.h>
 #include <HouseClass.h>
 #include <ScenarioClass.h>
-#include <OverlayTypeClass.h>
 
 #include <Ext/Anim/Body.h>
-#include <Ext/BulletType/Body.h>
 #include <Ext/House/Body.h>
 #include <Ext/Scenario/Body.h>
 #include <Ext/WeaponType/Body.h>

src/Misc/Hooks.UI.cpp

@@ -11,7 +11,12 @@
 #include <Ext/Scenario/Body.h>
 #include <Ext/TechnoType/Body.h>
 #include <Ext/SWType/Body.h>
+
 #include <Misc/FlyingStrings.h>
+
+#include <New/Entity/BannerClass.h>
+#include <New/Type/BannerTypeClass.h>
+
 #include <Utilities/Debug.h>
 
 DEFINE_HOOK(0x777C41, UI_ApplyAppIcon, 0x9)
@@ -240,6 +245,14 @@ DEFINE_HOOK(0x456776, BuildingClass_DrawRadialIndicator_Visibility, 0x6)
 	return DoNotDraw;
 }
 
+DEFINE_HOOK(0x6D4B25, TacticalClass_Render_Banner, 0x5)
+{
+	for (const auto& pBanner : BannerClass::Array)
+		pBanner->Render();
+
+	return 0;
+}
+
 #pragma region ShowBriefing
 
 namespace BriefingTemp