Skip to content

Commit

Permalink
Add documentation to TeslaZap.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mailaender committed Sep 2, 2022
1 parent 2f0f5f4 commit a02a481
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions OpenRA.Mods.Cnc/Projectiles/TeslaZap.cs
Expand Up @@ -23,21 +23,30 @@ public class TeslaZapInfo : IProjectileInfo
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 sequence to play at the center.")]
public readonly int BrightZaps = 1;

[Desc("How many sprite sequence 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 a moving actor.")]
public readonly bool TrackTarget = true;

public IProjectile Create(ProjectileArgs args) { return new TeslaZap(this, args); }
Expand Down

0 comments on commit a02a481

Please sign in to comment.