PeriodicWeapon by AGAGUGUG · Pull Request #2216 · Phobos-developers/Phobos

AGAGUGUG · 2026-05-17T15:05:57Z

The function of this property is to periodically fire weapons at all targets within its range. Currently, it determines which targets are locked by polling the units within its range. Currently, there are the following key-value pairs PeriodicWeapon= PeriodicWeapon.FiringDelay=
PeriodicWeapon.Range=
PeriodicWeapon.AffectsHouses=
PeriodicWeapon.UseInvokerAsOwner=
PeriodicWeapon.FireAll=
PeriodicWeapon.AffectTypes=
PeriodicWeapon.IgnoreTypes=
When the value is 'no', it will only fire at the nearest target within range that can be filtered; when this value is 'yes', it will fire at all targets within range.

TaranDahl · 2026-05-17T15:12:50Z

Docs needed

github-actions · 2026-05-17T15:18:12Z

Nightly build for this pull request:

compiled-dll-fd8d5fdca8a6916ddd6fd1841984acd093599364.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.

The function of this property is to periodically fire weapons at all targets within its range. Currently, it determines which targets are locked by polling the units within its range. Currently, there are the following key-value pairs PeriodicWeapon= PeriodicWeapon.FiringDelay= PeriodicWeapon.Range= PeriodicWeapon.AffectsHouses= PeriodicWeapon.UseInvokerAsOwner= PeriodicWeapon.FireAll= PeriodicWeapon.AffectTypes= PeriodicWeapon.IgnoreTypes= When the value is 'no', it will only fire at the nearest target within range that can be filtered; when this value is 'yes', it will fire at all targets within range.

phoboscn-bot · 2026-05-18T04:48:24Z

To Chinese users:
This pull request has been mentioned on Phobos CN. There might be relevant details there:

致中文用户：
此拉取请求已在 Phobos CN 上被提及。那里可能有相关详细信息：

https://www.phoboscn.top/t/topic/467/4

TaranDahl

You should really read this first: If all is clear - you should get in touch with maintainers of level respective to the complexity of your PR (see Types of contributions) to review/merge your upcoming PR and talk with them about key design aspects before you even submit a contribution.

- Renamed: `FiringDelay` → `Delay`, added `InitialDelay` for first-shot delay - Removed obsolete fields: `AffectsHouse`, `AffectTypes`, `IgnoreTypes`, `FireAll` - Added target selection strategy: `Target = nearest / all / random` - Legacy keys `FiringDelay` and `FireAll` are still readable but will trigger deprecation warnings (same as `RevengeWeapon`) - Targeting logic moved to `WeaponHelpers.cpp`, shared between `Splits` and `PeriodicWeapon` - Removed duplicate `IsProjectileEligibleTarget` - Target filtering now uses weapon-side rules: `CanTargetHouses`, `CanTarget`, health/veterancy, AE requirements, etc. - Self-targeting is now controlled by projectile flag `RetargetSelf` (no longer hard-excludes the attach owner) - `FirePeriodicWeapon` now respects firepower multiplier, sorts targets by distance - Updated documentation: `docs/New-or-Enhanced-Logics.md` and Chinese po file

AGAGUGUG · 2026-05-19T07:52:06Z

Preliminary modifications have been made

- Renamed: `FiringDelay` → `Delay`, added `InitialDelay` for first-shot delay - Removed obsolete fields: `AffectsHouse`, `AffectTypes`, `IgnoreTypes`, `FireAll` - Added target selection strategy: `Target = nearest / all / random` - Legacy keys `FiringDelay` and `FireAll` are still readable but will trigger deprecation warnings (same as `RevengeWeapon`) - Targeting logic moved to `WeaponHelpers.cpp`, shared between `Splits` and `PeriodicWeapon` - Removed duplicate `IsProjectileEligibleTarget` - Target filtering now uses weapon-side rules: `CanTargetHouses`, `CanTarget`, health/veterancy, AE requirements, etc. - Self-targeting is now controlled by projectile flag `RetargetSelf` (no longer hard-excludes the attach owner) - `FirePeriodicWeapon` now respects firepower multiplier, sorts targets by distance - Updated documentation: `docs/New-or-Enhanced-Logics.md` and Chinese po file

PeriodicWeapon.FiringDelay PeriodicWeapon.Target PeriodicWeapon.FireAll has been delete Currently, only the following key values are available PeriodicWeapon=YourWeaponName ; WeaponType PeriodicWeapon.Delay=30 ; integer - game frames PeriodicWeapon.InitialDelay=15 ; integer - game frames PeriodicWeapon.Range=5 ; floating point, cells PeriodicWeapon.TargetingMode=closest ; closest | all | <callback name> PeriodicWeapon.TargetSelf=false ; boolean PeriodicWeapon.UseInvokerAsOwner=false ; boolean

Refactored split/periodic target validation into WeaponTypeExt::IsAllowedTarget and BulletTypeExt::IsAllowedTarget with no intended behavioral change; call sites updated for splits and periodic weapon.

AGAGUGUG · 2026-05-19T15:23:50Z

Done

AGAGUGUG · 2026-05-20T09:04:34Z

So is there anything else that needs to be changed?

TaranDahl · 2026-05-20T09:31:15Z

So is there anything else that needs to be changed?

Will review this on Friday. I am not available now.

AGAGUGUG · 2026-05-20T09:32:26Z

OK I got it

TaranDahl · 2026-05-20T09:42:16Z

Besides, since this is your first contribution, it needs to be reviewed by senior maintainers in accordance with the process.
@ZivDero maybe you can take a look?

ZivDero · 2026-05-20T10:48:46Z

+PeriodicWeapon=                                    ; WeaponType
+PeriodicWeapon.Delay=0                             ; integer - game frames
+PeriodicWeapon.InitialDelay=0                      ; integer - game frames
+PeriodicWeapon.Range=0                             ; floating point value, distance in cells


What is the need for a separate range? Why should the weapon's range not be used?

ZivDero · 2026-05-20T10:50:29Z

+#### Periodic weapon custom targeting
+
+Modders can register custom target selection logic in code for use with `PeriodicWeapon.TargetingMode=<name>`:
+
+```cpp
+#include <New/PeriodicWeaponTargeting.h>
+
+static std::vector<TechnoClass*> MyTargeting(
+    AttachEffectClass* pAttachEffect, TechnoClass* pAttached,
+    WeaponTypeClass* pWeapon, TechnoClass* pFirer, HouseClass* pFirerHouse,
+    const PeriodicWeaponValidTargetList& validTargets)
+{
+    // validTargets is sorted by distance (nearest first)
+    // return technos to fire at this interval; empty vector skips firing
+}
+
+// Register during init, e.g. from a DEFINE_HOOK
+PeriodicWeaponTargeting::Register("MyMode", MyTargeting);
+```
+
+Target search uses `BulletTypeExt::IsAllowedTarget` and `WeaponTypeExt::IsAllowedTarget` with full weapon targeting enabled.
+


C++ code in docs? WUT?

No bother. I will move the callback things to the API doc when the API PR is finished.

ZivDero · 2026-05-20T10:54:51Z

+	TechnoClass* pFirer = pType->PeriodicWeapon_UseInvokerAsOwner ? this->Invoker : pTechno;
+	HouseClass* pFirerHouse = pType->PeriodicWeapon_UseInvokerAsOwner
+		? (this->InvokerHouse ? this->InvokerHouse : pTechno->Owner)
+		: pTechno->Owner;
+
+	if (!pFirer)
+		pFirer = pTechno;
+
+	if (!pFirerHouse)
+		pFirerHouse = pTechno->Owner;


Suggested change

TechnoClass* pFirer = pType->PeriodicWeapon_UseInvokerAsOwner ? this->Invoker : pTechno;

HouseClass* pFirerHouse = pType->PeriodicWeapon_UseInvokerAsOwner

? (this->InvokerHouse ? this->InvokerHouse : pTechno->Owner)

: pTechno->Owner;

if (!pFirer)

pFirer = pTechno;

if (!pFirerHouse)

pFirerHouse = pTechno->Owner;

const bool useInvoker = pType->PeriodicWeapon_UseInvokerAsOwner;

TechnoClass* pFirer = useInvoker && this->Invoker

? this->Invoker

: pTechno;

HouseClass* pFirerHouse = useInvoker && this->InvokerHouse

? this->InvokerHouse

: pTechno->Owner;

ZivDero · 2026-05-20T10:56:20Z

+	for (auto const pTarget : TechnoClass::Array)
+	{
+		if (!pTarget || pTarget->InLimbo)
+			continue;
+
+		if (!targetSelf && pTarget == pTechno)
+			continue;
+
+		if (!pTarget->IsInPlayfield || !pTarget->IsOnMap || !pTarget->IsAlive || pTarget->Health <= 0)
+			continue;
+
+		const int dist = pTarget->DistanceFrom(pTechno);
+
+		if (dist > searchRange)
+			continue;
+
+		if (!BulletTypeExt::IsAllowedTarget(pBulletType, pTarget, useWeaponTargeting, pFirer))
+			continue;
+
+		if (!WeaponTypeExt::IsAllowedTarget(pWeapon, pTarget, useWeaponTargeting, pFirer, pFirerHouse))
+			continue;
+
+		validTargets.emplace_back(pTarget, dist);
+	}


This is not the end of the world, to iterate all technos, but you could consider iterating cells' occipiers + using AircraftTrackerClass

ZivDero · 2026-05-20T10:57:18Z

+	if (!_strcmpi(mode, PeriodicWeaponTargeting::ModeAll))
+	{
+		for (auto const& [pTarget, _] : validTargets)
+			fireAt(pTarget);
+	}
+	else if (!_strcmpi(mode, PeriodicWeaponTargeting::ModeClosest))
+	{
+		fireAt(validTargets.front().first);
+	}


Uh.... No. Parse the mode while reading the INI and save it as an enum, don't do string comparisons when firing.

ZivDero · 2026-05-20T10:58:30Z

The whole "modders can make new modes" needs to be thoroghly elaborated on, and considered after that.

TaranDahl · 2026-05-20T12:06:38Z

The whole "modders can make new modes" needs to be thoroghly elaborated on, and considered after that.

I thought the callback thing was already discussed in 2131?

1.Now PeriodicWeapon.Range will no longer be used, all range-related code will read the properties of the weapon itself 2.Modify the enemy-locking related code, now it will no longer scan all units on the map, only units within the attack range will be scanned 3.Since the current method of mounting weapons uses InRange logic, some native weapon-related key values may not be effective, for example, using a cylindrical range to detect enemies.

ZivDero · 2026-05-20T15:45:28Z

The whole "modders can make new modes" needs to be thoroghly elaborated on, and considered after that.

I thought the callback thing was already discussed in 2131?

Ah.... If that's in relation to that I have no objections. Though it's not exactly a modder-facing feature, but that's a docs nitpick.

Then storing the type as a string sorta makes sense, too, if we haven't got a closed list of options.

TaranDahl · 2026-05-21T12:11:38Z

Then storing the type as a string sorta makes sense, too, if we haven't got a closed list of options.

I think we can try parsing it as both a callback name and an enum at the same time.

AGAGUGUG force-pushed the develop branch from d169b41 to e930763 Compare May 18, 2026 04:46

Fix Read projectile AA / AG / AAOnly / AU check

c848f6d

TaranDahl requested changes May 18, 2026

View reviewed changes

TaranDahl added ❓New feature Needs improvement ⚙️T2 T2 maintainer review is sufficient labels May 18, 2026

This comment was marked as duplicate.

Sign in to view

AGAGUGUG added 2 commits May 19, 2026 16:01

TaranDahl reviewed May 19, 2026

View reviewed changes

Comment thread Phobos.log Outdated

Comment thread src/Ext/Techno/Body.h Outdated

Comment thread src/Ext/Techno/Body.h Outdated

AGAGUGUG added 2 commits May 19, 2026 22:43

FIX

84bfebd

Refactored split/periodic target validation into WeaponTypeExt::IsAllowedTarget and BulletTypeExt::IsAllowedTarget with no intended behavioral change; call sites updated for splits and periodic weapon.

Make up submission

b9fc652

AGAGUGUG force-pushed the develop branch from 10db911 to b9fc652 Compare May 19, 2026 15:21

DeathFishAtEase reviewed May 19, 2026

View reviewed changes

Comment thread src/RCa55180 Outdated

Delete RCa55180

2b6c659

ZivDero requested changes May 20, 2026

View reviewed changes

Uh oh!

Conversation

AGAGUGUG commented May 17, 2026

Uh oh!

TaranDahl commented May 17, 2026

Uh oh!

github-actions Bot commented May 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

phoboscn-bot commented May 18, 2026

Uh oh!

TaranDahl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AGAGUGUG commented May 19, 2026

Uh oh!

This comment was marked as duplicate.

Uh oh!

Uh oh!

Uh oh!

AGAGUGUG commented May 19, 2026

Uh oh!

Uh oh!

AGAGUGUG commented May 20, 2026

Uh oh!

TaranDahl commented May 20, 2026

Uh oh!

AGAGUGUG commented May 20, 2026

Uh oh!

TaranDahl commented May 20, 2026

Uh oh!

ZivDero May 20, 2026

Choose a reason for hiding this comment

Uh oh!

ZivDero May 20, 2026

Choose a reason for hiding this comment

Uh oh!

TaranDahl May 20, 2026

Choose a reason for hiding this comment

Uh oh!

ZivDero May 20, 2026

Choose a reason for hiding this comment

Uh oh!

ZivDero May 20, 2026

Choose a reason for hiding this comment

Uh oh!

ZivDero May 20, 2026

Choose a reason for hiding this comment

Uh oh!

ZivDero commented May 20, 2026

Uh oh!

TaranDahl commented May 20, 2026

Uh oh!

ZivDero commented May 20, 2026

Uh oh!

TaranDahl commented May 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented May 17, 2026 •

edited

Loading