From e2284f660c904c8b8816df0d8d72c4b1ceb3e1ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20Mail=C3=A4nder?= Date: Fri, 2 Sep 2022 17:47:13 +0200 Subject: [PATCH] Add documentation to TeslaZap. --- OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs b/OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs index c50b8e8d87..f6d6bee708 100644 --- a/OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs +++ b/OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs @@ -23,21 +23,30 @@ namespace OpenRA.Mods.Cnc.Projectiles public readonly string Image = "litning"; [SequenceReference(nameof(Image))] + [Desc("Sprite sequence to play at the center.")] public readonly string BrightSequence = "bright"; [SequenceReference(nameof(Image))] + [Desc("Sprite sequence to play at the borders.")] public readonly string DimSequence = "dim"; [PaletteReference] + [Desc("The palette used to draw this electric zap.")] public readonly string Palette = "effect"; + [Desc("How many sprite sequences to play at the center.")] public readonly int BrightZaps = 1; + + [Desc("How many sprite sequences to play at the borders.")] public readonly int DimZaps = 2; + [Desc("How long (in ticks) to play the sprite sequences.")] public readonly int Duration = 2; + [Desc("How long (in ticks) until applying damage. Can't be longer than `" + nameof(Duration) + "`")] public readonly int DamageDuration = 1; + [Desc("Follow the targeted actor when it moves.")] public readonly bool TrackTarget = true; public IProjectile Create(ProjectileArgs args) { return new TeslaZap(this, args); }