From b6a1f9a9db74ff9442248e05b0e8041227022725 Mon Sep 17 00:00:00 2001 From: Gustas <37534529+PunkPun@users.noreply.github.com> Date: Wed, 24 Aug 2022 14:08:58 +0300 Subject: [PATCH] Add descriptions to all projectiles and warheads --- OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs | 1 + OpenRA.Mods.Common/Projectiles/AreaBeam.cs | 1 + OpenRA.Mods.Common/Projectiles/Bullet.cs | 1 + OpenRA.Mods.Common/Projectiles/GravityBomb.cs | 1 + OpenRA.Mods.Common/Projectiles/InstantHit.cs | 2 +- OpenRA.Mods.Common/Projectiles/Missile.cs | 1 + OpenRA.Mods.Common/Warheads/CreateEffectWarhead.cs | 1 + OpenRA.Mods.Common/Warheads/CreateResourceWarhead.cs | 1 + OpenRA.Mods.Common/Warheads/DestroyResourceWarhead.cs | 1 + OpenRA.Mods.Common/Warheads/FireClusterWarhead.cs | 1 + OpenRA.Mods.Common/Warheads/GrantExternalConditionWarhead.cs | 1 + OpenRA.Mods.Common/Warheads/HealthPercentageDamageWarhead.cs | 1 + OpenRA.Mods.Common/Warheads/LeaveSmudgeWarhead.cs | 1 + OpenRA.Mods.Common/Warheads/SpreadDamageWarhead.cs | 1 + OpenRA.Mods.Common/Warheads/TargetDamageWarhead.cs | 1 + 15 files changed, 15 insertions(+), 1 deletion(-) diff --git a/OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs b/OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs index 268249662d6a..c50b8e8d8755 100644 --- a/OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs +++ b/OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs @@ -17,6 +17,7 @@ namespace OpenRA.Mods.Cnc.Projectiles { + [Desc("Instant-hit projectile used to create electricity-like effects.")] public class TeslaZapInfo : IProjectileInfo { public readonly string Image = "litning"; diff --git a/OpenRA.Mods.Common/Projectiles/AreaBeam.cs b/OpenRA.Mods.Common/Projectiles/AreaBeam.cs index 962653ac08c3..159277685c5b 100644 --- a/OpenRA.Mods.Common/Projectiles/AreaBeam.cs +++ b/OpenRA.Mods.Common/Projectiles/AreaBeam.cs @@ -21,6 +21,7 @@ namespace OpenRA.Mods.Common.Projectiles { + [Desc("Beam projectile that travels in a straight line.")] public class AreaBeamInfo : IProjectileInfo { [Desc("Projectile speed in WDist / tick, two values indicate a randomly picked velocity per beam.")] diff --git a/OpenRA.Mods.Common/Projectiles/Bullet.cs b/OpenRA.Mods.Common/Projectiles/Bullet.cs index 873c4f8d764c..07bd528b9d5d 100644 --- a/OpenRA.Mods.Common/Projectiles/Bullet.cs +++ b/OpenRA.Mods.Common/Projectiles/Bullet.cs @@ -22,6 +22,7 @@ namespace OpenRA.Mods.Common.Projectiles { + [Desc("Projectile that travels in a straight line or arc.")] public class BulletInfo : IProjectileInfo { [Desc("Projectile speed in WDist / tick, two values indicate variable velocity.")] diff --git a/OpenRA.Mods.Common/Projectiles/GravityBomb.cs b/OpenRA.Mods.Common/Projectiles/GravityBomb.cs index 9f64a82a100b..796f2376a774 100644 --- a/OpenRA.Mods.Common/Projectiles/GravityBomb.cs +++ b/OpenRA.Mods.Common/Projectiles/GravityBomb.cs @@ -17,6 +17,7 @@ namespace OpenRA.Mods.Common.Projectiles { + [Desc("Projectile with customizable acceleration vector.")] public class GravityBombInfo : IProjectileInfo { public readonly string Image = null; diff --git a/OpenRA.Mods.Common/Projectiles/InstantHit.cs b/OpenRA.Mods.Common/Projectiles/InstantHit.cs index 459fca44186d..347587e3cf50 100644 --- a/OpenRA.Mods.Common/Projectiles/InstantHit.cs +++ b/OpenRA.Mods.Common/Projectiles/InstantHit.cs @@ -18,7 +18,7 @@ namespace OpenRA.Mods.Common.Projectiles { - [Desc("Simple, invisible, usually direct-on-target projectile.")] + [Desc("Instant, invisible, usually direct-on-target projectile.")] public class InstantHitInfo : IProjectileInfo { [Desc("The maximum/constant/incremental inaccuracy used in conjunction with the InaccuracyType property.")] diff --git a/OpenRA.Mods.Common/Projectiles/Missile.cs b/OpenRA.Mods.Common/Projectiles/Missile.cs index f01c44a938a8..a2821a0ba289 100644 --- a/OpenRA.Mods.Common/Projectiles/Missile.cs +++ b/OpenRA.Mods.Common/Projectiles/Missile.cs @@ -21,6 +21,7 @@ namespace OpenRA.Mods.Common.Projectiles { + [Desc("Projectile with smart tracking.")] public class MissileInfo : IProjectileInfo { [Desc("Name of the image containing the projectile sequence.")] diff --git a/OpenRA.Mods.Common/Warheads/CreateEffectWarhead.cs b/OpenRA.Mods.Common/Warheads/CreateEffectWarhead.cs index 7ee7194ad87b..f1b6e17d7c8a 100644 --- a/OpenRA.Mods.Common/Warheads/CreateEffectWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/CreateEffectWarhead.cs @@ -19,6 +19,7 @@ namespace OpenRA.Mods.Common.Warheads { + [Desc("Spawn a sprite with sound.")] public class CreateEffectWarhead : Warhead { [SequenceReference(nameof(Image), allowNullImage: true)] diff --git a/OpenRA.Mods.Common/Warheads/CreateResourceWarhead.cs b/OpenRA.Mods.Common/Warheads/CreateResourceWarhead.cs index 7f2dbf49130c..c521f6ae5155 100644 --- a/OpenRA.Mods.Common/Warheads/CreateResourceWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/CreateResourceWarhead.cs @@ -15,6 +15,7 @@ namespace OpenRA.Mods.Common.Warheads { + [Desc("Creates resources in a circle.")] public class CreateResourceWarhead : Warhead { [Desc("Size of the area. The resources are seeded within this area.", "Provide 2 values for a ring effect (outer/inner).")] diff --git a/OpenRA.Mods.Common/Warheads/DestroyResourceWarhead.cs b/OpenRA.Mods.Common/Warheads/DestroyResourceWarhead.cs index 9001ac18ae4c..346f170c092a 100644 --- a/OpenRA.Mods.Common/Warheads/DestroyResourceWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/DestroyResourceWarhead.cs @@ -16,6 +16,7 @@ namespace OpenRA.Mods.Common.Warheads { + [Desc("Destroys resources in a circle.")] public class DestroyResourceWarhead : Warhead { [Desc("Size of the area. The resources are removed within this area.", "Provide 2 values for a ring effect (outer/inner).")] diff --git a/OpenRA.Mods.Common/Warheads/FireClusterWarhead.cs b/OpenRA.Mods.Common/Warheads/FireClusterWarhead.cs index 37b83e28143b..4f1ce3080d6a 100644 --- a/OpenRA.Mods.Common/Warheads/FireClusterWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/FireClusterWarhead.cs @@ -17,6 +17,7 @@ namespace OpenRA.Mods.Common.Warheads { + [Desc("Fires weapons from the point of impact.")] public class FireClusterWarhead : Warhead, IRulesetLoaded { [WeaponReference] diff --git a/OpenRA.Mods.Common/Warheads/GrantExternalConditionWarhead.cs b/OpenRA.Mods.Common/Warheads/GrantExternalConditionWarhead.cs index 1b2ab3b40e3f..b186f324a7a5 100644 --- a/OpenRA.Mods.Common/Warheads/GrantExternalConditionWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/GrantExternalConditionWarhead.cs @@ -16,6 +16,7 @@ namespace OpenRA.Mods.Common.Warheads { + [Desc("Grant an external condition to hit actors.")] public class GrantExternalConditionWarhead : Warhead { [FieldLoader.Require] diff --git a/OpenRA.Mods.Common/Warheads/HealthPercentageDamageWarhead.cs b/OpenRA.Mods.Common/Warheads/HealthPercentageDamageWarhead.cs index d64e648466de..e670350c0bd3 100644 --- a/OpenRA.Mods.Common/Warheads/HealthPercentageDamageWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/HealthPercentageDamageWarhead.cs @@ -15,6 +15,7 @@ namespace OpenRA.Mods.Common.Warheads { + [Desc("Apply damage based on the target's health.")] public class HealthPercentageDamageWarhead : TargetDamageWarhead { protected override void InflictDamage(Actor victim, Actor firedBy, HitShape shape, WarheadArgs args) diff --git a/OpenRA.Mods.Common/Warheads/LeaveSmudgeWarhead.cs b/OpenRA.Mods.Common/Warheads/LeaveSmudgeWarhead.cs index 55d705421005..5aa3c5aa4579 100644 --- a/OpenRA.Mods.Common/Warheads/LeaveSmudgeWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/LeaveSmudgeWarhead.cs @@ -18,6 +18,7 @@ namespace OpenRA.Mods.Common.Warheads { + [Desc("Creates a smudge in `SmudgeLayer`.")] public class LeaveSmudgeWarhead : Warhead { [Desc("Size of the area. A smudge will be created in each tile.", "Provide 2 values for a ring effect (outer/inner).")] diff --git a/OpenRA.Mods.Common/Warheads/SpreadDamageWarhead.cs b/OpenRA.Mods.Common/Warheads/SpreadDamageWarhead.cs index e6083299894b..52382dd5654b 100644 --- a/OpenRA.Mods.Common/Warheads/SpreadDamageWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/SpreadDamageWarhead.cs @@ -18,6 +18,7 @@ namespace OpenRA.Mods.Common.Warheads { public enum DamageCalculationType { HitShape, ClosestTargetablePosition, CenterPosition } + [Desc("Apply damage in a specified range.")] public class SpreadDamageWarhead : DamageWarhead, IRulesetLoaded { [Desc("Range between falloff steps.")] diff --git a/OpenRA.Mods.Common/Warheads/TargetDamageWarhead.cs b/OpenRA.Mods.Common/Warheads/TargetDamageWarhead.cs index 07e1640a7fa5..43f3f8305959 100644 --- a/OpenRA.Mods.Common/Warheads/TargetDamageWarhead.cs +++ b/OpenRA.Mods.Common/Warheads/TargetDamageWarhead.cs @@ -16,6 +16,7 @@ namespace OpenRA.Mods.Common.Warheads { + [Desc("Apply damage to the targeted actor.")] public class TargetDamageWarhead : DamageWarhead { [Desc("Damage will be applied to actors in this area. A value of zero means only targeted actor will be damaged.")]